MAN-PAGES(7) Manuel du programmeur Linux MAN-PAGES(7)

man-pages - Conventions pour l'écriture des pages de manuel Linux

man [section] titre

Cette page décrit les conventions qui devraient être utilisées pour l’écriture des pages de manuel du projet man-pages de Linux, qui documente l'interface de programmation applicative pour l’espace utilisateur fourni par le noyau Linux et la bibliothèque GNU C. Le projet fournit donc la plupart des pages de la section 2, de nombreuses pages apparaissant dans les sections 3, 4, 5 et 7, et quelques pages apparaissant dans les sections 1, 5 et 8 des pages de manuel sur un système Linux. Les conventions décrites dans cette page peuvent aussi être utiles aux auteurs de pages de manuel pour d'autres projets.

Les sections du manuel sont traditionnellement les suivantes :
1 Commandes de l’utilisateur (programmes)
Commandes pouvant être invoquées par l'utilisateur depuis un interpréteur de commandes.
2 Appels système
Fonctions enveloppant les opérations réalisées par le noyau.
3 Fonctions des bibliothèques
Toutes les fonctions des bibliothèques en excluant les enveloppes d’appel système (la plupart des fonctions de la libc).
4 Fichiers spéciaux (périphériques)
Fichiers présents dans /dev permettant l’accès aux périphériques par l’intermédiaire du noyau.
5 Formats de fichier et fichiers de configuration
Descriptions des formats de fichier lisibles par un humain et des fichiers de configuration.
6 Jeux
Jeux et petits programmes amusants disponibles sur le système.
7 Vue d’ensemble, conventions et éléments divers
Overviews or descriptions of various topics, conventions, and protocols, character set standards, the standard filesystem layout, and miscellaneous other things.
8 Commandes d'administration du système
Commandes comme mount(8), la plupart exécutables uniquement par le superutilisateur.

Les nouvelles pages de manuel devraient être mises en forme en utilisant le paquet an.tmac de groff décrit dans man(7). Ce choix est principalement destiné à assurer une cohérence : la plupart des pages de manuel Linux sont mises en forme avec ces macros.

Veuillez limiter la longueur des lignes dans le source à environ 75 caractères, autant que faire se peut. Cela permet d'éviter les retours à la ligne ajoutés par les clients de courriel lorsque des modifications sont soumises par ce moyen.

La première commande d'une page de manuel devrait être une commande TH :
.TH titre section date source manuel

Les arguments de cette commande sont les suivants :

