Page suivante Page précédente Table des matières

Man page HOWTO

Auteur : Jens Schweikhardt schweikh@noc.dfn.de
www.shuttle.de/schweikh/home.html

Mars 1998

(Adaptation française par Alexandre Devaure adevaure@mail.dotcom.fr, 2 juin 1999). Ce HOWTO explique ce que vous devrez avoir en tête quand vous prévoyez d'écrire une documentation en ligne (plus connue sous le nom de page de manuel) que vous voulez rendre accessible via la commande man(1). Tout au long de ce HOWTO, une entrée du manuel sera simplement appelée page de manuel, quelque soit sa longueur réelle et sans intention sexiste.

1. Quelques évidences à propos de la documentation

2. Comment accède-t-on aux pages de manuel ?

3. A quoi ressemble une page de manuel formatée ?

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

5. Quel ensemble de macros utiliser ?

6. Quels préprocesseurs puis-je utiliser ?

7. Dois-je distribuer les sources et/ou la documentation déjà formatée ?

8. Quelles sont les conventions pour les fontes ?

9. Comment dois-je présenter ma page de manuel ?

10. Comment puis-je avoir un texte en pur ASCII sans tous ces fichus ^H^ de contrôle ?

11. Comment avoir une belle page de manuel en PostScript  ?

12. Comment faire fonctionner les programmes apropos et whatis ?

13. La langue française

14. Les conditions de copie

Page suivante Page précédente Table des matières