Formato de secciones de páginas del comando man

La siguiente información de referencia describe los contenidos de cada sección de página del comando man, la información que se encuentra en cada sección y el diseño estándar que se utiliza en todas las páginas del comando man de Oracle Solaris.

Descripción de secciones de páginas del comando man

En la siguiente tabla se describe cada sección de página del comando man y la información a la que cada página del comando man hace referencia.

Tabla 1-1 Descripción de secciones de páginas del comando man

Sección de página del comando man	Descripción
1	Describe comandos generales que están disponibles con el sistema operativo.
1M	Describe comandos y daemons que se emplean principalmente para mantenimiento del sistema y con fines administrativos.
2	Describe todas las llamadas del sistema.
3	Describe las funciones que se encuentran en varias bibliotecas.
4	Describe los varios formatos de archivo y convenciones.
5	Contiene documentación variada, como estándares, entornos y macros.
6	Contiene juegos y demostraciones. Tenga en cuenta que este apartado ya no existe.
7	Describe archivos especiales que hacen referencia a periféricos de hardware y controladores de dispositivos específicos.
9	Proporciona información de referencia que es necesaria para escribir controladores de dispositivos en el entorno de núcleo.

Formato de páginas del comando man

Las páginas del comando man utilizan un formato estándar que incluye algunas o todas las subsecciones siguientes. El orden de las subsecciones coincide con el orden en que la información aparece en las secciones individuales de páginas del comando man.

NAME: Proporciona el nombre del comando, función de biblioteca, archivo o controlador de dispositivos, incluida una breve descripción de lo que la construcción hace.
SYNOPSIS: Muestra la sintaxis del comando, función de biblioteca, archivo o controlador de dispositivos.
DESCRIPTION: Define la funcionalidad y el comportamiento del servicio.
IOCTL: Se utiliza para una clase concreta de dispositivos, todas las que tienen una terminación io, por ejemplo mtio(7I). Esta sección aparece en las páginas de la sección 7 solamente.
OPTIONS: Enumera las opciones del comando, incluido un resumen conciso de lo que cada opción hace.
OPERANDS: Enumera los operandos del comandos y describe cómo los operandos afectan las acciones del comando.
OUTPUT: Describe la salida, la salida estándar, el error estándar o los archivos de salida generados por el comando, función de biblioteca, archivo o controlador de dispositivos.
RETURN VALUES: Enumera los valores y describe las condiciones en las que se devuelven (sólo se aplica a páginas del comando man que informan funciones que devuelven valores).
ERRORS: Enumera alfabéticamente todos los códigos de error que una biblioteca de funciones puede generar y describe las condiciones que causan cada error.
USAGE: Enumera reglas especiales, características y comandos que requieren explicaciones detalladas.
EXAMPLES: Proporciona ejemplos de uso o cómo utilizar un comando, una función de biblioteca, un archivo o un controlador de dispositivos.
ENVIRONMENT VARIABLES: Enumera todas las variables de entorno a las que afectan el comando, la función de biblioteca, el archivo o el controlador de dispositivos, seguido de una breve descripción del efecto.
EXIT STATUS: Enumera los valores que el comando devuelve al shell o programa que realiza la llamada y las condiciones que originan que se devuelvan estos valores.
FILES: Enumera todos los nombres de archivo a los que hace referencia la página del comando man, incluidos los archivos de interés y los archivos creados o requeridos por los comandos.
ATTRIBUTES: Enumera las características de comandos, utilidades y controladores de dispositivos mediante la definición del tipo de atributo y el valor correspondiente. Consulte la página del comando man attributes(5).
SEE ALSO: Incluye cualquier comando o funciones de biblioteca relacionados.
DIAGNOSTICS: Enumera los mensajes de diagnóstico con una breve explicación de la condición que causa el error.
WARNINGS: Enumera advertencias sobre condiciones especiales que podrían afectar seriamente las condiciones de trabajo. Esto no es una lista de diagnósticos.
NOTES: Muestra información adicional que no pertenece a ninguna parte de la página.
BUGS: Describe errores conocidos y, cuando es posible, sugiere una solución.

Omitir V�nculos de navegaci�n
Salir de la Vista de impresi�n
	Administración de Oracle Solaris: tareas comunes Oracle Solaris 11 Information Library (Español)