WHATIS

NOMBRE
SINOPSIS
DESCRIPCIÃN
OPCIONES
ESTADO DE SALIDA
ENTORNO
FICHEROS
VÃASE TAMBIÃN
AUTOR
DEFECTOS

NOMBRE

whatis − muestra descripciones de una lÃnea de las pÃ¡ginas de manual

SINOPSIS

whatis [−dlv?V] [−r|−w] [−s lista] [−m sistema[,…]] [−M ruta] [−L localizaciÃ³n] [−C fichero] nombre …

DESCRIPCIÃN

Cada pÃ¡gina de manual despone de una descripciÃ³n breve. whatis busca nombres de pÃ¡gina de manual y muestra las descripciones de pÃ¡gina de cualquier nombre coincidente.

El nombre puede contener comodines (−w) o puede ser una expresiÃ³n regular (−r). Con estas opciones puede ser necesario entrecomillar el nombre o escapar () los caracteres especiales para impedir que la shell los interprete.

Durante la bÃºsqueda se utilizan bases de datos de Ãndices y el programa mandb las actualiza. Dependiendo de su instalaciÃ³n, esto lo ejecuta una tarea de cron periÃ³dica o puede ser que requiera ejecuciÃ³n manual despuÃ©s de instalar pÃ¡ginas de manual nuevas. Para generar un texto al viejo estilo de la base de datos de whatis desde la base de datos de Ãndices relativa, ejecute la orden:

whatis −M rutaman −w ’*’ | sort > rutaman/whatis

donde rutaman es una jerarquÃa de pÃ¡ginas de manual tal como /usr/man.

OPCIONES

−d, −−debug

Escribe informaciÃ³n de depuraciÃ³n.

−v, −−verbose

Escribe mensajes detallados de advertencia.

−r, −−regex

Interpreta cada nombre como una expresiÃ³n regular. Si un nombre coincide con cualquier parte de un nombre de pÃ¡gina, se da por satisfecha una coincidencia. Esta opciÃ³n ralentiza un poco whatis a causa de la naturaleza de las bÃºsquedas en base de datos.

−w, −−wildcard

Interpreta cada nombre como un patrÃ³n que contiene comodines de estilo shell. Para considerar una coincidencia, un nombre expandido debe coincidir con el nombre completo de pÃ¡gina. Esta opciÃ³n ralentiza un poco whatis a causa de la naturaleza de las bÃºsquedas en base de datos.

−l, −−long

No corta la salida a la anchura del terminal. Normalmente, la salida serÃ¡ truncada al ancho del terminal para evitar resultados indeseables de las secciones de NOMBRE pobremente escritas.

−s listado, −−sections=listado, −−section=listado

Busca solo las secciones del manual indicadas. listado es una lista de secciones separadas por dos puntos o por comas. Si una entrada en el listado es una secciÃ³n simple, por ejemplo “3”, entonces la lista de descripciones mostrada incluirÃ¡ pÃ¡ginas en las secciones “3”, “3perl”, “3x” y, asÃ, sucesivamente; mientras que si una entrada en el listado tiene una extensiÃ³n, por ejemplo, “3perl”, entonces la lista solo incluirÃ¡ pÃ¡ginas en esa precisa parte de la secciÃ³n del manual.

−m sistema[,…], −−systems=sistema[,…]

Si este sistema tiene acceso a otros nombres de pÃ¡gina de manual del sistema operativo, pueden ser accedidas utilizando esta opciÃ³n. Para buscar nombres de pÃ¡gina de manual del SOnuevo, utilice la opciÃ³n −m SOnuevo.

El sistema especificado puede ser una combinaciÃ³n de nombres de sistema operativo delimitados por comas. Para incluir una bÃºsqueda de los nombes de pÃ¡gina de manual del sistema operativo nativo, incluya el nombre del sistema man en la cadena del argumento. Esta opciÃ³n anula la variable de entorno $SYSTEM.

−M ruta, −−manpath=ruta

Especifica un conjunto alternativo de jerarquÃas de pÃ¡ginas de manual delimitadas por dos puntos (:) para bÃºsquedas. Por defecto, whatis utiliza la variable de entorno $MANPATH, a no ser que estÃ© vacÃa o no determinada, en cuyo caso determinarÃ¡ un manpath apropiado basado en su variable de entorno $PATH. Esta opciÃ³n anula el contenido de $MANPATH.

−L local, −−locale=local

whatis normalmente determinarÃ¡ su localizaciÃ³n actual mediante una llamada a la funciÃ³n C setlocale(3), la cual examina varias variables de entorno, posiblemente incluyendo $LC_MESSAGES y $LANG. Para anular temporalmente el valor determinado, utilice esta opciÃ³n para suministrar una cadena local directamente a whatis. NÃ³tese que no tendrÃ¡ efecto hasta que la bÃºsqueda de pÃ¡ginas realmente comience. Mensajes de salida como el de ayuda siempre se mostrarÃ¡n en la localizaciÃ³n determinada inicialmente.

−C fichero, −−config−file=fichero

Utilice este fichero de configuracion de usuario en lugar del predeterminado segÃºn ~/.manpath.

−?, −−help

Escribe un mensaje de ayuda y termina.

−−usage

Escribe mensaje breve sobre uso del programa y termina.

−V, −−version

Muestra informaciÃ³n sobre la versiÃ³n.

ESTADO DE SALIDA

	0		EjecuciÃ³n del programa correcta.
	1		Error de uso, de sintaxis o del fichero de configuraciÃ³n.
	2		Error operacional.
	16		No se ha encontrado nada que coincida con el criterio especificado.

ENTORNO

SYSTEM

Si se establece $SYSTEM, tendrÃ¡ el mismo efecto que si se hubiera especificado como el argumento de la opciÃ³n −m.

MANPATH

Si se establece $MANPATH, su valor se interpreta como la ruta de bÃºsqueda de jerarquÃa de pÃ¡ginas de manual delimitadas por dos puntos.

MANWIDTH

Si se establece $MANWIDTH, su valor se utiliza como la anchura del terminal (vea la opciÃ³n −−long). Si no estÃ¡ establecida, la anchura del terminal se calcularÃ¡ utilizando el valor de $COLUMNS y ioctl(2) o, en su defecto, se toman 80 caracteres si falla todo lo demÃ¡s.

FICHEROS

/usr/share/man/index.(bt|db|dir|pag)

/var/cache/man/index.(bt|db|dir|pag)

/usr/share/man/…/whatis

Una base de datos de texto whatis tradicional.

VÃASE TAMBIÃN

apropos(1), man(1), mandb(8)

AUTOR

Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).

DEFECTOS

https://savannah.nongnu.org/bugs/?group=man-db

Etiquetas: 1, es, whatis

Páginas de manual de GNU/Linux

WHATIS (es)