Hash :
c494d0e0
Author :
Thomas de Grivel
Date :
2023-01-21T15:08:42
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.1.
.TH HELP2MAN "1" "mai 2011" "help2man 1.40.1" "Commandes"
.SH NOM
help2man \- crée une page de manuel sommaire
.SH SYNOPSIS
.B help2man
[\fIOPTION\fR]... \fIPROGRAMME\fR
.SH DESCRIPTION
«\ help2man\ » crée la page de manuel d'un programme à partir des
indications fournies par celui\-ci lorsqu'il est lancé avec les
options «\ \-\-help\ » et «\ \-\-version\ ».
.TP
\fB\-n\fR, \fB\-\-name\fR=\fICHAÎNE\fR
description pour le paragraphe NOM
.TP
\fB\-s\fR, \fB\-\-section\fR=\fISECTION\fR
numéro de section de la page de
manuel (1, 6, 8)
.TP
\fB\-m\fR, \fB\-\-manual\fR=\fITEXTE\fR
nom du manuel (Commandes, ...)
.TP
\fB\-S\fR, \fB\-\-source\fR=\fITEXTE\fR
source du programme (FSF, Debian, ...)
.TP
\fB\-L\fR, \fB\-\-locale\fR=\fICHAÎNE\fR
changer les paramètres régionaux
(«\ C\ » par défaut)
.TP
\fB\-i\fR, \fB\-\-include\fR=\fIFICHIER\fR
ajouter du texte depuis «\ FICHIER\ »
.TP
\fB\-I\fR, \fB\-\-opt\-include\fR=\fIFICHIER\fR
ajouter du texte depuis «\ FICHIER\ »,
si ce fichier existe
.TP
\fB\-o\fR, \fB\-\-output\fR=\fIFICHIER\fR
envoyer le résultat dans «\ FICHIER\ »
.TP
\fB\-p\fR, \fB\-\-info\-page\fR=\fITEXTE\fR
nom du manuel Texinfo
.TP
\fB\-N\fR, \fB\-\-no\-info\fR
supprimer le pointeur vers le manuel Texinfo
.TP
\fB\-l\fR, \fB\-\-libtool\fR
exclure le «\ lt\-\ » du nom de programme
.TP
\fB\-\-help\fR
afficher cette aide, puis quitter
.TP
\fB\-\-version\fR
afficher le numéro de version, puis quitter
.PP
PROGRAMME devrait accepter les options «\ \-\-help\ » et «\ \-\-version\ »
et écrire sur la sortie standard mais des alternatives peuvent être
précisées en utilisant\ :
.TP
\fB\-h\fR, \fB\-\-help\-option\fR=\fICHAÎNE\fR
chaîne pour l'option équivalente à «\ \-\-help\ »
.TP
\fB\-v\fR, \fB\-\-version\-option\fR=\fICHAÎNE\fR
chaîne pour l'option équivalente à «\ \-\-version\ »
.TP
\fB\-\-version\-string\fR=\fICHAÎNE\fR
chaîne de version
.TP
\fB\-\-no\-discard\-stderr\fR
inclure la sortie d'erreur standard lors
de l'analyse de la sortie d'option
.SH "FICHIERS INCLUS"
Un supplément de texte peut être ajouté aux indications fournies par le
programme grâce aux options
.B \-\-include
et
.BR \-\-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
.BI [ section ]
(balise insensible à la casse), soit après un paragraphe correspondant à
.BI / motif /\fR.
Les motifs obéissent à la syntaxe des expressions rationnelles de Perl
et peuvent être suivis des modificateurs
.IR i ,
.I s
ou
.I m
(voir
.BR 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
ENVIRONNEMENT
FICHIERS
EXEMPLES
\fIautres\fR
AUTEUR
SIGNALER DES BOGUES
COPYRIGHT
VOIR AUSSI
Toute section
.B [NOM]
ou
.B [SYNOPSIS]
apparaissant dans le fichier inclus va remplacer celle qui aurait été
créée automatiquement (mais vous pouvez encore remplacer la première
avec
.B --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
.I autres
dans la liste ci-dessus, dans l'ordre dans lequel ces sections
apparaissent dans le fichier inclus.
.SH DISPONIBILITÉ
La dernière version de cette distribution est disponible en ligne sur\\ :
ftp://ftp.gnu.org/gnu/help2man/
.SH AUTEUR
Écrit par Brendan O'Dea <bod@debian.org>
.SH "SIGNALER DES BOGUES"
Signaler les bogues à <bug\-help2man@gnu.org>.
.SH COPYRIGHT
Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
2011 Free Software Foundation, Inc.
.br
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.
.SH "VOIR AUSSI"
La documentation complète pour
.B help2man
est mise à jour dans un manuel Texinfo (en anglais).
Si les programmes
.B info
et
.B help2man
sont correctement installés sur le système, la commande
.IP
.B info help2man
.PP
devrait donner accès au manuel complet (en anglais).