File: man.1

package info (click to toggle)
manpages-fr 0.5-2
  • links: PTS
  • area: main
  • in suites: hamm
  • size: 4,236 kB
  • ctags: 4
  • sloc: makefile: 55
file content (264 lines) | stat: -rw-r--r-- 8,353 bytes parent folder | download | duplicates (2)
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
.\"
.\" Generated automatically from man.1.in by the
.\" configure script.
.\"
.\" Man page for man (and the former manpath)
.\"
.\" Copyright (c) 1990, 1991, John W. Eaton.
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License as specified in the README file that comes with the man 1.0
.\" distribution.  
.\"
.\" John W. Eaton
.\" jwe@che.utexas.edu
.\" Department of Chemical Engineering
.\" The University of Texas at Austin
.\" Austin, Texas  78712
.\"
.\" Many changes - aeb 950902
.\"
.\" Traduction 16/07/1997 par Christophe Blaess (ccb@club-internet.fr)
.\"
.TH MAN 1 "16 Juillet 1997" Linux "Manuel de l'utilisateur Linux"
.SH NOM
man \- Mettre en forme et afficher des pages de manuel.
.br
manpath \- Determiner les chemins de recherche des pages de manuel.
.SH SYNOPSIS
man [\-adfhkKtwW] [\-m systeme] [\-p chaine] [\-C fichier_config] [\-M chemin]
[\-P pager] [\-S liste_sections] [section] nom ...
.SH DESCRIPTION
.B man
effectue la mise en forme puis l'affichage des pages de manuel en-ligne.

Cette version gere les variables d'environnement MANPATH et (MAN)PAGER,
ainsi chaque utilisateur peut disposer de ses pages de manuel personnelles,
et choisir le programme qui lui convient le mieux pour visualiser les
pages formattees.

Si une
.I section
est indiquee,
.B man
ne regardera que dans cette section du manuel.

On peut aussi configurer, au moyen d'arguments en ligne de commande, ou
au moyen de variables d'environnement, l'ordre de recherche dans les sections,
et les pre-processeurs a appliquer sur les fichiers sources.

Si le
.I nom
mentionne contient un / \fBman\fP le considerera d'abord comme un nom de fichier.
Il est donc possible d'invoquer \fBman\fP ainsi :
.B "man ./foo.5"
ou meme
.B "man /cd/foo/bar.1.gz\fR.\fP"
.SH OPTIONS
.TP
.B \-\^C " fichier_config"
Indiquer le fichier man.config a utiliser. Par defaut il s'agit de
/etc/man.config. (voir \fBman.config\fP(5).)
.TP
.B \-\^M " chemin"
Preciser la liste des repertoires a parcourir pour rechercher les
pages de manuel. Si cette option n'est pas fournie, la variable
d'environnement
.B MANPATH
est utilisee.
Si cette variable n'existe pas, la liste par defaut est extraite
de /etc/man.config. Si MANPATH contient une sous-chaine vide, cela
represente la liste par defaut.
.TP
.B \-\^P " pager"
Indiquer le programme d'affichage (pager) a utiliser.
Cette option a precedence sur la variable d'environnement
.BR MANPAGER ,
qui a son tour a precedence sur la variable
.BR PAGER .
Par defaut, \fBman\fP utilise
.BR /usr/bin/less -is .
.TP
.B \-\^S " liste_sections"
Fournir une liste de sections (separees par des doubles points)
dans lesquelles on recherchera les pages. Cette option a precedence
sur la variable d'environnement
.BR MANSECT .
.TP
.B \-\^a
Par defaut, \fBman\fP s'arrete apres avoir affiche la premiere page
de manuel qu'il trouve. En utilisant cette option, \fBman\fP continuera
a afficher les pages correspondantes dans les autres repertoires et
sections.
.TP
.B \-\^c
Refaire la mise en forme, meme si une page preformattee (cat page) existe
deja. Ceci est utile si la page cat a ete preformattee pour un ecran
disposant d'un nombre different de colonnes.
.TP
.B \-\^d
Ne pas afficher vraiment les pages, mais fournir des informations de debugging.
.TP
.B \-\^D
Afficher les pages et les informations de debugging.
.TP
.B \-\^f
Equivalent a
.B whatis.
.TP
.B \-\^h
Afficher une ligne d'aide et quitter.
.TP
.B \-\^k
Equivalent a
.B apropos.
.TP
.B \-\^K
Rechercher la chaine indiquee dans \fBtoutes\fP les pages de manuel.
Attention : ceci peut etre tres long ! Il est preferable de mentionner
au moins une section. (Juste pour vous donner une idee, sur ma machine
ceci prend une minute pour 500 pages).
.TP
.B \-\^m " systeme"
Recherche un autre jeu de page de manuel, en se basant sur le nom
du systeme fourni.
.TP
.B \-\^p " chaine"
Preciser une sequence de pre-processeurs a utiliser avant de
lancer nroff ou troff. Toutes les installations ne disposent pas
de tous les preprocesseurs. Voici quelques pre-processeurs courants,
et les lettres utilisees pour les designer :
eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r).
Cette option a precedence sur la variable d'environnement
.BR MANROFFSEQ .
.TP
.B \-\^t
Utiliser la commande
.B /usr/bin/groff -Tps -mandoc
(conversion en PostScript) pour formatter la page de manuel,
et envoyer le resultat sur la sortie standard
.B stdout.
Le resultat de
.B /usr/bin/groff -Tps -mandoc
peut necessiter un filtre (comme ghostscript) avant d'etre
envoye sur l'imprimante.
.TP
.B \-\^w \fRou\fP \-\-path
Ne pas afficher reellement les pages, mais donner l'emplacement
des fichiers qui devraient etre formattes ou affiches. Si aucun
nom de page n'est fourni, afficher sur la sortie standard la liste
des repertoires de recherche de
.BR man .
Si
.B manpath
est un lien vers man, alors la commande "manpath" est equivalente
a "man --path".
.TP
.B \-\^W
Comme \-\^w, mais en affichant un nom de fichier par ligne, sans
autre information. Ceci sert dans des scripts shell comme :
.ft CW
man -aW man | xargs ls -l
.ft

