Manuel utilisateur
==================

:Author: Sylvain Thnault
:Organization: Logilab
:Version: $Revision: 1.1 $
:Date: $Date: 2005-03-29 14:24:04 $
:Abstract:
    Manuel pour l'utilisateur des outils de documentations de
    Logilab.


py2dbk
------

Description
```````````
Formate un script Python afin de pouvoir l'inclure dans un document Docbook.

Synopsis
````````
::

    USAGE: py2dbk [OPTIONS] <input.py>...

    OPTIONS:
      -h / --help
	   display this help message and exit

      -r / --root "rootstring"
	   insert "rootstring" as root

      -f / --format <OUTPUT_FORMAT>
	   set output format. Default to docbook.
	   Available formats are docbook, extended-docbook.

      -s / --stdout
	   write results to standard output

Exemple
```````
::

    py2dbk --format extended-docbook monfichier.py

Cet exemple produira en sortie un fichier monfichier.xml.


xml2dbk
-------

Description
```````````
Formatte un fichier XML afin de pouvoir l'inclure dans un document Docbook. Il
est galement possible d'obtenir une sortie HTML (colorise)

Synopsis
````````
::

    USAGE: xml2dbk [OPTIONS] <input.xml>...

    OPTIONS:
      -h / --help
	   display this help message and exit

      -o / --output <OUTPUT_FILE>
	   write results in file <OUTPUT_FILE>.
      -s / --stdout
	   write results to standard output.
      -e / --encoding iso-8859-1
	   specify encoding to use in outputs.

      -n / --no-head
	   do not insert output headers.

      -f / --format <OUTPUT_FORMAT>
	   set output format. Default to docbook.
	   Available formats are docbook, extended-docbook, html.

Exemple
```````
::

    xml2dbk --format extended-docbook monfichier.xml

Cet exemple produira en sortie un fichier monfichier_dcbk.xml.


mkdoc
-----

Description
```````````
Convertit des fichiers au format ReST_ (Restructured Text) ou Docbook_ dans
divers formats tels que html ou pdf.

Synopsis
````````
::

    USAGE: mkdoc [OPTIONS] <input file>...

    OPTIONS:
      -h / --help
	   display this help message and exit

      -f / --format <OUTPUT_FORMAT>
	   set output format. Default to html.
	   Available formats are docbook, html, multi_html, pdf, pdf_ao, pdf_iup, pdf_manual, pdf_psyc, site_html.

      -n / --noverif
	   doesn't verify XML correctness.
      -k / --keep-tmp
	   doesn't remove temporary directory where transforms are done.

      -p / --parameter <NAME>:<VALUE>
	   sets the <NAME> stylesheet parameter to <VALUE>. You may set this option
	   multiple times. Parameters are given to the xslt processor.

Exemple
```````
::

    mkdoc --format pdf monfichier.rst unautrefichier.xml

Cet exemple produira en sortie 2 fichiers : monfichier.pdf et
unautrefichier.pdf.



.. _ReST: http://docutils.sourceforge.net/rst.html
.. _Docbook: http://www.docbook.org