Pages de manuel Linux

Mise à jour : Debian 9.8

Les manuels linux sont installés sur le système en même temps que les paquets correspondants. Par défaut, la consultation des manuels s'effectue en console avec un utilitaire d'affichage ("pager") minimum (less).

Les manuels peuvent également être consultés :

1 - Commandes de base

1.1 - Whatis

$ whatis man
man (1) - Interface de consultation des manuels de référence e...
man (7) - macros to format man pages

Dans le cas présent, la commande man est présente dans les sections 1 et 7 du manuel

1.2 - Man

$ man 7 man
$ man -L C 7 man

1.3 - Apropos

apropos <texte> affiche le champ "Nom" des programmes, utilitaires ou fonction contenant <texte> dans le champ "Nom" de leur manuel

$ apropos grub
grub-editenv (1) - edit GRUB environment block
grub-file (1) - check file type
grub-fstest (1) - debug tool for GRUB filesystem drivers
grub-glue-efi (1) - generate a fat binary for EFI
grub-install (8) - install GRUB to a device
........

2 - Utilisation de most

2.1 - Installation

$ sudo aptitude install most 
$ sudo update-alternatives --config pager

Sélectionner le choix 3 pour utiliser most comme pager

2.2 - Utilisation

L'affichage d'un manuel s'effectue avec la commande man habituelle. Par exemple, pour afficher le manuel de la commande most :

$ man most

Most en console

most utilise la couleur pour afficher les mots clés. Les commandes de base s'effectuent en tapant dans la page l'initiale de la commande suivi du paramètre.

Stexte       Search texte
T Go to Top
B Go to Bottom
U UP one page
D Down one page
Gxx Go to ligne xx

3- Affichage en html - man2html

3.1 - Installation

$ sudo aptitude install apache2
$ systemctl status apache2 |grep running
Active: active (running) since mer. 2017-01-11 10:08:47 CET; 6h ago
$ sudo a2enmod cgi
$ sudo systemctl restart apache2
$ sudo aptitude install man2html

3.2 - Utilisation

$ xdg-open http://localhost/cgi-bin/man/man2html

Manuel en navigateur

#! /usr/bin/env bash

# manhtml

# Vérification du passage du nom du manuel à utiliser
[[ $# -eq 0 ]] && { echo "Il manque le nom du manuel, abandon"; exit; }
[[ $# -eq 1 ]] || { echo "Il y a plus d'un nom de manuel, abandon"; exit; }

# Lancement de l'affichage du manueldans le navigateur par défaut
xdg-open http://localhost/cgi-bin/man/man2html?query=$1
exit
$ manhtml grub-install

4 - Consultation en ligne

https://manpages.debian.org/

Debian manpages

https://manpages.debian.org/xyz