Réalisation de pages de manuel

Jens Schweikhardt <jens@kssun3.rus.uni-stuttgart.de>, trad. Rene.Cougnenc@freenix.fr - Janvier 1996

Ce document explique ce que l'on doit connaître pour pouvoir rédiger de la documentation en ligne destinée à être exploitée par la commande man(1) : ce sont les fameuses pages de manuel.

1. Quelques évidences

2. Organisation et principe du manuel en ligne

3. À quoi une page de manuel formatée doit-t-elle ressembler ?

4. Comment documenter plusieurs choses dans une seule page ?

5. Quel ensemble de macros choisir ?

6. Quels préprocesseurs utiliser ?

7. Distribution : code source et/ou documentation formatée ?

8. Fontes disponibles et conventions typographiques

9. Conseils, trucs et astuces

10. Copyright