Localización de información en páginas del comando man

Puede buscar información sobre comandos de Oracle Solaris en las páginas del comando man mediante el comando man. La nueva opción -K (mayúscula) palabras clave le permite buscar palabras claves específicas en todas las secciones de todas las páginas del comando man. La opción -k (minúscula) está limitada sólo a la búsqueda en subsecciones NAME de todas las secciones de las páginas del comando man.

Creación de archivos de índice para permitir la búsqueda de palabras clave específicas en páginas del comando man

Para buscar información en las páginas del comando man especificando palabras clave, empiece por crear archivos de índice que puedan ser consultados por el comando man. Puede utilizar la utilidad catman para crear versiones formateadas previamente del manual de referencia en línea. Cuando se utiliza sin ninguna opción, la utilidad catman genera archivos de índice de las páginas del comando man que están en los directorios /usr/share/man y usr/gnu/share/man. Tenga en cuenta que debe ser el usuario root para utilizar la utilidad catman.

La utilidad catman también incluye una opción -w. Esta opción permite crear un archivo de índice de páginas del comando man en los directorios especificados por la variable MANPATH o cuando se utiliza la opción -M. Puede utilizar la opción -M de la utilidad catman para especificar un directorio alternativo para crear un archivo de índice de páginas del comando man de terceros. De manera predeterminada, cuando se utiliza sin ninguna opción, la utilidad catman crea un archivo de índice de páginas del comando man ubicadas en los directorios /usr/share/man y /usr/gnu/share/man.

Para especificar un directorio alternativo, escriba el siguiente comando:

# catman -M directory -w

Por ejemplo, para crear un archivo de índice para páginas del comando man ubicadas en el directorio /usr/local/share/man debería escribir el siguiente comando:

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

-M directorio

Actualiza las páginas del comando man que se encuentran en el directorio especificado, que es /usr/share/man de manera predeterminada. Si se especifica la opción -M, el argumento de directorio no debe contener una coma (,) porque la coma se utiliza para delinear números de secciones en páginas del comando man.

-w

Crea un archivo de índice en los directorios especificados por la variable MANPATH o con la opción -M. Si la variable MANPATH o la opción -M no se especifican, se crean archivos de índice para los directorios /usr/share/man/ y /usr/gnu/share/man.

Para obtener una descripción completa de la utilidad catman, incluidas todas las opciones de línea de comandos que puede especificar, consulte la página del comando man catman(1M).

Búsqueda de información en las páginas del comando man especificando palabras clave

Para buscar información en las páginas del comando man especificando palabras clave, cree un archivo de índice o archivos mediante la utilidad catman. Para obtener instrucciones, consulte Creación de archivos de índice para permitir la búsqueda de palabras clave específicas en páginas del comando man.

Para llevar a cabo una búsqueda de texto completo para obtener información en todas las secciones de las páginas del comando man mediante la especificación de palabras clave, escriba el comando man con la nueva opción -K palabras clave, como se indica a continuación:

$ man -K keywords

-K

Lleva a cabo una búsqueda de texto completo de las palabras clave especificadas en todas las secciones de las páginas del comando man.

palabras clave

Es una cadena definida por el usuario que está especificada. Para especificar varias palabras clave en una única búsqueda, utilice comillas dobles. Por ejemplo:

$ man -K "create zfs pool"

Para buscar información en sólo la subsección NAME de todas las páginas del comando man, escriba el comando man con la opción -k palabras clave, de la siguiente manera:

$ man -k keywords

Para buscar información en una subsección determinada de todas las páginas del comando man, incluya NOMBRE_SECCIÓN en la sintaxis del comando man -K palabras clave, como se indica a continuación:

$ man -K SECTNAME:keywords

Donde NOMBRE_SECCIÓN puede ser cualquiera de las siguientes subsecciones de todas las secciones de páginas del comando man.

• ATTRIBUTES

• DESCRIPTION

• ENVIRONMENT VARIABLES

• EXAMPLES

• EXIT STATUS

• FILES

• LIST OF COMMANDS

• NAME

• NOTES

• NULL

• OPTIONS

• OPERANDS

• OUTPUT

• SECURITY

• SEE ALSO

• SYNOPSIS

• USAGE

Para buscar una sección específica de página del comando man, utilice la opción -s con el comando man y la opción -k o -K.

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

Por ejemplo, para buscar las palabras clave "uso de cpu" en la sección de página del comando man 1M, debería escribir el siguiente comando:

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

Tenga en cuenta la siguiente información clave adicional sobre el comando man:

• La sintaxis de comando que se utiliza para buscar en páginas del comando man mediante el comando man con la opción -k o -K no distingue mayúsculas de minúsculas.

• El comando man normaliza las palabras clave antes de realizar una búsqueda, lo que significa que una consulta de una palabra clave especificada también genera resultados de todas las palabras que incluyen parte de esa palabra. Por ejemplo, si se consulta la palabra "búsqueda", las palabras "buscar", "búsquedas" y "buscado" también se incluyen en los resultados de la búsqueda.

Ejemplo 1-1 Búsqueda de comandos en la subsección NAME de todas las páginas del comando man mediante palabras clave

En el siguiente ejemplo, el comando man -k se utiliza para buscar instancias del comando init en la sección NAME de sólo todas las páginas del comando man:

$ 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

En este ejemplo, la salida del comando man -k muestra los resultados de búsqueda para el comando init en la subsección NAME de sólo todas las secciones de páginas del comando man. Tenga en cuenta que cualquier página del comando man que contiene init en su nombre también se incluye en los resultados de búsqueda.

Ejemplo 1-2 Búsqueda de comandos en todas las secciones de páginas del comando man mediante palabras clave

En el ejemplo siguiente, el comando man -K palabras clave se utiliza para buscar instancias del comando dumpadm en todas las secciones de páginas del comando man.

$ 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

En este ejemplo, la búsqueda devuelve tres instancias del comando dumpadm en las páginas del comando man:

• La primera instancia se encontró en la subsección NAME de la página del comando man dumpadm(1M).

• La segunda instancia se encontró en la subsección DESCRIPTION de la página del comando man savecore(1M).

• La tercera instancia se encontró en la subsección EXAMPLES de la página del comando man svccfg(1M).

En función de los resultados de esta consulta, el usuario sabe dónde se puede encontrar información adicional sobre el comando dumpadm en todas las páginas del comando man.

Ejemplo 1-3 Búsqueda de comandos en subsecciones de páginas del comando man específicas mediante palabras clave

En el siguiente ejemplo, el comando man -K se utiliza con el argumento NOMBRE_SECCIÓN:palabras clave para buscar instancias del comando bootadm en la subsección DESCRIPTION de todas las secciones de páginas del comando man.

$ 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

En este ejemplo, la búsqueda devuelve dos instancias del comando bootadm en la subsección DESCRIPTION de las siguiente secciones de páginas del comando man:

• La primera instancia se encontró en la página del comando man bootadm(1M).

• La segunda instancia se encontró en la página del comando man boot(1M).

Para obtener más información acerca del uso del comando man, consulte la página del comando man man(1).