O diagrama de sintaxe mostra como especificar um comando, para que o sistema operacional possa interpretar corretamente o que você digita. Leia o diagrama de sintaxe da esquerda para a direita e da parte superior para a parte inferior, seguindo a linha horizontal (o caminho principal).
Os seguintes símbolos são usados em diagramas de sintaxe:
Você deve incluir toda a pontuação, como dois pontos, aspas e sinais de menos, que são mostrados no diagrama de sintaxe.
Os seguintes tipos de parâmetros são usados em diagramas de sintaxe.
Os parâmetros são classificados como palavras-chave ou variáveis. As palavras-chave são exibidas em letras minúsculas e podem ser inseridas em minúsculas. Por exemplo, um nome de comando é uma palavra-chave. As variáveis são escritas em itálico e representam nomes ou valores fornecidos.
No seguinte exemplo, o comando de usuário é uma palavra-chave. A variável necessária é user_id, e a variável opcional é password. Substitua as variáveis pelos próprios valores.
>>-user--user_id--+-------+------------------------------------>< '-senha-'
Palavras-chave necessárias: as palavras-chave e as variáveis necessárias são exibidas na linha do caminho principal.
>>-required_keyword--------------------------------------------><
É necessário codificar as palavras-chave e os valores necessários.
Escolha um item necessário a partir de uma pilha: Se houver mais de uma palavra-chave ou variável necessárias mutuamente exclusivas das quais escolher, elas serão empilhadas verticalmente em ordem alfanumérica.
>>-+-required_parameter_1-+------------------------------------>< '-required_parameter_2-'
Valores opcionais: As palavras-chave e as variáveis opcionais são exibidas abaixo da linha do caminho principal.
>>-+---------+------------------------------------------------->< '-keyword-'
É possível escolher não codificar as palavras-chave e as variáveis opcionais.
Escolha uma palavra-chave opcional a partir de uma pilha: Se houver mais de uma palavra-chave ou variável opcionais mutuamente exclusivas das quais escolher, elas serão empilhadas verticalmente em ordem alfanumérica abaixo da linha do caminho principal.
>>-+-------------+--------------------------------------------->< +-parameter_1-+ '-parameter_2-'
Variáveis: Uma palavra toda em itálico é uma variável. Onde você vir uma variável na sintaxe, deverá substituí-la por um de seus nomes ou valores permitidos, conforme definido no texto.
>>-variable----------------------------------------------------><
Caracteres não alfanuméricos: Se um diagrama mostrar um caractere que não seja alfanumérico (como dois pontos, aspas ou sinais de menos), você deverá codificar o caractere como parte da sintaxe. Nesse exemplo, você deve codificar cluster:port.
>>-cluster:port------------------------------------------------><