3 La commande m2h
La syntaxe de la commande m2h est la suivante :
m2h
[-fhilostx]
[manpage
|directory
|[section] command]...
La commande produit une page HTML par page de manuel. Si on précise un
fichier c'est ce fichier qui est traité. Si on précise un répertoire,
c'est l'ensemble des pages de manuel de ce répertoire qui sont
traitées. Si on précise une commande, c'est la page de manuel de cette
commande qui est traitée. On peut alors préciser une section du manuel
dans laquelle rechercher la page.
Les options de m2h sont les suivantes :
-
-f
- Précise de produire la page demandée et
les pages suivantes, ce de manière récursive. Les pages suivantes
sont celles qui sont référencées dans la section SEE ALSO
du manuel.
- -h
- Précise de produire des liens
hypertextes vers les pages des commandes référencées dans la
section SEE ALSO.
- -i
- Produit un index au sein de la page HTML
générée. Cet index est composée d'une liste de liens hypertextes
vers les différentes sections de la page.
- -l logfile
- (par défaut la sortie
standard). Produit l'état d'avancement de la commande, les
problèmes rencontrés (par exemple la liste des macros
troff inconnues) dans le fichier précisé.
- -o outputdir
- (par défaut
.). Produit les fichiers HTML dans le répertoire
outputdir.
- -s stylefile
- utilise le fichier de
style (en général .m2hs) pour réaliser les conversions des
séquences d'échappement troff en balises HTML. Vous avez
à définir un format le mieux adapté pour ces fichiers de style.
Par exemple un tel fichier peut coder les séquences ``
\fB''
et ``\fR'' de la manière suivante :
\fB.*\fR <B>\1</B>
- -t
- Produit une page au format texte et non au format
HTML. Cette option est principalement utilisée pour mettre au
point la commande m2h.
- -x
- Produit dans le répertoire de sortie (voir option
-o) une page index.html qui référence l'ensemble
des pages de manuel générées.