Man Man en français
MAN(7)                 Manuel de l'administrateur Linux                 MAN(7)



 

NOM


       man - Macros pour la mise en forme des pages de manuel.

 

SYNOPSIS


       groff -Tascii -man fichier ...

       groff -Tps -man fichier ...

       man [section] titre

 

DESCRIPTION






       Cette  page  de  manuel  explique le contenu du paquetage groff tmac.an
       (souvent appele paquetage man).  Ce paquetage doit etre utilise par les
       developpeurs  pour ecrire ou porter des pages de manuels pour Linux. Il
       est largement compatible avec d'autres versions de ce  paquetage,  donc
       le  portage de pages pour Linux ne devrait pas poser de problemes (sauf
       pour NET-2 BSD qui utilise un paquetage completement  different  appele
       mdoc, voir mdoc(7)).

       Notez  que  les pages de manuel NET-2 BSD peuvent etre visualisees avec
       groff simplement en specifiant l'option -mdoc a la  place  de  l'option
       -man.   L'utilisation  de  l'option  -mandoc  est neanmoins recommandee
       puisqu'il detectera automatiquement le paquetage utilise.

 

PREAMBULE


       La premiere commande d'une page de manuel doit etre

              .TH titre section date source manuel,

       avec :

              titre   Le titre de la page de manuel (par exemple MAN).

              section Le numero de section dans laquelle placer la  page  (par
                      exemple 7).

              date    La  date  de la derniere modification. Pensez a modifier
                      cette date a chaque changement dans la page,  car  c'est
                      la  maniere la plus courante d'avoir un controle de ver-
                      sion.

              source  La source de la commande

                      Pour les executables, utilisez quelque chose comme  GNU,
                      NET-2, SLS Distribution, MCC Distribution.

                      Pour les appels systeme, vous pouvez indiquer la version
                      du noyau que vous utilisez : Linux 2.4.19.

                      Pour les fonctions de bibliotheque, utilisez  la  source
                      de la fonction : GNU, BSD 4.3, Linux DLL 4.4.1.

              manuel  Le  titre  du  manuel (par exemple Manuel du programmeur
                      Linux).

       Notez que les pages BSD formatees avec mdoc commencent avec la commande
       Dd et non pas TH.

       Les sections du manuel sont traditionnellement reparties ainsi :

              1 Commandes
                        Les  commandes  qui peuvent etre invoquees par l'util-
                        isateur depuis le shell.

              2 Appel systemes
                        Les fonctions fournies par le noyau.

              3 Fonctions de bibliotheques
                        La plupart des fonctions de la bibliotheque  C  telles
                        que qsort(3).

              4 Peripheriques
                        Fichiers speciaux trouves dans

              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
                        Une description du systeme de fichiers standard, cette
                        page   de   manuel,  des  jeux  de  caracteres,  entre
                        autres...

              8 Commandes d'administration systeme.
                        Les commandes comme mount(8), que seul root peut  exe-
                        cuter.

              9 Routines du noyau
                        Il  s'agit  d'une  section obsolete.  On a jadis pense
                        qu'il serait bon de documenter  le  noyau  Linux  ici,
                        mais en fait tres peu de documentation a ete realisee,
                        et celle qui existe est deja depassee.  Il  existe  de
                        bien  meilleures sources d'information pour les devel-
                        oppeurs du noyau.

