| Omitir V�nculos de navegaci�n | |
| Salir de la Vista de impresi�n | |
|
Páginas del comando man de Image Packaging System Oracle Solaris 11 Information Library (Español) |
| Omitir V�nculos de navegaci�n | |
| Salir de la Vista de impresi�n | |
|
|
Páginas del comando man de Image Packaging System Oracle Solaris 11 Information Library (Español) |
En este documento, se proporcionan las páginas del comando man para las herramientas de instalación del sistema Oracle Solaris 11.
A continuación, se incluye una breve descripción de cada sección de la página del comando man y la información a la que hace referencia:
En la sección 1 se describen los comandos disponibles con el sistema operativo.
En la sección 1M se describen los comandos que se utilizan principalmente para el mantenimiento y la administración del sistema.
En la sección 5 se incluye otra documentación, como tablas de conjuntos de caracteres.
A continuación, se muestra un formato genérico de las páginas del comando man. Las páginas del comando man de cada sección del manual generalmente siguen este orden, pero sólo incluyen los encabezados necesarios. Por ejemplo, si no hay ningún error para informar, no se incluye la sección de errores. Consulte el comando man para obtener más información sobre las páginas del comando man en general.
En esta sección se muestra la sintaxis de los comandos o las funciones. Cuando un comando o un archivo no existe en la ruta estándar, se muestra el nombre de la ruta completa. Las opciones y los argumentos se ordenan alfabéticamente, en primer lugar, los argumentos de una sola letra y, luego, las opciones con argumentos, a menos que se requiera un orden de argumentos diferente.
En esta sección se utilizan los siguientes caracteres especiales:
Corchetes. Las opciones o los argumento entre corchetes son opcionales. Si se omiten los corchetes, se debe especificar el argumento.
Puntos suspensivos. Se pueden proporcionar diversos valores para el argumento anterior, o el argumento anterior se puede especificar varias veces, por ejemplo, filename ....
Separador. Sólo uno de los argumentos separados por este carácter se puede especificar a la vez.
Llaves. Las opciones y/o argumentos entre llaves son interdependientes, de manera que todo lo que está dentro se debe tratar como una unidad.
Esta sección aparece sólo en la subsección 3R para indicar el archivo de descripción del protocolo.
En esta sección se define la funcionalidad y el comportamiento del servicio. De esta manera, se describe de manera concisa lo que hace el comando. No se analizan las OPCIONES ni se citan EJEMPLOS. En USO se describen las funciones, las macros, las solicitudes, los subcomandos y los comandos interactivos.
En esta sección se muestran las opciones de comandos y un resumen conciso de lo que hace cada opción. Las opciones se muestran literalmente y en el orden en que aparecen en la sección SINOPSIS. Los argumentos posibles para las opciones se analizan en la opción y, cuando corresponde, se proporcionan valores predeterminados.
En esta sección se muestran los operandos del comando y se describe cómo éstos afectan las acciones del comando.
En esta sección se describe la salida (salida estándar, error estándar o archivos de salida) generada por el comando.
Si la página del comando man documenta funciones que devuelven valores, en esta sección se muestran estos valores y se describen las condiciones en las que se devolverán. Si una función puede devolver sólo valores constantes, como 0 o -1, estos valores se muestran en párrafos etiquetados. De lo contrario, los valores de devolución de cada función se describen en un párrafo único. Las funciones declaradas nulas no devuelven valores, por lo que no se tratan en VALORES DE DEVOLUCIÓN.
En caso de fallo, la mayoría de las funciones colocan un código de error en la variable global errno que indica el motivo del fallo. En esta sección se muestran alfabéticamente todos los códigos de error que puede generar una función y se describen las condiciones que causan cada error. Cuando más de una condición puede causar el mismo error, cada condición se describe en un párrafo aparte en el código de error.
En esta sección se muestran los comandos, las funciones y las reglas especiales que requieren explicaciones detalladas. Las subsecciones que se muestran aquí se utilizan para explicar las funcionalidades integradas:
|
En esta sección se proporcionan ejemplos de uso o de cómo utilizar un comando o una función. Cuando es posible se muestra un ejemplo completo que incluye la entrada de la línea de comandos y la respuesta de la máquina. Cuando se proporciona un ejemplo, se muestra el indicador, como example%, o, si el usuario debe ser superusuario, example#. Los ejemplos incluyen explicaciones, reglas de sustitución de variables o valores devueltos. La mayoría de los ejemplos ilustran conceptos relacionados con las secciones SINOPSIS, DESCRIPCIÓN, OPCIONES y USO.
En esta sección se muestran todas las variables de entorno a las que afecta el comando o la función, y una breve descripción del efecto.
En esta sección se muestran los valores que devuelve el comando al programa o el shell que realiza la llamada, y las condiciones que generan que se devuelvan estos valores. Normalmente, se devuelve cero cuando se finaliza correctamente y valores distintos de cero cuando hay diversas condiciones de error.
En esta sección se muestran todos los nombres de archivo a los que hace referencia la página del comando man, los archivos de interés y los archivos creados o requeridos por comandos. Cada uno está seguido por un resumen descriptivo o una explicación.
En esta sección se muestran las características de los comandos, las utilidades y los controladores de dispositivos mediante la definición del tipo de atributo y el valor correspondiente. Para obtener más información, consulte la página del comando man attributes(5).
En esta sección se muestran las referencias a otras páginas del comando man, documentación interna y publicaciones externas.
En esta sección se muestran los mensajes de diagnóstico y una breve explicación de la condición que causó el error.
En esta sección se muestran las advertencias sobre condiciones especiales que podrían afectar seriamente las condiciones de trabajo. Esto no es una lista de diagnósticos.
En esta sección se muestra información adicional que no pertenece a ninguna otra sección de la página. Adopta la forma de un apartado para el usuario, y abarca puntos de especial interés. Aquí nunca se incluye información crítica.
En esta sección se describen errores conocidos y, cuando es posible, se sugieren soluciones.
|