La commande homme sur Linux est intégré dans la mémoire musculaire de chaque développeur et utilisateur Linux. Il est utilisé littéralement par tout le monde ; des développeurs amateurs et novices aux professionnels et experts Linux.
Il est utilisé pour lire la page de manuel de la ligne de commande pour une commande Linux, un fichier de configuration ou toute autre fonctionnalité. Les pages de manuel sont généralement installées avec l'installation d'un logiciel sous Linux. Il existe une syntaxe définie pour les pages de manuel, qui est analysée par la commande.
Créons une page de manuel pour le script bash suivant que j'ai écrit :
#!/bin/bash if [ "$1" == "h" ]; then echo "Bonjour" fi if [ "$1" = "b" ]; puis echo "Au revoir" fiCe script ne fait que deux choses : il affiche "Bonjour" si l'option "h" est spécifiée en argument, et il affiche "Au revoir" si l'option "b" est spécifiée en argument.
Créons une page de manuel pour ce programme. Utiliser vigueur ou n'importe quel éditeur de votre choix pour créer un fichier texte.
test vim.1L'extension '.1' signifie que cette page de manuel est pour une commande exécutable. Ce n'est pas une contrainte mais plutôt une convention largement suivie lors de l'écriture de pages de manuel. La page de manuel pour homme (homme homme !) liste les catégories :
1 Programmes exécutables ou commandes shell 2 Appels système (fonctions fournies par le noyau) 3 Appels de bibliothèque (fonctions dans les bibliothèques de programmes) 4 Fichiers spéciaux (généralement trouvés dans /dev) 5 Formats de fichiers et conventions, par exemple /etc/passwd 6 Jeux 7 Divers ( y compris les packages de macros et les conventions), par exemple man(7), groff(7) 8 Commandes d'administration système (généralement uniquement pour root) 9 Routines du noyau [Non standard]Une page de manuel est créée en utilisant le très vieux langage de balisage roff. Il a des commandes (marques de lecture) pour divers titres et sections.
.E– Cela devrait être la première commande dans le fichier man. Il est utilisé pour spécifier l'en-tête du titre de la page de manuel..SH- Tête de section..B– Il permet d'afficher le texte à côté en gras..TP– Il est utilisé pour afficher des informations sur un argument (drapeau) de la commande..BR– Il est utilisé pour afficher le texte en gras et dans la police romaine normale.
Voici la page de manuel de mon programme créé en utilisant uniquement les commandes roff (simples) ci-dessus.
.TH test.sh 1 .SH NOM test.sh \- Imprimer Bonjour ou au revoir .SH SYNOPSIS .B test.sh [ h ] [ b ] .SH DESCRIPTION .B test.sh Ceci est un exemple de script qui ne fait que 2 choses . Il affiche soit "Bonjour" si l'argument est "h", soit il affiche "Au revoir" si l'argument est "b" .SH OPTIONS .TP .BR h Affiche Bonjour .TP .BR b Affiche Au revoirEnregistrer le fichier en appuyant d'abord sur le ESC touche, puis tapez :wq pour enregistrer le fichier et quitter la console vim.
Testez la page de manuel que nous venons de créer à l'aide de la commande ci-dessous :
homme ./test.1
Pour plus d'informations sur homme utilisation, exécuter man pages de man commande dans votre terminal.
? Pointe
C'est la syntaxe de base pour écrire des pages de manuel. Pour faciliter les choses, vous pouvez utiliser des outils tels que txt2man pour convertir un fichier dans un format de langage de balisage au format roff.