File: man.7

package info (click to toggle)
manpages-fr 0.9.3-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 7,052 kB
  • ctags: 4
  • sloc: makefile: 58; sh: 8
file content (309 lines) | stat: -rw-r--r-- 8,349 bytes parent folder | download
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
.\" Copyright 1992 Rickard E. Faith (faith@cs.unc.edu)
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\" 
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" Modified Sun Jul 25 11:06:05 1993 by Rik Faith (faith@cs.unc.edu)
.\" Modified Sat Jun  8 00:39:52 1996 by aeb.
.\"
.\" Traduction 20/10/1996 par Christophe Blaess (ccb@club-internet.fr)
.\"
.\" Mise � jour 06/06/2001 - LDP-man-pages-1.36
.TH MAN 7 "6 juin 2001" Linux "Manuel de l'administrateur Linux" 
.SH NOM
man \- Macros pour la mise en forme des pages de manuel.
.SH SYNOPSIS
.B groff \-Tascii \-man
.I file
\&...
.LP
.B groff \-Tps \-man
.I file
\&...
.LP
.B man
.RI [ section ]
.I title
.SH DESCRIPTION
Cette page de manuel explique le contenu du package
.BR "groff tmac.an" .
Ce package doit �tre utilis� par les d�veloppeurs pour �crire ou porter des
pages de manuels pour Linux. Il est largement compatible avec d'autres
versions de ce package, donc le portage de pages pour Linux ne devrait pas
poser de probl�mes (sauf pour NET-2 BSD qui utilise un package compl�tement
diff�rent).

Notez que les pages de manuel NET-2 BSD peuvent �tre visualis�es avec
.B groff
simplement en sp�cifiant l'option
.B \-mdoc
� la place de l'option
.BR \-man .
L'utilisation de l'option
.B \-mandoc
est n�anmoins recommand�e puisqu'il d�tectera automatiquement le package
utilis�.
.SH PR�AMBULE
La premi�re commande d'une page de manuel doit �tre
.RS
.sp
.B \&.TH
.IR "titre section date source manuel" ,
.sp
.RE
o� :
.RS
.TP 0.8i
.I titre
Le titre de la page de manuel (par exemple
.IR MAN ).
.TP
.I section
Le num�ro de section dans laquelle placer la page (par exemple
.IR 7 ).
.TP
.I date
La date de la derni�re modification. Pensez � modifier cette date �
chaque changement dans la page, car c'est la maniere la plus courante
d'avoir un contr�le de version.
.TP
.I source
La source de la commande
.sp
Pour les ex�cutables, utilisez quelque chose comme
.IR GNU ", " NET-2 ", " "SLS Distribution" ", " "MCC Distribution" .
.sp
Pour les appels syst�mes, indiquez la version du noyau que vous
utilisez :
.IR "Linux 0.99.11" .
.sp
Pour les fonctions de biblioth�que, utilisez la source de la fonction :
.IR GNU ", " "BSD 4.3" ", " "Linux DLL 4.4.1" .
.TP
.I manuel
Le titre du manuel (par exemple
.IR "Manuel du programmeur Linux" ).
.RE
.PP
Les sections du manuel sont traditionnellement r�parties ainsi :
.RS
.TP 0.8i
.B 1 Commandes
Les commandes qui peuvent �tre invoqu�es par l'utilisateur depuis le shell.
.TP
.B 2 Appel syst�mes
Les fonctions fournies par le noyau.
.TP
.B 3 Fonctions de biblioth�ques
La plupart des fonctions de la 
.I libc
telles que
.BR sort (3))
.TP
.B 4 P�riph�riques
Fichiers sp�ciaux trouv�s dans
.IR /dev )
.TP
.B 5 Formats de fichiers et conventions
Le format de
.I /etc/passwd
et d'autres fichiers lisibles par un humain.
.TP
.B 6 Jeux
.TP
.B 7 Ensembles de macros et de standards
Une description du syst�me de fichiers standard, cette
page de manuel, des jeux de caract�res, entre autres...
.TP
.B 8 Commandes d'administration syst�me.
Les commandes comme
.BR mount (8),
que seul
.I root
peut ex�cuter.
.TP
.B 9 Routines du noyau
Il s'agit d'une section non\-standard, et est incluse ici
car le code source de Linux est librement disponible sous
license GPL, et beaucoup de gens travaillent sur les changements
dans le noyau.
.RE
.SH FONTES
Bien qu'il y ait de nombreuses conventions arbitraires concernant les
pages de manuel pour UNIX, l'existence de plusieurs centaines de pages
sp�cifiques � Linux d�finit nos propres standards :
.IP
Pour les fonctions, les arguments sont toujours indiqu�s en italique,
.IR "m�me dans le paragraphe SYNOPSIS" ,
ou le reste de la fonction est en caract�re gras:
.RS
.BI "int mafonction(int " argc ", char **" argv );
.RE
.IP
Les noms de fichiers sont toujours en italique (par exemple
.IR "/usr/include/stdio.h" ),
sauf dans le paragraphe SYNOPSIS, ou les fichiers inclus sont en gras (par exemple
.BR "#include <stdio.h>" ).
.IP
Les macros, g�n�ralement en majuscule, sont en gras (par exemple
.BR MAXINT ).
.IP
Dans l'�numeration d'une liste de code d'erreurs, les codes sont en gras, et
la liste utilise normalement la macro
.BR \&.TP .
.IP
Toute r�f�rence � une autre page de manuel, ou au sujet principal de la
page en cours, est en gras. Si le num�ro de section de manuel est donn�,
il est en Roman, sans espace (par exemple
.BR man (7)).

