Man page 7 : mdoc

mdoc - Guide de référence rapide pour l'ensemble de macros -mdoc

groff - m Ns Ar doc fichiers ...

-mdoc est un ensemble de macros utilisées pour formater les pages de manuel

x et basées sur le contenu et sur le domaine. Les noms des macros et leur signification sont listés ci-dessous pour une référence rapide ; pour une explication détaillée de l'utilisation du paquet, voir la page groff_mdoc(7) .

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

Les macros sont décrites 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 différencient le paquet -mdoc d'autre systèmes de formatage troff .

.Ss Macros de titre Pour créer une page de manuel valide, les trois macros suivantes sont nécessaires, dans cet ordre :

-tag -width
Li ".Dd " "mois jour, année" Date du document.
Li ".Dt " "TITRE_DOCUMENT [section] [volume]" Titre, en majuscules.
Li ".Os " "SYSTÈME_D_EXPLOITATION [version/release]" Système d'exploitation .Pq Tn BSD . .Ss Macros de mise en page En(hytêtes de section, changements de paragraphe, listes, affichage.

-tag -width flag -compact
Li .Sh En(hytêtes de section. En(hytêtes valides, par ordre de présentation :

-tag -width
NAME Section de nom, doit en général inclure les macros .Ql .Nm ou .Ql .Fn ainsi que .Ql - (N.d.T. : à ce jour, le titre de cette section ne doit pas être traduit, sinon les en-têtes et pieds de page ne seront pas affichés).
SYNOPSIS Utilisation.
DESCRIPTION Description générale, devrait inclure les options et paramètres.
RETURN VALUE (VALEUR DE RETOUR) Sections 2 et 3, appels de fonctions.
ENVIRONMENT (ENVIRONNEMENT) Décrit les variables d'environnement.
FILES (FICHIERS) Les fichiers associés au thème de la page.
EXAMPLES (EXEMPLES) Exemples et suggestions.
DIAGNOSTICS (DIAGNOSTIQUE) Utilisé en général pour la section 4, interface avec les périphérique.
ERRORS (ERREURS) Sections 2 et 3, gestion des erreurs et signaux.
SEE ALSO (VOIR AUSSI) Références croisées et citations.
CONFORMING TO (CONFORMITÉ) Conformité aux normes, quand c'est le cas.
HISTORY (HISTORIQUE) Si une norme n'est pas applicable, un historique du sujet devrait être donné.
BUGS (BOGUES) Bogues et difficultés d'utilisation.
autres Des en(hytêtes personnalisés peuvent être ajoutés, au choix des auteurs.
Li .Ss En(hytêtes de sous-section.
Li .Pp Coupure de paragraphe. Espace vertical d'une ligne.
Li .D1 (D-un) « Display-one ». Indenter et afficher une ligne de texte.
Li .Dl (D-ell) « Display-one literal ». Indenter et afficher une ligne de texte verbatim.
Li .Bd Début de bloc d'affichage. Options d'affichage :

-tag -width
-ragged Non justifié.
-filled Justifié.
-literal Texte ou code verbatim.
-file nom Lire dans le fichier indiqué, et afficher le contenu.
-offset chaîne Afficher avec un décalage. Valeurs de chaîne autorisées :

-tag -width indent-two -compact
left Aligner le bloc à gauche (par défaut)
center Marge centrale.
indent Indentation de six espaces (une tabulation).
indent-two Deux tabulations.
right Bloc aligné à gauche, à deux pouces de la limite droite.
xx Ns Cm n Où xx est un nombre entre 4 Ns Cm n à 99 Ns Cm n .
Aa Où Aa est le nom d'une macro appelable.
chaîne La largeur de la string est utilisée.
Li .Ed Fin de bloc d'affichage (correspond à .Bd).
Li .Bl Début de liste. Crée des listes ou des colonnes. Options :

-tag -width flag -compact
Types de liste

-column
-bullet Ta "Liste Énumération par puces"
-item Ta "Liste sans étiquette"
-enum Ta "Énumération"
-tag Ta "Liste avec étiquette"
-diag Ta "Liste pour le diagnostique"
-hang Ta "Liste avec étiquette suspendue"
-ohang Ta "Liste avec étiquette surplombante"
-inset Ta "Liste avec étiquette incrustée"
Paramètres de liste

-tag -width
-offset (Toutes les listes.) Consultez .Ql .Bd ci-dessus.
-width (Listes - tag et - hang seulement.) Consultez .Ql .Bd .
-compact (Toutes les listes.) Supprimer les lignes blanches.
Li .El Fin de liste.
Li .It Élément de liste.

Les macros de manuel et de texte générique sont spéciales, dans le sens où la plupart d'entre elles sont analysée à la recherche d'autres macros « appelables », par exemple :

-tag -width
Li ".Op -s fichier" Produit [-s fichier ]

Dans cet exemple, la macro d'option .Ql .Op est parsée, et appelle la macro de contenu appelable .Ql Fl qui s'applique à l'argument .Ql s , puis appelle la macro de contenu appelable .Ql Ar qui s'applique à l'argument .Ql fichier . Certaines macros sont appelables mais ne sont pas analysée, et vice-versa. Ces macros sont indiquées dans les colonnes .Em analysée et .Em appelable ci-dessous.

Sauf exception notée, les macros de manuels ont toutes la même syntaxe :

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

.Sy Note  : Les caractères de ponctuation ouvrants et fermants ne sont reconnus que s'ils sont présents un à la fois. La chaîne .Ql ")," n'est pas reconnue comme un signe de ponctuation, et est donc affichée précédée d'un espace, et dans la fonte utilisée par la macro appelante. La liste d'arguments .Ql "] ) ," est reconnue comme trois caractères de ponctuation fermants, et n'est donc pas précédée d'un espace. La signification particulière d'un signe de ponctuation peut être supprimée en le précédant par .Ql \& . Par exemple, la chaîne suivante

-tag -width
Li ". fichier1 , fichier2 , fichier3 ) ." Donne fichier1 , fichier2 , fichier3 ) . .Ss Macros du domaine manuel

-column Name Parsed Callable(dq -compact
Em "Nom Analysée Appelable Description"
Li Ad Ta Oui Ta Oui Ta "Adresse (cette macro peut être obsolète)."
Li An Ta Oui Ta Oui Ta "Nom de l'auteur."
Li Ta Oui Ta Oui Ta "gument de ligne de commande."
Li Cd Ta Non Ta Non Ta "Déclaration de configuration (uniquement section 4)."
Li Cm Ta Oui Ta Oui Ta "Modificateur d'argument de ligne de commande."
Li Dv Ta Oui Ta Oui Ta "Variable définie (code source)."
Li Er Ta Oui Ta Oui Ta "Code d'erreur (code source)."
Li Ev Ta Oui Ta Oui Ta "Variable d'environnement."
Li Fa Ta Oui Ta Oui Ta "gument d'une fonction."
Li Fd Ta Oui Ta Oui Ta "Déclaration de fonction."
Li Fn Ta Oui Ta Oui Ta "Appel de fonction (également .Fo et .Fc)."
Li Ta Oui Ta Oui Ta "Commande interactive."
Li Li Ta Oui Ta Oui Ta "Texte verbatim."
Li Nm Ta Oui Ta Oui Ta "Nom de commande."
Li Op Ta Oui Ta Oui Ta "Option (également .Oo et .Oc)."
Li Ot Ta Oui Ta Oui Ta "Type de fonction, ancien style (Fortran uniquement)."
Li Pa Ta Oui Ta Oui Ta "Nom de fichier ou chemin."
Li St Ta Oui Ta Oui Ta "Normes (-p1003.2, -p1003.1 ou -ansiC)"
Li Va Ta Oui Ta Oui Ta "Nom de variable."
Li Vt Ta Oui Ta Oui Ta "Type de variable (Fortran)."
Li Xr Ta Oui Ta Oui Ta "Référence à une page de manuel." .Ss Macros de texte génériques

-column Name Parsed Callable(dq -compact
Em "Nom Analysée Appelable Description"
Li %A Ta Oui Ta Non Ta "Auteur de la référence."
Li %B Ta Oui Ta Oui Ta "Titre du livre référencé."
Li %C Ta Non Ta Non Ta "Lieu (ville) de publication de la référence."
Li %D Ta Non Ta Non Ta "Date de la référence."
Li %J Ta Oui Ta Oui Ta "Titre du journal de la référence."
Li %N Ta Non Ta Non Ta "Numéro de la référence."
Li %O Ta Non Ta Non Ta "Information optionnelle sur la référence."
Li %P Ta Non Ta Non Ta "Numéro(s) de page de la référence."
Li %R Ta Non Ta Non Ta "Nom du rapport référencé."
Li %T Ta Oui Ta Oui Ta "Titre de l'article référencé."
Li %V Ta Non Ta Non Ta "Volume de la référence."
Li Ac Ta Oui Ta Oui Ta "Angle fermant."
Li Ao Ta Oui Ta Oui Ta "Angle ouvrant."
Li Ap Ta Oui Ta Oui Ta Apostrophe.
Li Aq Ta Oui Ta Oui Ta "Met ses arguments entre deux angles."
Li At Ta Non Ta Non Ta Tn "UNIX AT&T"
Li Bc Ta Oui Ta Oui Ta "Crochet fermant."
Li Bf Ta Non Ta Non Ta "Début de mode de police."
Li Bo Ta Oui Ta Oui Ta "Crochet ouvrant."
Li Bq Ta Oui Ta Oui Ta "Met ses arguments entre crochets."
Li Bx Ta Oui Ta Oui Ta Bx .
Li Db Ta Non Ta Non Ta "Débogage (par défaut, \*qoff\*q)"
Li Dc Ta Oui Ta Oui Ta "Guillemet double fermant."
Li Do Ta Oui Ta Oui Ta "Guillemet double ouvrant."
Li Dq Ta Oui Ta Oui Ta "Guillemet double."
Li Ec Ta Oui Ta Oui Ta "Fin d'entourage de chaîne."
Li Ef Ta Non Ta Non Ta "Fin du mode police."
Li Em Ta Oui Ta Oui Ta "Emphase (anglais traditionnel)."
Li Eo Ta Oui Ta Oui Ta "Début d'entourage de chaîne."
Li Fx Ta Non Ta Non Ta Tn "Système d'exploitation FreeBSD"
Li No Ta Oui Ta Oui Ta "Texte normal (no-op)."
Li Ns Ta Oui Ta Oui Ta "Pas d'espace."
Li Pc Ta Oui Ta Oui Ta "Fermeture de parenthèse."
Li Pf Ta Oui Ta Non Ta "Chaîne préfixe."
Li Po Ta Oui Ta Oui Ta "Ouverture de parenthèse."
Li Pq Ta Oui Ta Oui Ta "Parenthèses."
Li Qc Ta Oui Ta Oui Ta "Guillemet double droit fermant."
Li Ql Ta Oui Ta Oui Ta "Texte verbatim entre guillemets."
Li Qo Ta Oui Ta Oui Ta "Guillemet double droit ouvrant."
Li Qq Ta Oui Ta Oui Ta "Guillemets doubles droits."
Li Re Ta Non Ta Non Ta "Fin de référence."
Li Rs Ta Non Ta Non Ta "Début de référence."
Li Rv Ta Non Ta Non Ta "Valeurs renvoyées (sections 2 et 3)."
Li Sc Ta Oui Ta Oui Ta "Guillemet simple fermant."
Li So Ta Oui Ta Oui Ta "Guillemet simple ouvrant."
Li Sq Ta Oui Ta Oui Ta "Guillemet simple."
Li Sm Ta Non Ta Non Ta "Mode espace (par défaut, \*qon\*q)"
Li Sx Ta Oui Ta Oui Ta "Référence de section."
Li Sy Ta Oui Ta Oui Ta "Symbolique (anglais traditionnel)."
Li Tn Ta Oui Ta Oui Ta "Nom de marque ou de type (petites majuscules)."
Li Ux Ta Oui Ta Oui Ta Ux
Li Xc Ta Oui Ta Oui Ta "Fin de liste d'arguments."
Li Ta Oui Ta Oui Ta "Début de liste d'arguments."

Les macros dont le nom finit par .Ql q entourent les éléments restants dans la liste d'arguments. Les macros dont le nom finit par .Ql o commencent une citation qui peut prendre plusieurs lignes, et qui est terminée par la macro correspondante dont le nom finit par .Ql c . Les macros de ce type peuvent être imbriquées et sont limitées à huit arguments.

Note : les macros de liste d'arguments étendues .Pf ( Ql .Xo , .Ql .Xc ) et les macros de fonction .Pf ( Ql .Fo , .Ql .Fc ) sont spéciales. Les macros de liste d'arguments étendues servent à dépasser la limite à neuf arguments imposée par troff .

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

-tag -width tmac.doc-ditroff -compact
Pa doc.tmac Macros des domaines manuel et texte générique.
Pa tmac/doc-common Macros et définitions structurelles communes.
Pa tmac/doc-nroff Fichier de style nroff local.
Pa tmac/doc-ditroff Fichier de style troff local.
Pa tmac/doc-syms Définitions spéciales (comme les macros courantes).

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

Cette page fait partie de la publication 3.52 du projet .Em man-pages Linux. Une description du projet et des instructions pour signaler des anomalies peuvent être trouvées à l'adresse http://www.kernel.org/doc/man-pages/.

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

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 <section> <page_de_man> ».