De nombreux programmes (grep
, egrep
) et fonctions
(printf
, fprintf
, ...) sont décrits dans un seul document.
Toutefois, cette documentation serait quasiment inutile si elle n'était
accessible que sous un seul nom. Nous ne pouvons pas demander aux
utilisateurs de mémoriser que la page de manuel de egrep
est
en réalité celle de grep
. Il est par conséquent indispensable
que la page soit accessible sous plusieurs noms différents.
Il existe plusieurs possibilités pour obtenir cela :
groff
,
en employant la macro-instruction ".so
".La première solution est une perte de place, il faut l'éviter. La
seconde n'est pas recommandée, car les versions "intelligentes"
de l'utilitaire catman
peuvent gagner beaucoup de temps en
détectant le type ou le contenu du fichier. Les liens matériels
réduiront l'efficacité de cet outil (dont le but est de
formater à l'avance toutes les pages de manuel existantes afin
qu'elles s'affichent toutes rapidement, sans que l'utilisateur doive
attendre le temps nécessaire à ce traitement éventuel).
La troisième solution comporte un piège : si vous êtes concerné par
la portabilité, vous devez savoir qu'il existe des systèmes de fichiers
ne connaissant pas les liens symboliques. En conclusion, la meilleure
chose à faire consiste à employer la macro ".so
".
Voici comment opérer :
si vous désirez que votre page de manuel soit accessible par les noms
"truc" et "bidule" dans la section 1, mettez le document
dans truc.1
et réalisez un fichier bidule.1
contenant ceci :
.so man1/truc.1Il est très important de ne pas oublier le répertoire man1, 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 à .so
comme étant relatifs à cet emplacement.
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