Opciones generales¶

-C archivo, --config-file=archivo

Use this user configuration file rather than the default of ~/.manpath.

-d, --debug

Escribe información de depuración.

-D, --default

Esta opción, generalmente la primera de todas, restablece el comportamiento predefinido de man. Se utiliza para restablecer aquellas opciones que pueden haber sido establecidas en $MANOPT. Cualquier opción que siga a -D producirá su efecto habitual.

--warnings[=advertencias]

Enable warnings from groff. This may be used to perform sanity checks on the source text of manual pages. warnings is a comma-separated list of warning names; if it is not supplied, the default is "mac". To disable a groff warning, prefix it with "!": for example, --warnings=mac,!break enables warnings in the "mac" category and disables warnings in the "break" category. See the “Warnings” node in info groff for a list of available warning names.

Modos principales de operación¶

-f, --whatis

Approximately equivalent to whatis. Display a short description from the manual page, if available. See whatis(1) for details.

-k, --apropos

Approximately equivalent to apropos. Search the short manual page descriptions for keywords and display any matches. See apropos(1) for details.

-K, --global-apropos

Buscar texto en todas las páginas de manual. Esta es una búsqueda de fuerza bruta, y es probable que tarde un poco; si puede, debería especificar una sección para reducir el número de páginas en las cuales buscar. Los términos buscados pueden ser cadenas simples (lo predeterminado) o expresiones regulares si se utiliza la opción --regex.

Note that this searches the sources of the manual pages, not the rendered text, and so may include false positives due to things like comments in source files, or false negatives due to things like hyphens being written as "\-" in source files. Searching the rendered text would be much slower.

-l, --local-file

Activate "local" mode. Format and display local manual files instead of searching through the system's manual collection. Each manual page argument will be interpreted as an nroff source file in the correct format. No cat file is produced. If '-' is listed as one of the arguments, input will be taken from stdin.

If this option is not used, then man will also fall back to interpreting manual page arguments as local file names if the argument contains a "/" character, since that is a good indication that the argument refers to a path on the file system.

-w, --where, --path, --location

No muestra realmente la página de manual, sino que imprime la ubicación del archivo fuente nroff que se formatearía. Si también se utiliza la opción -a, entonces imprime las ubicaciones de todos los archivos fuente que coinciden con los criterios de búsqueda.

-W, --where-cat, --location-cat

No muestra realmente la página de manual, sino que imprime la ubicación del archivo cat preformateado que se mostraría. Si también se utiliza la opción -a, entonces imprime las ubicaciones de todos los archivos cat preformateados que coinciden con los criterios de búsqueda.

Si se utilizan tanto -w como -W, entonces imprime tanto el archivo fuente como el archivo cat separados por un espacio. Si se utilizan todas las opciones -w, -W y -a, entonces hace esto para cada posible coincidencia.

-c, --catman

Esta opción no es para utilización general y solo debería utilizarla el programa catman.

-R codificación, --recode=codificación

En vez de formatear la página de manual del modo habitual, saca su fuente convertida a la codificación especificada. Si ya sabe la codificación del archivo fuente, también puede utilizar manconv(1) directamente. Sin embargo, esta opción permite convertir varias páginas de manual a una codificación única sin necesidad de explicitar la codificación de cada una, siempre que estuvieran ya instaladas en una estructura similar a la jerarquía de página del manual.

Valore la alternativa de utilizar man-recode(1) para convertir varias páginas de manual, ya que dispone de una interfaz para conversión en masa que puede ser mucho más rápida.

Encontrando páginas de manual¶

-L local, --locale=local

man 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 man. 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.

-m sistema[,...], --systems=sistema[,...]

Si este sistema tiene acceso a las páginas de manual de otro sistema operativo, pueden consultarse utilizando esta opción. Para buscar una página de manual desde la colección de páginas de manual del SOnuevo, utilice la opción -m SOnuevo.

El sistema especificado puede ser una combinación de nombres de sistemas operativos delimitados por comas. Para incluir una búsqueda de las páginas de manual del sistema operativo nativo, incluya el nombre del sistema man en la cadena de argumentos. Esta opción anulará la variable de entorno $SYSTEM.

-M ruta, --manpath=ruta

Especifica una ruta de man alternativa. Por defecto, man utiliza código derivado de %manpath para determinar la ruta a buscar. Esta opción anula la variable de entorno $MANPATH y provoca que se descarte la opción -m.

Una ruta especificada como un manpath debe ser la raíz de una jerarquía de página man estructurada en secciones como se describe en el manual de man-db (en «El sistema de páginas de manual»). Para ver páginas del manual fuera de tales jerarquías, véase la opción -l.

-S listado, -s listado, --sections=listado

La lista dada es una lista de secciones separadas por dos puntos o por comas, que se utiliza para determinar qué secciones del manual buscar y en qué orden. Esta opción anula la variable de entorno $MANSECT. (La ortografía -s está para compatibilidad con System V.)