titre
Le titre de la page de manuel, en majuscules (par exemple MAN-PAGES).
section
Le numéro de section dans laquelle la page devrait être placée (par exemple, 7).
date
La date du dernier changement non trivial effectué sur cette page de manuel. Au sein du projet man-pages, les mises à jour des étiquettes temporelles sont automatiquement effectuées par des scripts, de sorte qu'il n'est pas nécessaire de les mettre à jour lors la fourniture d'un correctif. Les dates devraient être écrites sous la forme AAAA-MM-JJ.
source
L’origine de la commande, de la fonction ou de l'appel système.
Pour les quelques pages de man-pages dans les sections 1 et 8, il est conseillé d'écrire GNU.
Pour les appels système, écrivez simplement Linux. Précédemment, il était courant d'écrire aussi le numéro de version du noyau pour laquelle la page de manuel était écrite. Cependant, cela n'était pas fait de façon systématique, et était donc pire que d'omettre simplement le numéro de version. N'incluez donc pas de numéro de version.
Pour les fonctions de bibliothèque glibc ou de l'une des bibliothèques GNU standard, utilisez GNU C Library, GNU ou une chaîne vide.
Pour les pages de la section 4, utilisez Linux.
En cas d'hésitation, écrivez Linux ou GNU.
manuel
Le titre du manuel (par exemple Linux Programmer's Manual pour les pages des sections 2 et 3 dans le paquet man-pages)

La liste ci-dessous indique les sections classiques ou suggérées. La plupart des pages devraient contenir au moins les sections mises en évidence. Dans les nouvelles pages de manuel, placez les sections dans l'ordre indiqué dans la liste.
NAME (NOM)
SYNOPSIS
CONFIGURATION [Normally only in Section 4]
DESCRIPTION
OPTIONS [Normally only in Sections 1, 8]
CODE DE RETOUR [Normally only in Sections 1, 8]
VALEUR RENVOYÉE [Normally only in Sections 2, 3]
ERREURS [Typically only in Sections 2, 3]
ENVIRONNEMENT
FICHIERS
VERSIONS [Normally only in Sections 2, 3]
ATTRIBUTS [Normally only in Sections 2, 3]
CONFORMITÉ
NOTES
BOGUES
EXEMPLES
AUTEURS [Discouraged]
SIGNALER DES BOGUES [Not used in man-pages]
COPYRIGHT [Not used in man-pages]
SEE ALSO (VOIR AUSSI)

Lorsque l'une des sections traditionnelles s'applique, utilisez-la ; cette cohérence rend l'information plus facile à comprendre. Si cela est nécessaire, vous pouvez créer vos propres titres de section si cela rend les choses plus compréhensibles (particulièrement pour les pages des sections 4 et 5). Cependant, avant de faire cela, vérifiez qu'aucun titre de section traditionnel ne peut être utilisé avec des sous-sections (.SS) dans celle-ci.

La liste suivante décrit le contenu de chacune des sections ci-dessus.

NAME (NOM)
Nom de cette page de manuel
D'importantes précisions sur les lignes qui devraient suivre la commande .SH NAME sont disponibles dans la page man(7). Tous les mots de cette ligne (y compris le mot suivant immédiatement le « \- », sauf en français, dans les traductions, où la convention est de commencer le premier mot par une majuscule) devraient être en minuscules, sauf si l'anglais ou la convention terminologique technique impose autre chose.
SYNOPSIS
Bref résumé de l’interface de la commande ou de la fonction.
Pour les commandes, ce paragraphe montre la syntaxe et les arguments de la commande (y compris les options). Les caractères en gras marquent le texte invariable et ceux en italique indiquent les arguments remplaçables. Les crochets « [] » encadrent les arguments facultatifs, les barres verticales « | » séparent les alternatives et les points de suspension « ... » peuvent être des arguments répétés. Pour les fonctions, cela contient toutes les déclarations de données ou les directives #include, suivies de la déclaration de fonction.
Si une macro de test de fonctionnalité doit être définie pour obtenir la déclaration d'une fonction (ou d'une variable) dans un fichier d'en-tête, alors la section SYNOPSIS devrait l'indiquer, comme décrit dans feature_test_macros(7).
CONFIGURATION
Détails de configuration pour un périphérique.
Cette section est présente normalement que dans les pages de la section 4.
DESCRIPTION
Explication sur ce que le programme, la fonction ou le format réalise.
Cette section décrit les interactions avec les fichiers et l'entrée standard, et ce qui est produit sur la sortie standard ou d'erreur. Les détails d'implémentation internes sont omis sauf s'ils sont critiques pour comprendre l'interface. L’utilisation habituelle est décrite et la section OPTIONS est utilisée pour les détails.
La description d'un nouveau comportement ou de nouveaux drapeaux d'un appel système ou d'une fonction d'une bibliothèque doit préciser la version du noyau ou de la bibliothèque C qui a introduit ce changement. Il est recommandé de noter cette information à propos des drapeaux sous la forme d'une liste .TP, comme ci-dessous dans le cas d'un drapeau d'appel système :
XYZ_FLAG (depuis Linux 3.7)
Description du drapeau...
Préciser la version est particulièrement utile aux utilisateurs qui sont contraints d’utiliser d'anciennes versions du noyau ou de la bibliothèque C, ce qui est par exemple courant dans le cas des systèmes embarqués.
OPTIONS
Descriptions des options de ligne de commande acceptées par un programme et leur influence sur son comportement.
Cette section ne devrait être utilisée que pour les pages de manuel des sections 1 et 8.
EXIT STATUS (CODE DE RETOUR)
Liste des codes de retour d'un programme et des conditions de renvoi de ces valeurs.
Cette section ne devrait être utilisée que pour les pages de manuel des sections 1 et 8.
RETURN VALUE (VALEUR RENVOYÉE)
Pour les pages des sections 2 et 3, cette section donne une liste des valeurs qu'une routine de bibliothèque renverra à l'appelant et les conditions qui provoquent ces retours.
ERRORS (ERREURS)
Pour les pages des sections 2 et 3, cette section contient une liste des valeurs possibles de errno en cas d'erreur, avec la description des causes de ces erreurs.
Quand des conditions différentes produisent la même erreur, l’approche à préférer est de créer plusieurs entrées de liste séparées (avec des noms d’erreur dupliqués) pour chacune des conditions. Cela clarifie les différences de conditions, rend la liste plus facile à lire et permet aux méta-informations (par exemple, le numéro de version du noyau dans laquelle la condition est devenu applicable) d’être plus facilement caractérisées pour chaque condition.
La liste d’erreurs devrait être triée par ordre alphabétique.
ENVIRONMENT (ENVIRONNEMENT)
Liste de toutes les variables d'environnement affectant le programme ou la fonction, ainsi que de leurs effets.
FILES (FICHIERS)
Liste de tous les fichiers utilisés par le programme ou la fonction, tels les fichiers de configuration, les fichiers de démarrage et les fichiers manipulés directement par le programme.
Le chemin d'accès complet de ces fichiers doit être donné ainsi que le mécanisme d'installation utilisé pour modifier la partie répertoire afin de satisfaire aux préférences de l’utilisateur. Pour la plupart des programmes, l'installation par défaut se fait dans /usr/local, aussi, votre page de manuel de base devrait utiliser /usr/local comme base.
ATTRIBUTES (ATTRIBUTS)
Résumé des divers attributs de la ou des fonctions documentées sur cette page. Consulter attributes(7) pour de plus amples détails.
VERSIONS
Court résumé de la version du noyau Linux ou de la glibc où l'appel système ou la fonction de bibliothèque est apparue ou dont le fonctionnement est modifié de manière significative.
De manière générale, la page de manuel de chaque nouvelle interface devrait inclure une section VERSIONS. Malheureusement, bien des pages de manuel existantes n'incluent pas cette information (car il n'y avait pas de politique pour le faire lorsqu'elles ont été rédigées). Les correctifs pour y remédier sont les bienvenus. Dans la perspective d'écriture de nouveau code, cette information n'a de sens que dans le cas d'interface noyau ajoutée à Linux 2.4 ou suivant (c'est-à-dire les modifications depuis la version 2.2 du noyau), et dans celui des fonctions de la bibliothèque ajoutées dans glibc depuis la version 2.1 (c'est-à-dire les modifications depuis la version 2.0 de la glibc).
La page de manuel syscalls(2) fournit également des informations de versions de noyau dans lesquelles sont apparus les appels système.
CONFORMING TO (CONFORMITÉ)
Descriptions des normes ou conventions liées à la fonction ou à la commande décrite par la page de manuel.
Les termes privilégiés à utiliser pour les différentes normes sont listés dans les rubriques de standards(7)
Dans les pages de section 2 ou 3, cette section devrait indiquer les versions de POSIX.1 auxquelles l'appel se conforme et s'il est spécifié par C99 (pas la peine de trop se préoccuper des autres normes comme SUS, SUSv2 ou XPG, ni des implémentations SVr4 ou 4.xBSD, sauf si la fonction était présente dans ces systèmes mais ne l'est plus dans la version actuelle de POSIX.1).
Si la fonction n'est régie par aucune norme, mais existe sur d'autres systèmes, mentionnez-les. Si elle est spécifique à Linux, notez-le.
Si cette section ne consiste qu'en une liste de normes (ce qui est d'habitude le cas), terminez la liste par un point (« . »).
NOTES
Notes diverses
Pour les pages des sections 2 et 3, il peut être utile d'utiliser des sous-sections (SS) appelées Linux Notes (Notes sur Linux) ou Glibc Notes (Notes sur la glibc).
Dans la section 2, le titre C library/kernel differences est à utiliser pour délimiter les notes décrivant les différences (s’il en existe) entre la fonction C d’enveloppe de bibliothèque pour un appel système et l’interface brute d’appel système fournie par le noyau.
BUGS (BOGUES)
Liste des limitations, des défauts ou des inconvénients recensés, ainsi que des sujets à débat.
EXAMPLES (EXEMPLES)
One or more examples demonstrating how this function, file, or command is used.
Pour plus de détails sur l'écriture d'exemples de programme, consultez Exemples de programme ci-dessous.
AUTHORS (AUTEURS)
Liste des auteurs de la documentation ou du programme.
L'utilisation d'une section AUTHORS est fortement déconseillée. En général, il vaut mieux ne pas encombrer chaque page de manuel avec une liste (potentiellement longue) d'auteurs. Si vous écrivez ou modifiez de façon importante une page, ajoutez une notice de copyright en commentaire dans le fichier source. Si vous êtes l'auteur d'un pilote de périphérique et voulez inclure une adresse pour signaler les bogues, placez-la dans la section BUGS.
SIGNALER DES BOGUES
The man-pages project doesn't use a REPORTING BUGS section in manual pages. Information on reporting bugs is instead supplied in the script-generated COLOPHON section. However, various projects do use a REPORTING BUGS section. It is recommended to place it near the foot of the page.
COPYRIGHT
Le projet man-pages n’utilise pas de section COPYRIGHT dans les pages de manuel. Les informations de droits d’auteur sont à la place entretenues dans le source de la page. Dans les pages incluant cette section, il est recommandée de la placer en bas de page, juste au-dessus de la section SEE ALSO.
SEE ALSO (VOIR AUSSI)
Liste des pages de manuel (séparées par des virgules) ayant un rapport, éventuellement suivie par d’autres pages ou documents ayant un rapport.
La liste devrait être classée selon l'ordre des sections puis de façon alphabétique. Ne terminez pas la liste par un point.
Quand la liste SEE ALSO contient plusieurs noms longs de page de manuel, pour améliorer l'apparence de la sortie, il peut être utile d'utiliser les directives .ad l (pas de justification à droite) et .nh (pas de césure). La césure d'un nom de page en particulier peut-être évitée en faisant précéder son nom de la chaîne « \% ».
Étant donné la nature indépendante et distribuée des projets logiciels au code source ouvert (FOSS) et de leur documentation, il est parfois nécessaire (et dans de nombreux cas souhaitable) que la section SEE ALSO inclut des références vers des pages de manuel fournies par d’autres projets.

