Convenciones tipográficas

Este documento utiliza las siguientes convenciones tipográficas:

%, $ o #: Un signo de porcentaje representa el símbolo del sistema del shell C. Un signo de dólar representa el símbolo del sistema de los shells Bourne, Korn y POSIX. Un signo de número representa el símbolo del superusuario.
audit(5): Una página de manual. El nombre de la página de manual es audit y se ubica en la sección 5.
Comando: Nombre de un comando o expresión de comandos válida.
Salida informática: Texto que muestra el equipo.
Ctrl+x: Secuencia de teclas. Una secuencia como Ctrl+x indica que debe mantenerse presionada la tecla que presenta la etiqueta Ctrl al mismo tiempo que se presiona otra tecla o un botón del «mouse» (ratón).
Título de documento: El título de un documento. En la Web y en los medios Instant Information, puede ser un enlace activo con el propio documento.
VARIABLE DE ENTORNO: El nombre de una variable de entorno, por ejemplo, PATH.
NOMBRE DE ERROR: El nombre de un error, que normalmente se devuelve en la variable errno.
Tecla: El nombre de una tecla del teclado. Retorno y Entrar hacen referencia a la misma tecla.
Término: El uso definido de una palabra o expresión importante.
Entrada del usuario: Comandos y otro tipo de texto que escribe el usuario.
Variable: El nombre de un marcador de posición en un comando, función u otra presentación de sintaxis que se sustituye por un valor real.
[]: El contenido es opcional en la sintaxis. Si el contenido es una lista separada por una pleca (|), deberá elegir uno de los elementos.
{}: El contenido es obligatorio en la sintaxis. Si el contenido es una lista separada por una pleca (|), deberá elegir uno de los elementos.
...: El elemento anterior puede repetirse un número arbitrario de veces.
|: Separa los elementos de una lista de opciones.
ADVERTENCIA: Una advertencia llama la atención en relación con información importante que, si no se entiende o aplica, conllevará lesiones personales o problemas irrecuperables con el sistema.
PRECAUCIÓN: Una precaución llama la atención en relación con información importante que, si no se entiende o aplica, conllevará la pérdida de datos, el daño de los datos, o el deterioro del hardware o del software.
IMPORTANTE: Esta alerta proporciona información esencial para explicar un concepto o para completar una tarea.
NOTA: Una nota contiene información adicional para recalcar o complementar puntos importantes del texto principal.

Ejemplos y shells

Este documento describe prácticas empleadas por el administrador del sistema. Puesto que al usuario root (superusuario) se le exige utilizar el shell POSIX /sbin/sh, todos los ejemplos de comandos usan dicho shell. El shell POSIX se define en la página de manual de sh-posix(1). Para obtener información sobre otros shells, consulte el documento Shells User’s Guide y la página de manual de sh(1).

Sintaxis de comando

Literal: Palabra o carácter que se escribe literalmente.
Reemplazable: Palabra o expresión que se sustituye por un valor apropiado.
-caracteres: Una o varias opciones de comando agrupadas, por ejemplo, -ikx. Los caracteres normalmente son una cadena de caracteres literales en la que cada uno de ellos representa una opción específica. Por ejemplo, la entrada -ikx equivale a las opciones individuales -i, -k y -x. El carácter del signo más (+) a veces se utiliza como un prefijo de opción.
-palabra: Una opción de comando, por ejemplo, -help. La palabra es una palabra clave literal. La diferencia con -caracteres normalmente es evidente y se aclara en una descripción de las opciones. El carácter del signo más (+) y el doble guión (--) a veces se utilizan como prefijos de opción.
[ ]: Los metacaracteres de paréntesis encierran contenido optativo en cuanto a los formatos y descripciones de comandos.
{ }: Los metacaracteres de llave encierran contenido obligatorio en cuanto a los formatos y descripciones de comandos.
|: El metacarácter de pleca separa alternativas en una lista de opciones, que normalmente están entre paréntesis o llaves.
. . .: El metacarácter de puntos suspensivos después de un símbolo (abc...) o de un metacarácter de corchete de cierre ([ ]...) o de llave de cierre ({ }...) indica que el elemento precedente y su espacio en blanco precedente, si lo hay, pueden repetirse un número arbitrario de veces.
. . .: Los puntos suspensivos a veces se emplean para indicar los términos omitidos de una serie.

Convenciones tipográficas

Documentación técnica

» Tabla de contenido

» Glosario

» Índice

Ejemplos y shells

Sintaxis de comando