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
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.38.2.
.TH HELP2MAN "1" "avril 2010" "help2man 1.38.2" "Commandes"
.SH NOM
help2man \- gnre une page de manuel sommaire
.SH SYNOPSIS
.B help2man
[\fIOPTION\fR]... \fIEXECUTABLE\fR
.SH DESCRIPTION
`help2man' generates a man page out of `\-\-help' and `\-\-version' output.
.TP
\fB\-n\fR, \fB\-\-name\fR=\fISTRING\fR
description for the NAME paragraph
.TP
\fB\-s\fR, \fB\-\-section\fR=\fISECTION\fR
section number for manual page (1, 6, 8)
.TP
\fB\-m\fR, \fB\-\-manual\fR=\fITEXT\fR
name of manual (User Commands, ...)
.TP
\fB\-S\fR, \fB\-\-source\fR=\fITEXT\fR
source of program (FSF, Debian, ...)
.TP
\fB\-L\fR, \fB\-\-locale\fR=\fISTRING\fR
select locale (default "C")
.TP
\fB\-i\fR, \fB\-\-include\fR=\fIFILE\fR
include material from `FILE'
.TP
\fB\-I\fR, \fB\-\-opt\-include\fR=\fIFILE\fR
include material from `FILE' if it exists
.TP
\fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
send output to `FILE'
.TP
\fB\-p\fR, \fB\-\-info\-page\fR=\fITEXT\fR
name of Texinfo manual
.TP
\fB\-N\fR, \fB\-\-no\-info\fR
suppress pointer to Texinfo manual
.TP
\fB\-\-help\fR
print this help, then exit
.TP
\fB\-\-version\fR
print version number, then exit
.PP
EXECUTABLE should accept `\-\-help' and `\-\-version' options and produce output on
stdout although alternatives may be specified using:
.TP
\fB\-h\fR, \fB\-\-help\-option\fR=\fISTRING\fR
help option string
.TP
\fB\-v\fR, \fB\-\-version\-option\fR=\fISTRING\fR
version option string
.TP
\fB\-\-version\-string\fR=\fISTRING\fR
version string
.TP
\fB\-\-no\-discard\-stderr\fR
include stderr when parsing option output
.SH "FICHIERS INCLUS"
On peut ajouter un supplment de texte aux indications fournies par le
programme grce aux options
.B \-\-include
et
.BR \-\-opt\-include .
Le format est simple\ :
[section]
texte
/motif/
texte
Les blocs de texte (au format *roff) sont insrs tels quels dans la
sortie, soit au dbut de la zone dsigne par
.BI [ section ]
(balise insensible la casse), soit aprs un paragraphe correspondant
.BI / motif /\fR.
Les motifs obissent 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 prcdant la premire section (ou le premier motif) et
commenant par \ \-\ sont traites comme des options. Tout le
reste est ignor sans aucun avertissement, et peut tre utilis pour
des commentaires, des mots cls RCS ou d'autres lments.
L'ordre des sections produites est\ :
NOM
SYNOPSIS
DESCRIPTION
OPTIONS
ENVIRONMENT
FILES
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
gnre automatiquement (mais vous pouvez encore remplacer la premire
avec
.B --name
si ncessaire).
Le texte supplmentaire aux autres sections usuelles (celles
apparaissant dans cette liste) est insr avant la sortie gnre
automatiquement pour elles.
Les sections non usuelles sont insres la place marque
.I autres
dans la liste ci-dessus, dans l'ordre dans lequel ces sections
apparaissent dans le fichier inclus.
.SH DISPONIBILIT
La dernire 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"
Report bugs to <bug\-help2man@gnu.org>.
.SH COPYRIGHT
Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010
Free Software Foundation, Inc.
.br
Ce logiciel est libre\ ; voir les sources pour les conditions de
reproduction. AUCUNE garantie n'est donne, pas mme la garantie
implicite de COMMERCIALISATION ni l'ADAPTATION UN BESOIN PARTICULIER.
.SH "VOIR AUSSI"
La documentation complte pour
.B help2man
est mise jour dans un manuel Texinfo (en anglais).
Si les programmes
.B info
et
.B help2man
sont correctement installs sur votre systme, la commande
.IP
.B info help2man
.PP
devrait vous donner accs au manuel complet (en anglais).
|