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

Voil� quelques conseils pour rendre votre documentation plus s�re, plus lisible et plus «formatable» :

• Les exemples doivent fonctionner : testez-les (utilisez le copier-coller pour passer � votre shell ce que contient votre page de manuel) et redirigez la sortie de votre commande dans votre page, ne tapez pas ce que vous PENSEZ que votre programme affichera.
• relisez-vous, corrigez toutes les �ventuelles fautes de frappe ou d'orthographe, fa�tes-vous relire par un tiers (surtout si vous ne r�digez pas le texte dans votre langue natale) . (d'ailleurs ce HOWTO n'a pas �t� relu... Y a-t-il un volontaire ?)
• testez votre page de manuel : est-ce que groff trouve des erreurs lors du formatage ? C'est agr�able de trouver dans un commentaire la ligne de commande qu'il faut taper pour le formatage. Est-ce que la commande man(1) affiche des erreurs ou des avertissements lorsqu'on appelle "man votre_programme" ? Est-ce que la fa�on dont man(1) utilise le syst�me de formatage produit le r�sultat escompt� ? Est-ce que cela fonctionne aussi bien avec xman(1x) et tkman(1tk) ? XFree86 3.1 contient la version 3.1.6 de xman qui d�compacte les pages avec :

  gzip -c -d < %s > %s
  zcat < %s > %s
  

• Est-ce que makewhatis(8) pourra extraire la ligne de description de la section NAME ?

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