Como ler um Diagrama de Sintaxe

O diagrama de sintaxe mostra como especificar um comando, para que o sistema operacional possa interpretar corretamente o que é digitado. Leia o diagrama de sintaxe da esquerda para a direita e de cima para baixo, seguindo a linha horizontal (o caminho principal).

Símbolos

Os seguintes símbolos são usados nos diagramas de sintaxe:
Símbolo
Descrição
>>
Marca o início do diagrama de sintaxe.
>
Indica que o diagrama de sintaxe é continuado.
|
Marca o início e o final de um fragmento ou parte do diagrama de sintaxe.
><
O final do diagrama de sintaxe.

Operandos

Os seguintes tipos de operandos são usados nos diagramas de sintaxe:
Os operandos são classificados como palavras-chave ou variáveis:
  • Palavras-chave são constantes que devem ser fornecidas. Se a palavra-chave aparecer no diagrama de sintaxe em maiúscula e minúscula, a parte em maiúscula será a abreviação da palavra-chave (por exemplo, KEYword). As palavras-chave não fazem distinção entre maiúsculas e minúsculas. Você pode codificá-las em maiúsculas ou minúsculas.
  • As variáveis são escritas em itálico, aparecem em letras minúsculas e representam nomes ou valores fornecidos. Por exemplo, um nome do conjunto de dados é uma variável. As variáveis podem fazer distinção entre maiúsculas e minúsculas.

Exemplo de Sintaxe

No exemplo a seguir, o comando USER é uma palavra-chave. O parâmetro da variável necessária é user_id, e o parâmetro da variável opcional é password. Substitua os parâmetros da variável pelos seus próprios valores:
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-USER--user_id--+----------+---------------------------------><
                  '-password-'   

Caracteres Não Alfanuméricos e Espaços em Branco

Se o diagrama mostrar um caractere que não seja alfanumérico (como parênteses, pontos, vírgulas, sinais de igual e espaços em branco), você deverá codificar o caractere como parte da sintaxe. Neste exemplo, você deve codificar OPERAND=(001 0.001):
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-OPERAND--=--(--001 0.001--)---------------------------------><

Selecionando Mais de um Operando

Uma seta retornando à esquerda em um grupo de operandos significa que mais de um pode ser selecionado ou que um único pode ser repetido:
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-+----------------------+------------------------------------><
   +-REPEATABLE_OPERAND_1-+   
   +-REPEATABLE_OPERAND_2-+   
   '-<--------------------'   

Mais Longo do que uma Linha

Se um diagrama for mais longo do que uma linha, a primeira linha terminará com uma única ponta de seta e a segunda linha iniciará com uma única ponta de seta:
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-| A primeira linha de um diagrama de sintaxe é mais longa do que uma linha |-->

>--| A continuação dos subcomandos, parâmetro ou ambos |-------><

Fragmentos de Sintaxe

Alguns diagramas poderão conter fragmentos de sintaxe, o que serve para separar diagramas que são muito longos, mais complexos ou muito repetitivos. Os nomes dos fragmentos de sintaxe são compostos por letras maiúsculas e minúsculas e são mostrados no diagrama e no título do fragmento. O fragmento é colocado abaixo do diagrama principal:
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-| Fragmento de sintaxe |------------------------------------><

Fragmento de Sintaxe

|--1ST_OPERAND--,--2ND_OPERAND--,--3RD_OPERAND------------------|


Feedback