The following subsections note some details for preferred formatting and wording conventions in various sections of the pages in the man-pages project.

Wrap the function prototype(s) in a .nf/.fi pair to prevent filling.

In general, where more than one function prototype is shown in the SYNOPSIS, the prototypes should not be separated by blank lines. However, blank lines (achieved using .PP) may be added in the following cases:

  • to separate long lists of function prototypes into related groups (see for example list(3));
  • in other cases that may improve readability.

In the SYNOPSIS, a long function prototype may need to be continued over to the next line. The continuation line is indented according to the following rules:

1.
If there is a single such prototype that needs to be continued, then align the continuation line so that when the page is rendered on a fixed-width font device (e.g., on an xterm) the continuation line starts just below the start of the argument list in the line above. (Exception: the indentation may be adjusted if necessary to prevent a very long continuation line or a further continuation line where the function prototype is very long.) As an example:
int tcsetattr(int fd, int optional_actions,
              const struct termios *termios_p);
2.
But, where multiple functions in the SYNOPSIS require continuation lines, and the function names have different lengths, then align all continuation lines to start in the same column. This provides a nicer rendering in PDF output (because the SYNOPSIS uses a variable width font where spaces render narrower than most characters). As an example:
int getopt(int argc, char * const argv[],
           const char *optstring);
