Page suivantePage pr�c�denteTable des mati�res

4. Comment documenter plusieurs choses dans une seule page de manuel ?

De nombreux programmes (grep, egrep) et fonctions (printf, fprintf,...) sont document�es dans une seule page de manuel. Cependant, ces pages seraient inutilisables si elles n'�taient accessibles que par un seul nom. Nous ne pouvous nous attendre � ce qu'un utilisateur se souviennent que la page de manuel de egrep est en fait celle de grep. Il est par cons�quent indispensable que la page soit accessible sous diff�rents noms. Vous avez plusieurs possibilit�s pour y arriver :

  1. avoir des copies identiques pour chaque nom ;
  2. connecter toutes les pages de manuels en utilisant des liens physiques ;
  3. utiliser les liens symboliques pointant la page de manuel ;
  4. utiliser le m�canisme de "source" de groff fournie par la macro ".SO".
La premi�re possibilit� est une perte de place. La deuxi�me n'est pas recommand�e parce que les versions intelligentes du programme catman peuvent gagner beaucoup de temps en regardant le type du fichier et son contenu. Les liens physiques r�duiraient l'efficacit� de cet outil (dont le but est de formater toutes les pages de manuel pour qu'elles soient affich�es plus rapidement). La troisi�me alternative comporte un pi�ge si vous �tes concern� par la portabilit�, vous devez savoir qu'il existe des syst�mes de fichiers qui ne supportent pas les liens symboliques. En bref, la Meilleure Chose (TM) est d'utiliser le m�canisme source de groff.

Voila comment l'utiliser : si vous voulez que votre page soit accessible sous les noms truc et bidule dans la section 1, alors mettez la page de manuel dans truc.1 et r�alisez le fichier bidule.1 contenant :

 .SO man1/truc.1
Il est important de sp�cifier le r�pertoire man1/ aussi bien que le nom du fichier truc.1 car lors de l'ex�cution de groff, celui-ci aura comme r�pertoire courant le r�pertoire de base des pages de manuel, et il interpr�tera les arguments de .SO comme �tant relatifs � cet emplacement.


Page suivantePage pr�c�denteTable des mati�res

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