Localisation d'informations dans les pages de manuel

Vous pouvez rechercher des informations relatives aux commandes Oracle Solaris dans les pages de manuel à l'aide de la commande man. La nouvelle option -K (majuscule) mots-clés permet de rechercher les mots-clés spécifiés dans toutes les sections de l'ensemble des pages de manuel. L'option -k (minuscule) limite la recherche à la sous-section NAME de toutes les sections des pages de manuel.

Création de fichiers d'index pour permettre la recherche de mots-clés spécifiques dans les pages de manuel

Pour rechercher des informations dans les pages de manuel en spécifiant des mots-clés, commencez par créer des fichiers d'index pouvant être interrogés par la commande man. Vous pouvez utiliser l'utilitaire catman pour créer des versions préformatées du manuel de référence en ligne. Lorsqu'il est utilisé sans option, l'utilitaire catman génère des fichiers d'index des pages de manuel se trouvant dans les répertoires /usr/share/man et usr/gnu/share/man. Notez que vous devez être connecté en tant qu'utilisateur root pour utiliser l'utilitaire catman .

L'utilitaire catman inclut également une option -w. Cette option vous permet de créer un fichier d'index des pages de manuel dans les répertoires spécifiés par la variable MANPATH ou lorsque l'option -M est utilisée. L'option -M de l'utilitaire catman permet de spécifier un autre répertoire pour la création d'un fichier d'index de pages de manuel tierces. Par défaut, lorsqu'il est utilisé sans option, l'utilitaire catman crée un fichier d'index des pages de manuel qui se trouvent dans les répertoires /usr/share/man et /usr/gnu/share/man.

Pour spécifier un autre répertoire, saisissez la commande suivante :

# catman -M directory -w

Par exemple, pour créer un fichier d'index pour les pages de manuel du répertoire /usr/local/share/man, entrez la commande suivante :

# catman -M /usr/local/share/man -w

-M directory

Met à jour les pages de manuel se trouvant dans le répertoire spécifié, par défaut : /usr/share/man. Lorsque l'option -M est spécifiée, l'argument directory (répertoire) ne doit pas contenir de virgule (,) parce qu'une virgule est utilisée pour délimiter les numéros de section dans les pages de manuel.

-w

Crée un fichier d'index dans les répertoires spécifiés par la variable MANPATH ou à l'aide de l'option -M. Si la variable MANPATH ou l'option -M n'est pas spécifiée, des fichiers d'index sont créés pour les répertoires /usr/share/man/ et /usr/gnu/share/man.

Pour une description complète de l'utilitaire catman et de l'ensemble des options de ligne de commande pouvant être saisies, reportez-vous à la page de manuel catman(1M).

Recherche d'informations dans les pages de manuel à l'aide de mots-clés

Pour rechercher des informations dans les pages de manuel en spécifiant des mots-clés, créez un ou plusieurs fichiers d'index, à l'aide de l'utilitaire catman. Pour consulter les instructions, reportez-vous à la section Création de fichiers d'index pour permettre la recherche de mots-clés spécifiques dans les pages de manuel.

Pour effectuer une recherche d'informations en texte intégral à l'aide de mots-clés spécifiés dans l'ensemble des sections des pages de manuel, saisissez la commande man avec la nouvelle option -K keywords, comme suit :

$ man -K keywords

-K

Effectue une recherche de texte intégral des keywords (mots-clés) spécifiés dans l'ensemble des sections de la page de manuel.

keywords

Chaîne définie par l'utilisateur et spécifiée par lui. Pour spécifier plusieurs mots-clés dans une même recherche, utilisez des guillemets. Par exemple :

$ man -K "create zfs pool"

Pour rechercher uniquement des informations dans la sous-section NAME de l'ensemble des pages de manuel, saisissez la commande man avec l'option - k keywords comme suit :

$ man -k keywords

Pour rechercher des informations dans une sous-section donnée de l'ensemble des pages de manuel, ajoutez SECTNAME à la syntaxe de commande man - K keywords comme suit :

$ man -K SECTNAME:keywords

où SECTNAME peut être l'une des sous-sections suivantes de l'ensemble des sections des pages de manuel :

• ATTRIBUTES

• DESCRIPTION

• ENVIRONMENT VARIABLES

• EXAMPLES

• EXIT STATUS

• FILES

• LIST OF COMMANDS

• NAME

• NOTES

• NULL

• OPTIONS

• OPERANDS

• OUTPUT

• SECURITY

• SEE ALSO

• SYNOPSIS

• USAGE

Pour effectuer une recherche dans une section de page de manuel spécifique, utilisez l'option -s avec la commande man et l'option -k ou -K.

$ man -s manpage-section -K "keywords"

