mandato man

Finalidad

Muestra entradas manuales en línea.

Sintaxis

man [[[ -c ] [ -t ] [ sección ]] | [ -k | -f ]] [ -F ] [ -m ] [ -Mvía_acceso ] [ -r ] [ -a ] título ...

Descripción

El mandato man proporciona información de referencia sobre temas como, por ejemplo, mandatos, subrutinas y archivos. El mandato man proporciona descripciones de una línea de mandatos especificados por nombre. El mandato man también proporciona información sobre todos los mandatos cuyas descripciones contienen un conjunto de palabras clave especificadas por el usuario.

El mandato man formatea un conjunto especificado de páginas de manual. Si especifica una sección para el parámetro section , el mandato man busca en esa sección de las páginas de manual el título especificado por el parámetro title. El valor del parámetro section puede ser un número árabe de 1 a 8 o una letra.

Las letras de sección son:

Elemento	Descripción
C	Especifica mandatos (incluidos los mandatos de gestión del sistema).
g	Especifica páginas de manual de tipo archivo.
R	Especifica las funciones de biblioteca.
n	Especifica nuevo.
l	Especifica local.
o	Especifica antiguo.
p	Especifica public.

Nota: Los especificadores de sección n, l, oy p no son válidos para leer las bases de información de hipertexto, que contienen la documentación del sistema operativo.

Los números de sección son:

Elemento	Descripción
1	Indica mandatos de usuario y daemons.
2	Indica llamadas del sistema y servicios de kernel.
3	Indica subrutinas.
4	Indica archivos especiales, controladores de dispositivo y hardware.
5	Indica los archivos de configuración.
6	Indica juegos.
7	Indica mandatos varios.
8	Indica mandatos administrativos y daemons.

Nota: La documentación del sistema operativo en las bases de datos de información de hipertexto se agrupa en tres secciones únicamente: páginas de manual de mandatos (en la sección 1, equivalente a la sección C), páginas de manual de subrutinas (en la sección 3, equivalente a la sección L) y páginas de manual de archivos (en la sección 4, equivalente a la sección F). Al buscar información de hipertexto, especificar la sección 1, 6, 7 u 8 tomará por omisión las páginas de manual de mandatos, la sección 2 o 3 tomará por omisión las páginas de manual de subrutinas y la sección 4 o 5 tomará por omisión las páginas de manual de archivos.

Si se omite el parámetro section , el mandato man busca en todas las secciones del manual.

La vía de acceso de búsqueda que utiliza el mandato man es una lista de directorios separados por: (dos puntos) en los que se pueden encontrar subdirectorios manuales.

El mandato man muestra las páginas de manual de la forma siguiente:

El mandato man busca en los directorios nroff (man?) en el directorio /usr/share/man .
El mandato man busca en los directorios de versión formateada (cat?) en el directorio /usr/share/man . Si la versión formateada está disponible, y si tiene una hora de modificación más reciente que el origen del mandato nroff , el mandato man muestra la versión formateada. De lo contrario, la página de manual se formatea con el mandato nroff y se visualiza. Si el usuario tiene permiso, la página de manual formateada se deposita en el lugar adecuado, de modo que las invocaciones posteriores del mandato man no vuelven a formatear la página.
Nota: No hay ningún origen nroff para las páginas de manual proporcionadas. Sin embargo, puede colocar el origen nroff para las páginas de manual en los directorios man y el mandato man puede localizar y procesar el origen nroff .
Si el mandato man no encuentra una página manual en el directorio /usr/share/man/man o /usr/share/man/cat , el mandato man busca las vías de acceso especificadas mediante la opción -M o la variable de entorno MANPATH para los directorios nroff (man?) y directorios de versión formateada (cat?).
Si el mandato hombre no encuentra una página de manual en el directorio /usr/share/man/man o /usr/share/man/cat o en el directorio hombre/gato especificado por el usuario, el mandato hombre lee las bases de información de hipertexto. Las bases de información de hipertexto residen en la estructura de directorios /usr/share/man/info y contienen la documentación del sistema operativo. Al leer de las bases de datos de hipertexto, el mandato man no coloca ninguna página de manual en la estructura de directorios /usr/share/man/cat . El mandato man convierte el archivo HTML en un archivo de texto con formato para que quepa en la pantalla y muestra la página de manual utilizando el mandato descrito por la variable de entorno PAGER.
Si el mandato man no encuentra una página manual en las bases de información de hipertexto que residen en la estructura de directorios /usr/share/man/info , busca la base de información de hipertexto especificada por el usuario (a través de -M o MANPATH). La base de información de hipertexto definida por el usuario debe seguir la siguiente estructura de directorios:
```
BasePath[/%{ L | l }]/DocLibraryname/Section/command_or_routine_or_filename.htm
```
Donde:
- %L representa la notación de idioma ISO especificada utilizando LC_MESSAGES, %l representa los 2 primeros caracteres de la notación de idioma ISO especificada utilizando LC_MESSAGES. Por ejemplo, para LC_MESSAGES=en_US los documentos se pueden colocar en Path/en_US o Path/en.
- DocLibraryname representa el nombre de la biblioteca de documentación.
- Section representa el nombre de sección, que debe ser uno de los siguientes:
  - cmds -Representa la sección de mandatos
  - libs -Sección de biblioteca de representaciones
  - files -Sección Representa archivos
