Os diagramas de sintaxe descrevem como você deve inserir comandos
e quais opções estão disponíveis.
Os tópicos de sintaxe usam várias convenções para indicar
variável, parâmetros, itens necessários e itens opcionais. Insira todos
os comandos em uma única linha, mesmo que os exemplos de comando ou de sintaxe
sejam quebrados para a próxima linha.
command_name -option_1 variable_1 [-option_2 variable_2]
[-option_3 variable_3 | -option_4]
Onde:
- command_name
- O command_name é necessário.
- -option_1
- O parâmetro -option_1 é um parâmetro necessário.
- variable_1
- O valor variable_1 é uma variável necessária para
o parâmetro -option_1.
- [-option_2 variable_2]
- Os colchetes [] indicam itens opcionais. O parâmetro -option_2
com seu valor é opcional.
- -option_3 variable_3 | -option_4
- Uma barra vertical indica uma opção de parâmetros. Use o parâmetro -option_3
com seu valor ou use o parâmetro -option_4.
Neste exemplo, os dois itens são opcionais e é possível usar apenas
um ou outro.