cClaude.rocks ☕ Le blog

La documentation Unix formelle : « man »

La documentation sur une commande s’obtient à l’aide de la commande man :

man COMMAND

Exemple, l’aide de la commande man :

man man

Contre-exemple, pour la commande embarquée du bash : read qui vous retournera une documentation développeur pour le langage C :

man read

L’option « -h » ou « --help »

En général, les commandes Unix supporte l’option --help et parfois l’option courte -h (lorsque cela n’entre pas en conflit avec une des options de la commande).

COMMAND --help

Exemple :

ls --help

La documentation GNU : « info »

info est un lecteur de documentation autonome du GNU

Usage :

info COMMAND

Exemples :

info info

info ls

L’aide des commandes embarquées : « help »

Usage

help COMMAND

Exemples :

help help

help read

Un aide simplifié (ou pas) : « tldr »

L’abréviation tldr vient de l’anglais “Too Long; Didn’t Read“ qui se traduit par Trop Long, Pas Lu. Cet acronyme de plus en plus courant défend l’idée que les documentations sont trop longues à lire et propose une alternative basée sur quelques exemples.

Cette « version de la documentation » n’est pas native et demande l’installation de nodejs et *npm; puis de l’application tldr elle-même.

sudo apt install nodejs npm
sudo npm install -g tldr

Usage :

tldr COMMAND

Exemple :

tldr tar

Cette solution est très efficace dans de nombreux cas, mais elle à l’inconvénient de limiter la connaissance des outils que l’on utilise.

Documentations en ligne

Il existe beaucoup de sites et de blogs où on trouve de la documentation, donc voici une liste non-exhaustive de quelques points de départ :

• https://explainshell.com/, ou il est possible de savoir le détail d’une commande avec ces paramètres, exemple : ls -la,
• Un manuel Ubuntu en ligne en anglais,
• un manuel Ubuntu en ligne en français.