int getopt_long(int argc, char * const argv[],
           const char *optstring,
           const struct option *longopts, int *longindex);

The preferred wording to describe how errno is set is "errno is set to indicate the error" or similar. This wording is consistent with the wording used in both POSIX.1 and FreeBSD.

Note the following:
  • Wrap the table in this section in a .ad l/.ad pair to disable text filling and a .nh/.hy pair to disable hyphenation.
  • Ensure that the table occupies the full page width through the use of an lbx description for one of the columns (usually the first column, though in some cases the last column if it contains a lot of text).
  • Make free use of T{/T} macro pairs to allow table cells to be broken over multiple lines (also bearing in mind that pages may sometimes be rendered to a width of less than 80 columns).

For examples of all of the above, see the source code of various pages.

Les sous-sections suivantes décrivent le style privilégié pour le projet man-pages. Pour des précisions sur les points non couverts ci-dessous, le « Chicago Manual of Style » est généralement une source de qualité. Essayez également de parcourir les pages existantes dans l’arborescence des sources du projet pour prendre connaissance des habitudes courantes.

Autant que possible, utilisez le pluriel de genre neutre (en anglais) dans le texte des pages de manuel. L’utilisation de « they » (« them », « themself », « their ») en tant que pronom singulier de genre neutre est acceptable.