.SH "PAGES CAT"

Man essaye de sauver les pages preformattees afin de gagner du temps
lorsqu'elles seront a nouveau reclammees. Classiquement, les versions
formatees des pages se trouvant dans DIR/manX sont sauvees dans DIR/catX,
mais d'autres configurations peuvent etre mentionnees dans /etc/man.config.
Aucune page cat n'est sauvegardee si le repertoire cat n'existe pas.

Il est possible de fixer le bit Set-UID de \fBman\fP, en le faisant
appartenir a l'utilisateur 'man'. Ainsi, si le repertoire cat a pour
proprietaire 'man', et le mode 0755 (seul 'man' peut ecrire dedans),
et si les fichiers cat ont pour proprietaire 'man' et le mode 0644 ou
0444 (ecriture seulement par 'man', ou pas d'ecriture), aucun utilisateur
normal ne pourra modifier les pages cat, ou inscrire d'autres fichiers
dans le repertoire.

Si \fBman\fP n'a pas son bit Set-UID positionne, le repertoire cat
devrait avoir le mode 0777 afin que les pages soient sauvegardees, mais
les utilisateurs pourraient modifier ou effacer ces fichiers.

L'option -c force la remise en forme d'une page, meme si une page preformattee
existe.


.SH ENVIRONMENT
.TP
.B MANPATH
Si
.B MANPATH
existe, sa valeur est utilisee comme chemin de recherche des pages de manuel.
.TP
.B MANROFFSEQ
Si
.B MANROFFSEQ
est configuree, sa valeur sert a determiner l'ensemble des preprocesseurs
a declencher avant de lancer nroff ou troff. Par defaut, les pages
sont soumises au preprocesseur de table avant nroff.
.TP
.B MANSECT
Si
.B MANSECT
existe, sa valeur correspond aux sections du manuel qui seront parcourues
a la recherche des pages.
.TP
.B MANWIDTH
Si
.B MANWIDTH
est renseignee, elle contient la largeur avec laquelle les pages de
manuel doivent etre affichees. Dans le cas contraire, les pages sont
affichees avec la largeur complete de l'ecran.
.TP
.B MANPAGER
Si
.B MANPAGER
existe, elle contient le nom du programme a utiliser pour afficher
les pages. Sinon, 
.B PAGER
est utilisee. Si elle n'existe pas non plus 
.B /usr/bin/less -is
est utilise par defaut.
.TP
.B LANG
Si
.B LANG
existe, sa valeur permet de definir les sous-repertoires dans lesquels
\fBman\fP recherchera les pages en premier. Ainsi la commande
`LANG=fr man 1 foo' demande a \fBman\fP de regarder en premier si
une page .../fr/man1/foo.1 existe, puis si tel n'est pas le cas, il
cherchera .../man1/foo.1 (avec ... correspondant au chemin de recherche).
.TP
.B "NLSPATH, LC_MESSAGES, LANG"
Les variables d'environnement
.B NLSPATH
et
.B LC_MESSAGES
(ou
.B LANG
si la seconde n'existe pas) sont utilisees pour determiner l'emplacement
du catalogue de messages. De toute maniere les messages anglais sont
compiles dans \fBman\fP, et il n'y a pas besoin de catalogue pour
les avoir. [NDT : et alors, vous en etes fiers ?].

Notez que les programmes comme \fBcol\fP(1) qui sont invoques par
\fBman\fP utilisent egalement la localisation, par exemple : LC_CTYPE.
.TP
.B PATH
.B PATH
est utilisee pour construire le chemin de recherche par defaut des
pages de manuel.
.TP
.B SYSTEM
.B SYSTEM
est utilise pour obtenir un eventuel autre nom de systeme (a utiliser
avec l'option
.BR \-m )
.SH "VOIR AUSSI"
apropos(1), whatis(1), less(1), groff(1).
.SH BUGS
L'option
.B \-t
ne fonctionne que si un programme comme troff est installe.