François Goffinet

François Goffinet

Aide sous Linux

Il est essentiel de trouver de l’aide sous Linux grâce aux pages Manuel, aux fichiers sources et README mais aussi à travers des ressources en ligne.

1. Commandes less et more

less est une commande Unix permettant de visualiser un fichier texte page par page (sans le modifier). Sa fonction est similaire à la commande more, mais permet en plus de revenir en arrière ou de rechercher une chaîne. Contrairement à vi (qui permet aussi de visualiser des fichiers), less n’a pas besoin de charger entièrement le fichier en mémoire et s’ouvre donc très rapidement même pour consulter de gros fichiers.

Raccourcis dans less :

  • h ou help pour l’aide
  • / suivi d’une occurrence pour effectuer une recherche
  • Barre d’espace : pour avancer d’une page

Exemples :

more /var/log/dmesg

2. Commande man

man est une commande Unix. Elle permet de visionner le manuel d’une commande du shell. Elle utilise la commande less. Les raccourcis de navigation sont donc identiques.

Chaque page de manuel fait partie d’une section :

  • -1. Commandes utilisateur
  • -2 Appels système
  • -3 Fonctions de bibliothèque
  • -4 Fichiers spéciaux
  • -5 Formats de fichier
  • -6 Jeux
  • -7 Divers
  • -8 Administration système
  • -9 Interface du noyau Linux

Chaque section possède une page d’introduction qui présente la section, disponible en tapant man <section> intro.

Pour installer les pages de manuel en français : sudo yum install man-pages-fr.

3. Appel d’une page manuel

Pour appeler une page de manuel, tout simplement :

man [-s<section>] <nom_de_commande>

Par exemple :

man man

man ls

man 5 passwd

4. Recherche d’une page manuel man -f ou whatis

Une page de manuel peut avoir le même nom et faire partie d’une section différente (la portée de la page est différente). Par exemple :

man -f passwd

affiche ce résultat :

passwd (1)          - Modifier le mot de passe d’un utilisateur
passwd (5)           - fichier des mots de passe
passwd (1ssl)        - compute password hashes

L’option man -f passwd permet d’effectuer une recherche sur le nom des pages man. La commande whatis passwd aurait eu le même effet.

5. Contenu d’une page manuel

En en-tête de la page man on trouve le nom de la commande suivie d’un numéro entre parenthèses. Il s’agit du numéro de section.

Une page est composée habituellement de plusieurs sections (au sens interne de la page) :

NOM, SYNOPSIS, CONFIGURATION, DESCRIPTION, OPTIONS, CODE DE RETOUR, VALEUR RENVOYÉE, ERREURS, ENVIRONNEMENT, FICHIERS, VERSIONS, CONFORMITÉ, NOTES, BOGUES, EXEMPLE, AUTEURS et VOIR AUSSI.

Le SYNOPSIS indique brièvement l’interface de la commande ou de la fonction. Pour les commandes, ce paragraphe montre sa syntaxe et ses arguments. Les caractères gras marquent le texte invariable et l’italique indique les arguments remplaçables. Les crochets encadrent les arguments optionnels, les barres verticales (caractère pipe) séparent les alternatives, et les ellipses … signalent les répétitions.

La DESCRIPTION fournit une explication sur ce que la commande, la fonction ou le format représente. Décrit les interactions avec les fichiers et l’entrée standard, ou ce qui est produit sur la sortie standard ou d’erreur. Ne contient pas les détails d’implémentation internes, sauf s’ils sont critique pour comprendre l’interface. Décrit le cas principal, pour les détails sur les options, on utilise le paragraphe OPTIONS.

6. Se déplacer dans une page manuel

Pour se déplacer dans une page manuel, on utilise les raccourcis de less :

  • G pour arriver à la fin du document
  • gg pour revenir au début du document
  • /motif pour rechercher le motif dans la page

7. Commandes man -k ou apropos

Recherche la description courte et le nom des pages de manuel comportant le mot-clé, utilisé comme une expression rationnelle, puis affiche tout ce qui a été trouvé.

man -k password

La commande apropos donne l’équivalent :

apropos password

La commande whatis -r donne également le même résultat.

Man utilise une base donnée pour consulter les descriptions des pages. En cas de pages ou de logiciels ajoutés, il est indiqué de mettre à jour la base de données mandb:

mandb

8. Commande info

La commande info a d’abord été fourni avec le paquet Texinfo de GNU en alternative plus exhaustive et documentée que les pages de manuel UNIX et a été porté par la suite sur d’autres systèmes de type Unix.

info info

9. Autres ressources

On peut aussi trouver de l’aide autrement sur un système Linux :

  • Option : -h ou --help d’une commande :
      man --help
  • Les fichiers README des sources,
  • dans le dossier /usr/share/doc.

10. Manuels et wikis des distributions

11. Sites divers

Vous pourriez aimer aussi

Glossaire Ansible

49 minutes de lecture

Glossaire des termes utilisés dans le contexte Ansible

Configuration Ansible

48 minutes de lecture

Ce document propose d’examiner les principales options de configuration de Ansible sur le noeud de contrôle. Son architecture sans agent laisse le soin à chacun de configurer finement et personnellement le comportement par défaut de la solution. Le comportement d’Ansible peut être influencé de différentes manières : en configurant des variables d’environnement, en passant directement les paramètres sur la ligne de commande ansible ou ansible-playbook, en définissant un fic...