Os diagramas de sintaxe descrevem o modo como tem de introduzir os comandos e
as opções que estão disponíveis.
Os tópicos de sintaxe utilizam várias convenções para indicar a variável, os
parâmetros, os itens requeridos e os itens opcionais. Introduza todos os comandos numa
única linha, mesmo se os exemplos de comando ou sintaxe sejam translineados para a linha
seguinte.
command_name -option_1 variável_1 [-option_2 variável_2]
[-option_3 variável_3 | -option_4]
Em que:
- command_name
- O command_name é requerido.
- -option_1
- O parâmetro -option_1 é um parâmetro requerido.
- variável_1
- O valor variável_1 consiste numa variável requerida para o
parâmetro -option_1.
- [-option_2 variável_2]
- Parêntesis rectos [] indicam itens opcionais. O parâmetro -option_2
com o respectivo valor é opcional.
- -option_3 variável_3 | -option_4
- Uma barra vertical indica uma opção de parâmetros. Utilize o parâmetro
-option_3 com o respectivo valor ou utilize o parâmetro
-option_4.
Neste exemplo, ambos os itens são opcionais, sendo que
apenas um pode ser utilizado.