Les commandes pour s�lectionner les fontes sont les suivantes :
.TP 0.8i
.B \&.B
Gras
.TP
.B \&.BI
Gras altern� avec Italique
.TP
.B \&.BR
Gras altern� avec Roman
.TP
.B \&.I
Italique
.TP
.B \&.IB
Italique altern� avec Gras
.TP
.B \&.IR
Italique altern� avec Roman
.TP
.B \&.RB
Roman altern� avec Gras
.TP
.B \&.RI
Roman altern� avec Italique
.TP
.B \&.SB
Petit altern� avec Gras
.TP
.B \&.SM
Petit
.LP
Traditionnellement, chaque commande peut avoir jusqu'� six arguments, mais
les versions GNU semblent �liminer cette contrainte.
Les arguments sont d�limit�s par des espaces. Des guillemets sont utilis�s
pour encadrer un argument qui contient des espaces.
Tous les arguments seront imprim�s les uns apr�s les autres sans
inercaler d'espace, ainsi la commande
.B \&.BR
peut �tre utilis�e pour indiquer un mot en Gras suivi par un signe de
ponctuation en Roman.
.SH SECTIONS (PARAGRAPHES)
Les sections commencent par
.B \&.SH
suivies de leurs titres. Si le titre contient des espaces, l'encadrer
par des guillemets.
Les titres traditionnels sont :
NOM, SYNOPSIS, DESCRIPTION, OPTIONS, FICHIERS, VOIR AUSSI, DIAGNOSTIQUE, BOGUES,
et AUTEUR.  Le seul titre indispensable est
.IR NOM ,
qui doit �tre suivi sur la ligne suivante par une courte description du
programme :
.RS
.sp
\&.SH NOM
.br
chess \\- Jeu d'echec
.sp
.RE
Il est tres important que ce format soit respect�, et qu'il se trouve un
backslash avant le tiret suivant le nom du programme. Il est important que
toute la description soit plac�e sur une seule ligne. Cette syntaxe
est utilis�e par le programme
.BR makewhatis (8)
pour cr�er la base de donn�es des descriptions pour les commandes
.BR whatis (1)
et
.BR apropos (1).

NDT : Vous vous doutez bien que la version de distribution de 
.BR makewhatis (8)
ne reconna�t pas la section 'NOM' mais la section 'NAME'. Pour que
les commandes
.BR whatis "(1) et " apropos (1)
fonctionnent, il faut modifier le script
.BR makewhatis (8).
la modification � apporter est d�crite dans le fichier
.IR LISEZ_MOI ,
qui est livr� avec l'archive des pages de manuel en fran�ais.

.SH "AUTRES MACROS"
D'autres macros sont disponibles :
.TP
.B \&.DT
Tabulation par d�faut.
.TP
.B \&.HP
D�but d'indentation.
.TP
.B \&.IP
D�but de paragraphe avec un mot\-cl�. C'est le m�me format que
.BR \&.TP ,
sauf que le mot\-cl� est sur la m�me ligne, pas sur la suivante.
.TP
.B \&.LP
Comme
.B \&.PP
.TP
.B \&.PD
Fixe la distance entre paragraphe � la valeur fournie en argument
.TP
.B \&.PP
Commencer un nouveau paragraphe
.TP
.B \&.RE
Fin d'indentation relative (dans un paragraphe)
.TP
.B \&.RS
D�but d'indentation relative (dans un paragraphe)
.TP
.B \&.SS
Sous\-titre, comme
.BR \&.SH ,
mais pour une sous\-section
.TP
.B \&.TP
D�but de paragraphe avec un mot\-cl�. Ce mot est sur la ligne suivante.
Commande similaire �
.B \&.IP
.LP
.SH FICHIERS
.I /usr/share/groff/tmac/tmac.an
.br
.I /usr/man/whatis
.SH "VOIR AUSSI"
.BR groff (1),
.BR man (1),
.BR whatis (1),
.BR apropos (1),
.BR makewhatis (8)

.SH TRADUCTION
Christophe Blaess, 1997.