SECTIONS (PARAGRAPHES)
       Les sections commencent par .SH suivies de leurs titres.  Si  le  titre
       contient des espaces, l'encadrer par des guillemets.  Les titres tradi-
       tionnels sont : NOM, SYNOPSIS, DESCRIPTION, VALEUR  RENVOYEE,  CODE  DE
       RETOUR,  ERREURS, OPTIONS, FICHIERS, EXEMPLE, VOIR AUSSI, DIAGNOSTIQUE,
       BOGUES, ENVIRONNEMENT, SECURITE, CONFORMITE,  AUTEUR,  VOIR  AUSSI,  et
       TRADUCTION.   Utilisez de preference ces titres s'il vous plait ; cette
       coherence rend les pages de manuel plus  faciles  a  comprendre.  Main-
       tenant,  creez  vos propres titres si vous pensez que c'est necessaire.
       Le seul titre indispensable est NOM, qui doit etre suivi sur  la  ligne
       suivante par une courte description du programme :

              .SH NOM
              chess \- Jeu d'echecs

       Il  est  tres important que ce format soit respecte, et qu'il se trouve
       un backslash avant le tiret suivant le nom du programme. Il est  impor-
       tant  que  toute  la description soit placee sur une seule ligne. Cette
       syntaxe est utilisee par le programme makewhatis(8) pour creer la  base
       de donnees des descriptions pour les commandes whatis(1) et apropos(1).

       Ndt : Vous vous doutez bien que la version  de  distribution  de  make-
       whatis(8)  ne  reconnait  pas  la section  NOM  mais la section  NAME .
       Pour que les commandes whatis(1) et apropos(1)  fonctionnent,  il  faut
       modifier  le  script  makewhatis(8).   La  modification  a apporter est
       decrite dans le fichier LISEZ_MOI, qui est  livre  avec  l'archive  des
       pages de manuel en francais.

       Les autres sections contiennent habituellement les elements suivants :

       SYNOPSIS      indique  brievement  l'interface  de la commande ou de la
                     fonction.  Pour les commandes, ce  paragraphe  montre  sa
                     syntaxe  et  ses arguments.  Les caracteres gras marquent
                     le texte invariable et l'italique indique  les  arguments
                     remplacables.  Les  crochets  []  encadrent les arguments
                     optionnels, les barres verticales  |  separent les alter-
                     natives, et les ellipses  ...  signalent les repetitions.
                     Pour les fonctions, on trouve toutes les declarations  et
                     directives  #include,  suivies de la declaration de fonc-
                     tion.

       DESCRIPTION   fournit une explication sur ce que la commande, la  fonc-
                     tion  ou  le  format  represente. Decrit les interactions
                     avec les fichiers et l'entree standard,  ou  ce  qui  est
                     produit  sur la sortie standard ou d'erreur.  Ne contient
                     pas les details  d'implementation  internes,  sauf  s'ils
                     sont critique pour comprendre l'interface.  Decrit le cas
                     principal, pour les details sur les options,  on  utilise
                     le  paragraphe  OPTIONS.  S'il y a une sorte de grammaire
                     d'entree, ou un jeu de sous-commandes, on peut les placer
                     dans  un  paragraphe  UTILISATION  supplementaire  (juste
                     apres la section DESCRIPTION).

 

       VALEUR RENVOYEE


                     donne une liste des valeurs  qu'une  routine  de  biblio-
                     theque renverra a l'appelant et les conditions qui provo-
                     quent ces retours.

 

       CODE DE RETOUR


                     indique les codes de retour d'un programme et les  condi-
                     tions associees.

       OPTIONS       decrit  les options acceptees par le programme et comment
                     son comportement se modifie.

       UITILISATION  decrit la grammaire de tout sous-langage implemente.

       EXEMPLES      donne un ou plusieurs exemples d'utilisation de la  fonc-
                     tion, du fichier ou de la commande.

       FICHIERS      liste  les fichiers utilises par le programme ou la fonc-
                     tion, tels que fichiers de configuration,  de  demarrage,
                     et  les  fichiers manipules directement par le programme.
                     Il faut donner le chemin d'acces complet des fichiers  et
                     utiliser  le  mecanisme  d'installation  pour modifier le
                     prefixe.  Pour la plupart des programmes,  l'installation
                     par  defaut se fait dans /usr/local, aussi, votre page de
                     manuel de base devrait utiliser /usr/local comme base.

       ENVIRONNEMENT decrit toutes les variables d'environnement qui affectent
                     le programme ou la fonction, ainsi que leurs effets.

       DIAGNOSTIQUE  fournit  un  survol des messages d'erreurs usuels et com-
                     ment les considerer.  Il n'est pas necessaire  d'indiquer
                     les  messages  d'erreur systeme ou les signaux fatals qui
                     peuvent apparaitre durant l'execution du programme,  sauf
                     s'ils sont traites specialement.

       SECURITE      concerne les problemes de securite et leurs implications.
                     Doit contenir les avertissements a propos des  configura-
                     tions ou des environnements a eviter, les commandes ayant
                     des repercussions au niveau securite, etc. surtout  s'ils
                     ne  sont pas evidents.  Il n'est pas obligatoire de faire
                     un paragraphe specifique sur la securite. Si l'intelligi-
                     bilite  est  amelioree,  on  peut placer ces informations
                     dans les autres sections (telles que DESCRIPTION ou UTIL-
                     ISATION).   Neanmoins,  il  est  important  de placer les
                     informations de securite quelque part.

       CONFORMITE    decrit  les  standards  ou  les  conventions  suivis  par
                     l'implementation.

       NOTES         contient des notes diverses.

       BOGUES        liste  les limitations ou les defauts recenses, ainsi que
                     les sujets a debat.

       AUTEUR        liste les auteurs de la  documentation  ou  du  programme
                     afin de pouvoir leur envoyer les rapports de bogue.

       VOIR AUSSI    fournit  une  liste des pages de manuel ayant un rapport,
                     dans l'ordre alphabetique, suivies des  autres  documents
                     eventuels.

       TRADUCTION    le  nom  du traducteur. Si son adresse courriel n'est pas
                     fournie, vous la  trouverez  dans  le  fichier  LISEZ_MOI
                     fournit  avec  les pages de manuel en francais.  Le para-
                     graphe  TRADUCTION  n'est pas destine a flatter l'ego  du
                     traducteur,  mais  a  savoir  a  qui  s'adresser  si vous
                     relevez une erreur !

 

