Les macros disponibles sont présentées
par ordre alphabétique :
.B [mots]
Met les mots en gras. Cela ne renvoie pas
à la ligne. Si aucun argument n'est donné, la ligne
suivante est traitée.
.BI [mots]
Joint les mots alternativement en gras et
italique. Cela ne renvoie pas à la ligne. Si aucun argument
n'est donné, la ligne suivante est traitée.
.BR [mots]
Joint les mots alternativement en gras et
roman. Cela ne renvoie pas à la ligne. Si aucun argument n'est
donné, la ligne suivante est traitée.
.DT
Remet l'espace de tabulation par défaut
à 0,5 pouces. Cela ne renvoie pas à la ligne.
.HP [indent]
Commence un paragraphe avec l'indentation courante
puis met cette valeur à indent. Cette requète
force le retour à la ligne. Si indent n'est pas
spécifié, la valeur courante est utilisée.
.I [mots]
Met les mots en italique. Cela ne renvoie pas
à la ligne. Si aucun argument n'est donné, la ligne
suivante est traitée.
.IB [mots]
Joint les mots alternativement en italique et
en gras. Cela ne renvoie pas à la ligne. Si aucun argument
n'est donné, la ligne suivante est traitée.
.IP [tag [indent]]
Commence un paragraphe indenté avec la marque
tag et la valeur d'indentation courante mise à
indent. Si tag n'est pas spécifié, il est
pris pour la chaîne nulle "". Si indent n'est pas
spécifié, la valeur courante est utilisée.
.IR [mots]
Joint les mots alternativement en italique et
roman. Cela ne renvoie pas à la ligne. Si aucun argument n'est
donné, la ligne suivante est traitée.
.LP
Aligne le paragraphe à gauche. L'indentation
courante est mise à sa valeur par défaut. Cette
requère force le passage à la ligne.
.P
Alias de .LP.
.PD [distance]
Met la distance verticale entre les paragraphes
à distance. Si l'argument distance n'est pas
spécifié, la valeur 0,4v est utilisée.
.PP
Alias de .LP.
.RE
Fin de l'indentation relative (voir .RS ci-dessous).
Cette requète force le retour à la ligne et remet
l'indentation courante à sa valeur précédante.
.RB [mots]
Joint les mots alternativement en roman et
gras. Cela ne renvoie pas à la ligne. Si aucun argument n'est
donné, la ligne suivante est traitée.
.RI [mots]
Joint les mots alternativement en roman et
italique. Cela ne renvoie pas à la ligne. Si aucun argument
n'est donné, la ligne suivante est traitée.
.RS [indent]
Commence une indentation relative, la décalant
de indent. Si l'argument indent n'est pas donné,
la valeur courante est utilisée.
.SB [mots]
Ecrit les mots en gras après avoir
diminué la taille de la police de 1 point. Cela ne renvoie pas
à la ligne. Si aucun argument n'est donné, la ligne
suivante est traitée.
.SH [mots]
Définie un début de section (Section
Heading). Cette requète force le retour à la ligne et
remet l'indentation courante et la marge à leurs valeurs par
défaut.
.SM [mots]
Affiche les mots après les avoir
réduit de 1 point. Cela ne renvoie pas à la ligne. Si
aucun argument n'est donné, la ligne suivante est
traitée.
.SS [mots]
Définit un sous-début de section. Cette
requète force le retour à la ligne. Si aucun argument
n'est donné, la ligne suivante est traitée.
L'indentation courante et la marge sont remises à leurs
valeurs par défaut.
.TH nom section date [pied
[centre]]
Référence la page nom comme
appartenant à la section section. Le troisième
argument, date, est la date de la plus récente
modification. S'il est présent, pied indique le texte
gauche du pied de page et centre le texte centré de
l'entête. Cette requète doit être la toute
première requète d'une page de manuel.
.TP [indent]
Commence un paragraphe indenté avec la marque
spécifiée à la ligne suivante. Si l'argument
indent est donné, il spécifie la nouvelle valeur
de l'indentation courante. Cette requète force le retour
à la ligne.
La plupart des pages de manuel suivent la structure
décrite ci-dessous :
.TH titre [numéro-section]
La toute première macro requète d'une
page de manuel est celle qui établie le nom et le titre de la
page. La requète .TH donne aussi le numéro de la
section.
.SH NAME
Le nom (ou la liste de noms) par lequel la commande
est appelée suivi d'un trait d'union et d'une courte
description de ce qu'elle fait. Cette partie ne doit contenir aucune
commande troff, aucun échappement et aucune macro
requète. Elle est utilisée pour remplir la base de
données de la commande
whatis(1).
.SH SYNOPSIS
Un résumé de la façon d'utiliser
la commande et les fonctions décrites.
Commandes.
La syntaxe de la commande et de ses arguments telle qu'elle doit
être tapée dans la ligne de commandes. Les mots qui
doivent être tapés exactement comme décrit sont
en gras. Les arguments sont écrits en italique. Les arguments
et les noms de commandes ne prennent pas de majuscule même en
début de phrase.
Les symboles syntaxiques apparaissent en roman :
[] Les crochets sont utilisés pour indiquer des arguments
optionnels.
| Les bares verticales sont utilisées pour indiquer des
choix exclusifs. Un seul élément d'une liste à
bares verticales peut être choisi.
... Les points de suspension suivant un argument indiquent que
celui-ci peut être répété. Lorsqu'ils
suivent des crochets, l'expression entre crochets peut être
répétée.
Fonctions.
Les déclarations de données requises et les
directives #include sont inscrites en premier suivies de la
déclaration de la fonction.
.SH DESCRIPTION
Une description du comportement de la commande ou de
la fonction, ses interactions avec les fichiers et les
données, le traitement des entrées, sortie et erreur
standard. Les détails internes et les implémentations
ne sont normalement pas abordés. La question à laquelle
répond cette section est "Qu'est-ce que ça fait ?" ou
"C'est pourquoi faire ?"
Le texte littéral, les noms de fichiers et les
références à des éléments qui
apparaissent ailleurs dans les manuels de référence
sont présentés en caractères non-proportionnels.
Les arguments sont présentés en italique.
.SH OPTIONS
La liste des options avec la description de la
façon dont elles affectent la commande.
.SH UTILISATION
Cette section est optionnelle. Elle contient une
description détaillée des sous commandes et de la
grammaire comprise par la commande.
.SH VALEURS RETOURNEES
La liste des valeurs qu'une routine peut retourner
avec les conditions qui font qu'elles sont retournées.
.SH STATUS DE SORTIE
La liste des valeurs retournées lorsque la
commande est terminée avec les conditions qui font qu'elles
sont retournées.
.SH FICHIERS
La liste des fichiers associés à la
commande ou fonction.
.SH VOIR AUSSI
Une liste de pages de manuel, séparées
par des virgules, en relation avec celle-ci ainsi que des
références à des ouvrages publiés.
.SH DIAGNOSTIQUES
La liste des messages de diagnostique avec leur
explication.
.SH BUGS
Les problèmes connus et les limitations, s'ils
existent.