Comment créer une page de manuel pour mon script shell?

Je vous conseille d’utiliser Grapse est un éditeur de page de manuel en ligne, car vous pouvez voir les résultats en temps réel, je pense que c’est vraiment utile pour les débutants.

Exemple de page de manuel, à partir du lien :

.\" Manpage for nuseradd. .\" Contact [email protected] to correct errors or typos. .TH man 8 "06 May 2010" "1.0" "nuseradd man page" .SH NAME nuseradd \- create a new LDAP user .SH SYNOPSIS nuseradd [USERNAME] .SH DESCRIPTION nuseradd is high level shell program for adding users to LDAP server. On Debian, administrators should usually use nuseradd.debian(8) instead. .SH OPTIONS The nuseradd does not take any options. However, you can supply username. .SH SEE ALSO useradd(8), passwd(5), nuseradd.debian(8) .SH BUGS No known bugs. .SH AUTHOR Vivek Gite ([email protected]) 

Installation avec votre script:

 install -g 0 -o 0 -m 0644 nuseradd.1 /usr/local/man/man8/ gzip /usr/local/man/man8/nuseradd.1 

L’installer manuellement:

 cp nuseradd /usr/local/man/man8/nuseradd.1 gzip /usr/local/man/man8/nuseradd.1 

Qu’en est-il de l’utilisation de pandoc . Vous pouvez écrire un document en markdown (ou même en html, latex) et vous convertir en HTML, pdf, word, pages de manuel , epub, etc. De cette façon, vous pouvez écrire de la documentation dans un format

help2man utilise la sortie de votre script lorsqu’il reçoit l’indicateur --help pour générer une page de manuel décente.

Cela nécessite très peu d’effort et fournit un résultat raisonnable. Comme il repose sur la sortie de votre script lorsqu’il est passé --help et --version il vous oblige également à écrire un --help décent 🙂

C1sc0 il y a une erreur dans votre réponse.

pour créer votre propre page de manuel, suivez les étapes ci-dessous:

1- devenir superutilisateur:

 $ sudo -i 

2- allez dans ce répertoire:

 $ cd /usr/bin $ nano your_function 

3- copiez ce modèle de page homme (maual) et personnalisez-le en fonction de votre projet:

 ./" Manpage for your_fonction .TH man 1 "10 September 2017" "1.0" "your_fonction man page" .SH NAME your_fonction - do.... .SH SYNOPSIS your_fonction [optionnal argument] [optionnal argument] .SH DESCRIPTION your_fonction is a function which ..... .SH OPTIONS your_fonction does not take any options .SH BUGS No known bugs. .SH AUTHOR written by your_name (your_website or your_github or whatever) .SH REPORTING BUGS you_github_repository/isssues for example 

4- vous devez choisir dans quel répertoire votre fichier doit être, regardez:

 $ cd/usr/share/man/ && ls 

vous voyez man1, man2, …. Ce sont les catégories:

(man1) 1 – Commandes disponibles pour les utilisateurs
(man2) 2 – Appels système Unix et C
(man3) 3 – Routines de bibliothèque C pour les programmes C
(man4) 4 – Noms de fichiers spéciaux
(man5) 5 – Formats de fichier et conventions pour les fichiers utilisés par Unix
(man6) 6 – Jeux
(man7) 7 – Paquets de traitement de texte
(man8) 8 – Commandes et procédures d’administration système

ici pour l’exemple la destination sera man1, donc:

5- retour à usr / bin

 $ cd /usr/bin 

6- faire une copie avec le bon suffixe:

 $ cp your_function your_function.1 

7- gzip your_function.1

 $ gzip your_function.1 

8- l’envoyer dans le bon répertoire, ici pour l’exemple man1:

 $ cp your_function.1.gz /usr/share/man/man1/ 

c’est fait, vous pouvez tester votre belle page de manuel!

  $ man your_function