Pour les pages de manuel décrivant une commande (généralement dans les sections 1 et 8) les arguments sont toujours indiqués en italique, même dans la section SYNOPSIS.

Le nom de la commande et de ses options devraient toujours être en caractères gras.

Pour les pages de manuel décrivant une fonction (généralement dans les sections 2 et 3) les arguments sont toujours indiqués en italique, même dans la section SYNOPSIS, où le reste de la fonction est indiqué en caractères gras.

int mafonction(int argc, char **argv);

Les noms de variables devraient, tout comme les noms de paramètres, être indiqués en italique.

Toute référence au sujet de la page de manuel courante devrait être écrite avec le nom en caractères gras suivi par une paire de parenthèses en caractères romains (normaux). Par exemple, dans la page fcntl(2), les références au sujet de la page devrait être écrites fcntl(). La façon privilégiée d'écrire cela dans le fichier source est :

.BR fcntl ()

(L’utilisation de ce format, plutôt que celle de « \fB...\fP() », facilite l’écriture d’outils qui analysent les sources des pages de manuel.)

Dans le code source d’une page de manuel, les nouvelles phrases devraient débuter sur de nouvelles lignes et les phrases longues découpées en lignes selon les changements de proposition (virgules, deux-points, points-virgules, etc.) Cette convention, parfois appelée « nouvelles lignes sémantiques », facilite la visualisation des effets de correctif qui opère au niveau de lignes spécifiques ou de propositions de phrases.

Les paragraphes devraient être séparés par des marqueurs adaptés (habituellement soit .PP ou .IP). Ne pas séparer les paragraphes en utilisant des lignes blanches, car cela aboutit à un rendu médiocre dans certains formats de sortie (tels que PostScript et PDF).

Les noms de fichiers, que ce soit des chemins ou des références à des fichiers d’en-tête, sont toujours en italique (par exemple <stdio.h>), sauf dans la section SYNOPSIS où les fichiers inclus sont en caractères gras (par exemple #include <stdio.h>). Lorsque vous faites référence à un fichier d'en-tête standard, indiquez le fichier d'en-tête entouré de chevrons, de la même manière que dans un fichier source C (par exemple, <stdio.h>).

Les macros spéciales, généralement en majuscules, sont en caractères gras (par exemple MAXINT). Exception : NULL ne doit pas être en gras.

Dans l'énumération d'une liste de codes d'erreur, les codes sont en caractères gras, et la liste utilise normalement la macro .TP.

Les commandes complètes devraient, si elles sont longues, être écrites sous une forme indentée, précédées et suivies d’une ligne vide, par exemple :


man 7 man-pages

Si la commande est courte, elle peut être incluse dans le texte, en italique, par exemple, man 7 man-pages. Dans ce cas, des espaces insécables (« \  ») pourraient être utilisées aux endroits appropriés dans la commande. Les options des commandes devraient elles aussi être écrites en italique (par exemple, -l).

Les expressions, si elles ne sont pas écrites sur une ligne séparée indentée, devraient être mises en italique. Ici aussi, l'utilisation d'espaces insécables est appropriée si l'expression est mélangée à du texte normal.

Pour montrer des sessions d’interpréteur de commandes, les saisies de l’utilisateur devraient être écrites en caractères gras.


$ date
Thu Jul  7 13:01:27 CEST 2016

Toute référence à une autre page de manuel devrait être écrite avec le nom en caractères gras toujours suivi du numéro de section en caractères romains (normaux), sans espace intermédiaire (par exemple intro(2)). Dans le source, la façon préconisée est :

.BR intro (2)

(Inclure le numéro de section dans les références croisées permet à des outils comme man2html(1) de créer des liens hypertextes appropriés)

Les caractères de contrôle devraient être écrits en gras, sans guillemets. Par exemple : ^X.

Depuis la version 2.59, la version anglaise de man-pages suit les conventions orthographiques américaines (auparavant, un mélange aléatoire de conventions britanniques et américaines existait). Veuillez écrire les nouvelles pages et les correctifs en suivant ces conventions.

En plus des différences d’orthographe bien connues, quelques autres subtilités sont à surveiller :

  • L’anglais américain a tendance à utiliser les formes « backward », « upward », « toward », etc., au lieu des formes britanniques « backwards », « upwards », « towards », etc.
  • Opinions are divided on "acknowledgement" vs "acknowledgment". The latter is predominant, but not universal usage in American English. POSIX and the BSD license use the former spelling. In the Linux man-pages project, we use "acknowledgement".

Le schéma classique d’écriture des numéros de version BSD est x.yBSD, où x.y est un numéro de version (par exemple 4.2BSD). Éviter les formes du genre BSD 4.3.

Dans les titres de sous-section (« SS »), le premier mot commence par une majuscule, mais le reste devrait être en minuscule, sauf si l'anglais (par exemple les noms propres) ou les exigences du langage de programmation imposent autre chose (par exemple, les noms d’identificateur). Par exemple :
.SS Unicode sous Linux

Lorsque des définitions de structure, des journaux de session d'interpréteur, etc., sont inclus dans le corps de texte, indentez-les avec quatre espaces (c'est-à-dire un bloc entouré par .in +4n et .in), formatez-les en utilisant les macros .EX et EE et entourez-les avec les marqueurs de paragraphe adaptés (soit .PP ou .IP). Par exemple :


