Accueil

CPU_SET
INFINITY
MB_CUR_MAX
MB_LEN_MAX
__setfpucw
_exit
_syscall
a64l
abort
abs
accept
access
acct
acos
acosh
addpart
addseverity
adduser
adjtime
adjtimex
aio_cancel
aio_error
aio_fsync
aio_read
aio_return
aio_suspend
aio_write
alarm
alloc_hugepages
alloca
apropos
arch
arch_prctl
argz_add
armscii-8
arp
ascii
asin
asinh
asprintf
assert
assert_perror
at
atan
atan2
atanh
atd
atexit
atof
atoi
atq
atrm
atrun
backend-spec
backtrace
basename
bash
bashbug
batch
bcmp
bcopy
bdflush
bind
bindresvport
blockdev
boot
bootlogd
bootparam
bosskill
brk
bsd_signal
bsearch
bstring
btowc
btree
builtin
builtins
byteorder
bzero
c
cabs
cacheflush
cacos
cacosh
cal
canonicalize_file_name
capabilities
capget
carg
casin
casinh
catan
catanh
catgets
catopen
cbrt
ccos
ccosh
ceil
cerf
cexp
cexp2
cfree
chage
charmap
charsets
chatise
chdir
chgrp
chmod
chown
chpasswd
chroot
chrt
chsh
cimag
clearenv
clock
clock_getcpuclockid
clock_getres
clock_nanosleep
clog
clog10
clog2
clone
close
closedir
cmp
cmsg
col
complex
confstr
conj
connect
console
console_codes
console_ioctl
consoletype
copysign
core
cos
cosh
cp
cp1251
cpow
cproj
cpuid
cpuset
creal
create_module
createrepo
credentials
cron
crond
crontab
crypt
crypttab
csin
csinh
csqrt
ctan
ctanh
ctermid
ctime
ctluser
ctrlaltdel
daemon
db2dvi
db2html
db2pdf
db2ps
db2rtf
dbopen
dd
ddp
delete_module
delpart
depmod
des_crypt
df
diff
diff3
difftime
dir
dir_colors
dircolors
dirfd
div
dl_iterate_phdr
dlopen
dmesg
docbook2dvi
docbook2html
docbook2man
docbook2man-spec
docbook2pdf
docbook2ps
docbook2rtf
docbook2tex
docbook2texi
docbook2texi-spec
docbook2txt
doexec
domainname
dprintf
drand48
drand48_r
dsp56k
du
dup
dysize
ecvt
ecvt_r
egrep
eject
elf
encrypt
end
endian
environ
envz_add
epoll
epoll_create
epoll_ctl
epoll_wait
erf
erfc
err
errno
error
ether_aton
ethers
euidaccess
eventfd
evim
exec
execve
exit
exit_group
exp
exp10
exp2
expm1
exportfs
exports
fabs
faccessat
faillog
fallocate
fchmodat
fchownat
fclose
fcloseall
fcntl
fd
fdformat
fdim
fdisk
feature_test_macros
fenv
ferror
fexecve
fflush
ffs
fgetgrent
fgetpwent
fgetwc
fgetws
fgrep
fifo
filesystems
finite
flock
flockfile
floor
fma
fmax
fmemopen
fmin
fmod
fmtmsg
fnmatch
fopen
fopencookie
fork
fpathconf
fpclassify
fpurge
fputwc
fputws
fread
free
frexp
frontend-spec
fseek
fseeko
fstab
fstab-decode
fstatat
fsync
ftime
ftok
ftpusers
fts
ftw
full
fuser
futex
futimes
futimesat
fwide
gamma
gcvt
get_kernel_syms
get_mempolicy
get_thread_area
getaddrinfo
getcontext
getcpu
getcwd
getdate
getdents
getdirentries
getdomainname
getdtablesize
getenv
getfsent
getgid
getgrent
getgrent_r
getgrnam
getgrouplist
getgroups
gethostbyname
gethostid
gethostname
getifaddrs
getipnodebyname
getitimer
getkey
getline
getloadavg
getlogin
getmntent
getnameinfo
getnetent
getnetent_r
getopt
getpagesize
getpass
getpeername
getpid
getpriority
getprotoent
getprotoent_r
getpt
getpw
getpwent
getpwent_r
getpwnam
getresuid
getrlimit
getrpcent
getrpcent_r
getrpcport
getrusage
gets
getservent
getservent_r
getsid
getsockname
getsockopt
getsubopt
gettid
gettimeofday
getttyent
getuid
getumask
getusershell
getutent
getutmp
getw
getwchar
getxattr
glob
gnu_get_libc_version
gpasswd
grantpt
grep
group
groupadd
groupdel
groupmod
grpck
grpconv
grpunconv
gshadow
gsignal
gssd
gunzip
guru
gzexe
gzip
halt
hash
hd
hier
host
hostname
hosts
hsearch
hypot
i386
icmp
iconv
iconv_close
iconv_open
idle
idmapd
ifconfig
ilogb
index
inet
inet_ntop
inet_pton
infnan
init
init_module
initgroups
initlog
initrd
initscript
inittab
inotify
inotify_add_watch
inotify_init
inotify_rm_watch
insmod
insque
install
install-catalog
intro
io_cancel
io_destroy
io_getevents
io_setup
io_submit
ioctl
ioctl_list
ioperm
iopl
ioprio_set
ip
ipc
ipcalc
ipcrm
ipcs
ipv6
isalpha
isatty
isgreater
iso_8859-1
iso_8859-10
iso_8859-11
iso_8859-13
iso_8859-14
iso_8859-15
iso_8859-16
iso_8859-2
iso_8859-3
iso_8859-4
iso_8859-5
iso_8859-6
iso_8859-7
iso_8859-8
iso_8859-9
issue
iswalnum
iswalpha
iswblank
iswcntrl
iswctype
iswdigit
iswgraph
iswlower
iswprint
iswpunct
iswspace
iswupper
iswxdigit
j0
jade
jw
key_setsecret
kill
killall
killall5
killpg
koi8-r
koi8-u
last
lastb
lastlog
ld
ldconfig
ldd
ldexp
lgamma
libc
link
linkat
linux32
linux64
listen
listxattr
llseek
ln
locale
localeconv
lockd
lockf
log
log10
log1p
log2
logb
login
longjmp
lookup_dcookie
lp
lrint
lround
ls
lsearch
lseek
lseek64
lsmod
lspci
lsusb
madvise
mailaddr
makecontext
makedev
makewhatis
malloc
malloc_hook
man
man-pages
math_error
matherr
mbind
mblen
mbrlen
mbrtowc
mbsinit
mbsnrtowcs
mbsrtowcs
mbstowcs
mbtowc
mcookie
mdoc
mem
memccpy
memchr
memcmp
memcpy
memfrob
memmem
memmove
mempcpy
memset
mesg
mincore
mkdir
mkdirat
mkdtemp
mkfifo
mkfifoat
mkfs
mknod
mknodat
mkstemp
mkswap
mktemp
mlock
mmap
mmap2
modf
modify_ldt
modifyrepo
modinfo
modprobe
more
motd
mount
mountd
mountpoint
mouse
move_pages
mpool
mprotect
mq_close
mq_getattr
mq_getsetattr
mq_notify
mq_open
mq_overview
mq_receive
mq_send
mq_unlink
mremap
msgctl
msgget
msgop
msr
msync
mtrace
mv
nan
nanosleep
netdevice
netlink
netreport
netstat
networks
newgrp
newusers
nextafter
nfs
nfsd
nfsservctl
nfsstat
nice
nicknames
nisdomainname
nl_langinfo
nmap
nologin
nscd
nsgmls
nsswitch
ntpd
ntpdc
null
numa
offsetof
on_exit
onsgmls
open
openat
opendir
openjade
openpty
operator
osgmlnorm
ospam
ospcat
ospent
osx
outb
package-cleanup
packet
passwd
path_resolution
pause
pciconfig_read
pcilib
perror
personality
pgrep
pidof
pipe
pivot_root
pkill
plipconfig
pmap
poll
popen
posix_fadvise
posix_fallocate
posix_memalign
posix_openpt
posixoptions
pow
pow10
poweroff
ppp-watch
pppoe
pppoe-connect
pppoe-relay
pppoe-server
pppoe-setup
pppoe-sniff
pppoe-start
pppoe-status
pppoe-stop
pppoe-wrapper
prctl
pread
printf
proc
profil
program_invocation_name
protocols
psignal
pstree
pthread_atfork
pthread_attr_destroy
pthread_attr_getdetachstate
pthread_attr_getinheritsched
pthread_attr_getschedparam
pthread_attr_getschedpolicy
pthread_attr_getscope
pthread_attr_init
pthread_attr_setaffinity_np
pthread_attr_setdetachstate
pthread_attr_setguardsize
pthread_attr_setinheritsched
pthread_attr_setschedparam
pthread_attr_setschedpolicy
pthread_attr_setscope
pthread_attr_setstack
pthread_attr_setstackaddr
pthread_attr_setstacksize
pthread_cancel
pthread_cleanup_pop
pthread_cleanup_pop_restore_np
pthread_cleanup_push
pthread_cleanup_push_defer_np
pthread_cond_broadcast
pthread_cond_destroy
pthread_cond_init
pthread_cond_signal
pthread_cond_timedwait
pthread_cond_wait
pthread_condattr_destroy
pthread_condattr_init
pthread_create
pthread_detach
pthread_equal
pthread_exit
pthread_getattr_np
pthread_getcpuclockid
pthread_getschedparam
pthread_getspecific
pthread_join
pthread_key_create
pthread_key_delete
pthread_kill
pthread_kill_other_threads_np
pthread_mutex_destroy
pthread_mutex_init
pthread_mutex_lock
pthread_mutex_trylock
pthread_mutex_unlock
pthread_mutexattr_destroy
pthread_mutexattr_getkind_np
pthread_mutexattr_gettype
pthread_mutexattr_init
pthread_mutexattr_setkind_np
pthread_mutexattr_settype
pthread_once
pthread_self
pthread_setaffinity_np
pthread_setcancelstate
pthread_setcanceltype
pthread_setconcurrency
pthread_setschedparam
pthread_setschedprio
pthread_setspecific
pthread_sigmask
pthread_testcancel
pthread_tryjoin_np
pthread_yield
pthreads
ptrace
pts
ptsname
pty
putenv
putgrent
putpwent
puts
putwchar
pwck
pwconv
pwdx
pwunconv
qecvt
qsort
query_module
queue
quotactl
raise
ram
rand
random
random_r
raw
rbash
rcmd
re_comp
read
readahead
readdir
readlink
readlinkat
readv
realpath
reboot
recno
recv
regex
remainder
remap_file_pages
remove
removexattr
remquo
rename
renameat
renice
repo-rss
repoquery
reposync
resolv
resolver
rev
rewinddir
rexec
rgrep
rint
rm
rmdir
rmmod
round
route
rpc
rpm
rpmatch
rquotad
rtc
rtime
rtld-audit
rtnetlink
runlevel
scalb
scalbln
scandir
scanf
sched_get_priority_max
sched_getcpu
sched_rr_get_interval
sched_setaffinity
sched_setparam
sched_setscheduler
sched_yield
sd
sdiff
securetty
sed
seekdir
select
select_tut
sem_close
sem_destroy
sem_getvalue
sem_init
sem_open
sem_overview
sem_post
sem_unlink
sem_wait
semctl
semget
semop
send
sendfile
service
services
set_mempolicy
set_thread_area
set_tid_address
setaliasent
setarch
setbuf
setenv
seteuid
setfsgid
setfsuid
setgid
setjmp
setlocale
setlogmask
setnetgrent
setpci
setpgid
setresuid
setreuid
setsid
setuid
setup
setxattr
sfdisk
sg
sgetmask
sgmldiff
sgmlnorm
shadow
shells
shm_open
shm_overview
shmctl
shmget
shmop
showmount
shutdown
sigaction
sigaltstack
siginterrupt
signal
signalfd
signbit
significand
sigpause
sigpending
sigprocmask
sigqueue
sigreturn
sigset
sigsetops
sigsuspend
sigvec
sigwait
sigwaitinfo
sin
sincos
sinh
sk98lin
skill
slabinfo
slabtop
slattach
sleep
snice
sockatmark
socket
socketcall
socketpair
spam
spent
splice
spu_create
spu_run
spufs
sqrt
st
standards
stat
statd
statfs
statvfs
stdarg
stdin
stdio
stdio_ext
stime
stpcpy
stpncpy
strcasecmp
strcat
strchr
strcmp
strcoll
strcpy
strdup
strerror
strfmon
strfry
strftime
string
strlen
strnlen
strpbrk
strptime
strsep
strsignal
strspn
strstr
strtod
strtoimax
strtok
strtol
strtoul
strverscmp
strxfrm
suffixes
sulogin
svcgssd
svipc
swab
swapoff
swapon
switchdesk
sx
symlink
symlinkat
sync
sync_file_range
sys-unconfig
syscall
syscalls
sysconf
sysctl
sysfs
sysinfo
syslog
system
sysv_signal
tailf
tan
tanh
tcgetpgrp
tcgetsid
tcp
tee
telinit
telldir
tempnam
termcap
termio
termios
tgamma
time
timegm
timer_create
timer_delete
timer_getoverrun
timer_settime
timeradd
timerfd_create
times
tkill
tkpppoe
tload
tmpfile
tmpnam
toascii
touch
toupper
towctrans
towlower
towupper
trunc
truncate
tsearch
tty
ttyS
tty_ioctl
ttyname
ttyslot
ttytype
tzfile
tzselect
tzset
ualarm
udp
udplite
ulimit
umask
umount
uname
undocumented
ungetwc
unicode
unimplemented
units
unix
unlink
unlinkat
unlocked_stdio
unlockpt
unshare
update-pciids
updwtmp
uptime
uri
uselib
useradd
userdel
usermod
usernetctl
usleep
ustat
utf-8
utime
utimensat
utmp
vcs
vdir
vfork
vhangup
vigr
vim
vimdiff
vimtutor
vipw
vm86
vmsplice
vmstat
volname
w
wait
wait4
wall
watch
wavelan
wcpcpy
wcpncpy
wcrtomb
wcscasecmp
wcscat
wcschr
wcscmp
wcscpy
wcscspn
wcsdup
wcslen
wcsncasecmp
wcsncat
wcsncmp
wcsncpy
wcsnlen
wcsnrtombs
wcspbrk
wcsrchr
wcsrtombs
wcsspn
wcsstr
wcstoimax
wcstok
wcstombs
wcswidth
wctob
wctomb
wctrans
wctype
wcwidth
whatis
whereis
wmemchr
wmemcmp
wmemcpy
wmemmove
wmemset
wordexp
wprintf
write
x25
x86_64
xcrypt
xdr
xxd
y0
ypcat
ypchfn
ypchsh
ypdomainname
ypmatch
yppasswd
yppoll
ypset
yptest
ypwhich
yum
yum-builddep
yum-complete-transaction
yum-shell
yum-updatesd
yum-utils
yum-verify
yumdownloader
zcat
zcmp
zdiff
zdump
zforce
zgrep
zic
zmore
znew

