NOM
man - Macros pour la mise en forme des pages de manuelSYNOPSIS
groff -Tascii -man fichier ...DESCRIPTION
Cette page de manuel explique le contenu du paquet groff an.tmac (souvent appelé paquet de macros man). Ce paquet doit être utilisé par les développeurs pour écrire ou porter des pages de manuel. Il est largement compatible avec d'autres versions de ce paquet, donc le portage de pages pour Linux ne devrait pas poser de problèmes (sauf pour NET-2 BSD qui utilise un paquet de macros complètement différent appelé mdoc, consultez mdoc(7)). Notez que les pages de manuel NET-2 BSD peuvent être visualisées avec groff simplement en spécifiant l'option -mdoc à la place de l'option -man. L'utilisation de l'option -mandoc est néanmoins recommandée puisque cela détectera automatiquement le paquet de macros utilisé. Les conventions utilisées pour les pages de manuel du paquet man-pages pour Linux sont décrites dans man-pages(7).Ligne de titre
La première commande d'une page de manuel (après des lignes de commentaire, qui commencent par .\") doit être
.TH titre section date source
manuel
Les détails des arguments passés à la commande TH
sont décrits dans man-pages(7).
Notez que les pages BSD formatées avec mdoc commencent avec la commande
Dd et non pas TH.
Sections
Les sections commencent par .SH suivi du titre de section. La seule section obligatoire est NAME (NOM), qui doit être la première section et dont la ligne suivant le titre doit être une description courte du programme :.SH NAME
objet \- description
Ce format doit absolument être respecté et le tiret suivant le nom
de l'objet doit être précédé d'une barre oblique
inversée. Toute la description doit être contenue sur une seule
ligne. Cette syntaxe est utilisée par le programme mandb(8) pour
créer la base de données des descriptions courtes pour les
commandes whatis(1) et apropos(1) (consultez lexgrog(1)
pour de plus amples précisions sur la syntaxe de la section NAME).
Pour une liste des autres sections pouvant apparaître dans une page de
manuel, consultez man-pages(7).
Fontes
Les commandes pour sélectionner le type de caractère sont les suivantes.- .B
- Gras.
- .BI
- Gras alterné avec italique (très utile pour les spécifications de fonctions).
- .BR
- Gras alterné avec romain (très utile pour les références aux autres pages de manuel).
- .I
- Italique.
- .IB
- Italique alterné avec gras.
- .IR
- Italique alterné avec romain.
- .RB
- Romain alterné avec gras.
- .RI
- Romain alterné avec italique.
- .SB
- Minuscule alterné avec gras.
- .SM
- Minuscule (utile pour les acronymes).
Autres macros et chaînes
Below are other relevant macros and predefined strings. Unless noted otherwise, all macros cause a break (end the current line of text). Many of these macros set or use the "prevailing indent". The "prevailing indent" value is set by any macro with the parameter i below; macros may omit i in which case the current prevailing indent will be used. As a result, successive indented paragraphs can use the same indent without respecifying the indent value. A normal (nonindented) paragraph resets the prevailing indent value to its default value (0.5 inches). By default, a given indent is measured in ens; try to use ens or ems as units for indents, since these will automatically adjust to font size changes. The other key macro definitions are:Paragraphes normaux
- .LP
- Comme .PP (début d’un nouveau paragraphe).
- .P
- Comme .PP (début d’un nouveau paragraphe).
- .PP
- Début d’un nouveau paragraphe et réinitialisation de l'indentation prévalente.
Indentation relative de marge
- .RS i
- Début d’une indentation relative : déplacement de la marge gauche de i vers la droite (si i est absent, la valeur d'indentation prévalente est utilisée). Une nouvelle valeur d'indentation prévalente est placée à 0,5 pouce. En conséquence, tous les paragraphes suivants seront indentés jusqu'au .RE correspondant.
- .RE
- Fin d’une indentation relative et restauration de la valeur précédente d'indentation prévalente
Macros d'indentation de paragraphe
- .HP i
- Début d’un paragraphe avec une indentation d’accroche (la première ligne de paragraphe est le long de la marge gauche et les autres lignes sont indentées).
- .IP x i
- Indentation de paragraphe avec une balise d’accroche éventuelle. Si la balise x est omise, tout le paragraphe est indenté de i. Si la balise x est fournie, elle est accrochée le long de la marge gauche, avant le paragraphe indenté (c'est comme .TP sauf que la balise est incluse avec la commande elle-même plutôt que d'être sur la ligne suivante). Si la balise est trop longue, le texte sera transposé à la ligne suivante (le texte ne sera ni perdu ni tronqué). Pour les listes à puces, utilisez cette macro avec \(bu (rond) ou \(em (tiret) comme balise, et pour les listes numérotées utilisez le numéro ou la lettre suivi par un point. Cela simplifie la traduction dans d'autres formats.
- .TP i
- Début d'un paragraphe avec une balise d’accroche. La balise est donnée sur la ligne suivante, mais le résultat est identique à celui de la commande .IP.
Macros de liens hypertextes
- .UR url
- Insertion d’un lien hypertexte vers l’URI (URL) url, avec tout le texte jusqu’à la macro .UE suivante comme texte du lien.
- .UE .RI [ trailer ]
- Fin du texte du lien de la macro .UR précédente avec le caractère final trailer (si présent, habituellement une parenthèse fermante ou une ponctuation de fin de phrase) en suite immédiate. Pour les dispositifs de sortie non HTML (par exemple, man -Tutf8), le texte du lien est suivi par l’URL encadré de chevrons. S’il n’y a pas de texte de lien, l’URL est affiché comme son propre texte de lien, entouré de chevrons (les chevrons peuvent ne pas être disponibles dans tous les dispositifs de sortie). Pour les dispositifs de sortie HTML, le texte de sortie sert d’hypertexte pour l’URL. S’il n’y a pas de texte de lien, l’URL est affiché comme son propre texte de lien.
Macros diverses
- .DT
- Réinitialisation des tabulations à leurs valeurs par défaut, tous les demi-pouces. Ne provoque pas de saut de ligne.
- .PD d
- Définition de la distance verticale entre paragraphes à la valeur d (si absente, 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).
Chaînes prédéfinies
Le paquet man contient les chaînes prédéfinies suivantes :- \*R
- Symbole de marque déposée : ®
- \*S
- Taille de la fonte par défaut.
- \*(Tm
- Symbole marque déposée : (Tm)
- \*(lq
- Double guillemet-virgule gauche : “
- \*(rq
- Double guillemet-virgule droit : ”
Sous‐ensemble sûr
Bien que techniquement man soit un paquet de macros troff, en réalité un grand nombre d'autres outils traitent les fichiers des pages de manuel, sans implémenter toutes les possibilités de troff. Il vaut donc mieux éviter certaines fonctionnalités exotiques de troff. Évitez d'utiliser les préprocesseurs de troff (s'il le faut, utilisez tbl(1), mais essayez d'employer plutôt les commandes IP et TP pour les tableaux à deux colonnes). Évitez d'utiliser les calculs, la plupart des autres outils ne les réalisent pas. Utilisez des commandes simples faciles à traduire dans d'autres formats. Les macros suivantes sont reconnues comme sûres (même si elles sont parfois ignorées par les outils) : \", ., ad, bp, br, ce, de, ds, el, ie, if, fi, ft, hy, ig, in, na, ne, nf, nh, ps, so, sp, ti, tr. You may also use many troff escape sequences (those sequences beginning with \). When you need to include the backslash character as normal text, use \e. Other sequences you may use, where x or xx are any characters and N is any digit, include: \', \`, \-, \., \", \%, \*x, \*(xx, \(xx, \$N, \nx, \n(xx, \fx, and \f(xx. Avoid using the escape sequences for drawing graphics. Do not use the optional parameter for bp (break page). Use only positive values for sp (vertical space). Don't define a macro (de) with the same name as a macro in this or the mdoc macro package with a different meaning; it's likely that such redefinitions will be ignored. Every positive indent ( in) should be paired with a matching negative indent (although you should be using the RS and RE macros instead). The condition test ( if,ie) should only have 't' or 'n' as the condition. Only translations ( tr) that can be ignored should be used. Font changes ( ft and the \f escape sequence) should only have the values 1, 2, 3, 4, R, I, B, P, or CW (the ft command may also have no parameters). Si vous utilisez d'autres fonctionnalités que celles-ci, vérifiez le résultat soigneusement sur divers outils. Une fois que vous avez confirmation que la nouvelle fonctionnalité est sûre, faites-le savoir au mainteneur de cette page.FICHIERS
/usr/share/groff/[*/]tmac/an.tmacNOTES
Par tous les moyens, insérez les URL complets dans le texte lui-même, certains outils comme man2html(1) peuvent les transformer automatiquement en liens hypertextes. Vous pouvez aussi utiliser les macros UR et UE pour associer les liens aux informations correspondantes. Si vous insérez des URL, utilisez des URL complets (par exemple http://www.kernel.org pour s'assurer que ces outils les trouveront automatiquement. Tools processing these files should open the file and examine the first nonwhitespace character. A period (.) or single quote (') at the beginning of a line indicates a troff-based file (such as man or mdoc). A left angle bracket (<) indicates an SGML/XML-based file (such as HTML or Docbook). Anything else suggests simple ASCII text (e.g., a "catman" result). Many man pages begin with '\" followed by a space and a list of characters, indicating how the page is to be preprocessed. For portability's sake to non-troff translators we recommend that you avoid using anything other than tbl(1), and Linux can detect that automatically. However, you might want to include this information so your man page can be handled by other (less capable) systems. Here are the definitions of the preprocessors invoked by these characters:- e
- eqn(1)
- g
- grap(1)
- p
- pic(1)
- r
- refer(1)
- t
- tbl(1)
BOGUES
La plupart des macros décrivent la mise en forme (fonte, espacement, etc.) au lieu de marquer le contenu sémantique (par exemple, référence vers une autre page) comme le font des formats comme mdoc ou DocBook (même l'HTML a des balises plus sémantiques). Cette situation rend le format man difficile à diversifier pour différents médias, pour rendre le formatage cohérent pour un média donné et pour insérer automatiquement des références croisées. En se limitant au sous-ensemble de macros sûres décrites plus haut, il devrait être plus facile de basculer automatiquement vers un autre format de référence de page dans l'avenir. La macro Sun TX n'est pas implémentée.VOIR AUSSI
apropos(1), groff(1), lexgrog(1), man(1), man2html(1), groff_mdoc(7), whatis(1), groff_man(7), groff_www(7), man-pages(7), mdoc(7)TRADUCTION
La traduction française de cette page de manuel a été créée par Christophe Blaess <https://www.blaess.fr/christophe/>, Stéphan Rafin <[email protected]>, Thierry Vignaud <[email protected]>, François Micaux, Alain Portal <[email protected]>, Jean-Philippe Guérard <[email protected]>, Jean-Luc Coulon (f5ibh) <[email protected]>, Julien Cristau <[email protected]>, Thomas Huriaux <[email protected]>, Nicolas François <[email protected]>, Florentin Duneau <[email protected]>, Simon Paillard <[email protected]>, Denis Barbier <[email protected]>, David Prévot <[email protected]> et Jean-Paul Guillonneau <[email protected]> Cette traduction est une documentation libre ; veuillez vous reporter à la GNU General Public License version 3 concernant les conditions de copie et de distribution. Il n'y a aucune RESPONSABILITÉ LÉGALE. Si vous découvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message à [email protected]| 5 février 2023 | Pages du manuel de Linux 6.03 |