Nota: Si se especifica la opción -m , la búsqueda de páginas de manual sólo se realizará en el orden de las vías de acceso especificadas mediante -M o la variable de entorno MANPATH.

Al acceder a las bases de datos HTML, man busca la biblioteca del sistema operativo antes de continuar con otras bibliotecas LPP. Dentro de estas bibliotecas, procesa la información en el orden siguiente:

Elemento	Descripción
cmds	Referencia de mandatos
libras	Subrutinas, Llamadas del sistema
archivos	Files Reference

Si la salida estándar es un tty, el mandato hombre transfiere su salida utilizando el mandato más con los distintivos - y -v . El distintivo -s elimina varias líneas en blanco y se detiene después de cada página de la pantalla. El distintivo -v suprime la visualización de los caracteres que no se imprimen en la pantalla. Para continuar con el desplazamiento, pulse la barra espaciadora. Para desplazar 11 líneas adicionales cuando se detenga la salida, pulse la secuencia de teclas Control-D.

La variable de entorno PAGER se puede establecer en el paginador que desee. El valor predeterminado es el mandato more . Para cambiar el paginador predeterminado, entre:

PAGER=Somepager
export PAGER

Por ejemplo, si hay páginas de manual personalizadas formateadas con saltos de línea inversos o fraccionarios, la variable de entorno PAGER se puede establecer en /usr/bin/pg para que los saltos de línea no se impriman como caracteres de control. Este procedimiento no es necesario para las páginas de manual.

Cuando el mandato man utiliza una base de datos de hipertexto, puede recuperar varios artículos. Por ejemplo,man openmuestra varios artículos. El uso de SIGINT (Ctrl-C) sale completamente del mandato man . Por otro lado,man open closetambién muestra varios artículos, pero el uso de SIGINT (Ctrl-C) hace que man muestre la información del mandato close en lugar de salir. Si utiliza SIGINT (Ctrl-C), vuelve a salir del mandato man por completo.

Al especificar una de las rutinas de biblioteca de Network Computing System que contiene un $ (signo de dólar) en su nombre, especifique una \ (barra inclinada invertida) antes de $.

Distintivos