FONTES


       Bien qu'il y ait de nombreuses conventions arbitraires  concernant  les
       pages  de manuel pour UNIX, l'existence de plusieurs centaines de pages
       specifiques a Linux definit nos propres standards :

              Pour les fonctions, les  arguments  sont  toujours  indiques  en
              italique,  meme  dans  le paragraphe SYNOPSIS, ou le reste de la
              fonction est en caracteres gras:
              int mafonction(int argc, char **argv);

              Les noms de fichiers sont  toujours  en  italique  (par  exemple
              /usr/include/stdio.h),  sauf dans le paragraphe SYNOPSIS, ou les
              fichiers inclus sont en gras (par exemple #include ).

              Les macros, generalement en majuscules, sont en gras (par  exem-
              ple MAXINT).

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

              Toute reference a une autre page de manuel, ou au sujet  princi-
              pal de la page en cours, est en gras. Si le numero de section de
              manuel est donne, il est en  Roman,  sans  espace  (par  exemple
              man(7)).

              Les commandes pour selectionner les fontes sont les suivantes :

       .B  Gras

       .BI Gras  alterne  avec  Italique  (surtout  pour les specifications de
           fonctions)

       .BR Gras alterne avec Roman (surtout pour  les  references  aux  autres
           pages de manuel)

       .I  Italique

       .IB Italique alterne avec Gras

       .IR Italique alterne avec Roman

       .RB Roman alterne avec Gras

       .RI Roman alterne avec Italique

       .SB Petit alterne avec Gras

       .SM Petit (utile pour les acronymes)

       Traditionnellement,  chaque  commande peut avoir jusqu'a six arguments,
       mais les versions GNU semblent eliminer cette  contrainte.   Les  argu-
       ments sont delimites par des espaces. Des guillemets sont utilises pour
       encadrer un argument qui contient  des  espaces.   Tous  les  arguments
       seront  imprimes  les  uns  apres  les autres sans intercaler d'espace,
       ainsi la commande .BR peut etre utilisee pour indiquer un mot  en  Gras
       suivi  par  un  signe de ponctuation en Roman.  Si aucun argument n'est
       fourni, la commande s'applique a la ligne suivante.

 

AUTRES MACROS ET CHAINES


       Ci-dessous se trouvent les macros et chaines predefinies. Sauf  indica-
       tion  contraire,  toutes  les  macros declenchent un saut de ligne.  La
       plupart de ces macros utilisent ou  modifient  l'indentation  courante.
       Celle-ci est fixee par toute macro avec le parametre i ci-dessous ; les
       macros peuvent omettre le  i  auquel  cas  l'indentation  courante  est
       utilisee.   En  consequence, les paragraphes sucessifs peuvent utiliser
       la meme indentation  sans  la  repeter.   Un  paragraphe  normal,  non-
       indente,  replace  l'indentation  courante  a sa valeur par defaut (0.5
       pouces).  Par defaut, les indentations sont mesurees  en  ens  (largeur
       d'une lettre  n ") ou ems ( m ). Ainsi, les largeurs s'ajustent automa-
       tiquement en cas de  changement  de  police.   Les  principales  macros
       disponibles sont :

   Paragraphes normaux
       .LP      Comme .PP (debute un nouveau paragraphe).

       .P       Comme .PP (debute un nouveau paragraphe).

       .PP      Debute  un  nouveau  paragraphe  et reinitialise l'indentation
                courante.

   Indentation Relative
       .RS i    Debute une indentation relative - deplace la marge gauche de i
                vers  la  droite  (si  i  est  absent, la valeur d'indentation
                courante est utilisee).  Une nouvelle valeur d'indentation est
                placee  a  0.5  pouces.   En consequence, tous les paragraphes
                suivants seront indentes jusqu'au RE correspondant.

       .RE      Terminer une indentation relative  et  restituer  les  valeurs
                precedentes d'indentation courante.

   Macros d'indentation de paragraphe
       .HP i    Debute  un paragraphe avec une indentation d'accroche (la pre-
                miere ligne du paragraphe est le long de la marge  gauche,  et
                les autres lignes sont indentees).

       .IP x i  Paragraphe  indente avec une balise d'accroche eventuelle.  Si
                la balise x est omise, tout le paragraphe est  indente  de  i.
                Si  la  balise x est fournie, elle est accrochee le long de la
                marge gauche, avant le paragraphe  indente  (C'est  comme  .TP
                sauf que la balise est incluse avec la commande elle-meme plu-
                tot que d'etre sur la ligne suivante).  Si la balise est  trop
                longue,  le texte sera transpose a la ligne suivante (le texte
                ne sera ni perdu  ni  tronque).   Pour  les  listes  a  puces,
                utilisez  cette  macro  avec \(bu (rond) ou \(em (tiret) comme
                balise, et pour les listes numerotees utilisez le numero ou la
                lettre  suivi  par un point. Ceci simplifie la traduction dans
                d'autres formats.

       .TP i    Debut d'un paragraphe avec une balise  d'accroche.  La  balise
                est  donnee  sur la ligne suivante, mais le resultat est iden-
                tique a celui de la commande .IP.

   Macros de liens hypertextes
       (Fonctionnalite supportee par groff seulement.)   Afin  d'utiliser  les
       macros  de  liens  hypertexte,  il  est necessaire de charger le paquet
       macro www.tmac.  Utiliser la requete .mso www.tmac pour le faire.

       .URL url lien fin
                Insere un lien hypertexte vers  l'URI  (URL)  url,  avec  lien
                comme  texte  du  lien.   La  fin  sera affichee immediatement
                apres.  Lors d'une conversion en HTML, cela se traduit par les
                commandes HTML .  lienfin.

                Les macros d'insertion de liens hypertextes sont nouvelles, et
                de nombreux outils n'en feront rien. Mais, comme  de  nombreux
                outils (y compris troff) les ignoreront simplement (ou au pire
                ecriront leur texte), on peut les utiliser sans souci.

                Il peut etre utile de definir votre propre macro URL dans  les
                pages  de manuels pour le benefice de ceux qui les regarderont
                avec un visualisateur roff autre que groff.  De  cette  facon,
                l'URL,  le  texte  du  lien  et  le texte de fin (s'il y en a)
                restent visibles.

                Voici un exemple:
                      .de URL
                      \\$2 \(laURL: \\$1 \(ra\\$3
                      ..
                      .if \n[.g] .mso www.tmac
                      .TH ...
                      (plus bas dans la page page)
                      Ce logiciel est fournit par le
                      .URL "http://www.gnu.org/" "Projet GNU" " de la"
                      .URL "http://www.fsf.org/" "Free Software Foundation"  .

                Dans ce qui precede, si groff est utilise, la definition de la
                macro URL du paquet macro www.tmac surchargera celle  qui  est
                definie localement.  defined one.

       Un   certain   nombre  d'autres  macros  lien  sont  disponibles.  Voir
       groff_www(7) pour plus de details.

   Macros diverses
       .DT      Reinitialiser les tabulations a leurs valeurs par defaut, tous
                les 0.5 pouces sans declencher de saut de ligne.

       .PD d    Fixer  la  distance  verticale entre paragraphes a la valeur d
                (si absent, d=0.4v).  Ne provoque pas de saut de ligne.

       .SS t    Sous-chapitre t (comme .SH, mais  pour  les  sous-sections  au
                sein d'une section).

   Chaines predefinies
       Le paquetage man contient les chaines predefinies suivantes :

       \*R    Symbole d'enregistrement : (R)

       \*S    Taille de police par defaut.

       \*(Tm  Symbole marque deposee : tm

       \*(lq  Guillemets en chevrons droits : "

       \*(rq  Guillemets en chevrons gauches : "

Ensemble de commandes sres
       Bien  que  techniquement  man  soit  un  paquetage  de macros troff, en
       realite un grand nombre d'autres outils traitent les fichiers des pages
       de  manuel,  sans implementer toutes les possibilites de troff. Il vaut
       donc mieux eviter certaines fonctionnalites exotiques de troff.  Evitez
       d'utiliser  les preprocesseurs de troff (s'il le faut, utilisez tbl(1),
       mais essayez d'employer plutot les commandes IP et TP pour les tableaux
       a deux colonnes).  Evitez d'utiliser les calculs, la plupart des autres
       outils ne les realisent pas. Utilisez des commandes  simples  facile  a
       traduire  dans  d'autres  formats.  Les macros suivantes sont reconnues
       comme sres (meme si elles sont parfois ignorees par les  traducteurs) :
       \",  ., ad, bp, br, ce, de, ds, el, ie, if, fi, ft, hy, ig, in, na, ne,
       nf, nh, ps, so, sp, ti, tr.

       Vous pouvez aussi employer les sequences d'echappement de troff (celles
       qui  commencent par \).  Si vous devez inserer une contre inverse comme
       du texte normal, utilisez \e.  Les autres  sequences  que  vous  pouvez
       utiliser,  x  et  xx etant des caracteres quelconques, et N un chiffre,
       sont : \', \`, \-, \., \", \%, \*x, \*(xx, \(xx, \$N, \nx, \n(xx,  \fx,
       et  \f(xx.  Evitez d'utiliser des sequences d'echappement pour dessiner
       des graphiques.

       N'utilisez  pas  les  parametres  optionnels  pour  bp  (break   page).
       Utilisez  seulement des valeurs positives pour sp (vertical space).  Ne
       definissez pas de macro (de) avec le meme  nom  qu'une  macro  dans  ce
       paquetage  ou  dans celui de mdoc avec une signification differente, il
       est probable que la definition en  serait  ignoree.   Tout  indentation
       positive (in) devrait etre appariee avec une indentation negative iden-
       tique (bien que vous devriez plutot utiliser les macros RS et RE  a  la
       place).  Les tests (if,ie) ne devraient avoir que  t  ou  n  comme con-
       dition.   Seules  les  traductions  (tr)  qui  peuvent  etre   ignorees
       devraient  etre  utilisees.   Les  changement  de  fontes  (ft  et  les
       sequences d'echappement \f) ne doivent prendre comme valeurs que 1,  2,
       3,  4,  R,  I,  B,  P,  ou  CW (la commande ft peut aussi n'avoir aucun
       parametre).

       Si vous utilisez d'autres fonctionnalites que  celles-ci,  verifiez  le
       resultat  soigneusement sur divers outils.  Une fois que vous avez con-
       firmation que la nouvelle fonctionnalite est sre, faites-le  savoir  au
       mainteneur de cette page.

 

NOTES


       Inserez les URLs complets dans le texte lui-meme, certains outils comme
       man2html(1) peuvent les transformer  automatiquement  en  liens  hyper-
       textes.  Vous pouvez aussi utiliser la nouvelle macro URL pour associer
       les liens aux informations correspondantes.  Si vous inserer des  URLs,
       utilisez  des  URL  complets (par exemple )
       pour s'assurer que les outils les trouveront automatiquement.

       Les outils traitant ces fichiers devront les ouvrir et examiner le pre-
       mier  caractere  non-blanc.  Un  point ou un apostrophe simple au debut
       d'une ligne indiquent un fichier troff (comme man ou mdoc).   Un  angle
       gauche   <  indique un document SGML/XML comme (HTML ou Docbook).  Tout
       autre caractere correspond a un texte ASCII  simple  (par  exemple  une
       sortie  catman ).

       Plusieurs  pages  commencent avec '\" suivi d'une espace et d'une liste
       de caracteres indiquant comment la page doit  etre  pre-traitee.   Pour
       ameliorer  la  portabilite  vers  des  traducteurs non-troff, nous vous
       recommandons d'eviter d'utiliser autre chose que tbl(1).   Sous  Linux,
       la  detection en est automatique.  Nenamoins, vous pouvez inclure cette
       information pour que votre page  de  manuel  puisse  etre  traitee  par
       d'autres  systemes  (moins  capables).  Voici la definition des prepro-
       cesseurs invoques par ces caracteres :

       e  eqn(1)

       g  grap(1)

       p  pic(1)

       r  refer(1)

       t  tbl(1)

       v  vgrind(1)


       [Ndt] En francais, nous utilisons plus frequement les  espaces  inseca-
       bles  que les anglo-saxons. Pour transformer un espace normal en espace
       insecable, il suffit de le prefixer par   \ .  Si  vous  traduisez  des
       pages,  essayez  de placer ces espaces insecables avant les points-vir-
       gules, deux-points, point d'exclamation et  d'interrogation,  et  entre
       les nombres et les unites (par exemple 1024 ko, s'ecrira 1024\ ko).

 

FICHIERS


       /usr/share/groff/ [*/] tmac/tmac.an
       /usr/man/whatis

 

BOGUES


       La  plupart  des  macros  decrivent  la  mise en forme (police, espace-
       ment...) au lieu de marquer le contenu semantique (par  exemple  refer-
       ence  vers une autre page) comme le font des formats comme mdoc ou Doc-
       Book (meme l'HTML a des balises  plus  semantiques).   Cette  situation
       rend le format man difficile a traduire sur differents supports.  En se
       limitant au sous-ensemble de macros decrites plus haut, il devrait etre
       plus facile de basculer automatiquement vers un autre format de page de
       reference dans l'avenir.

       La macro Sun TX n'est pas implementee.

 

AUTEURS


       -- James Clark (jjc@jclark.com) a ecrit l'implementation  du  paquetage
          de macros.

       -- Rickard  E.  Faith (faith@cs.unc.edu) a ecrit la version initiale de
          cette page de manuel.

       -- Jens Schweikhardt (schweikh@noc.fdn.de) a ecrit le mini HOWTO Linux-
          man-page.  (qui a influence cette page de manuel).

       -- David  A. Wheeler (dwheeler@ida.org) a largement modifie cette page,
          en ajoutant des details sur les sections et les macros.

 

VOIR AUSSI


       apropos(1), groff(1), man(1),  man2html(1),  mdoc(7),  mdoc.samples(7),
       groff_man(7), groff_www(7), whatis(1)

 

TRADUCTION


       Ce   document   est  une  traduction  realisee  par  Christophe  Blaess
        le  20 octobre 1996  et  revisee  le
       7 decembre 2006.

       L'equipe  de  traduction a fait le maximum pour realiser une adaptation
       francaise de qualite. La version anglaise la plus a jour de ce document
       est  toujours consultable via la commande :  LANG=C man 7 man .  N'hes-
       itez pas a signaler a l'auteur ou au traducteur, selon  le  cas,  toute
       erreur dans cette page de manuel.



LDP                             27 juillet 2004                         MAN(7)