.PP
.in +4n
.EX
int
main(int argc, char *argv[])
{
    return 0;
}
.EE
.in
.PP

Le tableau suivant indique les termes à privilégier dans les pages anglaises de manuel, principalement pour assurer une cohérence entres les pages.
Terme Utilisation à éviter Notes
bit mask bitmask
built-in builtin
Epoch epoch Pour l’époque d’UNIX (00:00:00, 1 Jan 1970 UTC)
filename file name
filesystem file system
hostname host name
inode i-node
lowercase lower case, lower-case
nonzero non-zero
pathname path name
pseudoterminal pseudo-terminal
privileged port reserved port, system port
real-time realtime, real time
run time runtime
saved set-group-ID saved group ID, saved set-GID
saved set-user-ID saved user ID, saved set-UID
set-group-ID set-GID, setgid
set-user-ID set-UID, setuid
superuser super user, super-user
superblock super block, super-block
timestamp time stamp
timezone time zone
uppercase upper case, upper-case
usable useable
user space userspace
username user name
x86-64 x86_64 Excepté si cela se réfère à « uname -m » ou similaire
zeros zeroes

Consultez la section Écriture des mots composés épithètes ci-dessous.

Le tableau suivant indique les termes à éviter dans les pages anglaises de manuel, avec quelques suggestions d’alternatives, principalement pour assurer la cohérence entres les pages.
Avoid Use instead Notes
32bit 32-bit de même pour 8-bit, 16-bit, etc.
current process calling process Une erreur commune des programmeurs du noyau qui écrivent des pages de manuel
manpage man page, manual page
minus infinity negative infinity
non-root unprivileged user
non-superuser unprivileged user
nonprivileged unprivileged
OS operating system
plus infinity positive infinity
pty pseudoterminal
tty terminal
Unices UNIX systems
Unixes UNIX systems

Utiliser l’orthographe et la casse adéquates pour les marques déposées. Voici une liste des orthographes adéquates de quelques marques déposées parfois mal orthographiées :

DG/UX HP-UX UNIX UnixWare

Un pointeur NULL est un pointeur qui ne pointe nulle part, et est habituellement indiqué par la constante NULL. D’un autre côté, NUL est l’octet NULL : un octet de valeur nulle, représenté en C à l’aide de la constante caractère « \0 ».

Le terme à préférer pour le pointeur est « null pointer » (pointeur NULL) ou simplement « NULL ». Éviter d’écrire « NULL pointer ».

