Convenciones del documento, Formato de texto, Convenciones de la sintaxis de los comandos – Dell Brocade Adapters User Manual

Page 20

Advertising
background image

xx

Manual de referencia e instalación de adaptadores Brocade

53-1002144-01

Convenciones del documento

Esta sección describe las convenciones de formato de texto y formatos de aviso importante
utilizados en este documento.

Formato de texto

Las convenciones de formato de texto narrativo que se utilizan son las siguientes:

texto en negrita Identifica los nombres de los comandos

Identifica los nombres de los elementos GUI manipulados por el usuario

Identifica palabras clave y operandos

Identifica texto a introducir en la GUI o CLI

texto en cursiva Proporciona énfasis

Identifica variables

Identifica rutas y direcciones de internet

Identifica títulos de documentos

texto

código

Identifica salida de comandos CLI

Identifica ejemplos de sintaxis de comandos

Por motivos de legibilidad, los nombres de los comandos de las partes narrativas de esta guía se
presentan en letras mayúsculas y minúsculas mezcladas: por ejemplo, switchShow. En los
ejemplos actuales, las letras de los comandos están, a menudo, todas en minúscula.

Convenciones de la sintaxis de los comandos

La sintaxis de los comandos en este manual se rige por estas convenciones:

comando

Los comandos se escriben en negrita.

--

opción, opción

Las opciones de los comandos se escriben en negrita.

-

argumento, arg

Argumentos.

[ ]

Elemento opcional.

variable

Las variables se escriben en cursiva. En las páginas de ayuda, los valores
aparecen subrayados o entre paréntesis angulares < >.

...

Repita el elemento anterior, por ejemplo “miembro[;miembro...]”

valor

Los valores fijos que siguen a los argumentos se escriben en texto sin
formato. Por ejemplo,

--

show WWN

|

Booleano. Los elementos son exclusivos. Ejemplo:

--

show

-

mode

egress | ingress

Advertising