Par exemple, pour rechercher les mots-clés "cpu usage" dans la section de la page de manuel 1 M, saisissez la commande suivante :

$ man -s 1m -K "cpu usage"

Tenez compte des informations importantes suivantes relatives à la commande man :

• La syntaxe de commande utilisée pour la recherche de pages de manuel à l'aide de la commande man avec l'option -k ou - K ne tient pas compte de la casse.

• La commande man normalise les mots-clés avant d'effectuer une recherche. Cela signifie qu'une recherche d'un mot-clé spécifié génère également des résultats pour tous les termes incluant une partie de ce terme. Par exemple, si vous recherchez le terme "recherchant", les mots "recherche", "recherches" et "recherché" sont également inclus dans les résultats de la recherche.

Exemple 1-1 Recherche de commandes dans la sous-section NAME de l'ensemble des pages de manuel à l'aide de mots-clés

Dans l'exemple suivant, la commande man -k permet de rechercher des occurrences de la commande init dans la section NAME uniquement de toutes les pages de manuel :

$ man -k init
Searching in: /usr/man
Searching in: /usr/dt/man
Searching in: /usr/openwin/share/man
Searching in: /usr/sfw/man

1. init(1m)     "NAME"  /usr/share/man/man1m/init.1m
init, telinit - process control initialization


2. inittab(4)   "NAME"  /usr/share/man/man4/inittab.4
inittab - script for init


3. init.d(4)    "NAME"  /usr/share/man/man4/init.d.4
init.d - initialization and termination scripts for changing init states

Dans cet exemple, la sortie de la commande man -k affiche les résultats de la recherche pour la commande init dans la sous-section NAME uniquement de toutes les sections des pages de manuel. Notez que les pages de manuel contenant init dans leur nom sont également incluses dans les résultats de la recherche.

Exemple 1-2 Recherche de commandes dans toutes les sections des pages de manuel à l'aide de mots-clés

Dans l'exemple qui suit, la commande man -K keywords permet de rechercher des occurrences de la commande dumpadm dans toutes les sections des pages de manuel.

$ man -K dumpadm
Searching in: /usr/man
Searching in: /usr/dt/man
Searching in: /usr/openwin/share/man
Searching in: /usr/sfw/man

1. dumpadm(1m)  NAME    /usr/share/man/man1m/dumpadm.1m
dumpadm - configure operating system crash dump


2. savecore(1m) DESCRIPTION     /usr/share/man/man1m/savecore.1m
The savecore utility saves a crash dump of the kernel (assuming that one
was made) and writes a reboot message in the shutdown log. It is invoked
by the dumpadm service each time the system boots.


3. svccfg(1m)   EXAMPLES        /usr/sh

Dans cet exemple, la recherche renvoie trois occurrences de la commande dumpadm dans les pages de manuel :

• La première occurrence a été trouvée dans la sous-section NAME de la page de manuel dumpadm(1M).

• La deuxième occurrence a été trouvée dans la sous-section DESCRIPTION de la page de manuel savecore(1M).

• La troisième occurrence a été trouvée dans la sous-section EXAMPLES de la page de manuel svccfg(1M).

Sur la base des résultats de cette requête, l'utilisateur sait où les informations supplémentaires relatives à la commande dumpadm peuvent être trouvées dans l'ensemble des pages de manuel.

Exemple 1-3 Recherche de commandes dans des sous-sections de pages de manuel spécifiques à l'aide de mots-clés

Dans l'exemple suivant, la commande man -K est utilisée avec l'argument SECTNAME: keywords pour rechercher des occurrences de la commande bootadm dans la sous-section DESCRIPTION de l'ensemble des sections des pages de manuel.

$ man -K description:bootadm
Searching in: /usr/man
Searching in: /usr/dt/man
Searching in: /usr/openwin/share/man
Searching in: /usr/sfw/man

1. bootadm(1m)  DESCRIPTION     /usr/share/man/man1m/bootadm.1m
The bootadm command manages the boot archive and, with x86 boot environments,
the GRUB (GRand Unified Bootloader) menu. The update-archive option
provides a way for user to update the boot archive as a preventative
measure or as part of a


2. boot(1m)     DESCRIPTION     /usr/share/man/man1m/boot.1m
# bootadm update-archive

Dans cet exemple, la recherche renvoie deux occurrences de la commande bootadm dans la sous-section DESCRIPTION des sections suivantes des pages de manuel :

• La première occurrence a été trouvée dans la page de manuel bootadm(1M).

• La deuxième occurrence a été trouvée dans la page de manuel boot(1M).

Pour plus d'informations sur l'utilisation de la commande man, reportez-vous à la page de manuel man(1).