Le terme à préférer pour l’octet est « null byte » (octet NULL). Évitez d’écrire « NUL » car cela pourrait être facilement confondu avec « NULL ». Évitez aussi les termes « zero byte » (octet zéro) et « null character » (caractère NULL). L’octet qui termine une chaîne en C devrait être décrit comme « the terminating null byte » (l’octet NULL final). Les chaînes peuvent être décrites comme « null-terminated » (terminées par NULL), mais évitez « NUL-terminated » (terminées par NUL).

Pour les liens hypertextes, utilisez la paire de macros .UR et .UE (consultez groff_man(7)). Cela produit des liens propres qui peuvent être utilisés dans des navigateurs web, lors du rendu de pages, avec par exemple :

BROWSER=firefox man -H nom_de_page

En général, l’utilisation d’abréviations comme « e.g. », « i.e. », « etc. », « cf. » et « a.k.a. » devrait être évitée, en faveur d’une écriture complète (« for example », « that is », « and so on », « compare to », « also known as ») (Idem pour les traductions françaises des pages de manuel).

Le seul endroit où ce genre d’abréviation pourrait être acceptable est dans les parenthèses courtes (e.g., like this one).

Toujours inclure les points dans ces abréviations comme ici. De plus en anglais, « e.g. » et « i.e. » devraient toujours êtres suivies d’une virgule.

