Man formatea y muestra las páginas del manual en línea. Si especifica sección, man sólo busca en esa sección del manual. Nombre es normalmente el nombre de la página de manual, que es típicamente el nombre de un comando, función o archivo. Sin embargo, si name contiene una barra ( / ) entonces man lo interpreta como una especificación de archivo para que pueda hacer man./foo.5 o incluso man /cd/foo/bar.1.gz . Vea a continuación una descripción de dónde man busca los archivos de página del manual.

Nombre

man – formatear y mostrar las páginas del manual en líneamanpath – determina la ruta de búsqueda del usuario para las páginas man

Sinopsis

man [ -acdfFhkKtwW ] [ –path ] [ -m system] [ -p string] [ -] (tagC config_file] [ -M pathlist] [ -P pager] [ -S section_list] [ section] section_14) nombre .

Opciones

-C archivo_de_configuración

Especifique el archivo de configuración que desea utilizar; el valor predeterminado es /etc/man.config [Ver man.conf (5)].

-Ruta M

Especifique la lista de directorios para buscar páginas man. Separe los directorios con dos puntos. Una lista vacía es lo mismo que no especificar -M en absoluto. Ver BUSCAR PÁGINAS MANUALES .

-P localizador

Especifique el buscapersonas que desea utilizar. Esta opción anula la variable de entorno MANPAGER , que a su vez anula la variable PAGER . Por defecto, man usa /usr/bin/less -isr .

-S lista_de_sección

Lista es una lista de secciones manuales separadas por dos puntos para buscar. Esta opción anula la variable de entorno MANSECT .

-a

Por defecto, man saldrá después de mostrar la primera página del manual que encuentre. Usando esta opción fuerza man a mostrar todas las páginas de manual que coinciden con el nombre , no sólo con el primero.

-c

Vuelva a formatear la página de manual de origen, incluso cuando exista una página de gato actualizada. Esto puede ser significativo si la página del gato fue formateada para una pantalla con un número diferente de columnas, o si la página preformateada está dañada.

-d

En realidad, no muestre las páginas de manual, pero sí imprima una gran cantidad de información de depuración.

-D

Muestra e imprime información de depuración.

-f

Equivalente a whatis .

-F o –preformato

Sólo formato – no mostrar.

-h

Imprima un mensaje de ayuda de una línea y salga.

-k

Equivalente a apropos .

-K

Busque la cadena especificada en *todas* las páginas de manual. Advertencia : ¡esto es probablemente muy lento! Ayuda a especificar una sección. (Para dar una idea aproximada, en mi máquina esto toma alrededor de un minuto por cada 500 páginas de manual.)

-m sistema

Especifique un conjunto alternativo de páginas de manual para buscar en función del nombre del sistema asignado.

-p string

Especifique la secuencia de preprocesadores que se ejecutarán antes de nroff o troff . No todas las instalaciones tendrán un conjunto completo de preprocesadores. Algunos de los preprocesadores y las letras utilizadas para designarlos son: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Esta opción anula la variable de entorno MANROFFSEQ .

-t

Utilice /usr/bin/groff -Tps -mandoc para formatear la página de manual, pasando la salida a stdout. La salida de /usr/bin/groff -Tps -mandoc puede que tenga que pasar por algún filtro antes de ser impresa.

-w o –path

No muestre las páginas de manual, pero sí imprima la(s) ubicación(es) de los archivos que se formatearán o mostrarán. Si no se da ningún argumento: muestra (en stdout) la lista de directorios que son buscados por man para las páginas man. Si manpath es un enlace al hombre, entonces «manpath» es equivalente a «man –path».

-W

Como -w, pero imprime los nombres de los archivos uno por línea, sin información adicional. Esto es útil en comandos shell como man -aW man | xargs ls -l

Páginas CAT

