Aide et documentation sur les commandes

Mise à jour : Debian 10.1 / Buster

Sommaire

1 - Aide en ligne

1.1 - Option --help

La plupart des primitives du shell et des programmes exécutables disposent d'une aide résumée sous la forme d'une option --help, qui affiche un résumé des options, arguments, ....

Exemple pour la primitive "type"

$ type --help
type: type [-afptP] nom [nom ...]
    Affiche des informations sur le type de commande.
    
    Pour chaque NOM, indique comment il serait interprété s'il était
    utilisé comme un nom de commande.
...... 

1.2 - Help

Les primitives et mots réservés du shell disposent d'une aide sous la forme help <commande>, à utiliser en particulier lorsque l'option --help n'est pas disponible

• L'option --help n'est pas disponible dans le cas des mots réservés du shell, par exemple for
  

$ for --help
> ^C

• La commande help permet d'afficher une aide pour la commande for
  

$ help for
for: for NOM [in MOTS ... ] ; do COMMANDES; done
    Exécute des commandes pour chaque membre d'une liste.
......

2 - Documentation de type man

2.1 - Installation

La plupart des primitives du shell et des programmes exécutables disposent d'une aide de type man, située dans le répertoire /usr/share/man/manx ou manx est la section du manuel

• Les pages de manuel sont généralement fournies par les paquets ayant installés les commandes

• Quelques pages de manuel sont fournies par les paquets manpages et manpages-posix. Pour les installer :
  

$ aptitude install manpages manpages-posix

• Pour vérifier la présence du (ou des) fichiers fournissant une commande, utiliser whereis avec l'option -m
  

$ whereis -m type
type: /usr/share/man/man1/type.1posix.gz

2.2 - Utilisation

• Courte description de la commande

$ whatis type
type (1posix)        - write a description of command type

• Affichage de la page du manuel de la section 1 (man1) de la commande type
  

$ man 1 type

3 - Documentation de type info

• Certaines documentations sont de type info, comme par exemple celle de coreutils

$ whereis -m coreutils
coreutils: /usr/share/info/coreutils.info.gz

• Installer le navigateur pour l'aide au format info

$ aptitude install info

• Pour consulter l'aide coreutils dans son ensemble

$ info coreutils

• Pour consulter l'aide d'une commande fournie par coreutils, par exemple cat
  

$ info cat

4 - Autre documentation

• Il arrive que certaines commandes ne disposent pas de documentation de type man ou info, par exemple

$ whereis -m heimdall
heimdall:

• Mais que de la documentation soit fournie avec le paquet, généralement dans le répertoire /usr/share/doc/<nom_du_paquet>

$ dpkg -L heimdall-flash |grep /usr/share/doc/heimdall-flash/
/usr/share/doc/heimdall-flash/README.gz
/usr/share/doc/heimdall-flash/changelog.Debian.amd64.gz
/usr/share/doc/heimdall-flash/changelog.Debian.gz
/usr/share/doc/heimdall-flash/copyright

• Pour lire la documentation texte, au format compressée gz, utiliser zcat, zless, zmore ....
  

$ zless /usr/share/doc/heimdall-flash/README.gz