pod2usage

pod2usage

# Affiche l'aide rapide de la commande pour savoir comment l'utiliser
pod2usage -help

# Génère et affiche la page manuelle complète (équivalent à 'man')
pod2usage -man

# Exécute le script en sortant avec un code d'erreur spécifique (ex: 42)
pod2usage -exit 42

# Envoie l'output de usage vers un fichier texte précis
pod2usage -output usage_doc.txt mon_script.sh

# Affiche uniquement la syntaxe générale (niveau de verbosité 1)
pod2usage -verbose 1 mon_fichier.manpage

# Affiche les sections et arguments, mais pas le contenu complet (niveau 2)
pod2usage -verbose 2 autre_commande.txt

# Génère l'intégralité du manpage dans la console (niveau de verbosité 3)
pod2usage -verbose 3 fichier_complet.sh

# Recherche et utilise un fichier en cherchant d'abord dans /usr/share/man
pod2usage -pathlist /usr/share/man mon_fichier.txt

# Recherche le fichier dans plusieurs répertoires pour trouver la documentation
pod2usage -pathlist /opt/docs:/home/user/doc autre_script.sh

# Exemple de redirection standard output vers un fichier spécifique
pod2usage -output >&1 script.py

# Utilise l'erreur standard (stderr) comme destination d'output pour le log
pod2usage -output >&2 erreur.log

# Teste la génération d'usage avec un chemin absolu complet
pod2usage /etc/man-pages/fichier_test.txt

# Génère une documentation en utilisant un format de module spécifique (si supporté)
pod2usage -formatter custom_module fichier.sh

# Vérifie l'utilisation du flag UTF-8 pour les caractères spéciaux dans le contenu
pod2usage --utf8 document_unicode.txt

# Exemple combinant plusieurs options pour une documentation détaillée et exportée
pod2usage -verbose 3 -output full_doc.md mon_outil.sh