Apparence
Uubu.fr

Les systèmes Linux, l’open source, les réseaux, l’interopérabilité, etc.
« Il vaut mieux viser la perfection et la manquer que viser l’imperfection et l’atteindre. » (Bertrand Arthur William RUSSEL)
30 janvier 2014

man pager           Affichage de texte


man

man

Man est le pager de manuel système. Chaque page donné en argument est normalement le nom du programme, utilitaire ou fonction.

Liste des sections

1 Programmes exécutables ou commandes shell
2 appels système (fonctions fournies par le kernel)
3 Appel de librarie
4 Fichiers spéciaux généralement trouvés dans /dev
5 Formats de fichier et conventions
6 Jeux
7 Divers
8 Commandes d'administration système
9 Routine kernel non standard

   Les sections conventionnels incluent:

  NAME, SYNOPSIS, CONFIGURATION, DESCRIPTION, OPTIONS, EXIT STATUS, RETURN VALUE, ERRORS, ENVIRONNEMENT, FILES, VERSIONS, CONFORMING TO, NOTES, BUGS, EXAMPLE, AUTHORS et SEE ALSO.

  Les conventions suivantes s'appliquent à la section synopsis et peuvent être utilisées comme guide dans les autres sections:

Texte en gras taper exactement comme affiché
texte italique Remplace avec l'argument approprié
[-abc] ces arguments sont optionnels
-a|-b Ne peuvent pas être utilisés ensemble
argument ... L'argument est répétable
[expressions] ... Toutes l'expression est répétable

OPTIONS Générales

-C file, --config-file=file Spécifie le fichier de configuration à utiliser au lieu de ~/.manpath
-d, --debug Mode debug
-D, --default Réinitialise les paramètres à leur valeurs par défaut
--warnings[=warnings] Active les alertes de groff.

Opérations du mode principal

-f, --whatis Equivalent à whatis
-k, --apropos Equivalent à apropos
-K, --global-apropos Recherche du texte dans toutes les pages de manuel.
-l, --local-file Active le mode local. Recherche dans les fichiers locaux au lieu des manuels système.
-w, --where, --location N'affiche pas le man, mais affiche l'emplacement des fichiers source nroff
-W, --where-cat, --location-cat N'affiche pas le man, mais affiche l'emplacement des fichiers cat
-c, --catman Utilisé par le programme catman
-R encoding, --recode=encoding Spécifie l'encodage pour l'affichage des manuels

Recherche de pages de manuel

-L locale, --locale=locale Remplace l'appel setlocale(3)
-m system[,...], --systems=system[,...] Permet d'accéder à des page de manuel d'autres OS.
-M path, --manpath=path Spécifie un manpath alternatif à utiliser.
-S list, -s list, --sections=list Liste de sections de manuel à rechercher.
-e sub-extension, --extension=sub-extension sur les systèmes qui incorporent beaucoup de pages de manuel, il peut y avoir plusieurs manuels ayant le même nom. exemple tcl peut avoir exit(3), on peut l'appeler avec exit(3tcl). *tcl permet de restreindre les recherches.
-i, --ignore-case Insensible à la casse lors de la recherche de pages de man
-I, --match-case Recherche sensible à la casse
--regex Permet de spécifier que la recherche est un regex. implique a
--wildcard Affiche toutes les pages avec n'importe quelle partie dans le nom ou le contenu matchent chaque argument page. implique -a
--names-only si --regex ou --wildcard, match uniquement les nom des pages, pas la description, comme avec whatis
-a, --all Par défaut, man va quitter après avoir affiché les pages de man qu'il a trouvé
-u, --update effectue une vérification de consistance 'inode level' sur son cache.
--no-subpages Support pour les page de manuel qui ont des sous commandes. ex:

        man -aw git diff
        /usr/share/man/man1/git-diff.1.gz
        man -aw --no-subpages git diff
        /usr/share/man/man1/git.1.gz
        /usr/share/man/man3/Git.3pm.gz
        /usr/share/man/man1/diff.1.gz

Contrôler la sortie formatée

-p pager, --pager=pager Spécifie le pager à utiliser. ne peut pas être utilisé avec -f ou -k
-r prompt, --prompt=prompt si une version récente de less est utilisé comme pager, tente de définir son prompt et certaines options sensibles.
-7, --ascii Affiche en pure ascii(7)
-E encoding, --encoding=encoding Génère la sortie pour un jeu de caractères tel que UTF-8
--no-hyphenation, --nh Désactive la césure automatique
--no-justification, --nj Désactive la justification automatique
-p string, --preprocessor=string Spécifie la séquence de pré-processeurs à lancer avant nroff ou groff. ex: eqn (e), grap (g), pic (p), tbl (p), tbl (t), vgrind (v), refer (r). zsoelim est toujours lancé au tout début.
-t, --troff Utilise groff -mandoc pour formater la page de manuel.
-T[device], --troff-device[=device] Change la sortie de groff. implique -t. ex: dvi, latin1, ps, utf8, X75 et X100
-H[browser], --html[=browser] Force groff à produire une sortie HTML.
-X[dpi], --gxditview[=dpi] Affiche la sortie de groff en utilisant gxditview. dpi peut être 75, 75-12, 100 ou 100-12.
-Z, --ditroff Groff utilise un post-processeur pour produire une sortie utilisable pour le périphérique choisi.

Exemples

Affiche la page de manuel de ls
man ls
Affiche successivement, toutes les pages de manuel intro disponibles.
man -a intro
Formatte le manuel référencé par l'alias en format troff par défaut et le pipe dans une imprimante nommée ps
man -t alias | lpr -Pps
Décompress et formatte en dvi
man -l -Tdvi ./foo.1x.gz › ./foo.1x.dvi
Recherche la description courte et les noms de page de manuel pour le regex donné. (idem à apropos -r printf)
man -k printf
Recherche les pages de manuel référencés par smail et affiche les descriptions courtes. (idem à whatis -r smail)
man -f smail

Variables d'environnement

MANPATH Chemin de recherche pour les pages de manuel
MANROFFSEQ Détermine le jeu de préprocesseurs à utiliser
MANSECT Liste de sections dans lesquels rechercher et dans quel ordre.
MANPAGER Pager à utiliser (défaut: pager -s)
PAGER Pager à utiliser (défaut: pager -s)
MANLESS Avec less comme pager, copie cette valeur telle quelle dans $LESS
BROWSER Liste de commandes utilisées pour lancer un navigateur web.
SYSTEM Si le système a accès à des pages de manuel d'autres OS, permet de les inclure
MANOPT Parsé avant la ligne de commande pour des options spécifiques
MANWIDTH Longueur de ligne (défaut: 80)
MAN_KEEP_FORMATTING les caractères de formattage définis sont affichés.
MAN_KEEP_STDERR non vide, permet d'afficher les erreurs dans la sortie
LANG Utilisé pour rechercher les locales
LC_MESSAGES Utilisé pour rechercher les locales.

Fichiers

/etc/manpath.config Fichier de configuration de man-db
/usr/share/man Contient les manuels
/usr/share/man/index.(bt|db|dir|pag) DB cache pour l'index global.
/var/cache/man/index.(bt|db|dir|pag) DB cache pour l'index global. FHS compliant