Modèle pod de manpage modifiée pour le projet
- Keywords:
- pod manpage manuel
- Last updated by:
- Jean-Mi
Le modèle pod est inclut à la fin du script, il suffit de renseigner les différentes sections avec formatage ou non (Ceci peut être fait ultérieurement)
Vous pouvez tester le résultat en faisant
$ monscript -u # usage
$ monscript -h # usage + options et arguments
$ monscript -m # page de manuel (pour quitter appuyez sur la touche q)
Pour des exemples d'utilisation plus détaillée de la syntaxe pod
http://
http://
http://
A mettre à la fin du script (Je n'ai mis que les section, sans le détail)
Il peut être intéressant de séparer la page pod du script pour l'édition, ainsi gvim reconnait la syntaxe ainsi que kate
Ne pas modifier les entête de section (en particulier NOM, SYNOPSIS, OPTIONS AND ARGUMENTS, README, NEWS et TODO), merci
******
=pod
=head1 NOM
monscript.sh - Le programme fait ceci et cela...
=head1 SYNOPSIS
B<monscript.sh> { B<ceci>|B<cela> } [ B<-flags> ] [ B<-o> I<option> ] I<argument> [ I<plus...> ]
=head1 OPTIONS AND ARGUMENTS
Liste des options et arguments (voir format)
=head1 EXEMPLES
Exemple de ce que fait le script avec une ligne de commande pertinente
=head1 DESCRIPTION
ce que fait le script en détail
=head1 VALEUR DE RETOUR
Ce que le script renvoie comme valeur en cas de succès.
=head1 ERREURS
Code de retours d'erreurs.
=head1 ENVIRONEMENT
Les variables d'environement qui affecte le script.
=head1 FICHIERS
Tous les fichiers utilisés par le script.
=head1 NOTES
Des commentaires généraux.
=head1 CAVEATS
Des points auxquels il faut prêter attention, parfois appelé WARNINGS.
=head1 DIAGNOSTICS
Tous les messages d'erreurs possibles
=head1 BUGS
Liste des erreurs connues
=head1 RESTRICTIONS
Des bugs que vous ne planifiez pas de corriger :-)
=head1 AUTEURS
Liste des ateurs
=head1 DEPENDANCES
Liste des paquets dont le script dépend
=head1 HISTORIQUE
=head1 VOIR AUSSI
=head1 README
=head1 NEWS
=head1 TODO
=cut
