Como Ler os Diagramas de Sintaxe
Diagramas de sintaxe descrevem como você deve inserir comandos e quais opções estão disponíveis.
Os tópicos de sintaxe utilizam 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 se os exemplos de comando ou sintaxe forem quebrados para a próxima linha.
command_name -option_1 variable_1 [-option_2
variable_2]
[-option_3 variable_3 | -option_4]
Em que:- command_name
- O command_name é necessário.
- -option_1
- O parâmetro -option_1 é um parâmetro obrigatório.
- variable_1
- O valor variable_1 é uma variável obrigatória para o parâmetro -option_1.
- [-option_2 variable_2]
- 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. Utilize o parâmetro -option_3 com seu valor ou utilize o parâmetro -option_4. Neste exemplo, ambos os itens são opcionais, e você só pode utilizar um ou outro.