Aide en ligne d'une commande
Un article de Wiki de la communauté Mandriva.
Sommaire |
[modifier] Introduction
Si vous êtes en console, prêt à lancer une commande, il peut être utile de pouvoir obtenir rapidement, sans changer d'environnement, quelques éléments rapides d'information, quelques lignes, qui vous permettront de vous rafraîchir la mémoire sur certains aspects de l'utilisation de la commande en question.
La plupart des commandes ou des programmes comportent un outil de ce genre.
Malheureusement, pour invoquer cet outil il n'y a pas de méthode générale. Les cas suivants peuvent se présenter.
[modifier] Le cas des commandes internes du shell
Les commandes internes du shell, comme la commande alias, utilisent le système d'aide du shell et vous pouvez alors taper quelque chose comme :
help commande
où commande représente le nom de la commande qui vous intéresse.
|
Et comment savoir si j'ai affaire à une commande interne du shell ???
Très simple, tapez : type commande Si vous obtenez quelque chose comme : commande is a shell builtin c'est que vous avez affaire à une commande interne du shell. |
[modifier] L'option --help
Les utilitaires système et de nombreux programmes acceptent l'option --help.
Essayez par exemple avec la commande ls, la commande cp et la commande mv :
ls --help
cp --help
mv --help
[modifier] Les commandes qui ont besoin d'au moins un argument ou d'une option
Les commandes qui ont besoin d'options ou d'arguments impriment un message d'aide si vous saisissez uniquement leur nom
C'est le cas par exemple de rpm ou de tar. Essayez, pour voir, faites donc :
rpm
tar
[modifier] Options diverses
D'autres commandes pourront posséder l'une de ces options :
-?, -h
ou encore
-help (avec un unique tiret).
Si les diverses possibilités énumérées dans les sections précédentes n'ont rien donné, essayez donc celles-ci...
[modifier] Options spécifiques à un programme
Certains programmes disposent d'options spéciales pour invoquer une aide.
Par exemple, le logiciel de synchronisation et de sauvegarde Unison vous permet d'afficher tout un tutoriel en lançant la commande unison -doc tutorial. Pour faire apparaître une liste de rubriques de documentation, vous taperez unison -doc topics, et pour invoquer une rubrique particulière, vous taperez une commande de la forme générale unison rubrique.