-e sub-extensión, --extension=sub-extensión

Algunos sistemas incorporan paquetes grandes de páginas de manual, como aquellas que acompañan al paquete Tcl, dentro de la jerarquía de páginas del manual principal. Para solucionar el problema de tener dos páginas del manual con el mismo nombre, como exit(3), las páginas de Tcl habitualmente se asignaban a la sección I. Como esa era una idea poco afortunada, ahora pueden ponerse las páginas en la sección correcta y asignarles una «extensión» propia, en este caso, exit(3tcl). Normalmente, man mostrará exit(3) preferentemente, no exit(3tcl). Para negociar esta situación y evitar tener que saber en qué sección reside la página requerida, ahora se le puede dar a man una cadena de sub-extensión que indique a qué paquete debe pertenecer la página. Utilizando el ejemplo anterior, suministrar la opción -e tcl a man restringirá la búsqueda a páginas que tengan una extensión *tcl.

-i, --ignore-case

No distingue mayúsculas y minúsculas cuando busque páginas de manual. Esto es lo predeterminado.

-I, --match-case

Busca páginas de manual distinguiendo mayúsculas y minúsculas.

--regex

Muestra todas las páginas en las que alguna parte de los nombres o las descripciones coincida con cada argumento de página como expresión regular, tal como apropos(1). Como no suele haber ninguna forma razonable de tomar la «mejor» página cuando se busca una expresión regular, esta opción implica -a.

--wildcard

Muestra todas las páginas en las que alguna parte de los nombres o las descripciones coincida con cada argumento de página con comodines como los de la shell, tal como apropos(1) --wildcard. El argumento de página debe coincidir con el nombre o la descripción en su totalidad o coincidir con los límites de palabra en la descripción. Como no suele haber ninguna forma razonable de tomar la «mejor» página cuando se busca un comodín, esta opción implica -a.

--names-only

Si se utiliza la opción --regex o --wildcard, solo intenta conicidencias con los nombres de página, no con las descripciones de página, tal como con whatis(1). En caso contrario, no tiene efecto.

-a, --all

El comportamiento predeterminado es que man termine tras mostrar la página de manual más adecuada que encuentra. Esta opción provoca que man muestre todas las páginas del manual con nombres que coincidan con los criterios de búsqueda.

-u, --update

Esta opción provoca que man actualice sus cachés de base de datos de las páginas de manual instaladas. Rara vez es necesario hacer eso, por lo que normalmente es preferible ejecutar mandb(8).

--no-subpages

Por omisión, man intenta interpretar los pares de nombres de páginas de manual dados en la línea de órdenes como equivalentes a una página de manual simple que contenga un guión o un subrayado. Se admiten los patrones habituales de programas que implementan varias subórdenes, permitiéndoles proporcionar páginas de manual para cada una a la que se pueda acceder utilizando una sintaxis similar a la que se utilizaría para invocar a las propias subórdenes. Por ejemplo:

  $ man -aw git diff
  /usr/share/man/man1/git-diff.1.gz

Para desactivar este comportamiento, utilice la opción --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

Controlando salida formateada¶

-P paginador, --pager=paginador

Especifica el paginador de salida que se va a utilizar. Por defecto, man utiliza pager, retrotrayéndose a cat si pager no se encuentra o no es ejecutable. Esta opción anula la variable de entorno $MANPAGER, la cual, a su vez, anula la variable de entorno $PAGER. No se emplea a la vez que -f o -k.

El valor puede ser un nombre de orden simple o una orden con argumentos y puede utilizar entrecomillado de shell (barra inclinada hacia atrás, comillas sencillas o comillas dobles). No pueden utilizar tuberías para conectar varias órdenes; si hicera falta, utilice un script que coja el archivo que hay que mostrar de un argumento o de la entrada estándar.

-r prompt, --prompt=prompt

Si se emplea como paginador una versión reciente de less, man tratará de establecer su indicador y algunas opciones razonables. El indicador predeterminado se parece a

Página de manual nombre(sec) línea x

donde nombre denota el nombre de la página de manual, sec denota la sección en la que se ha encontrado y x el número de línea actual. Esto se consigue utilizando la variable de entorno $LESS.

Suministrar -r con una cadena anula esta configuración predefinida. La cadena puede contener el texto $MAN_PN que será expandido al nombre de la página actual de manual y su nombre de sección entre "(" y ")". La cadena utilizada para generar la configuración predefinida puede expresarse como

\ Página\ del\ Manual\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (FINAL):?pB\ %pB\\%..
(pulse h para ayuda o q para salir)

Está partido en tres líneas aquí solo para facilitar la lectura. Para su significado véase la página de manual de less(1). La cadena del indicador primero la evalúa la shell. Todas las comillas dobles, comillas traseras y barras inclinadas hacia atrás en el indicador deben ser escapadas anteponiendo una barra inclinada hacia atrás. La cadena del indicador puede terminar en un $ escapado que puede ir seguido por más opciones para less. Por omisión, man establece las opciones -ix8.

