man - une interface vers les manuels de référence du système
SYNOPSIS
man [options man] [[section] page ...] ...
man -k [options apropos] regexp ...
man -K [options man] [section] terme ...
man -f [options whatis] page ...
man -l [options man] fichier ...
man -w|-W [options man] page ...
DESCRIPTION
man est le programme de pagination du système. Chaque argument de page donné à man est normalement le nom d'un programme, d'un utilitaire ou d'une fonction. La page de manuel associée à chacun de ces arguments est ensuite trouvée et affichée. Une section, si elle est fournie, indiquera à man de rechercher uniquement dans cette section du manuel. L'action par défaut est de rechercher dans toutes les sections disponibles en suivant un ordre prédéfini (voir DÉFAUTS), et d'afficher uniquement la première page trouvée, même si la page existe dans plusieurs sections.
Le tableau ci-dessous montre les numéros de section du manuel, suivis des types de pages qu'ils contiennent.
1 Programmes exécutables ou commandes shell
2 Appels système (fonctions fournies par le noyau)
3 Appels de bibliothèque (fonctions dans les bibliothèques de programmes)
4 Fichiers spéciaux (généralement trouvés dans /dev)
5 Formats de fichiers et conventions, par exemple /etc/passwd
6 Jeux
7 Divers (y compris les macros et les conventions), par exemple man(7), groff(7), man-pages(7) 8 Commandes d'administration système (généralement uniquement pour root) 9 Routines du noyau [Non standard]
Une page de manuel est composée de plusieurs sections.
Les noms de section conventionnels incluent NAME, SYNOPSIS, CONFIGURATION, DESCRIPTION, OPTIONS, EXIT STATUS, RETURN VALUE, ERRORS, ENVIRONMENT, FILES, VERSIONS, STANDARDS, NOTES, BUGS, EXAMPLE, AUTHORS et SEE ALSO.
Les conventions suivantes s'appliquent à la section SYNOPSIS et peuvent être utilisées comme guide dans d'autres sections.
texte en gras : tapez exactement comme indiqué.
texte en italique : remplacez par l'argument approprié.
[-abc] : tous ou partie des arguments entre [ ] sont facultatifs.
-a|-b : les options délimitées par | ne peuvent pas être utilisées ensemble.
argument ... : l'argument est répétable.
[expression] ... : toute l'expression entre [ ] est répétable.
Le rendu exact peut varier en fonction du périphérique de sortie. Par exemple, man ne pourra généralement pas rendre l'italique lorsqu'il s'exécute dans un terminal, et utilisera généralement du texte souligné ou coloré à la place.
L'illustration de la commande ou de la fonction est un modèle qui doit correspondre à tous les appels possibles. Dans certains cas, il est conseillé d'illustrer plusieurs appels exclusifs, comme indiqué dans la section SYNOPSIS de cette page de manuel.
EXEMPLES
man ls
Affiche la page de manuel pour l'élément (programme) ls.
man man.7
Affiche la page de manuel du paquet macro man de la section 7. (Il s'agit d'une orthographe alternative de "man 7 man".)
man 'man(7)'
Affiche la page de manuel du paquet macro man de la section 7. (Il s'agit d'une autre orthographe alternative de "man 7 man". Cela peut être plus pratique lors de la copie et du collage de références croisées vers des pages de manuel. Notez que les parenthèses doivent normalement être placées entre guillemets pour les protéger de l'interpréteur de commandes.)
man -a intro
Affiche successivement toutes les pages de manuel intro disponibles dans le manuel. Il est possible de quitter entre les affichages successifs ou d'ignorer l'une d'entre elles.
man -t bash | lpr -Pps
Met en forme la page de manuel de bash dans le format troff ou groff par défaut et la transmet au périphérique d'impression nommé ps. La sortie par défaut de groff est généralement PostScript. man --help devrait indiquer à quel processeur l'option -t est associée.
man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
Cette commande décompresse et met en forme la page de manuel nroff source ./foo.1x.gz dans un fichier indépendant du périphérique (dvi). La redirection est nécessaire car l'indicateur -T fait en sorte que la sortie soit dirigée vers stdout sans pagination. La sortie peut être visualisée avec un programme tel que xdvi ou traitée ultérieurement en PostScript à l'aide d'un programme tel que dvips.
man -k printf
Recherche les descriptions courtes et les noms des pages de manuel pour le mot-clé printf en tant qu'expression régulière. Affiche toutes les correspondances. Équivalent à apropos printf.
man -f smail
Recherche les pages de manuel référencées par smail et affiche les descriptions courtes de celles qui sont trouvées. Équivalent à whatis smail.
APERÇU
De nombreuses options sont disponibles dans man afin d'offrir autant de flexibilité que possible à l'utilisateur. Des modifications peuvent être apportées au chemin de recherche, à l'ordre des sections, au processeur de sortie et à d'autres comportements et opérations détaillés ci-dessous.
Si elles sont définies, diverses variables d'environnement sont interrogées pour déterminer le fonctionnement de man. Il est possible de définir la variable « catch-all » $MANOPT sur n'importe quelle chaîne au format de la ligne de commande, à l'exception que tous les espaces utilisés dans un argument d'option doivent être échappés (préfixés par une barre oblique inversée). man analysera $MANOPT avant d'analyser sa propre ligne de commande. Les options qui nécessitent un argument seront remplacées par les mêmes options trouvées dans la ligne de commande. Pour réinitialiser toutes les options définies dans $MANOPT, -D peut être spécifié en tant que première option de la ligne de commande. Cela permettra à man d'« oublier » les options spécifiées dans $MANOPT, bien qu'elles doivent encore être valides.
Les pages de manuel sont normalement stockées au format nroff(1) dans un répertoire tel que /usr/share/man. Dans certaines installations, il peut également y avoir des pages cat préformatées pour améliorer les performances. Voir manpath(5) pour plus de détails sur l'emplacement de ces fichiers.
Ce paquet prend en charge les pages de manuel dans plusieurs langues, contrôlées par vos paramètres régionaux. Si votre système ne l'a pas configuré automatiquement, vous devrez peut-être définir $LC_MESSAGES, $LANG ou une autre variable d'environnement dépendante du système pour indiquer vos paramètres régionaux préférés, généralement spécifiés dans le format POSIX :
<language>[_<territory>[.<character-set>[,<version>]]]
Si la page demandée est disponible dans votre langue, elle sera affichée à la place de la page standard (généralement en anglais américain).
Si vous constatez que les traductions fournies avec ce paquet ne sont pas disponibles dans votre langue maternelle et que vous souhaitez les fournir, veuillez contacter le responsable, qui coordonnera cette activité.
Les pages de manuel individuelles sont généralement écrites et maintenues par les responsables du programme, de la fonction ou de tout autre sujet qu'elles documentent, et ne sont pas incluses dans ce paquet. Si vous constatez qu'une page de manuel est manquante ou inadéquate, veuillez le signaler aux responsables du paquet en question.
Pour plus d'informations sur les autres fonctionnalités et extensions disponibles avec cette page de manuel, veuillez consulter les documents fournis avec le paquet.
VALEURS PAR DÉFAUT
L'ordre des sections à rechercher peut être remplacé par la variable d'environnement $MANSECT ou par la directive SECTION dans /etc/manpath.config. Par défaut, il est le suivant :
1n l 8 3 0 2 3type 3posix 3pm 3perl 3am 5 4 9 6 7
La page de manuel formatée est affichée à l'aide d'un paginateur. Cela peut être spécifié de plusieurs façons, ou il sera utilisé par défaut (voir l'option -P pour plus de détails).
Les filtres sont décodés par plusieurs moyens. Tout d'abord, l'option de ligne de commande -p ou la variable d'environnement $MANROFFSEQ est interrogée. Si -p n'a pas été utilisé et que la variable d'environnement n'a pas été définie, la première ligne du fichier nroff est analysée pour détecter une chaîne de préprocesseur. Pour contenir une chaîne de préprocesseur valide, la première ligne doit ressembler à :
'\" <chaîne>
où chaîne peut être n'importe quelle combinaison de lettres décrites par l'option -p ci-dessous.
Si aucune des méthodes ci-dessus ne fournit d'informations sur les filtres, un ensemble par défaut est utilisé.
Un pipeline de formatage est formé à partir des filtres et du formateur principal (nroff ou [tg]roff avec -t) et est exécuté. Alternativement, si un programme exécutable mandb_nfmt (ou mandb_tfmt avec -t) existe dans le répertoire racine de l'arborescence man, il est exécuté à la place. Il reçoit le fichier source du manuel, la chaîne de préprocesseur et éventuellement le périphérique spécifié avec -T ou -E en tant qu'arguments.
OPTIONS
Les options sans argument qui sont dupliquées soit sur la ligne de commande, soit dans $MANOPT, soit dans les deux, ne sont pas nuisibles. Pour les options qui nécessitent un argument, chaque duplication remplacera la valeur d'argument précédente.
Options générales
-C fichier, --config-file=fichier
Utilisez ce fichier de configuration utilisateur au lieu de la valeur par défaut \~/.manpath.
-d, --debug
Affiche les informations de débogage.
-D, --default
Cette option est généralement émise comme toute première option et réinitialise le comportement de man à sa valeur par défaut. Son but est de réinitialiser les options qui peuvent avoir été définies dans $MANOPT. Toutes les options qui suivent -D auront leur effet habituel.
--warnings[=warnings]
Active les avertissements de groff. Cela peut être utilisé pour effectuer des vérifications de cohérence sur le texte source des pages de manuel. `warnings` est une liste d’avertissements séparés par des virgules ; s’il n’est pas fourni, la valeur par défaut est « mac ». Pour désactiver un avertissement groff, préfixez-le avec un « ! » : par exemple,
`--warnings=mac,!break` active les avertissements de la catégorie « mac » et désactive les avertissements de la catégorie « break ». Voir le nœud « Warnings » dans info groff pour obtenir la liste des noms d’avertissement disponibles.
Modes d’opération principaux
-f, --whatis
Équivalent à `whatis`. Affiche une brève description de la page de manuel, si disponible. Voir `whatis(1)` pour plus de détails.
-k, --apropos
Équivalent à `apropos`. Recherche les brèves descriptions des pages de manuel pour trouver des mots-clés et affiche les correspondances. Voir `apropos(1)` pour plus de détails.
-K, --global-apropos
Recherche du texte dans toutes les pages de manuel. Il s’agit d’une recherche exhaustive, qui peut prendre un certain temps ; si possible, vous devez spécifier une section pour réduire le nombre de pages à rechercher. Les termes de recherche peuvent être des chaînes simples (par défaut) ou des expressions régulières si l’option `--regex` est utilisée.
Notez que cela recherche les sources des pages de manuel, et non le texte rendu, et peut donc inclure des faux positifs en raison de choses comme les commentaires dans les fichiers sources, ou de faux négatifs en raison de choses comme les tirets écrits sous la forme `\-"` dans les fichiers sources. La recherche dans le texte rendu serait beaucoup plus lente.
-l, --local-file
Active le mode « local ». Formate et affiche les fichiers de manuel locaux au lieu de rechercher dans la collection de manuels du système. Chaque argument de page de manuel sera interprété comme un fichier source nroff dans le format correct. Aucun fichier cat n’est produit. Si « - » est répertorié comme l’un des arguments, l’entrée sera prise à partir de l’entrée standard.
Si cette option n’est pas utilisée, `man` interprétera également les arguments des pages de manuel comme des noms de fichiers locaux si l’argument contient un caractère « / », car il s’agit d’une bonne indication que l’argument fait référence à un chemin sur le système de fichiers.
-w, --where, --path, --location
N’affiche pas réellement la page de manuel, mais affiche l’emplacement du fichier source nroff qui serait formaté. Si l’option `-a` est également utilisée, affiche les emplacements de tous les fichiers sources qui correspondent aux critères de recherche.
-W, --where-cat, --location-cat
N’affiche pas réellement la page de manuel, mais affiche l’emplacement du fichier cat préformaté qui serait affiché. Si l’option `-a` est également utilisée, affiche les emplacements de tous les fichiers cat préformatés qui correspondent aux critères de recherche.
Si `-w` et `-W` sont tous deux utilisés, affiche à la fois le fichier source et le fichier cat, séparés par un espace.
Si `-w`, `-W` et `-a` sont tous utilisés, effectuez cette opération pour chaque correspondance possible.
-c, --catman
Cette option n’est pas destinée à un usage général et ne doit être utilisée que par le programme `catman`.
-R encoding, --recode=encoding
Au lieu de formater la page de manuel de la manière habituelle, affiche sa source convertie dans l’encodage spécifié. Si vous connaissez déjà l’encodage du fichier source, vous pouvez également utiliser directement `manconv(1)`. Toutefois, cette option vous permet de convertir plusieurs pages de manuel dans un seul encodage sans avoir à spécifier explicitement l’encodage de chacune, à condition qu’elles aient déjà été installées dans une structure similaire à une hiérarchie de pages de manuel.
Envisagez plutôt d’utiliser man-recode(1) pour convertir plusieurs pages de manuel, car il possède une interface conçue pour la conversion en masse et peut donc être beaucoup plus rapide.
Recherche de pages de manuel
-L locale, --locale=locale
`man` détermine normalement votre locale actuelle en appelant la fonction C `setlocale(3)`, qui interroge diverses variables d’environnement, notamment `$LC_MESSAGES` et `$LANG`. Pour remplacer temporairement la valeur déterminée, utilisez cette option pour fournir directement une chaîne de locale à `man`. Notez que cela ne prendra effet que lorsque la recherche de pages commencera réellement. Les messages tels que le message d’aide seront toujours affichés dans la locale initialement déterminée.
-m système[,...], --systems=système[,...]
Si ce système a accès aux pages de manuel d’autres systèmes d’exploitation, elles peuvent être consultées en utilisant cette option. Pour rechercher une page de manuel de la collection de pages de manuel de NewOS, utilisez l’option -m NewOS.
Le système spécifié peut être une combinaison de noms de systèmes d’exploitation séparés par des virgules. Pour inclure une recherche des pages de manuel du système d’exploitation natif, incluez le nom du système man dans la chaîne d’arguments. Cette option remplacera la variable d’environnement $SYSTEM.
-M chemin, --manpath=chemin
Spécifiez un chemin manpath alternatif à utiliser. Par défaut, man utilise un code dérivé de manpath pour déterminer le chemin à rechercher. Cette option remplace la variable d’environnement $MANPATH et fait en sorte que l’option -m soit ignorée.
Un chemin spécifié en tant que manpath doit être la racine d’une hiérarchie de pages de manuel structurée en sections, comme décrit dans le manuel man-db (sous « Le système de pages de manuel »). Pour afficher des pages de manuel en dehors de ces hiérarchies, consultez l’option -l.
-S liste, -s liste, --sections=liste
La liste donnée est une liste de sections séparées par des deux-points ou des virgules, utilisée pour déterminer quelles sections de manuel rechercher et dans quel ordre. Cette option remplace la variable d’environnement $MANSECT. (L’orthographe -s est utilisée pour la compatibilité avec System V.)
-e sous-extension, --extension=sous-extension
Certains systèmes intègrent de grands ensembles de pages de manuel, tels que ceux qui accompagnent le paquet Tcl, dans la hiérarchie principale des pages de manuel. Pour résoudre le problème d’avoir deux pages de manuel portant le même nom, comme exit(3), les pages Tcl étaient généralement toutes affectées à la section l. Étant donné que ce n’est pas idéal, il est maintenant possible de placer les pages dans la section correcte et de leur attribuer une « extension » spécifique, dans ce cas, exit(3tcl). En fonctionnement normal, man affichera exit(3) de préférence à exit(3tcl). Pour gérer cette situation et éviter d’avoir à savoir dans quelle section se trouve la page que vous recherchez, il est maintenant possible de fournir à man une chaîne de sous-extension indiquant à quel paquet la page doit appartenir. En utilisant l’exemple ci-dessus, en fournissant l’option -e tcl à man, la recherche sera limitée aux pages ayant une extension de *tcl.
-i, --ignore-case
Ignore la casse lors de la recherche de pages de manuel. C'est le comportement par défaut.
-I, --match-case
Effectue une recherche de pages de manuel en respectant la casse.
--regex
Affiche toutes les pages dont le nom ou la description correspondent à chaque argument de page en tant qu'expression régulière, comme avec apropos(1). Étant donné qu'il n'existe généralement aucun moyen raisonnable de choisir la « meilleure » page lors de la recherche d'une expression régulière, cette option implique -a.
--wildcard
Affiche toutes les pages dont le nom ou la description correspondent à chaque argument de page à l'aide de caractères génériques de type shell, comme avec apropos(1) --wildcard. L'argument de page doit correspondre au nom ou à la description entière, ou correspondre aux limites de mots dans la description. Étant donné qu'il n'existe généralement aucun moyen raisonnable de choisir la « meilleure » page lors de la recherche d'un caractère générique, cette option implique -a.
--names-only
Si l'option --regex ou --wildcard est utilisée, effectue la correspondance uniquement sur les noms des pages, et non sur les descriptions des pages, comme le ferait whatis(1). Dans le cas contraire, aucun effet.
-a, --all
Par défaut, man se termine après avoir affiché la page de manuel la plus appropriée qu'elle trouve. L'utilisation de cette option force man à afficher toutes les pages de manuel dont les noms correspondent aux critères de recherche.
-u, --update
Cette option permet à man de mettre à jour ses caches de base de données des pages de manuel installées. Cela n'est nécessaire que dans de rares situations, et il est généralement préférable d'utiliser mandb(8) à la place.
--no-subpages
Par défaut, man tente d'interpréter les paires de noms de pages de manuel spécifiées sur la ligne de commande comme équivalentes à un seul nom de page de manuel contenant un tiret ou un soulignement. Cela prend en charge le modèle courant des programmes qui implémentent un certain nombre de sous-commandes, ce qui leur permet de fournir des pages de manuel pour chacune, accessibles à l'aide d'une syntaxe similaire à celle qui serait utilisée pour invoquer les sous-commandes elles-mêmes. Par exemple :
$ man -aw git diff
/usr/share/man/man1/git-diff.1.gz
Pour désactiver ce comportement, utilisez l'option --no-subpages.
$ 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ôle de la sortie formatée
-P pager, --pager=pager
Spécifie quel programme de pagination de sortie utiliser. Par défaut, man utilise pager, en utilisant cat si pager n'est pas trouvé ou n'est pas exécutable. Cette option remplace la variable d'environnement $MANPAGER, qui remplace à son tour la variable d'environnement $PAGER. Elle n'est pas utilisée en conjonction avec -f ou -k.
La valeur peut être un simple nom de commande ou une commande avec des arguments, et peut utiliser des guillemets shell (barres obliques inverses, guillemets simples ou guillemets doubles). Elle ne peut pas utiliser de tuyaux pour connecter plusieurs commandes ; si vous en avez besoin, utilisez un script d'enveloppement, qui peut prendre le fichier à afficher soit en tant qu'argument, soit sur l'entrée standard.
-r prompt, --prompt=prompt
Si une version récente de less est utilisée comme paginator, man tentera de définir son invite de commande et quelques options sensées. L'invite de commande par défaut ressemble à :
Nom de la page de manuel(section) ligne x
où `name` désigne le nom de la page de manuel, `sec` désigne la section dans laquelle elle a été trouvée et `x` désigne le numéro de ligne actuel. Ceci est réalisé en utilisant la variable d'environnement `$LESS`.
Fournir -r avec une chaîne remplacera cette valeur par défaut. La chaîne peut contenir le texte $MAN_PN qui sera étendu au nom de la page de manuel actuelle et à son nom de section, entourés de parenthèses. La chaîne utilisée pour produire la valeur par défaut pourrait être exprimée comme suit :
\ Page\ de\ manuel\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
(appuyez sur h pour obtenir de l'aide ou sur q pour quitter)
Elle est divisée en trois lignes ici uniquement pour des raisons de lisibilité. Pour sa signification, consultez la page de manuel less(1). La chaîne d'invite est d'abord évaluée par le shell. Toutes les guillemets doubles, les guillemets obliques et les barres obliques inversées dans l'invite doivent être précédés d'une barre oblique inversée. La chaîne d'invite peut se terminer par un signe dollar échappé, suivi d'options supplémentaires pour less. Par défaut, man définit les options -ix8.
La variable d'environnement $MANLESS décrite ci-dessous peut être utilisée pour définir une chaîne d'invite par défaut si aucune n'est fournie sur la ligne de commande.
-7, --ascii
Lorsqu'une page de manuel ASCII pure est affichée sur un terminal 7 bits ou un émulateur de terminal, certains caractères peuvent ne pas s'afficher correctement lors de l'utilisation de la description de périphérique latin1(7) avec GNU nroff. Cette option permet d'afficher les pages de manuel ASCII pures en ASCII avec le périphérique latin1. Elle ne traduira aucun texte latin1. Le tableau suivant montre les traductions effectuées : certaines de ces traductions ne peuvent être affichées correctement que lors de l'utilisation du périphérique latin1 de GNU nroff.
Description Octal latin1 ascii
tiret de continuation 255 ‐ point médian 267 • o
accent aigu 264 ´ '
signe de multiplication 327 × x
Si la colonne latin1 s'affiche correctement, votre terminal est peut-être configuré pour les caractères latin1 et cette option n'est pas nécessaire. Si les colonnes latin1 et ascii sont identiques, vous lisez cette page en utilisant cette option ou man n'a pas formaté cette page en utilisant la description de périphérique latin1. Si la colonne latin1 est manquante ou corrompue, vous devrez peut-être afficher les pages de manuel avec cette option.
Cette option est ignorée lors de l'utilisation des options -t, -H, -T ou -Z et peut être inutile pour n'importe quel autre nroff que celui de GNU.
-E encoding, --encoding=encoding
Générer une sortie pour un encodage de caractères autre que celui par défaut. Pour assurer la compatibilité avec les versions antérieures, encoding peut être un périphérique nroff tel que ascii, latin1 ou utf8, ainsi qu'un véritable encodage de caractères tel que UTF-8.
--no-hyphenation, --nh
Normalement, nroff effectuera automatiquement une coupure de mot aux fins de mise en page, même pour les mots qui ne contiennent pas de tirets, si cela est nécessaire pour disposer les mots sur une ligne sans espacement excessif. Cette option désactive la coupure automatique des mots, de sorte que les mots ne seront coupés que s’ils contiennent déjà des tirets.
Si vous rédigez une page de manuel et que vous souhaitez simplement empêcher nroff de couper un mot à un endroit inapproprié, n’utilisez pas cette option, mais consultez plutôt la documentation de nroff ; par exemple, vous pouvez placer « \ % » à l’intérieur d’un mot pour indiquer qu’il peut être coupé à cet endroit, ou placer « \ % » au début d’un mot pour empêcher sa coupure.
--no-justification, --nj
Normalement, nroff justifiera automatiquement le texte par rapport aux deux marges. Cette option désactive la justification complète, laissant le texte justifié uniquement par rapport à la marge gauche, ce qui est parfois appelé texte « dégagé à gauche ».
Si vous rédigez une page de manuel et que vous souhaitez simplement empêcher nroff de justifier certains paragraphes, n’utilisez pas cette option, mais consultez plutôt la documentation de nroff ; par exemple, vous pouvez utiliser les requêtes « .na », « .nf », « .fi » et « .ad » pour désactiver temporairement l’ajustement et le remplissage.
-p string, --preprocessor=string
Spécifiez la séquence des préprocesseurs à exécuter avant nroff ou troff/groff. Toutes les installations n’auront pas un ensemble complet de préprocesseurs. Certains des préprocesseurs et les lettres utilisées pour les désigner sont : eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Cette option remplace la variable d’environnement $MANROFFSEQ. zsoelim est toujours exécuté comme le tout premier préprocesseur.
-t, --troff
Utilisez groff -mandoc pour formater la page de manuel vers la sortie standard. Cette option n’est pas requise en conjonction avec -H, -T ou -Z.
-T[device], --troff-device[=device]
Cette option est utilisée pour modifier la sortie de groff (ou éventuellement de troff) afin qu’elle convienne à un périphérique autre que celui par défaut. Elle implique -t. Les exemples (à partir de groff 1.23.0) incluent : dvi, latin1, pdf, ps, utf8, X75 et X100.
-H[browser], --html[=browser]
Cette option fera en sorte que groff produise une sortie HTML et affichera cette sortie dans un navigateur Web. Le choix du navigateur est déterminé par l’argument de navigateur facultatif s’il est fourni, par la variable d’environnement $BROWSER ou par une valeur par défaut au moment de la compilation si celle-ci n’est pas définie (généralement lynx). Cette option implique -t et ne fonctionnera qu’avec GNU troff.
-X[dpi], --gxditview[=dpi]
Cette option affiche la sortie de groff dans une fenêtre graphique à l’aide du programme gxditview. Le dpi (points par pouce) peut être 75, 75-12, 100 ou 100-12, avec une valeur par défaut de 75 ; les variantes -12 utilisent une police de base de 12 points. Cette option implique -T avec les périphériques X75, X75-12, X100 ou X100-12 respectivement.
-Z, --ditroff
groff exécutera troff, puis utilisera un post-processeur approprié pour produire une sortie adaptée au périphérique choisi. Si groff -mandoc est groff, cette option est transmise à groff et supprimera l’utilisation d’un post-processeur. Elle implique -t.
Obtenir de l’aide
-?, --help
Affiche un message d’aide et quitte.
--usage
Affiche un bref message d’utilisation et quitte.
-V, --version
Affiche les informations de version.
CODE DE SORTIE
0 Exécution du programme réussie.
1 Erreur d’utilisation, de syntaxe ou de fichier de configuration.
2 Erreur opérationnelle.
3 Un processus enfant a renvoyé un code de sortie différent de zéro.
16 Au moins une des pages/fichiers/mots-clés n’existe pas ou n’a pas été trouvée.
ENVIRONNEMENT
MANPATH
Si $MANPATH est défini, sa valeur est utilisée comme chemin de recherche des pages de manuel.
Consultez la section « CHEMIN DE RECHERCHE » de manpath(5) pour connaître le comportement par défaut et les détails sur la façon dont cette variable d’environnement est gérée.
MANROFFOPT
Chaque fois que man invoque le formateur (nroff, troff ou groff), il ajoute le contenu de $MANROFFOPT à la ligne de commande du formateur.
Par exemple, MANROFFOPT=-P-i indique au formateur d’utiliser du texte en italique (ce qui n’est pris en charge que par certains terminaux) au lieu du texte souligné.
MANROFFSEQ
Si $MANROFFSEQ est défini, sa valeur est utilisée pour déterminer l’ensemble des préprocesseurs à transmettre à chaque page de manuel. La liste par défaut des préprocesseurs dépend du système.
MANSECT
Si $MANSECT est défini, sa valeur est une liste délimitée par des deux-points des sections et elle est utilisée pour déterminer les sections de manuel à rechercher et dans quel ordre. Par défaut, il s’agit de « 1 n l 8 3 0 2 3ype 3posix 3pm 3perl 3am 5 4 9 6 7 », sauf si cela est remplacé par la directive SECTION dans /etc/manpath.config.
MANPAGER, PAGER
Si $MANPAGER ou $PAGER est défini ($MANPAGER est utilisé en priorité), sa valeur est utilisée comme nom du programme utilisé pour afficher la page de manuel. Par défaut, pager est utilisé, puis cat si pager n’est pas trouvé ou n’est pas exécutable.
La valeur peut être un simple nom de commande ou une commande avec des arguments, et peut utiliser des guillemets shell (barres obliques inverses, guillemets simples ou guillemets doubles). Elle ne peut pas utiliser de tubes pour connecter plusieurs commandes ; si vous en avez besoin, utilisez un script d’enveloppement, qui peut prendre le fichier à afficher soit comme argument, soit sur l’entrée standard.
MANLESS
Si $MANLESS est défini, sa valeur sera utilisée comme chaîne de requête par défaut pour le programme moins, comme si elle avait été transmise à l’aide de l’option -r (de sorte que toutes les occurrences du texte $MAN_PN seront développées de la même manière). Par exemple, si vous souhaitez définir la chaîne de requête de manière inconditionnelle à « ma chaîne de requête », définissez $MANLESS sur « -Psma chaîne de requête ». L’utilisation de l’option -r remplace cette variable d’environnement.
BROWSER
Si $BROWSER est défini, sa valeur est une liste délimitée par des deux-points de commandes, chacune d’entre elles étant utilisée pour essayer de démarrer un navigateur Web pour man --html. Dans chaque commande, %s est remplacé par un nom de fichier contenant la sortie HTML de groff, %% est remplacé par un seul signe de pourcentage (%) et %c est remplacé par deux-points (:).
SYSTEM Si $SYSTEM est défini, il aura le même effet que si l'on l'avait spécifié comme argument de l'option -m.
MANOPT Si $MANOPT est défini, il sera analysé avant la ligne de commande de man et il est supposé qu'il sera dans un format similaire. Étant donné que toutes les autres variables d'environnement spécifiques à man peuvent être exprimées sous forme d'options de ligne de commande, et qu'elles sont donc des candidates à être incluses dans $MANOPT, il est prévu qu'elles deviendront obsolètes. Remarque : tous les espaces qui doivent être interprétés comme faisant partie de l'argument d'une option doivent être échappés.
MANWIDTH
Si $MANWIDTH est défini, sa valeur est utilisée comme longueur de ligne pour laquelle les pages de manuel doivent être formatées. Si elle n'est pas définie, les pages de manuel seront formatées avec une longueur de ligne appropriée au terminal actuel (en utilisant la valeur de $COLUMNS, et ioctl(2) si disponible, ou en revenant à 80 caractères si ni l'un ni l'autre n'est disponible). Les pages Cat ne seront enregistrées que lorsque le formatage par défaut peut être utilisé, c'est-à-dire lorsque la longueur de ligne du terminal est comprise entre 66 et 80 caractères.
MAN_KEEP_FORMATTING
Normalement, lorsque la sortie n'est pas dirigée vers un terminal (par exemple, vers un fichier ou un tube), les caractères de formatage sont supprimés afin de faciliter la lecture du résultat sans outils spéciaux. Cependant, si $MAN_KEEP_FORMATTING est défini sur une valeur non vide, ces caractères de formatage sont conservés. Cela peut être utile pour les programmes d'encapsulation autour de man qui peuvent interpréter les caractères de formatage.
MAN_KEEP_STDERR
Normalement, lorsque la sortie est dirigée vers un terminal (généralement vers un afficheur de pages), toute sortie d'erreur de la commande utilisée pour produire des versions formatées des pages de manuel est supprimée afin d'éviter d'interférer avec l'affichage de l'afficheur de pages. Les programmes tels que groff produisent souvent des messages d'erreur relativement mineurs concernant des problèmes typographiques tels que un mauvais alignement, qui sont disgracieux et généralement déroutants lorsqu'ils sont affichés avec la page de manuel. Cependant, certains utilisateurs souhaitent les voir de toute façon, de sorte que si $MAN_KEEP_STDERR est défini sur une valeur non vide, la sortie d'erreur sera affichée comme d'habitude.
MAN_DISABLE_SECCOMP
Sous Linux, man confine normalement les sous-processus qui gèrent des données non fiables à l'aide d'un bac à sable seccomp(2). Cela le rend plus sûr pour exécuter un code d'analyse complexe sur des pages de manuel arbitraires. Si cela ne fonctionne pas correctement pour une raison sans rapport avec le contenu de la page affichée, vous pouvez définir $MAN_DISABLE_SECCOMP sur une valeur non vide afin de désactiver le bac à sable.
PIPELINE_DEBUG
Si la variable d'environnement $PIPELINE_DEBUG est définie sur « 1 », man affichera des messages de débogage sur la sortie standard décrivant chaque sous-processus qu'il exécute.
LANG, LC_MESSAGES
En fonction du système et de l'implémentation, soit $LANG, soit $LC_MESSAGES (ou les deux) seront interrogés pour déterminer la locale de message actuelle. man affichera ses messages dans cette locale (si disponible). Voir setlocale(3) pour plus de détails.
FICHIERS
/etc/manpath.config
Fichier de configuration de man-db.
/usr/share/man
Hiérarchie globale des pages de manuel.
NORMES
POSIX.1-2001, POSIX.1-2008, POSIX.1-2017.
VOIR AUSSI
apropos(1), groff(1), less(1), manpath(1), nroff(1), troff(1), whatis(1), zsoelim(1), manpath(5), man(7), catman(8), mandb(8)
La documentation de certains paquets peut être disponible dans d’autres formats, tels que info(1) ou HTML.
HISTORIQUE
1990 1991 – Écrit à l’origine par John W. Eaton (_).
23 déc. 1992 : Rik Faith (_) a appliqué des corrections de bogues fournies par Willem Kasdorp (_).
30 avril 1994 – 23 février 2000 : Wilf. (_) a développé et maintenu ce paquet avec l’aide de quelques personnes dévouées.
30 oct. 1996 – 30 mars 2001 : Fabrizio Polacco <_> a maintenu et amélioré ce paquet pour le projet Debian, avec l’aide de toute la communauté.
31 mars 2001 – aujourd’hui : Colin Watson <_> développe et maintient désormais man-db.
BOGUES
https://gitlab.com/man-db/man-db/-/issues https://savannah.nongnu.org/bugs/?group=man-db