MDOC(7)

  NOM

  SYNOPSIS

  DESCRIPTION
est un ensemble de macros utilisées pour formater les pages de manuel 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 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 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 d'autre systèmes de formatage

  DOMAINE DE STRUCTURE DE PAGES
Pour créer une page de manuel valide, les trois macros suivantes sont nécessaires, dans cet ordre : Date du document. Titre, en majuscules. Système d'exploitation En-têtes de section, changements de paragraphe, listes, affichage. En-têtes de section. En-têtes valides, par ordre de présentation : Section de nom, doit en général inclure les macros ou ainsi que (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). Utilisation. Description générale, devrait inclure les options et paramètres. Sections 2 et 3, appels de fonctions. Décrit les variables d'environnement. Les fichiers associés au thème de la page. Exemples et suggestions. Utilisé en général pour la section 4, interface avec les périphérique. Sections 2 et 3, gestion des erreurs et signaux. Références croisées et citations. Conformité aux normes, quand c'est le cas. Si une norme n'est pas applicable, un historique du sujet devrait être donné. Bogues et difficultés d'utilisation. Des en-têtes personnalisés peuvent être ajoutés, au choix des auteurs. En-têtes de sous-section. Coupure de paragraphe. Espace vertical d'une ligne. (D-un) « Display-one ». Indenter et afficher une ligne de texte. (D-ell) « Display-one literal ». Indenter et afficher une ligne de texte verbatim. Début de bloc d'affichage. Options d'affichage : Non justifié. Justifié. Texte ou code verbatim. Lire dans le indiqué, et afficher le contenu. Afficher avec un décalage. Valeurs de autorisées : Aligner le bloc à gauche (par défaut) Marge centrale. Indentation de six espaces (une tabulation). Deux tabulations. Bloc aligné à gauche, à deux pouces de la limite droite. Où est un nombre entre à Où est le nom d'une macro appelable. La largeur de la est utilisée. Fin de bloc d'affichage (correspond à .Bd). Début de liste. Crée des listes ou des colonnes. Options : (Toutes les listes.) Consultez ci-dessus. (Listes et seulement.) Consultez (Toutes les listes.) Supprimer les lignes blanches. Fin de liste. Élément de liste.

  MACROS DES DOMAINES MANUEL ET TEXTE GÉNÉRIQUE
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 : Produit Dans cet exemple, la macro d'option est parsée, et appelle la macro de contenu appelable qui s'applique à l'argument puis appelle la macro de contenu appelable qui s'applique à l'argument Certaines macros sont appelables mais ne sont pas analysée, et vice-versa. Ces macros sont indiquées dans les colonnes et ci-dessous. Sauf exception notée, les macros de manuels ont toutes la même syntaxe : : Les caractères de ponctuation ouvrants et fermants ne sont reconnus que s'ils sont présents un à la fois. La chaîne n'est pas reconnue comme un signe de ponctuation, et est donc affichée précédée d'un espace, et dans la police utilisée par la macro appelante. La liste d'arguments 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 Par exemple, la chaîne suivante Donne Les macros dont le nom finit par entourent les éléments restants dans la liste d'arguments. Les macros dont le nom finit par commencent une citation qui peut prendre plusieurs lignes, et qui est terminée par la macro correspondante dont le nom finit par Les macros de ce type peuvent être imbriquées et sont limitées à huit arguments. Note : les macros de liste d'arguments étendues et les macros de fonction sont spéciales. Les macros de liste d'arguments étendues servent à dépasser la limite à neuf arguments imposée par 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 pour plus d'informations sur ces macros.

  FICHIERS
Macros des domaines manuel et texte générique. Macros et définitions structurelles communes. Fichier de style local. Fichier de style local. Définitions spéciales (comme les macros courantes).

  VOIR AUSSI

  COLOPHON
Cette page fait partie de la publication 3.57 du projet 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/.

  TRADUCTION
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 à <debian-l10n-french@lists.debian.org> ou par un rapport de bogue sur le paquet manpages-fr. Vous pouvez toujours avoir accès à la version anglaise de ce document en utilisant la commande « man -L C <section> <page_de_man> ».