Il existe un certain nombre de jeux de macros étudiés spécialement pour
la confection de pages de manuel. On les trouve généralement dans le
répertoire /usr/lib/groff/tmac. Les noms des fichiers sont
du genre tmac.<quelque-chose>, où <quelque-chose>
est l'argument passé à l'option -m
de groff
. Souvent,
l'espace entre -m
et <quelque-chose> est omis, de sorte
que l'on peut écrire groff -man
lorsque l'on désire formater
des pages utilisant le jeu de macros tmac.an. Voilà la raison
de ce nom bizarre, "tmac.an".
En plus de ce tmac.an, il existe un autre ensemble de macros très
populaire, tmac.doc, qui provient de l'université de Berkeley,
Californie (UCB). De nombreuses pages de manuel BSD l'utilisent et il
semble que l'UCB en ait fait un standard pour la documentation.
Les macros tmac.doc sont bien plus souples mais malheureusement,
beaucoup d'outils de lecture du manuel n'y font pas appel et utilisent
toujours la commande groff -man
. Par exemple, tous les programmes
xman
que nous avons rencontrés affichent n'importe quoi lorsqu'ils
rencontrent des pages prévues pour ces macros tmac.doc.
Alors, vous devez vous résigner : n'utilisez que tmac.an (l'emploi
de tout autre ensemble de macros est très risqué).
Le jeu tmac.andoc est un pseudo ensemble de macros qui analyse le
code source et charge soit tmac.an, soit tmac.doc selon son
contenu. En fait, tous les programmes d'exploitation du manuel devraient
l'utiliser, mais jusqu'à présent peu le font, aussi il vaut mieux assurer
le coup en se cantonnant au bon vieux tmac.an. À partir de
maintenant, tout ce que nous décrirons concernant les macros
ne sera valable que pour tmac.an.
mdoc
et il vous trouvera mdoc(7)
et mdoc.samples(7)
, un didacticiel
sur la réalisation des pages de manuel BSD.
Chapitre suivant, Chapitre Précédent
Table des matières de ce chapitre, Table des matières générale
Début du document, Début de ce chapitre