help2man - génère une page de manuel sommaire

help2man [OPTION]... PROGRAMME

« help2man » génère la page de manuel d'un programme à partir des indications fournies par celui-ci lorsqu'il est lancé avec les options « --help » et « --version ».

-n, --name=CHAÎNE

description pour le paragraphe NOM

-s, --section=SECTION

numéro de section de la page de manuel (1, 6, 8)

-m, --manual=TEXTE

nom du manuel (Commandes, ...)

-S, --source=TEXTE

source du programme (FSF, Debian, ...)

-L, --locale=CHAÎNE

changer les paramètres régionaux (« C » par défaut)

-i, --include=FICHIER

ajouter du texte depuis « FICHIER »

-I, --opt-include=FICHIER ajouter du texte depuis « FICHIER »,

si ce fichier existe

-o, --output=FICHIER

envoyer le résultat dans « FICHIER »

-p, --info-page=TEXTE

nom du manuel Texinfo

-N, --no-info

supprimer le pointeur vers le manuel Texinfo

--help

afficher cette aide, puis quitter

--version

afficher le numéro de version, puis quitter

PROGRAMME devrait accepter les options « --help » et « --version » mais des alternatives peuvent être spécifiées en utilisant :

-h, --help-option=CHAÎNE

chaîne pour l'option équivalente à « --help » -v, --version-option=CHAÎNE chaîne pour l'option équivalente à « --version »

On peut ajouter un supplément de texte aux indications fournies par le programme grâce aux options --include et --opt-include. Le format est simple :

[section] texte

/motif/ texte

Les blocs de texte (au format *roff) sont insérés tels quels dans la sortie, soit au début de la zone désignée par [section] (balise insensible à la casse), soit après un paragraphe correspondant à /motif/.

Les motifs obéissent à la syntaxe des expressions rationnelles de Perl et peuvent être suivis des modificateurs i, s ou m (voir perlre(1)).

Les lignes précédant la première section (ou le premier motif) et commençant par « - » sont traitées comme des options. Tout le reste est ignoré sans aucun avertissement, et peut être utilisé pour des commentaires, des mots clés RCS ou d'autres éléments.

L'ordre des sections produites est :

NOM SYNOPSIS DESCRIPTION OPTIONS EXEMPLES autres AUTEUR SIGNALER DES BOGUES COPYRIGHT VOIR AUSSI

Toute section [nom] ou [synopsis] apparaissant dans le fichier inclus va remplacer celle qui aurait êté générée automatiquement (mais vous pouvez encore remplacer la première avec --name si nécessaire).

Le texte supplémentaire aux autres sections usuelles (celles apparaissant dans cette liste) est inséré avant la sortie générée automatiquement pour elles. Les sections non usuelles sont insérées à la place marquée autres dans la liste ci-dessus, dans l'ordre dans lequel ces sections apparaissent dans le fichier inclus.

La dernière version de cette distribution est disponible en ligne sur :

ftp://ftp.gnu.org/gnu/help2man/

Écrit par Brendan O'Dea <bod@debian.org>

Signaler les bogues à <bug-help2man@gnu.org>.

Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.

Ce logiciel est libre ; voir les sources pour les conditions de reproduction. AUCUNE garantie n'est donnée, pas même la garantie implicite de COMMERCIALISATION ni l'ADAPTATION À UN BESOIN PARTICULIER.

La documentation complète pour help2man est mise à jour dans un manuel Texinfo (en anglais). Si les programmes info et help2man sont correctement installés sur votre système, la commande

info help2man

devrait vous donner accès au manuel complet (en anglais).