Je n'ai aucune idée de la façon dont je peux rendre mes scripts spécialisés maison (écrits principalement en Bash et Perl) disponibles via le man
pages.
Quelle procédure devrais-je suivre, et y a-t-il un format particulier dans lequel la documentation doit être rédigée pour que je puisse le faire ?
Réponse acceptée :
J'ai trouvé qu'il est beaucoup plus facile d'utiliser le POD de Perl que d'écrire directement des pages de manuel, et vous pouvez créer une page de manuel à partir du fichier POD avec le pod2man
utilitaire (partie du package Perl de base). Étant donné que certains de vos exécutables sont déjà écrits en Perl, vous pouvez ajouter le formatage POD directement à vos scripts et ils peuvent être transformés directement en fichiers POD. J'ai également vu plusieurs projets utiliser le format POD même si leur code est écrit dans d'autres langages, en raison de la simplicité de POD.
Pour ajouter un répertoire supplémentaire de pages de manuel, vous pouvez définir le $MANPATH
variables d'environnement. Préfixe $MANPATH
avec un :
pour l'ajouter à la liste des chemins de manuel déjà configurés. Utilisez le manpath
commande pour voir les chemins d'accès utilisateur actuellement définis.