Los diagramas de sintaxis describe cómo debe entrar mandatos y qué opciones están disponibles.
Los temas de sintaxis utilizan varias convenciones para indicar variables, parámetros, elementos necesarios y elementos opcionales. Entre todos los mandatos en una única línea, aunque los ejemplos de sintaxis o mandatos se pasen a la línea siguiente.
command_name -option_1 variable_1 [-option_2 variable_2]
[-option_3 variable_3 | -option_4]
Donde:
- command_name
- Se necesita command_name .
- -option_1
- El parámetro -option_1 es un parámetro necesario.
- variable_1
- El valor variable_1 es una variable necesaria para el parámetro -option_1 .
- [-option_2 variable_2]
- Los corchetes [] indican elementos opcionales. El parámetro -option_2 con este valor es opcional.
- -option_3 variable_3 | -option_4
- Una barra vertical indica una selección de parámetros. Utilice el parámetro -option_3 con este valor, o utilice el parámetro -option_4 .
En este ejemplo, ambos elementos son opcionales y puede utilizar únicamente uno o el otro.