Man intentará guardar las páginas de manual formateadas, para ahorrar tiempo de formateo la próxima vez que se necesiten estas páginas. Tradicionalmente, las versiones formateadas de las páginas en DIR/manX se guardan en DIR/catX, pero otras asignaciones de man dir a cat dir se pueden especificar en /etc/man.config . No se guardan páginas de gato cuando no existe el directorio de gato requerido. No se guardan páginas de gato cuando están formateadas para una longitud de línea diferente de 80. No se guardan páginas de gatos cuando man.conf contiene la línea NOCACHE.

Es posible hacer que man suid a un usuario man. Entonces, si un directorio cat tiene owner man y modo 0755 (sólo escribible por man), y los archivos cat tienen owner man y modo 0644 o 0444 (sólo escribible por man, o no escribible en absoluto), ningún usuario normal puede cambiar las páginas cat o poner otros archivos en el directorio cat. Si man no se hace suid, entonces un directorio cat debería tener el modo 0777 si todos los usuarios deberían poder dejar las páginas cat allí.

La opción -c obliga a reformatear una página, incluso si existe una página reciente del gato.

Ruta de búsqueda de páginas manuales

man utiliza un sofisticado método de búsqueda de archivos de página manuales, basado en las opciones de invocación y las variables de entorno, el archivo de configuración /etc/man.config , y algunas convenciones y heurísticas incorporadas.

En primer lugar, cuando el argumento name a man contiene una barra ( / ), man asume que se trata de una especificación de archivo en sí misma, y que no hay búsquedas involucradas.

Pero en el caso normal donde name no contiene una barra oblicua, man busca en una variedad de directorios un archivo que podría ser una página de manual para el tema nombrado.

Si especifica la opción -M pathlist, pathlist es una lista separada por dos puntos de los directorios que busca man .

Si no especifica -M pero establece la variable de entorno MANPATH , el valor de esa variable es la lista de los directorios que busca man .

Si no especifica una lista de rutas explícitas con -M o MANPATH , man desarrolla su propia lista de rutas basada en el contenido del archivo de configuración /etc/man.config . Las sentencias MANPATH en el archivo de configuración identifican los directorios particulares a incluir en la ruta de búsqueda.

Además, las sentencias MANPATH_MAP se añaden a la ruta de búsqueda dependiendo de su ruta de búsqueda de comandos (es decir, su variable de entorno PATH ). Para cada directorio que puede estar en la ruta de búsqueda del comando, una sentencia MANPATH_MAP especifica un directorio que debe añadirse a la ruta de búsqueda para los archivos de página manuales. man mira la variable PATH y añade los directorios correspondientes a la ruta de búsqueda del archivo de página manual. Así, con el uso correcto de MANPATH_MAP , cuando se emite el comando man xyz , se obtiene una página de manual para el programa que se ejecutaría si se emitiera el comando xyz .

Además, para cada directorio en la ruta de búsqueda de comandos (lo llamaremos «directorio de comandos») para el cual usted tiene not una declaración MANPATH_MAP , man busca automáticamente un directorio de página manual «cercano», es decir, como un subdirectorio en el propio directorio de comandos o en el directorio principal del directorio de comandos.

Puede desactivar las búsquedas automáticas «cercanas» incluyendo una sentencia NOAUTOPATH en /etc/man.config .

En cada directorio de la ruta de búsqueda como se describe anteriormente, man busca un archivo llamado topic . section, con un sufijo opcional en el número de sección y posiblemente un sufijo de compresión. Si no encuentra tal archivo, busca en cualquier subdirectorio llamado man N o cat N donde N es el número de sección manual. Si el archivo está en un subdirectorio cat N, man asume que es un archivo de página de manual formateado (cat page). De lo contrario, man asume que no tiene formato. En cualquier caso, si el nombre de archivo tiene un sufijo de compresión conocido (como .gz ), man asume que es gzipped.

Si desea ver dónde (o si) man encontraría la página de manual para un tema en particular, use la opción –path ( -w ).

Utilice el comando man ( % man) para ver cómo se utiliza un comando en su equipo particular.