Pages de MAN

MAN-PAGES(7)		  Manuel du programmeur Linux		  MAN-PAGES(7)



NOM
       man-pages - Conventions pour l'écriture des pages de manuel Linux

SYNOPSIS
       man [section] titre

DESCRIPTION
       Cette page décrit les conventions utilisées pour les pages de manuel du
       projet man-pages pour Linux, qui contient  les  pages  de  manuel  pour
       Linux  dans  les sections 2, 3, 4, 5 et 7. Les conventions décrites sur
       cette page peuvent aussi être utiles aux auteurs de  pages  de  manuels
       pour d'autres projets.

   Sections des pages de manuel
       Les sections du manuel sont traditionnellement les suivantes :

       1 Commandes (programmes)
		 Les  commandes	 qui  peuvent être invoquées par l'utilisateur
		 depuis un interpréteur de commandes.

       2 Appels système
		 Les fonctions fournies par le noyau.

       3 Fonctions de bibliothèques
		 La plupart des fonctions de la bibliothèque C (libc).

       4 Fichiers spéciaux (périphériques)
		 Fichiers spéciaux trouvés dans /dev.

       5 Formats de fichiers et conventions
		 Le format de /etc/passwd et d'autres fichiers lisibles par un
		 humain.

       6 Jeux

       7 Conventions et divers
		 Panorama  de divers sujets, conventions et protocoles, normes
		 de jeux de caractères, et diverses autres choses.

       8 Commandes d'administration système
		 Les commandes comme mount(8), que seul root peut exécuter.

   Paquet de macros
       Les nouvelles pages de manuel doivent être mises en forme en  utilisant
       le paquet groff an.tmac décrit dans man(7). Ce choix est principalement
       destiné à assurer une cohérence : la plupart des pages de manuel	 Linux
       sont mises en forme avec ces macros.

   Conventions pour l'agencement des sources
       Veuillez	 limiter  la  longueur	des lignes dans le source à environ 75
       caractères, autant que faire se peut. Cela permet d'éviter les  retours
       à  la  ligne  ajoutés  par les clients de mail lorsque des patches sont
       soumis par ce moyen.

       Chaque phrase doit commencer  une  ligne.  Cela	permet	de  voir  plus
       facilement  l'effet  des	 patches,  qui	s'appliquent souvent au niveau
       d'une phrase.

   Ligne de titre
       La première commande d'une page de manuel doit être une commande TH

	      .TH titre section date source manuel,

       où :

	      titre	Le titre de la page  de	 manuel,  en  majuscules  (par
			exemple MAN-PAGES).

	      section	Le numéro de section dans laquelle placer la page (par
			exemple 7).

	      date	La date de la dernière modification. Pensez à modifier
			cette date à chaque changement dans la page, car c'est
			la manière la plus courante  d'avoir  un  contrôle  de
			version.   Les	 dates	 doivent   être	 de  la	 forme
			AAAA-MM-JJ.

	      source	La source de la	 commande,  fonction,  ou  de  l'appel
			système.

			Pour les quelques pages de man-pages dans les sections
			1 et 8, il est conseillé d'écrire GNU.

			Pour les appels	 système,  écrivez  simplement	Linux.
			Précédemment,  il  était  courant  d'écrire  aussi  le
			numéro de version du noyau pour laquelle  la  page  de
			manuel	était écrite. Cependant, cela n'était pas fait
			de façon systématique, et était donc pire que  d'omet-
			tre  simplement	 le  numéro de version. N'incluez donc
			pas de numéro de version.

			Pour les fonctions de  bibliothèque  de	 glibc	ou  de
			l'une  des  bibliothèques GNU standard, utilisez GNU C
			Library, GNU, ou une chaîne vide.

			Pour les pages de la section 4, utilisez Linux.

			En cas d'hésitation, écrivez Linux ou GNU.

	      manuel	Le titre du manuel  (par  exemple  Linux  Programmer's
			Manual	pour  les  pages  des  sections 2 et 3 dans le
			paquet man-pages)

   Sections dans une page de manuel
       La liste ci-dessous indique les sections habituelles ou	suggérées.  La
       plupart	des  pages  devraient  contenir au moins les sections mises en
       évidence. Dans les nouvelles pages de manuel, placez les sections  dans
       l'ordre indiqué dans la liste.

	    NAME
	    SYNOPSIS
	    CONFIGURATION      [En général seulement section 4]
	    DESCRIPTION
	    OPTIONS	       [En général seulement sections 1, 8]
	    EXIT STATUS	       [En général seulement sections 1, 8]
	    RETURN VALUE       [En général seulement sections 2, 3]
	    ERRORS	       [Typiquement uniquement sections 2, 3]
	    ENVIRONMENT
	    FILES
	    VERSIONS	       [En général seulement sections 2, 3]
	    CONFORMING TO
	    NOTES
	    BUGS
	    EXAMPLE
	    SEE ALSO

       Lorsque	l'une  des  sections traditionnelles s'applique, utilisez-la ;
       cette cohérence rend l'information plus facile à	 comprendre.  Si  cela
       est  nécessaire,	 vous  pouvez  créer vos propres titres de sections si
       cela rend les choses plus compréhensibles  (particulièrement  pour  les
       pages  des  sections  4 et 5). Cependant, avant de faire cela, vérifiez
       qu'aucun des titres de sections traditionnels  ne  peut	être  utilisé,
       avec des sous-sections (.SS).

       La  liste suivante décrit le contenu de chacune des sections ci-dessus.

       NAME	     Le nom de cette page. D'importants détails sur les lignes
		     qui  doivent suivre la commande .SH NAME se trouvent dans
		     la page man(7).

       SYNOPSIS	     Indique brièvement l'interface de la commande  ou	de  la
		     fonction.	Pour  les  commandes,  ce paragraphe montre sa
		     syntaxe et ses arguments. Les caractères gras marquent le
		     texte invariable et l'italique indique les arguments rem-
		     plaçables. Les crochets « [] »  encadrent	les  arguments
		     optionnels,  les  barres  verticales  « | »  séparent les
		     alternatives,  et	les  ellipses  «... »  signalent   les
		     répétitions.  Pour	 les  fonctions,  on trouve toutes les
		     déclarations et directives #include, suivies de la décla-
		     ration de fonction.

		     Si	 une macro de test de fonctionnalité doit être définie
		     pour obtenir la  déclaration  d'une  fonction  (ou	 d'une
		     variable)	dans  un  fichier  d'en-tête, alors la section
		     SYNOPSIS  doit  l'indiquer,  comme	  décrit   dans	  fea-
		     ture_test_macros(7).

       CONFIGURATION Détails de configuration pour un périphérique. Cette sec-
		     tion est présente normalement que dans les	 pages	de  la
		     section 4.

       DESCRIPTION   Fournit  une explication sur ce que la commande, la fonc-
		     tion ou le format	représente.  Décrit  les  interactions
		     avec  les	fichiers  et  l'entrée standard, ou ce qui est
		     produit sur la sortie standard ou d'erreur.  Ne  contient
		     pas  les  détails	d'implémentation  internes, sauf s'ils
		     sont critique pour comprendre l'interface. Décrit le  cas
		     principal,	 pour  les détails sur les options, on utilise
		     le paragraphe OPTIONS.

       OPTIONS	     Décrit les options acceptées par  le  programme  et  leur
		     influence	sur  son  comportement.	 Cette section ne doit
		     être utilisée que pour les pages de manuel des sections 1
		     et 8.

       EXIT STATUS (CODE DE RETOUR)
		     Indique  les codes de retour d'un programme et les condi-
		     tions associées. Cette section ne doit être utilisée  que
		     pour les pages de manuel des sections 1 et 8.

       RETURN VALUE (VALEUR RENVOYÉE)
		     Pour  les	pages des sections 2 et 3, donne une liste des
		     valeurs  qu'une  routine  de  bibliothèque	  renverra   à
		     l'appelant	 et les conditions qui provoquent ces retours.

       ERRORS	     Pour les pages des sections 2 et 3, cette partie contient
		     une liste des valeurs possibles de errno en cas d'erreur,
		     avec la description des causes de ces erreurs.  La	 liste
		     d'erreurs doit être triée par ordre alphabétique.

       ENVIRONMENT (ENVIRONNEMENT)
		     Décrit toutes les variables d'environnement qui affectent
		     le programme ou la fonction, ainsi que leurs effets.

       FILES (FICHIERS)
		     Liste les fichiers utilisés par le programme ou la	 fonc-
		     tion,  tels  que fichiers de configuration, de démarrage,
		     et les fichiers manipulés directement par	le  programme.
		     Il	 faut donner le chemin d'accès complet des fichiers et
		     utiliser le mécanisme  d'installation  pour  modifier  le
		     préfixe.  Pour  la plupart des programmes, l'installation
		     par défaut se fait dans /usr/local, aussi, votre page  de
		     manuel de base devrait utiliser /usr/local comme base.

       VERSIONS	     Un	 court	résumé	de  la version du noyau Linux ou de la
		     glibc où l'appel système ou la fonction  de  bibliothèque
		     est  apparu,  ou  dont  le	 fonctionnement est modifié de
		     manière significative. De manière générale,  la  page  de
		     manuel  de	 chaque nouvelle interface devrait inclure une
		     section VERSIONS.	Malheureusement,  bien	des  pages  de
		     manuel  existantes	 n'incluent pas cette information (car
		     il n'y avait pas de politique pour le faire lors qu'elles
		     ont  été  rédigées).  Les correctifs pour y remédier sont
		     les bienvenus. Dans la perpective d'écriture  de  nouveau
		     code,  cette  information	n'a  de	 sens  que dans le cas
		     d'interface  noyau	 ajoutée  à  Linux  2.4	  ou   suivant
		     (c'est-à-dire  les modifications depuis la version 2.2 du
		     noyau), et les fonctions de la bibliothèque ajoutées dans
		     glibc  depuis  la version 2.1 (c'est-à-dire les modifica-
		     tions depuis la version 2.0 de la glibc).

		     La page  de  manuel  syscalls(2)  fournit	également  des
		     informations  de  versions	 de noyau dans lesquelles sont
		     apparus les appels système.

       CONFORMING TO (CONFORMITÉ)
		     Décrit les normes ou conventions liées à la fonction ou à
		     la	 commande décrite par la page de manuel. Pour une page
		     dans la section 2 ou 3, cette section  doit  indiquer  la
		     version  de  POSIX.1  à  laquelle l'appel se conforme, et
		     s'il est spécifié par C99. (Il est	 inutile  de  trop  se
		     préoccuper	 des autres normes comme SUS, SUSv2 ou XPG, ou
		     des implémentations SVr4 ou BSD4.x, sauf si  la  fonction
		     était  présente  dans ces systèmes mais n'est pas dans la
		     version actuelle de POSIX.1. (Voir standards(7).)

		     Si la fonction n'est gouvernée par aucun  standard,  mais
		     existe sur d'autres systèmes, mentionnez-les. Si elle est
		     spécifique à Linux, notez-le.

		     Si cette section ne consiste qu'en une  liste  de	normes
		     (ce  qui est d'habitude le cas), terminez la liste par un
		     point (« . »).

       NOTES	     Contient des notes diverses. Pour les pages des  sections
		     2	et  3, il peut être utile d'utiliser des sous-sections
		     (SS) appelées Linux Notes ou Glibc Notes.

       BUGS (BOGUES) Liste les limitations ou les défauts recensés, ainsi  que
		     les sujets à débat.

       EXAMPLE (EXEMPLE)
		     Donne  un ou plusieurs exemples d'utilisation de la fonc-
		     tion, du fichier ou de la commande. Pour plus de  détails
		     sur  l'écriture d'exemples de programmes, voir la section
		     qui y est consacrée ci-dessous.

       AUTHORS (AUTEURS)
		     Liste les auteurs de la documentation  ou	du  programme.
		     L'utilisation   d'une   section   AUTHORS	est  fortement
		     découragée. En général, il vaut mieux ne pas remplir  les
		     pages  de	manuel avec une liste (potentiellement longue)
		     d'auteurs ; si vous écrivez ou modifiez de	 façon	impor-
		     tante  une	 page, ajoutez une notice de copyright en com-
		     mentaire dans le fichier source. Si  vous	êtes  l'auteur
		     d'un pilote de périphérique et voulez inclure une adresse
		     pour signaler les bogues, placez-la dans la section BUGS.

       SEE ALSO (VOIR AUSSI)
		     Fournit  une  liste des pages de manuel (séparées par des
		     virgules) ayant un rapport,  dans	l'ordre	 des  sections
		     puis   alphabétique,   suivies   des   autres   documents
		     éventuels. Ne terminez pas la liste par un point.

   Conventions de fontes
       Pour les fonctions, les arguments sont toujours indiqués	 en  italique,
       même  dans  le  paragraphe  SYNOPSIS, où le reste de la fonction est en
       caractères gras :

	int myfunction(int argc, char **argv);

       Les noms de variables devraient, tout comme  les	 noms  de  paramètres,
       être formatés en italique.

       Les  noms  de fichiers, que ce soit des chemins ou des références à des
       fichiers du répertoire /usr/include) sont  toujours  en	italique  (par
       exemple	),  sauf dans le paragraphe SYNOPSIS, où les fichiers
       inclus sont en gras (par	 exemple  #include  ).	 Lorsque  vous
       faites	référence   à	un   fichier   d'entête	 standard  situé  dans
       /usr/include, spécifiez le fichier d'entête entouré avec	 les  symboles
       inférieur et supérieur, de la même manière que dans un fichier source C
       (par exemple, ).

       Les macros, généralement en majuscules, sont en gras (par exemple  MAX-
       INT). Exception : NULL ne doit pas être en gras.

       Dans  l'énumération  d'une  liste  de code d'erreurs, les codes sont en
       gras, et la liste utilise normalement la macro .TP.

       Les commandes complètes devraient, si elles sont longues, être  écrites
       sous forme indentée, par exemple

	   man 7 man-pages

       Si  la  commande	 est  courte, elle peut être incluse dans le texte, en
       italique, par exemple, man 7 man-pages.	Dans  ce  cas,	il  peut  être
       intéressant  d'utiliser	des  espaces  insécables (« \  ») aux endroits
       appropriés dans la commande. Les options des  commandes	doivent	 elles
       aussi être formatées en italique, par exemple, -l.

       Les  expressions,  si elles ne sont pas écrites sur une ligne indentée,
       devraient être mises en italique. Ici  aussi,  l'utilisation  d'espaces
       insécables  est appropriée si l'expression est mélangée à du texte nor-
       mal.

       Toute référence au sujet de la page de manuel courante doit être écrite
       en  gras.  Si le sujet est une fonction (c'est-à-dire s'il s'agit d'une
       page de section 2 ou 3), le nom doit être suivi	d'une  paire  de  par-
       enthèses	 en  caractères	 romans	 (normaux).  Par exemple, dans la page
       fcntl(2), les références au sujet de la page sont écrites  fcntl().  La
       façon d'écrire ceci dans le fichier source est :

	   .BR fcntl ()

       (avec  ce  format  au  lieu  de « \fB...\fP() » le travail d'outils qui
       parsent les sources des pages de manuel est plus facile)

       Toute référence à une autre page de manuel, ou au sujet principal de la
       page  en cours, est en gras, et toujours suivi du numéro de section, en
       fonte normale, sans espace (par exemple intro(2)). Dans le  source,  on
       l'écrit habituellement de cette façon :

	   .BR intro (2)

       (inclure le numéro de section dans les références croisées permet à des
       outils comme man2html(1) de créer des liens hypertexte appropriés)

   Orthographe
       A partir de la version 2.59, la version anglaise de man-pages suit  les
       conventions orthographiques américaines ; veuillez écrire les nouvelles
       pages et les rustines en suivants ces conventions.

   Programmes d'exemples et sessions shell.
       Les pages de manuel peuvent contenir des programmes permettant de  mon-
       trer comment utiliser un appel système ou une fonction de bibliothèque.
       Cependant, veuillez noter ceci :

       *  Les programmes d'exemple doivent être écrits en C.

       *  Un programme d'exemple n'est nécessaire et  utile  que  s'il	montre
	  quelque  chose  qui  ne  peut	 pas  être  fourni facilement dans une
	  description de l'interface.  Un  programme  d'exemple	 qui  ne  fait
	  qu'appeler une fonction ne sert en général à rien.

       *  Les  programmes  d'exemple doivent être plutôt courts (de préférence
	  moins de 100 lignes, idéalement moins de 50 lignes).

       *  Les programmes d'exemple doivent  vérifier  les  erreurs  après  les
	  appels système et les appels de fonctions de bibliothèque.

       *  Les  programmes  d'exemple  doivent  être  complets et compiler sans
	  avertissements avec cc -Wall.

       *  Si possible et raisonnable, les programmes d'exemples doivent perme-
	  ttre	d'expérimenter,	 en  changeant de comportement en fonction des
	  entrées (arguments de ligne de commande, ou bien entrées lues par le
	  programme).

       *  Les  programmes d'exemple doivent être mis en forme dans le style de
	  Kernighan et Ritchie, avec des indentations  de  4  espaces  (évitez
	  d'utiliser le caractère tabulation dans les fichiers source !).

       Pour  voir à quoi les programmes d'exemples devraient ressembler, voyez
       wait(2) et pipe(2).

       Si vous incluez une session d'interpréteur de commandes pour  démontrer
       l'utilisation  d'un programme ou d'autres fonctionnalités système, met-
       tez le texte entré par l'utilisateur en gras pour le distinguer	de  la
       sortie produite par le système.

   Indentation des définitions de structure, session shell, etc.
       Lorsque	des  définitions  de  structure, des sorties de session shell,
       etc. sont inclus dans le texte courant,	indentez-les  avec  4  espaces
       (c'est-à-dire un bloc entouré par .in +4n et .in).

EXEMPLE
       Pour  des  exemples  canoniques de pages de manuel du paquet man-pages,
       voir pipe(2) et fcntl(2).

VOIR AUSSI
       man(1), man2html(1), groff(7), groff_man(7), man(7), mdoc(7)

COLOPHON
       Cette page fait partie de  la  publication  3.23	 du  projet  man-pages
       Linux.  Une description du projet et des instructions pour signaler des
       anomalies  peuvent  être	 trouvées  à  l'adresse	  .

TRADUCTION
       Depuis  2010,  cette  traduction est maintenue à l'aide de l'outil po4a
        par l'équipe de traduction franco-
       phone	     au		sein	     du		projet	      perkamon
       .

       Julien	Cristau	  et   l'équipe	  francophone	de    traduction    de
       Debian (2006-2009).

       Veuillez	 signaler  toute  erreur  de  traduction en écrivant à .

       Vous pouvez toujours avoir accès à la version anglaise de  ce  document
       en utilisant la commande « LC_ALL=C man 
». Linux 28 octobre 2008 MAN-PAGES(7)

 


www.eurower.info