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

Hosting by: Hurra Communications GmbH
Generated: 2007-01-26 18:01:31