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

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