Elemento	Descripción
-a	Visualizar todas las entradas coincidentes.
-c	Muestra la información manual utilizando el mandato cat .
-f	Muestra entradas en la base de datos de palabras clave relacionadas sólo con el nombre de mandato proporcionado como parámetro final. Puede especificar más de un nombre de mandato, cada uno separado por un espacio. Utilice este distintivo para buscar sólo artículos de mandato. Para utilizar el distintivo -f , un usuario root debe haber especificado previamente `catman` `-w` para crear el archivo /usr/share/man/whatis .
-F	Visualizar sólo la primera entrada coincidente.
-k	Muestra cada línea de la base de datos de palabras clave que contiene una serie de caracteres que coinciden con el título proporcionado como parámetro final. Puede especificar más de un título, cada uno separado por un espacio. Para utilizar el distintivo -k , un usuario root debe haber especificado previamente `catman` `-w` para crear el archivo /usr/share/man/whatis .
-m	Buscar sólo en las vías de acceso especificadas en MANPATH o -M.
-Mvía_acceso	Cambia la ubicación estándar donde el mandato man busca información manual. La vía de acceso es una lista de vías de acceso separadas por dos puntos, donde se pueden utilizar los siguientes símbolos especiales: %D- Las rutas por defecto de AIX® para las páginas man. %L-Una ubicación de directorio específica del entorno local correspondiente a la categoría LC_MESSAGES del entorno local actual. %l-Una ubicación de directorio específica del entorno local correspondiente a los 2 primeros caracteres de la categoría LC_MESSAGES de la actual.
-r	Busca de forma remota la información manual. Si por alguna razón la búsqueda remota falla, man realiza una búsqueda local para la página man solicitada. Cualquiera de las condiciones siguientes puede hacer que falle la búsqueda remota: No se puede acceder a la máquina remota. Hay un problema al leer URL. Un applet Java™ no está instalado o no se encuentra en la vía de acceso de búsqueda del usuario, especificada en la variable de entorno PATH . Nota: la variable de entorno DOCUMENT_SERVER_MACHINE_NAME debe establecerse en el nombre de la máquina del servidor de búsqueda de documentación que el usuario desea utilizar. Si la documentación base de AIX no es compatible con la configuración regional del host, el comando man busca la documentación para una configuración regional alternativa. Si la búsqueda es satisfactoria, la página de documentación se visualiza después de la conversión al entorno local del host local. Si el entorno local alternativo no está instalado en el host local, el mandato man no puede visualizar la página de documentación.
-T	Formatea la información manual utilizando el mandato troff . Este distintivo se ignora si la página manual se encuentra en una base de información de hipertexto.

Estado de salida

Este mandato devuelve los siguientes valores de salida:

Elemento	Descripción
0	Finalización satisfactoria.
>0	Se ha producido un error.

Ejemplos

Para visualizar información sobre el mandato grep , especifique el mandato siguiente:
```
man grep
```
Para visualizar información sobre la rutina de biblioteca rpc_$register , especifique el mandato siguiente:
```
man rpc_\$register
```
Para visualizar todas las entradas de la base de datos de palabras clave /usr/share/man/whatis que contienen la serie "mkdir", especifique el mandato siguiente:
```
man -k mkdir
```
La salida es equivalente al mandato apropos . Sólo recibe la salida del distintivo -k cuando la base de datos de palabras clave /usr/share/man/whatis ya existe.
Para visualizar todas las entradas de la base de datos de palabras clave relacionadas con los mandatos nroff y troff , especifique el mandato siguiente:
```
man -f nroff troff
```
La salida es equivalente al mandato whatis . Sólo recibe la salida del distintivo -f cuando la base de datos de palabras clave /usr/share/man/whatis ya existe.
Para visualizar todos los artículos relacionados con el mandato ftp en la vía de acceso /usr/share/man o /usr/share/man/local , especifique el mandato siguiente:
```
man -M/usr/share/man:/usr/share/man/local ftp
```
Para visualizar todas las entradas coincidentes, especifique el mandato siguiente:
```
man -a title
```
Para visualizar sólo la primera entrada coincidente, especifique el mandato siguiente:
```
man -F title
```
Para buscar sólo en las vías de acceso especificadas en MANPATH o -M, especifique el mandato siguiente:
```
man -m -M PATH title
```
Para buscar en la variable PATH definida por el usuario, especifique el mandato siguiente:
```
man -M PATH title
```

Archivos

Elemento	Descripción
/usr/bin/man	Contiene el mandato man .
/usr/share/man	Estructura de directorios manual estándar.
/usr/share/man/cat?/*	Directorio que contiene páginas preformateadas.
/usr/share/man/whatis	Contiene la base de datos de palabras clave.
/usr/share/man/man?/*	Directorio que contiene páginas de manual con formato nroff .