Quelques commodités de la commande man

Imaginons qu'on veuille des précisions sur la commande mv. Le bon réflexe est :

man mv

Le titre de cette page de manuel est MV(1), ce qui signifie que nous sommes dans la section 1 des pages de manuel. La partie importante est le SYNOPSIS. Voici quelques règles de syntaxes usuelles concernant le SYNOPSIS :

  • Ce qui est en gras est à taper tel quel ;
  • Ce qui est entre crochet est optionnel ;
  • Ce qui est souligné est à adapter en fonction du contexte et à ne pas écrire tel quel a priori ;
  • Ce qui est suivi de points de suspension peut être répété autant de fois que l'on veut.

Pour faire des recherches, il faut utiliser la touche « / » et taper ensuite une expression régulière puis ENTER. La touche « n » (comme next) permet de passer à l'occurrence suivante et la touche « p » (comme previous) permet de passer à l'occurrence précédente.

Une partie utile dans les pages de manuel est la partie SEE ALSO qui nous renvoie vers d'autres pages de manuel connexes à la page courante. Par exemple pour la page MV(1), on a rename(2) dans la partie SEE ALSO. Mais pour consulter cette page, ceci ne fonctionne pas :

man rename

car on tombe sur la page rename(1). Pour consulter rename(2), il faut taper :

man 2 rename

On peut également taper le radical :

man -a rename

ce qui nous permettra de consulter successivement toutes les pages portant le nom rename dans l'ordre croissant des numéros de section. Au passage, les pages de manuel se trouvent dans des fichiers. Pour afficher le chemin de ces fichiers, sans afficher les pages, il faut utiliser l'option -w :

# Affiche le premier fichier correspondant
$ man -w rename
/usr/share/man/man1/prename.1.gz

# Affiche le fichier correspondant et se trouvant dans la section 2
$ man -w 2 rename
/usr/share/man/man2/rename.2.gz

# Affiche tous les fichiers correspondants
$ man -w -a rename
/usr/share/man/man1/prename.1.gz
/usr/share/man/man2/rename.2.gz

Voici également l'option -H (ou --html) qui permet d'afficher une page de manuel sur le navigateur Web de son choix :

man -H"firefox" bash
# équivalent à
man --html="firefox" bash

C'est très pratique pour consulter des pages très longes car les rubriques comme SYNOPSIS, DESCRIPTION etc. sont présentées dans un sommaire dont les entrées sont «cliquables» comme des liens classiques. On peut donc se rendre dans une partie précise très rapidement. Sur ma Debian, si je ne précise pas de navigateur comme ici :

man -H bash

la page de manuel s'affiche directement dans la console, mais sous un format proche d'une page Web classique avec également un sommaire cliquable. Il faut alors taper «q» (comme avec une page de manuel classique) pour sortir de cette page et obtenir le prompt.

Enfin, il est hautement recommandé de consulter les pages de manuel en anglais car les traductions françaises (quand elles existent) comportent parfois des erreurs. Pour consulter une page du manuel en anglais, il faut taper :

man -L en_US.utf8 mv
# Ou bien
man --locale=en_US.utf8 mv

# Le mieux est d'en faire un alias :
alias man='man -L en_US.utf8'
man mv # on aura la page en anglais

# Et si on souhaite vraiment consulter la page en français
# (si elle existe) :
\man -L fr_FR.utf8 mv
# Le « \man » envoie le token « man » au bash sans
# le développer via l'alias. On court-circuite l'alias.
# On peut même utiliser la variable d'environnement LANG :
\man -L $LANG mv
Cette entrée a été publiée dans Commandes pratiques, avec comme mot(s)-clef(s) . Vous pouvez la mettre en favoris avec ce permalien.

Les commentaires sont fermés.