help2man.fr.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.10.
   2 .TH HELP2MAN "1" "mars 2019" "help2man 1.47.10" "Commandes"
   3 .SH NOM
   4 help2man \- Créer une page de manuel sommaire
   5 .SH SYNOPSIS
   6 .B help2man
   7 [\fI\,OPTION\/\fR]... \fI\,PROGRAMME\/\fR
   8 .SH DESCRIPTION
   9 «\ help2man\ » crée la page de manuel d'un programme à partir des
  10 indications fournies par celui\-ci lorsqu'il est lancé avec les
  11 options «\ \-\-help\ » et «\ \-\-version\ ».
  12 .TP
  13 \fB\-n\fR, \fB\-\-name\fR=\fI\,CHAÎNE\/\fR
  14 description pour le paragraphe NOM
  15 .TP
  16 \fB\-s\fR, \fB\-\-section\fR=\fI\,SECTION\/\fR
  17 numéro de section de la page de
  18 manuel (1, 6, 8)
  19 .TP
  20 \fB\-m\fR, \fB\-\-manual\fR=\fI\,TEXTE\/\fR
  21 nom du manuel (Commandes, ...)
  22 .TP
  23 \fB\-S\fR, \fB\-\-source\fR=\fI\,TEXTE\/\fR
  24 source du programme (FSF, Debian, ...)
  25 .TP
  26 \fB\-L\fR, \fB\-\-locale\fR=\fI\,CHAÎNE\/\fR
  27 changer les paramètres régionaux
  28 («\ C\ » par défaut)
  29 .TP
  30 \fB\-i\fR, \fB\-\-include\fR=\fI\,FICHIER\/\fR
  31 ajouter du texte depuis «\ FICHIER\ »
  32 .TP
  33 \fB\-I\fR, \fB\-\-opt\-include\fR=\fI\,FICHIER\/\fR
  34 ajouter du texte depuis «\ FICHIER\ »,
  35 si ce fichier existe
  36 .TP
  37 \fB\-o\fR, \fB\-\-output\fR=\fI\,FICHIER\/\fR
  38 envoyer le résultat dans «\ FICHIER\ »
  39 .TP
  40 \fB\-p\fR, \fB\-\-info\-page\fR=\fI\,TEXTE\/\fR
  41 nom du manuel Texinfo
  42 .TP
  43 \fB\-N\fR, \fB\-\-no\-info\fR
  44 supprimer le pointeur vers le manuel Texinfo
  45 .TP
  46 \fB\-l\fR, \fB\-\-libtool\fR
  47 exclure le «\ lt\-\ » du nom de programme
  48 .TP
  49 \fB\-\-help\fR
  50 afficher cette aide, puis quitter
  51 .TP
  52 \fB\-\-version\fR
  53 afficher le numéro de version, puis quitter
  54 .PP
  55 PROGRAMME devrait accepter les options «\ \-\-help\ » et «\ \-\-version\ »
  56 et écrire sur la sortie standard mais des alternatives peuvent être
  57 précisées en utilisant\ :
  58 .TP
  59 \fB\-h\fR, \fB\-\-help\-option\fR=\fI\,CHAÎNE\/\fR
  60 chaîne pour l'option équivalente à «\ \-\-help\ »
  61 .TP
  62 \fB\-v\fR, \fB\-\-version\-option\fR=\fI\,CHAÎNE\/\fR
  63 chaîne pour l'option équivalente à «\ \-\-version\ »
  64 .TP
  65 \fB\-\-version\-string\fR=\fI\,CHAÎNE\/\fR
  66 chaîne de version
  67 .TP
  68 \fB\-\-no\-discard\-stderr\fR
  69 inclure la sortie d'erreur standard lors
  70 de l'analyse de la sortie d'option
  71 .SH "FICHIERS INCLUS"
  72 Un supplément de texte peut être ajouté aux indications fournies par le
  73 programme grâce aux options
  74 .B \-\-include
  75 et
  76 .BR \-\-opt\-include .
  77 Le format est simple\ :
  78
  79     [section]
  80     texte
  81
  82     /motif/
  83     texte
  84
  85 Les blocs de texte (au format *roff) sont insérés tels quels dans la
  86 sortie, soit au début de la zone désignée par
  87 .BI [ section ]
  88 (balise insensible à la casse), soit après un paragraphe correspondant au
  89 .BI / motif /\fR.
  90
  91 Les motifs obéissent à la syntaxe des expressions rationnelles de Perl
  92 et peuvent être suivis des modificateurs
  93 .IR i ,
  94 .I s
  95 ou
  96 .I m
  97 (voir
  98 .BR perlre (1)).
  99
 100 Les lignes précédant la première section (ou le premier motif) et
 101 commençant par «\ \-\ » sont traitées comme des options. Tout le
 102 reste est ignoré sans aucun avertissement, et peut être utilisé pour
 103 des commentaires, des mots clefs RCS ou d'autres éléments.
 104
 105 L'ordre des sections produites est\ :
 106
 107     NOM
 108     SYNOPSIS
 109     DESCRIPTION
 110     OPTIONS
 111     ENVIRONNEMENT
 112     FICHIERS
 113     EXEMPLES
 114     \fIautres\fR
 115     AUTEUR
 116     BOGUES
 117     COPYRIGHT
 118     VOIR AUSSI
 119
 120 Toute section
 121 .B [NOM]
 122 ou
 123 .B [SYNOPSIS]
 124 apparaissant dans le fichier inclus va remplacer celle qui aurait été
 125 créée automatiquement (mais vous pouvez encore remplacer la première
 126 avec
 127 .B \-\-name
 128 si nécessaire).
 129
 130 Le texte supplémentaire aux autres sections usuelles (celles
 131 apparaissant dans cette liste) est inséré avant la sortie générée
 132 automatiquement pour elles.
 133 Les sections non usuelles sont insérées à la place marquée
 134 .I autres
 135 dans la liste ci-dessus, suivant l'ordre dans lequel ces sections
 136 apparaissent dans le fichier inclus.
 137
 138 Le placement du texte au sein de la section peut être explicitement indiqué en
 139 utilisant la syntaxe
 140 .RI [< section ],
 141 .RI [= section ]
 142 ou
 143 .RI [> section ]
 144 pour placer le texte supplémentaire respectivement avant, à la place de ou
 145 après la sortie par défaut.
 146 .SH DISPONIBILITÉ
 147 La dernière version de cette distribution est disponible en ligne sur\ :
 148
 149     ftp://ftp.gnu.org/gnu/help2man/
 150 .SH AUTEUR
 151 Écrit par Brendan O'Dea <bod@debian.org>
 152 .SH BOGUES
 153 Signaler les bogues à <bug\-help2man@gnu.org>.
 154 .SH COPYRIGHT
 155 Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
 156 2011, 2012, 2013, 2014, 2015, 2016, 2017 Free Software Foundation, Inc.
 157 .br
 158 Ce logiciel est libre\ ; voir les sources pour les conditions de
 159 reproduction. AUCUNE garantie n'est donnée, pas même la garantie
 160 implicite de COMMERCIALISATION ni l'ADÉQUATION À UN BESOIN PARTICULIER.
 161 .SH "VOIR AUSSI"
 162 La documentation complète pour
 163 .B help2man
 164 est mise à jour dans un manuel Texinfo (en anglais).
 165 Si les programmes
 166 .B info
 167 et
 168 .B help2man
 169 sont correctement installés sur le système, la commande
 170 .IP
 171 .B info help2man
 172 .PP
 173 devrait donner accès au manuel complet (en anglais).