Provided by: manpages-fr_3.32d0.2p4-1_all bug

NOM

     mdoc -- Guide de reference rapide pour l'ensemble de macros -mdoc

SYNOPSIS

     groff -mdoc fichiers ...

DESCRIPTION

     -mdoc est un ensemble de macros utilisees pour formater les pages de
     manuel BSD et basees sur le contenu et sur le domaine. Les noms des
     macros et leur signification sont listes ci-dessous pour une reference
     rapide ; pour une explication detaillee de l'utilisation du paquet, voir
     la page groff_mdoc(7).

     Notez que ceci n'est pas l'ensemble de macros usuel pour la documentation
     sous Linux, bien qu'il soit utilise pour la documentation de nombreux
     programmes largement utilises ; voir man(7).

     Les macros sont decrites en deux groupes. Le premier inclut les macros de
     mise en page structurelle et physique. Le second contient les macros de
     domaine manuel et texte qui differencient le paquet -mdoc d'autre
     systemes de formatage troff.

DOMAINE DE STRUCTURE DE PAGES

   Macros de titre
     Pour creer une page de manuel valide, les trois macros suivantes sont
     necessaires, dans cet ordre :
     .Dd   mois jour, ann'ee                      Date du document.
     .Dt   TITRE_DOCUMENT [section] [volume]     Titre, en majuscules.
     .Os   SYST`EME_D_EXPLOITATION [version/release]
                                                 Systeme d'exploitation (BSD).

   Macros de mise en page
     En-tetes de section, changements de paragraphe, listes, affichage.
     .Sh   En-tetes de section. En-tetes valides, par ordre de presentation :
           NAME          Section de nom, doit en general inclure les macros
                         '.Nm' ou '.Fn' ainsi que '.Nd' (N.d.T. : a ce jour,
                         le titre de cette section ne doit pas etre traduit,
                         sinon les en-tetes et pieds de page ne seront pas
                         affiches).
           SYNOPSIS      Utilisation.
           DESCRIPTION   Description generale, devrait inclure les options et
                         parametres.
           RETURN VALUE (VALEUR DE RETOUR)
                         Sections 2 et 3, appels de fonctions.
           ENVIRONMENT (ENVIRONNEMENT)
                         Decrit les variables d'environnement.
           FILES (FICHIERS)
                         Les fichiers associes au theme de la page.
           EXAMPLES (EXEMPLES)
                         Exemples et suggestions.
           DIAGNOSTICS (DIAGNOSTIQUE)
                         Utilise en general pour la section 4, interface avec
                         les peripherique.
           ERRORS (ERREURS)
                         Sections 2 et 3, gestion des erreurs et signaux.
           SEE ALSO (VOIR AUSSI)
                         References croisees et citations.
           CONFORMING TO (CONFORMIT'E)
                         Conformite aux normes, quand c'est le cas.
           HISTORY (HISTORIQUE)
                         Si une norme n'est pas applicable, un historique du
                         sujet devrait etre donne.
           BUGS (BOGUES)
                         Bogues et difficultes d'utilisation.
           autres        Des en-tetes personnalises peuvent etre ajoutes, au
                         choix des auteurs.
     .Ss   En-tetes de sous-section.
     .Pp   Coupure de paragraphe. Espace vertical d'une ligne.
     .D1   (D-un) << Display-one >>. Indenter et afficher une ligne de texte.
     .Dl   (D-ell) << Display-one literal >>. Indenter et afficher une ligne
           de texte verbatim.
     .Bd   Debut de bloc d'affichage. Options d'affichage :
           -ragged          Non justifie.
           -filled          Justifie.
           -literal         Texte ou code verbatim.
           -file nom        Lire dans le fichier indique, et afficher le
                            contenu.
           -offset cha^ine   Afficher avec un decalage. Valeurs de cha^ine
                            autorisees :
                            left        Aligner le bloc a gauche (par defaut)
                            center      Marge centrale.
                            indent      Indentation de six espaces (une
                                        tabulation).
                            indent-two  Deux tabulations.
                            right       Bloc aligne a gauche, a deux pouces de
                                        la limite droite.
                            xxn         Ou xx est un nombre entre 4n a 99n.
                            Aa          Ou Aa est le nom d'une macro
                                        appelable.
                            cha^ine      La largeur de la string est utilisee.
     .Ed   Fin de bloc d'affichage (correspond a .Bd).
     .Bl   Debut de liste. Cree des listes ou des colonnes. Options :
           Types de liste
                 -bullet    Liste Enumeration par puces
                 -item      Liste sans etiquette
                 -enum      Enumeration
                 -tag       Liste avec etiquette
                 -diag      Liste pour le diagnostique
                 -hang      Liste avec etiquette suspendue
                 -ohang     Liste avec etiquette surplombante
                 -inset     Liste avec etiquette incrustee
           Parametres de liste
                 -offset    (Toutes les listes.) Consultez '.Bd' ci-dessus.
                 -width     (Listes -tag et -hang seulement.) Consultez '.Bd'.
                 -compact   (Toutes les listes.) Supprimer les lignes
                            blanches.
     .El   Fin de liste.
     .It   Element de liste.

MACROS DES DOMAINES MANUEL ET TEXTE G'EN'ERIQUE

     Les macros de manuel et de texte generique sont speciales, dans le sens
     ou la plupart d'entre elles sont analysee a la recherche d'autres macros
     << appelables >>, par exemple :

           .Op Fl s Ar fichier
                       Produit [-s fichier]

     Dans cet exemple, la macro d'option '.Op' est parsee, et appelle la macro
     de contenu appelable 'Fl' qui s'applique a l'argument 's', puis appelle
     la macro de contenu appelable 'Ar' qui s'applique a l'argument 'fichier'.
     Certaines macros sont appelables mais ne sont pas analysee, et vice-
     versa. Ces macros sont indiquees dans les colonnes analys'ee et appelable
     ci-dessous.

     Sauf exception notee, les macros de manuels ont toutes la meme syntaxe :

           .Va argument [ . , ; : ( ) [ ] argument ... ]

     Note  : Les caracteres de ponctuation ouvrants et fermants ne sont
     reconnus que s'ils sont presents un a la fois. La chaine '),' n'est pas
     reconnue comme un signe de ponctuation, et est donc affichee precedee
     d'un espace, et dans la fonte utilisee par la macro appelante. La liste
     d'arguments '] ) ,' est reconnue comme trois caracteres de ponctuation
     fermants, et n'est donc pas precedee d'un espace. La signification
     particuliere d'un signe de ponctuation peut etre supprimee en le
     precedant par '\&'.  Par exemple, la chaine suivante

           .Ar fichier1 , fichier2 , fichier3 ) .
                                           Donne fichier1, fichier2,
                                           fichier3).

   Macros du domaine manuel
     Nom     Analys'ee  Appelable    Description
     Ad      Oui       Oui          Adresse (cette macro peut etre obsolete).
     An      Oui       Oui          Nom de l'auteur.
     Ar      Oui       Oui          Argument de ligne de commande.
     Cd      Non       Non          Declaration de configuration (uniquement
                                    section 4).
     Cm      Oui       Oui          Modificateur d'argument de ligne de
                                    commande.
     Dv      Oui       Oui          Variable definie (code source).
     Er      Oui       Oui          Code d'erreur (code source).
     Ev      Oui       Oui          Variable d'environnement.
     Fa      Oui       Oui          Argument d'une fonction.
     Fd      Oui       Oui          Declaration de fonction.
     Fn      Oui       Oui          Appel de fonction (egalement .Fo et .Fc).
     Ic      Oui       Oui          Commande interactive.
     Li      Oui       Oui          Texte verbatim.
     Nm      Oui       Oui          Nom de commande.
     Op      Oui       Oui          Option (egalement .Oo et .Oc).
     Ot      Oui       Oui          Type de fonction, ancien style (Fortran
                                    uniquement).
     Pa      Oui       Oui          Nom de fichier ou chemin.
     St      Oui       Oui          Normes (-p1003.2, -p1003.1 ou -ansiC)
     Va      Oui       Oui          Nom de variable.
     Vt      Oui       Oui          Type de variable (Fortran).
     Xr      Oui       Oui          Reference a une page de manuel.

   Macros de texte g'en'eriques
     Nom     Analys'ee  Appelable    Description
     %A      Oui       Non          Auteur de la reference.
     %B      Oui       Oui          Titre du livre reference.
     %C      Non       Non          Lieu (ville) de publication de la
                                    reference.
     %D      Non       Non          Date de la reference.
     %J      Oui       Oui          Titre du journal de la reference.
     %N      Non       Non          Numero de la reference.
     %O      Non       Non          Information optionnelle sur la reference.
     %P      Non       Non          Numero(s) de page de la reference.
     %R      Non       Non          Nom du rapport reference.
     %T      Oui       Oui          Titre de l'article reference.
     %V      Non       Non          Volume de la reference.
     Ac      Oui       Oui          Angle fermant.
     Ao      Oui       Oui          Angle ouvrant.
     Ap      Oui       Oui          Apostrophe.
     Aq      Oui       Oui          Met ses arguments entre deux angles.
     At      Non       Non          UNIX AT&T
     Bc      Oui       Oui          Crochet fermant.
     Bf      Non       Non          Debut de mode de police.
     Bo      Oui       Oui          Crochet ouvrant.
     Bq      Oui       Oui          Met ses arguments entre crochets.
     Bx      Oui       Oui          BSD.
     Db      Non       Non          Debogage (par defaut, "off")
     Dc      Oui       Oui          Guillemet double fermant.
     Do      Oui       Oui          Guillemet double ouvrant.
     Dq      Oui       Oui          Guillemet double.
     Ec      Oui       Oui          Fin d'entourage de chaine.
     Ef      Non       Non          Fin du mode police.
     Em      Oui       Oui          Emphase (anglais traditionnel).
     Eo      Oui       Oui          Debut d'entourage de chaine.
     Fx      Non       Non          Systeme d'exploitation FreeBSD
     No      Oui       Oui          Texte normal (no-op).
     Ns      Oui       Oui          Pas d'espace.
     Pc      Oui       Oui          Fermeture de parenthese.
     Pf      Oui       Non          Chaine prefixe.
     Po      Oui       Oui          Ouverture de parenthese.
     Pq      Oui       Oui          Parentheses.
     Qc      Oui       Oui          Guillemet double droit fermant.
     Ql      Oui       Oui          Texte verbatim entre guillemets.
     Qo      Oui       Oui          Guillemet double droit ouvrant.
     Qq      Oui       Oui          Guillemets doubles droits.
     Re      Non       Non          Fin de reference.
     Rs      Non       Non          Debut de reference.
     Rv      Non       Non          Valeurs renvoyees (sections 2 et 3).
     Sc      Oui       Oui          Guillemet simple fermant.
     So      Oui       Oui          Guillemet simple ouvrant.
     Sq      Oui       Oui          Guillemet simple.
     Sm      Non       Non          Mode espace (par defaut, "on")
     Sx      Oui       Oui          Reference de section.
     Sy      Oui       Oui          Symbolique (anglais traditionnel).
     Tn      Oui       Oui          Nom de marque ou de type (petites
                                    majuscules).
     Ux      Oui       Oui          UNIX
     Xc      Oui       Oui          Fin de liste d'arguments.
     Xo      Oui       Oui          Debut de liste d'arguments.

     Les macros dont le nom finit par 'q' entourent les elements restants dans
     la liste d'arguments. Les macros dont le nom finit par 'o' commencent une
     citation qui peut prendre plusieurs lignes, et qui est terminee par la
     macro correspondante dont le nom finit par 'c'.  Les macros de ce type
     peuvent etre imbriquees et sont limitees a huit arguments.

     Note : les macros de liste d'arguments etendues ('.Xo', '.Xc') et les
     macros de fonction ('.Fo', '.Fc') sont speciales. Les macros de liste
     d'arguments etendues servent a depasser la limite a neuf arguments
     imposee par troff.

     Les macros UR (qui ouvre une reference hypertexte vers un URI ou URL), UE
     (qui la ferme) et UN (qui identifie la cible d'une reference) sont
     egalement disponibles. Consultez man(7) pour plus d'informations sur ces
     macros.

FICHIERS

     doc.tmac          Macros des domaines manuel et texte generique.
     tmac/doc-common   Macros et definitions structurelles communes.
     tmac/doc-nroff    Fichier de style nroff local.
     tmac/doc-ditroff  Fichier de style troff local.
     tmac/doc-syms     Definitions speciales (comme les macros courantes).

VOIR AUSSI

     groff_mdoc(7), mdoc.samples(7), man(7), man-pages(7)

COLOPHON

     Cette page fait partie de la publication 3.32 du projet man-pages Linux.
     Une description du projet et des instructions pour signaler des anomalies
     peuvent etre trouvees a l'adresse http://www.kernel.org/doc/man-pages/.

TRADUCTION

     Cette traduction est maintenue a l'aide de l'outil po4a
     <URL:http://po4a.alioth.debian.org/> par l'equipe de traduction
     francophone au sein du projet perkamon
     <URL:http://perkamon.alioth.debian.org/>.

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

     Veuillez signaler toute erreur de traduction en ecrivant a
     <debian-l10n-french@lists.debian.org> ou par un rapport de bogue sur le
     paquet manpages-fr.

     Vous pouvez toujours avoir acces a la version anglaise de ce document en
     utilisant la commande << man -L C <section> <page_de_man> >>.