La façon d’écrire un tiret cadratin « em-dash », le glyphe apparaissant à chaque extrémité d’une proposition incise, est dans *roff la macro « \(em ». (Sur un terminal ASCII, un tiret long est vu comme deux tirets courts, mais dans des contextes typographiques il apparait comme un tiret long.) Les « em-dash » devraient être écrits sans espaces avoisinantes.

Les mots composés devraient être reliés par un tiret lorsqu’utilisés comme attributs (c'est-à-dire pour qualifier un nom suivant). Quelques exemples :

32-bit value command-line argument floating-point number run-time check user-space function wide-character string

La tendance générale en anglais moderne est de ne pas utiliser de tirets après les préfixes comme « multi », « non », « pre », « re », « sub », etc. Les pages de manuel devraient normalement suivre cette règle quand ces préfixes sont utilisés dans des constructions anglaises naturelles avec de simples suffixes. La liste suivante donne des exemples de forme préférée :

interprocess multithreaded multiprocess nonblocking nondefault nonempty noninteractive nonnegative nonportable nonzero preallocated precreate prerecorded reestablished reinitialize rearm reread subcomponent subdirectory subsystem

Les tirets sont gardés en anglais lorsque les préfixes sont utilisés dans des mots anglais non standard, avec les marques déposées, les noms propres, les acronymes ou les mots composés. Quelques exemples :

non-ASCII non-English non-NULL non-real-time

Enfin, remarquez qu’en anglais « re-create »(recréer) et « recreate » (s’amuser) sont deux mots différents et que c’est sans doute le premier qu’il faut utiliser.

Quand un véritable caractère moins est nécessaire (par exemple pour les nombres comme -1, pour des références croisées de pages de manuel telles que utf-8(7) ou pour écrire des options qui commencent par un tiret comme dans ls -l), utilisez la forme suivante dans le source de la page de manuel :

\-

Ce guide s’applique aussi aux exemples de code.

The use of real minus signs serves the following purposes:

  • To provide better renderings on various targets other than ASCII terminals, notably in PDF and on Unicode/UTF-8-capable terminals.
  • To generate glyphs that when copied from rendered pages will produce real minus signs when pasted into a terminal.

Pour produire des guillemets simples qui rendront aussi bien en ASCII qu’en UTF-8, utilisez « \(aq » (« apostrophe quote »). Par exemple :

\(aqC\(aq

C est le caractère protégé. Ce guide s’applique aussi aux constantes caractère utilisées dans les exemples de code. Dans la traduction en français, si possible, préférez la forme typographique en vigueur (par exemple : « C »).

Lorsque qu’un caret approprié (^) dont un bon rendu dans un terminal comme en PDF est nécessaire, « \(ha » est à utiliser. Cela est particulièrement nécessaire dans les exemples de code, pour obtenir un rendu élégant du caret en PDF.

L’utilisation d’un caractère nu « ~ » aboutit à un mauvais rendu en PDF. Utilisez « \(ti ». Cela est particulièrement nécessaire dans les exemples de code, pour obtenir un rendu élégant du tilde en PDF.

Les pages de manuel peuvent contenir des programmes permettant de montrer comment utiliser un appel système ou une fonction de bibliothèque. Cependant, veuillez respecter les points suivants.
  • Les programmes d'exemple devraient être écrits en C.
  • Un programme d'exemple n'est nécessaire et utile que s'il montre quelque chose qui ne peut pas être fourni facilement dans une description textuelle de l'interface. Un programme d'exemple qui ne fait qu'appeler une fonction ne sert en général à rien.
  • Example programs should ideally be short (e.g., a good example can often be provided in less than 100 lines of code), though in some cases longer programs may be necessary to properly illustrate the use of an API.
  • Expressive code is appreciated.
  • Comments should included where helpful. Complete sentences in free-standing comments should be terminated by a period. Periods should generally be omitted in "tag" comments (i.e., comments that are placed on the same line of code); such comments are in any case typically brief phrases rather than complete sentences.
  • Les programmes d'exemple devraient faire une vérification d’erreurs après les appels système et les appels de fonction de bibliothèque.
  • Les programmes d'exemple devraient être complets et compiler sans avertissements avec cc -Wall.
  • Si possible et raisonnable, les programmes d'exemples doivent permettre d'expérimenter, en changeant de comportement en fonction des entrées (arguments de ligne de commande ou entrées lues par le programme).
  • Les programmes d'exemple doivent être mis en forme dans le style de Kernighan et Ritchie, avec des indentations de quatre espaces (évitez le caractère tabulation dans les fichiers source). La commande suivante peut être utilisée pour mettre en forme le code source vers quelque chose proche du style préféré :
indent -npro -kr -i4 -ts4 -sob -l72 -ss -nut -psl prog.c
*
Par cohérence, tous les programmes d’exemple devraient se terminer par une des deux formes suivantes :
exit(EXIT_SUCCESS); exit(EXIT_FAILURE);
Évitez d’utiliser les formes suivantes pour terminer un programme :
exit(0); exit(1); return n;
*
Si un texte d’explication complète précède le code source du programme, indiquez le code source à l’aide d’un titre de sous-section Source du programme, comme :
.SS Source du programme
Toujours faire comme cela si le texte d’explication contient un journal de session d’interpréteur.

Si vous incluez un journal de session d'interpréteur de commandes pour démontrer l'utilisation d'un programme ou d'autres fonctionnalités système :

  • placez le journal de session au dessus du code source ;
  • indentez le journal de session par quatre espaces ;
  • mettez le texte entré par l'utilisateur en gras pour le distinguer de la sortie produite par le système.

Pour voir à quoi les programmes d'exemples devraient ressembler, consultez wait(2) et pipe(2).

Pour des exemples canoniques de pages de manuel se conformant au paquet man-pages, consultez pipe(2) et fcntl(2).

man(1), man2html(1), attributes(7), groff(7), groff_man(7), man(7), mdoc(7)

Cette page fait partie de la publication 5.11 du projet man-pages 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/.

La traduction française de cette page de manuel a été créée par Christophe Blaess https://www.blaess.fr/christophe/, Stéphan Rafin <stephan.rafin@laposte.net>, Thierry Vignaud <tvignaud@mandriva.com>, François Micaux, Alain Portal <aportal@univ-montp2.fr>, Jean-Philippe Guérard <fevrier@tigreraye.org>, Jean-Luc Coulon (f5ibh) <jean-luc.coulon@wanadoo.fr>, Julien Cristau <jcristau@debian.org>, Thomas Huriaux <thomas.huriaux@gmail.com>, Nicolas François <nicolas.francois@centraliens.net>, Florentin Duneau <fduneau@gmail.com>, Simon Paillard <simon.paillard@resel.enst-bretagne.fr>, Denis Barbier <barbier@debian.org>, David Prévot <david@tilapin.org> et Jean-Paul Guillonneau <guillonneau.jeanpaul@free.fr>

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 à debian-l10n-french@lists.debian.org.

22 mars 2021 Linux