La variable de entorno $MANLESS descrita abajo puede utilizarse para establecer una cadena del indicador predeterminada si no se suministra ninguna en la línea de órdenes.

-7, --ascii

Cuando se vea una página de manual en ascii(7) puro en un terminal de 7 bits o en un emulador de terminal, algunos caracteres podrían no mostrarse correctamente cuando se utiliza la descripción de dispositivo latin1(7) con GNU nroff. Esta opción permite mostrar en ascii páginas puras en ascii con el dispositivo latin1. No traduce ningún texto latin1. La tabla siguiente muestra las traducciones realizadas: algunas de sus partes podrían no mostrarse apropiadamente cuando se utiliza un dispositivo latin1(7) de GNU nroff.

Descripción	Octal	latin1	ascii
guión de continuación	255	‐	-
viñeta (punto medio)	267	•	o
tilde	264	´	'
signo de multiplicar	327	×	x

Si la columna latin1 se muestra correctamente, su terminal podría estar configurado para caracteres latin1 y esta opción no es necesaria. Si las columnas latin1 y ascii son idénticas, está leyendo esta página utilizando esta opción o man no formateó esta página utilizando la descripción de dispositivo latin1. Si la columna latin1 falta o está corrupta, podría ser que necesitase ver las páginas de manual con esta opción.

Se hace caso omiso de esta opción cuando se utilizan las opciones -t, -H, -T o -Z y podría ser inservible con un nroff que no sea el de GNU.

-E codificación, --encoding=codificación

Genera salida para una codificación de caracteres distinta de la predeterminada. Por compatibilidad hacia atrás, la codificación puede ser un dispositivo nroff tal como ascii, latin1 o utf8 así como una codificación de caracteres verdadera como UTF-8.

--no-hyphenation, --nh

Normalmente, nroff parte el texto con guiones automáticamente en los saltos de línea incluso en palabras que no contienen guiones, si es necesario hacerlo para disponer las palabras en una línea sin espaciado excesivo. Esta opción desactiva los guiones automáticos, por lo que las palabras solo serán partidas con guiones si ya tienen guiones.

Si está escribiendo una página de manual y simplemente quiere impedir que nroff parta palabras por medio de guiones en un punto inapropiado, no debe utilizar esta opción, sino consultar la documentación de nroff; por ejemplo, puede poner "\%" dentro de una palabra para indicar que puede entregionarse en ese punto, o "\%" al principio de una palabra para impedirlo.

--no-justification, --nj

Normalmente, nroff justifica automáticamente el texto en ambos márgenes. Esta opción desactiva la justificación completa, dejando justificado solo al margen izquierdo, algunas veces llamado texto «irregular por la derecha».

Si está escribiendo una página de manual y simplemente quiere impedir que nroff justifique cierto párrafo, no utilice esta opción; es mejor que consulte la documentación de nroff; por ejemplo, puede utilizar las peticiones de ".na", ".nf", ".fi" y ".ad" para desactivar temporalmente los ajustes y rellenos.

-p cadena, --preprocessor=cadena

Especifica la secuencia de preprocesadores para ejecutar antes que nroff o troff/groff. 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. zsoelim siempre se ejecuta como el primer preprocesador.

-t, --troff

Utilice groff -mandoc para dar formato a la página de manual hacia la salida estándar. Esta opción no se requiere en conjucnión con -H, -T o -Z.

-T[dispositivo], --troff-device[=dispositivo]

This option is used to change groff (or possibly troff's) output to be suitable for a device other than the default. It implies -t. Examples (as of groff 1.23.0) include dvi, latin1, pdf, ps, utf8, X75 and X100.

-H[navegador], --html[=navegador]

Esta opción hace que groff produzca salida HTML y muestre esa salida en un navegador web. La elección del navegador está determinada por el argumento opcional navegador si se proporciona, por la variable de entorno $BROWSER o por uno predefinido en tiempo de compilación si aquella se ha anulado (habitualmente lynx). Esta opción implica -t y solo funciona con GNU troff.

-X[ppp], --gxditview[=ppp]

La opción muestra la salida de groff en una ventana gráfica utilizando el programa gxditvew. El ppp (puntos por pulgada) puede ser 75, 75-12, 100, o 100-12, siendo 75 el predefinido; las variantes -12 utilizan una tipografía base de 12 puntos. Esta opción implica -T con los respectivos dispositivos X75, X75-12, X100 o X11-12.

-Z, --ditroff

groff ejecuta troff y después utiliza un post-procesador adecuado para generar la salida adecuada para el dispositivo elegido. Si groff -mandoc es groff, esta opción se le pasa a groff y suprime el uso de un post-procesador. Implica -t.

Obtener ayuda¶

-?, --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.