Qu'est-ce qu'une page de manuel ?
Une page de manuel (abréviation de page de manuel) est la forme traditionnelle de documentation logicielle sur un système d'exploitation de type Unix comme Ubuntu. Pour la grande majorité des commandes et des programmes, il existe une page de manuel qui répertorie ses options et explique son utilisation.
Comment trouver et afficher les pages de manuel?
Hors ligne dans un terminal
Les pages de manuel sont automatiquement installées sur votre système avec les commandes qu’elles décrivent. Pour afficher et rechercher des pages de manuel, il y a la commande man
:
man mv
affiche la page de manuel de mv
while
man -k mv
recherche les noms et les descriptions brèves de toutes les pages de manuel installées pour la chaîne mv
. Les expressions régulières étendues POSIX sont autorisées et il s'agit d'une recherche . git-mv
et semver
, si vous souhaitez rechercher exactement mv
utilisez plutôt ^mv$
.
Voir Quelle est la différence entre "man" et "man (#)"? pour en savoir plus sur les sections de la page de manuel . Pour plus d'informations, consultez la page de manuel de man
. ;)
Comment puis-je influencer l'affichage d'une page de manuel?
Le programme par défaut pour afficher les pages de manuel est less
. Ce pager fournit une fonction de recherche utile, entrez simplement /
suivi du terme recherché, par exemple
/--version
et appuyez sur Enter . Cela marquera chaque résultat et défilera vers le premier. Appuyez sur N pour aller au résultat suivant et ift Shift + N pour aller au précédent (voir Comment puis-je rechercher dans une page de manuel? ). Pour une liste de commandes, appuyez sur H , pour quitter less
appuyez sur Q .
À côté de less
, il existe d'autres pagers disponibles: pg
, most
et w3m
pour n'en citer que trois. Je recommande most
: Il est livré avec une coloration très utile des mots-clés, ce qui rend la page de manuel beaucoup plus facile à lire et à naviguer, voyez par vous-même:
Pour afficher une page de manuel différente de votre pager par défaut, utilisez l’option -P
, par exemple:
man -P most mv
Si vous souhaitez modifier le pager par défaut , les pages de manuel sont affichées avec deux options:
-
change le pagineur par défaut uniquement de man
export MANPAGER=most
Pour que la modification soit persistante, ajoutez cette commande à votre fichier ~/.bashrc
.
-
modifiez le pagineur par défaut de l’ensemble de votre système
sudo update-alternatives --config pager
Les fans peuvent même (ab) utiliser vim
comme MANPAGER
, voir cet article écrit par muru .
Les pages de manuel sont affichées dans la police spécifiée dans les paramètres de votre émulateur de terminal. Si vous travaillez régulièrement avec le terminal, vous souhaiterez peut-être modifier cette police. Je ne peux que recommander Hack - une police de caractères conçue pour le code source , voir la capture d'écran ci-dessus pour sa beauté.
Hors ligne via l'interface graphique
Une méthode simple et conviviale pour afficher des pages de manuel avec une interface graphique simple est le programme yelp
préinstallé. Pour démarrer une page de manuel avec yelp
execute yelp man:PROGRAM
ou gnome-help man:PROGRAM
, par exemple:
yelp man:mv
Vous pouvez également afficher les pages de manuel avec votre navigateur préféré , voir Comment ouvrir les pages de manuel dans un navigateur Web? , par exemple pour man mv
in firefox
:
man -Hfirefox mv
Enfin, vous pouvez convertir des pages de manuel au format PDF et les afficher avec votre lecteur PDF préféré, voir: Y a-t-il un moyen d'imprimer des pages d'information / man au format PDF?
En ligne
Vous pouvez afficher les pages de manuel des programmes disponibles via les référentiels de chaque version d'Ubuntu actuellement prise en charge avec l'URL abrégée manpg.es/PROGRAM
, par ex. lien . Cela ouvre la page de manuel de mv
pour la dernière version Ubuntu, vous pouvez choisir une version différente dans la barre du haut. Pour rechercher des pages de manuel, vous pouvez utiliser par exemple lien .
Comme expliqué ci-dessus, man
ne peut afficher que les pages de manuel des logiciels installés sur le système. Pour afficher les pages de manuel à partir de lien à l'aide d'un pageur de terminal, dman
est disponible dans le package bikeshed
.
Autres sources
Lorsque vous lisez une documentation provenant d’autres sources en ligne, il est conseillé de garder un œil sur la version du programme. La plupart des programmes ont une option --version
qui affiche la version du programme en question, par exemple
$ mv --version
mv (GNU coreutils) 8.25
Il y a beaucoup de sites Web qui se sont consacrés à rendre les pages de manuel facilement accessibles, je vais juste présenter les deux qui me plaisent le plus:
-
man7.org est fourni avec une mise en évidence de la syntaxe, mais il ne comporte que la dernière version du programme.
-
manpag.es Les pages de manuel des hôtes des versions d'Ubuntu sont devenues obsolètes.
Source non déjà liée: lien