.\" -*- coding: UTF-8 -*- .\" (C) Copyright 1992-1999 Rickard E. Faith and David A. Wheeler .\" (faith@cs.unc.edu and dwheeler@ida.org) .\" .\" %%%LICENSE_START(VERBATIM) .\" Permission is granted to make and distribute verbatim copies of this .\" manual provided the copyright notice and this permission notice are .\" preserved on all copies. .\" .\" Permission is granted to copy and distribute modified versions of this .\" manual under the conditions for verbatim copying, provided that the .\" entire resulting derived work is distributed under the terms of a .\" permission notice identical to this one. .\" .\" Since the Linux kernel and libraries are constantly changing, this .\" manual page may be incorrect or out-of-date. The author(s) assume no .\" responsibility for errors or omissions, or for damages resulting from .\" the use of the information contained herein. The author(s) may not .\" have taken the same level of care in the production of this manual, .\" which is licensed free of charge, as they might when working .\" professionally. .\" .\" Formatted or processed versions of this manual, if unaccompanied by .\" the source, must acknowledge the copyright and authors of this work. .\" %%%LICENSE_END .\" .\" Modified Sun Jul 25 11:06:05 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Sat Jun 8 00:39:52 1996 by aeb .\" Modified Wed Jun 16 23:00:00 1999 by David A. Wheeler (dwheeler@ida.org) .\" Modified Thu Jul 15 12:43:28 1999 by aeb .\" Modified Sun Jan 6 18:26:25 2002 by Martin Schulze .\" Modified Tue Jul 27 20:12:02 2004 by Colin Watson .\" 2007-05-30, mtk: various rewrites and moved much text to new man-pages.7. .\" .\"******************************************************************* .\" .\" This file was generated with po4a. Translate the source file. .\" .\"******************************************************************* .TH MAN 7 "1 novembre 2020" Linux "Manuel du programmeur Linux" .SH NOM man \- Macros pour la mise en forme des pages de manuel .SH SYNOPSIS \fBgroff \-Tascii \-man\fP \fIfichier\fP \&... .PP \fBgroff \-Tps \-man\fP \fIfichier\fP \&... .PP \fBman\fP [\fIsection\fP] \fItitre\fP .SH DESCRIPTION Cette page de manuel explique le contenu du paquet \fBgroff an.tmac\fP (souvent appelé paquet de macros \fBman\fP). 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 \fBmdoc\fP(7)). .PP Notez que les pages de manuel NET\-2 BSD peuvent être visualisées avec \fBgroff\fP simplement en spécifiant l'option \fB\-mdoc\fP à la place de l'option \fB\-man\fP. L'utilisation de l'option \fB\-mandoc\fP est néanmoins recommandée puisque cela détectera automatiquement le paquet de macros utilisé. .PP Les conventions utilisées pour les pages de manuel du paquet \fIman\-pages\fP pour Linux sont décrites dans \fBman\-pages\fP(7). .SS "Ligne de titre" La première commande d'une page de manuel (après des lignes de commentaire, qui commencent par \fB.\e"\fP) doit être .PP .RS \fB\&.TH\fP \fItitre section date source manuel\fP .RE .PP Les détails des arguments passés à la commande \fBTH\fP sont décrits dans \fBman\-pages\fP(7). .PP Notez que les pages BSD formatées avec mdoc commencent avec la commande \fBDd\fP et non pas \fBTH\fP. .SS Sections .\" The following doesn't seem to be required (see Debian bug 411303), .\" If the name contains spaces and appears .\" on the same line as .\" .BR \&.SH , .\" then place the heading in double quotes. Les sections commencent par \fB\&.SH\fP suivi du titre de section. .PP 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\ : .PP .RS \&.SH NAME .br objet \e\- description .RE .PP 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 \fBmandb\fP(8) pour créer la base de données des descriptions courtes pour les commandes \fBwhatis\fP(1) et \fBapropos\fP(1) (consultez \fBlexgrog\fP(1) pour de plus amples précisions sur la syntaxe de la section NAME). .PP Pour une liste des autres sections pouvant apparaître dans une page de manuel, consultez \fBman\-pages\fP(7). .SS Fontes Les commandes pour sélectionner le type de caractère sont les suivantes. .TP 4 \fB\&.B\fP Gras. .TP \fB\&.BI\fP Gras alterné avec italique (très utile pour les spécifications de fonctions). .TP \fB\&.BR\fP Gras alterné avec romain (très utile pour les références aux autres pages de manuel). .TP \fB\&.I\fP Italique. .TP \fB\&.IB\fP Italique alterné avec gras. .TP \fB\&.IR\fP Italique alterné avec romain. .TP \fB\&.RB\fP Romain alterné avec gras. .TP \fB\&.RI\fP Romain alterné avec italique. .TP \fB\&.SB\fP Minuscule alterné avec gras. .TP \fB\&.SM\fP Minuscule (utile pour les acronymes). .PP Traditionnellement, chaque commande peut avoir jusqu'à six arguments, mais les versions GNU semblent éliminer cette contrainte (vous préférerez sûrement vous limiter à 6\ arguments pour des raisons de portabilité). Les arguments sont délimités par des espaces. Des guillemets sont utilisés pour encadrer un argument qui contient des espaces. Pour les macros qui produisent des types de caractère différents, les arguments seront imprimés les uns après les autres sans intercaler d'espace, ainsi la commande \fB\&.BR\fP peut être utilisée pour indiquer un mot en gras suivi par un signe de ponctuation en romain. Si aucun argument n'est fourni, la commande s'applique à la ligne suivante. .SS "Autres macros et chaînes" Ci\-dessous se trouvent d’autres macros importantes et des chaînes prédéfinies. Sauf indication contraire, toutes les macros déclenchent un saut de ligne. La plupart de ces macros définissent ou modifient «\ l'indentation prévalente\ ». Celle\-ci est définie par toute macro avec le paramètre \fIi\fP ci\-dessous\ ; les macros peuvent omettre le \fIi\fP auquel cas l'indentation prévalente courante est utilisée. En conséquence, les paragraphes suivants peuvent utiliser la même indentation sans redéfinir la valeur de l’indentation. Un paragraphe normal, non indenté, redéfinit l'indentation prévalente à sa valeur par défaut (0,5\ pouce). Par défaut, les indentations sont mesurées en «\ en\ » (largeur d'une lettre «\ n\ »") ou «\ em\ » (largeur d’une lettre «\ m\ »). Essayez d’utiliser en ou em comme unité pour les indentations, ainsi les largeurs s'ajustent automatiquement en cas de changement de taille de fonte. Les autres principales macros disponibles sont\ : .SS "Paragraphes normaux" .TP 9m \fB\&.LP\fP Comme \fB\&.PP\fP (début d’un nouveau paragraphe). .TP \fB\&.P\fP Comme \fB\&.PP\fP (début d’un nouveau paragraphe). .TP \fB\&.PP\fP Début d’un nouveau paragraphe et réinitialisation de l'indentation prévalente. .SS "Indentation relative de marge" .TP 9m \fB\&.RS\fP\fI i\fP Début d’une indentation relative\ : déplacement de la marge gauche de \fIi\fP vers la droite (si \fIi\fP 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 \fB\&.RE\fP correspondant. .TP \fB\&.RE\fP Fin d’une indentation relative et restauration de la valeur précédente d'indentation prévalente .SS "Macros d'indentation de paragraphe" .TP 9m \fB\&.HP\fP\fI i\fP 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). .TP \fB\&.IP\fP\fI x i\fP Indentation de paragraphe avec une balise d’accroche éventuelle. Si la balise \fIx\fP est omise, tout le paragraphe est indenté de \fIi\fP. Si la balise \fIx\fP est fournie, elle est accrochée le long de la marge gauche, avant le paragraphe indenté (c'est comme \fB\&.TP\fP 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 \e(bu (rond) ou \e(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 \fB\&.TP\fP\fI i\fP 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 \fB\&.IP\fP. .SS "Macros de liens hypertextes" .TP \fB\&.UR\fP\fI url\fP Insertion d’un lien hypertexte vers l’URI (URL) \fIurl\fP, avec tout le texte jusqu’à la macro \fB\&.UE\fP suivante comme texte du lien. .TP \fB\&.UE .RI [ trailer ]\fP Fin du texte du lien de la macro \fB\&.UR\fP précédente avec le caractère final \fItrailer\fP (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, \fBman\ \-Tutf8\fP), 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. .PP Ces macros sont prises en charge depuis GNU Troff\ 1.20 (5\ janvier\ 2009) et Heirloom Doctools Troff depuis 160217 (17\ février\ 2016). .SS "Macros diverses" .TP 9m \fB\&.DT\fP Réinitialisation des tabulations à leurs valeurs par défaut, tous les demi\-pouces. Ne provoque pas de saut de ligne. .TP \fB\&.PD\fP\fI d\fP Définition de la distance verticale entre paragraphes à la valeur \fId\fP (si absente, d\ =\ 0,4v). Ne provoque pas de saut de ligne. .TP \fB\&.SS\fP\fI t\fP Sous\-chapitre \fIt\fP (comme \fB\&.SH\fP, mais pour les sous\-sections au sein d'une section). .SS "Chaînes prédéfinies" Le paquet \fBman\fP contient les chaînes prédéfinies suivantes\ : .IP \e*R Symbole de marque déposée\ : \*R .IP \e*S Taille de la fonte par défaut. .IP \e*(Tm Symbole marque déposée\ : \*(Tm .IP \e*(lq Double guillemet\-virgule gauche\ : \*(lq .IP \e*(rq Double guillemet\-virgule droit\ : \*(rq .SS "Sous\(hyensemble sûr" Bien que techniquement \fBman\fP 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 \fBtbl\fP(1), mais essayez d'employer plutôt les commandes \fBIP\fP et \fBTP\fP 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)\ : \fB\e"\fP, \fB.\fP, \fBad\fP, \fBbp\fP, \fBbr\fP, \fBce\fP, \fBde\fP, \fBds\fP, \fBel\fP, \fBie\fP, \fBif\fP, \fBfi\fP, \fBft\fP, \fBhy\fP, \fBig\fP, \fBin\fP, \fBna\fP, \fBne\fP, \fBnf\fP, \fBnh\fP, \fBps\fP, \fBso\fP, \fBsp\fP, \fBti\fP, \fBtr\fP. .PP Vous pouvez aussi employer les séquences de protection de troff (celles qui commencent par \e). Si vous devez insérer une barre oblique inverse comme du texte normal, utilisez \ee. Les autres séquences que vous pouvez utiliser, x et xx étant des caractères quelconques, et N un chiffre, sont\ :\fB\e\(aq\fP, \fB\e\(ga\fP, \fB\e\-\fP, \fB\e.\fP, \fB\e"\fP, \fB\e%\fP, \fB\e*x\fP, \fB\e*(xx\fP, \fB\e(xx\fP, \fB\e$N\fP, \fB\enx\fP, \fB\en(xx\fP, \fB\efx\fP et \fB\ef(xx\fP. Évitez d'utiliser les séquences de protection pour dessiner des graphiques. .PP N'utilisez pas les paramètres optionnels pour \fBbp\fP (break page). Utilisez seulement des valeurs positives pour \fBsp\fP (espace vertical). Ne définissez pas de macro (\fBde\fP) avec le même nom qu'une macro dans ce paquet ou dans celui de mdoc avec une signification différente, il est probable que la définition en serait ignorée. Toute indentation positive (\fBin\fP) devrait être appariée avec une indentation négative identique (bien que vous devriez plutôt utiliser les macros \fBRS\fP et \fBRE\fP à la place). Les tests (\fBif,ie\fP) ne devraient avoir que «\ t\ » ou «\ n\ » comme condition. Seules les traductions (\fBtr\fP) qui peuvent être ignorées devraient être utilisées. Les changements de fonte (\fBft\fP et les séquences de protection \fB\ef\fP) ne doivent prendre comme valeurs que 1, 2, 3, 4, R, I, B, P ou CW (la commande ft peut aussi n'avoir aucun paramètre). .PP 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. .SH FICHIERS \fI/usr/share/groff/\fP[*/]\fItmac/an.tmac\fP .br \fI/usr/man/whatis\fP .SH NOTES Par tous les moyens, insérez les URL complets dans le texte lui\-même, certains outils comme \fBman2html\fP(1) peuvent les transformer automatiquement en liens hypertextes. Vous pouvez aussi utiliser les macros \fBUR\fP et \fBUE\fP pour associer les liens aux informations correspondantes. Si vous insérez des URL, utilisez des URL complets (par exemple .UR http://www.kernel.org .UE ) pour s'assurer que ces outils les trouveront automatiquement. .PP Les outils traitant ces fichiers devront les ouvrir et examiner le premier caractère non blanc. Un point ou une apostrophe simple (\(aq) au début d'une ligne indiquent un fichier troff (comme man ou mdoc). Un chevron gauche «\ <\ » indique un document SGML/XML comme (HTML ou DocBook). Tout autre caractère correspond à un texte ASCII simple (par exemple une sortie «\ catman\ »). .PP Beaucoup de pages de manuel commencent avec \fB\(aq\e"\fP suivi d'une espace et d'une liste de caractères indiquant comment la page doit être prétraitée. Pour améliorer la portabilité vers des traducteurs non troff, nous vous recommandons d'éviter d'utiliser autre chose que \fBtbl\fP(1). Sous Linux, la détection en est automatique. Néanmoins, vous pouvez inclure cette information pour que votre page de manuel puisse être traitée par d'autres systèmes (moins capables). Voici la définition des préprocesseurs invoqués par ces caractères\ : .TP 3 \fBe\fP eqn(1) .TP \fBg\fP grap(1) .TP \fBp\fP pic(1) .TP \fBr\fP refer(1) .TP \fBt\fP tbl(1) .TP \fBv\fP vgrind(1) .SH 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 \fBman\fP 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. .PP .\" .SH AUTHORS .\" .IP \(em 3m .\" James Clark (jjc@jclark.com) wrote the implementation of the macro package. .\" .IP \(em .\" Rickard E. Faith (faith@cs.unc.edu) wrote the initial version of .\" this manual page. .\" .IP \(em .\" Jens Schweikhardt (schweikh@noc.fdn.de) wrote the Linux Man-Page Mini-HOWTO .\" (which influenced this manual page). .\" .IP \(em .\" David A. Wheeler (dwheeler@ida.org) heavily modified this .\" manual page, such as adding detailed information on sections and macros. La macro Sun \fBTX\fP n'est pas implémentée. .SH "VOIR AUSSI" \fBapropos\fP(1), \fBgroff\fP(1), \fBlexgrog\fP(1), \fBman\fP(1), \fBman2html\fP(1), \fBgroff_mdoc\fP(7), \fBwhatis\fP(1), \fBgroff_man\fP(7), \fBgroff_www\fP(7), \fBman\-pages\fP(7), \fBmdoc\fP(7) .SH COLOPHON Cette page fait partie de la publication\ 5.10 du projet \fIman\-pages\fP Linux. Une description du projet et des instructions pour signaler des anomalies et la dernière version de cette page peuvent être trouvées à l'adresse \%https://www.kernel.org/doc/man\-pages/. .PP .SH TRADUCTION La traduction française de cette page de manuel a été créée par Christophe Blaess , Stéphan Rafin , Thierry Vignaud , François Micaux, Alain Portal , Jean-Philippe Guérard , Jean-Luc Coulon (f5ibh) , Julien Cristau , Thomas Huriaux , Nicolas François , Florentin Duneau , Simon Paillard , Denis Barbier , David Prévot et Jean-Paul Guillonneau . .PP Cette traduction est une documentation libre ; veuillez vous reporter à la .UR https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License version 3 .UE concernant les conditions de copie et de distribution. Il n'y a aucune RESPONSABILITÉ LÉGALE. .PP Si vous découvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message à .MT debian-l10n-french@lists.debian.org .ME .