Page suivantePage précédenteTable des matières

5. Quel ensemble de macros utiliser ?

Il y a de nombreux ensembles de macros étudiés spécialement pour écrire des pages de manuel. Ils sont habituellement dans le répertoire de macro de groff /usr/lib/groff/tmac. Les noms de fichiers sont du genre tmac.<quelque chose>, où <quelque-chose> est l'argument de l'option -m de groff. groff utilisera tmac.<quelque-chose> quand l'option -m <quelque-chose> sera donnée. Souvent, l'espace entre "-m" et <quelque-chose> est oublié, on écrira donc groff -man pour formater des pages de manuel en utilisant l'ensemble de macro tman.an. Voilà la raison de ce nom bizarre "tman.an".

En plus de tman.an, il existe un autre ensemble de macro populaire, tman.doc, originaire de l'université de Californie à Berkeley (UCB). De nombreuses pages de manuels de BSD l'utilisent et il semble que UCB en a fait son standard pour la documentation. Les macros de tman.doc sont plus souples mais, hélas, il y a des lecteurs de pages de manuels qui ne les utilisent pas mais qui appellent toujours groff -man. Par exemple, toutes les versions du programme xman que j'ai rencontrées faisaient la tête devant les pages de manuels requérant tman.doc. Donc faîtes-vous une faveur : utilisez tmac.an, utiliser un autre ensemble de macros est considéré comme hasardeux. tmac.andoc est un pseudo ensemble de macros qui regarde le source et charge soit tmac.an ou tmac.doc. En fait, tous les programmes de lecture 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. Tout ce que je dirais à partir de maintenant concernant les macros est valable seulement pour tmac.an. Si vous voulez quand même utiliser les macros de tmac.doc, voici un pointeur vers leur documentation et un mode d'emploi très détaillé : www.bsdi.com/bsdi-man. Vous trouverez un formulaire de recherche sur cette page. Entrez mdoc et il vous trouvera mdoc(7) et mdoc.samples(7), un didacticiel sur la réalisation des pages de manuel BSD.


Page suivantePage précédenteTable des matières