Diagramas de Sintaxe

Um diagrama de sintaxe usa símbolos para representar os elementos de um comando e para especificar as regras para o uso desses elementos.

Tabela 1 explica como ler os diagramas de sintaxe que representam os comandos da interface de linha de comandos (CLI). Com isso, ela define os símbolos que representam os elementos do comando da CLI.

Tabela 1. Diagramas de Sintaxe
Elemento Sintaxe Descrição
Linha do caminho principal >>><>() () () A linha do caminho principal começa à esquerda com pontas de seta duplas: >>. A linha do caminho principal termina à direita com duas pontas de setas uma virada para a outra: ><. Se um diagrama for mais longo que uma linha, cada linha a ser continuada terminará com uma ponta de seta única e a linha seguinte começará com uma ponta de seta única: >

Leia os diagramas da esquerda para a direita, de cima para baixo, seguindo a linha de caminho principal.

Palavra-chave
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-esscli------------------------------------------------------><

Representa o nome de um comando, sinalizador, parâmetro ou argumento. Uma palavra-chave não é colocada em itálico. A palavra-chave deve ser digitada exatamente como mostrada no diagrama de sintaxe.
Palavras-chave obrigatórias
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-+-­a--AccessFile-+------------------------------------------><
   +-­u--Userid-----+   
   '-­p--Password---'   

Indicam os parâmetros ou argumentos que devem ser especificados para o comando. As palavras-chave obrigatórias devem ser escritas na linha de caminho principal. Palavras-chave que não podem ser usadas juntas são empilhadas verticalmente.
Palavras-chave Opcionais
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-+--------+--------------------------------------------------><
   +-­h-----+   
   +- -help-+   
   '-­?-----'   

Indicam os parâmetros ou argumentos que você pode escolher especificar para o comando. As palavras-chave opcionais devem ser escritas abaixo da linha de caminho principal. Palavras-chave opcionais mutuamente exclusivas são empilhadas verticalmente.
Valor padrão
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
                .-FCP---.   
>>-protocol--=--+-FICON-+--------------------------------------><

O valor padrão deve ser escrito acima da linha de caminho principal.
Palavra-chave ou valor Repetidos
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-newports--=--+-ALL-----------------+------------------------><
                '-PortId1,PortId2,...-'   

Representa um parâmetro ou argumento que pode ser especificado mais de uma vez. Uma palavra-chave ou valor repetível é representada por uma seta retornando para a esquerda acima à esquerda da palavra-chave ou valor.
Variável
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-AccessFile--------------------------------------------------><

Representa o valor que deve ser fornecido para um parâmetro ou argumento, como um nome de arquivo, um nome de usuário ou uma senha. As variáveis são mostradas em itálico.
Separador de espaço
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-­u-- --Userid-- --p-- --Password----------------------------><

Inclui um espaço em branco na linha do caminho principal para separar elementos como palavras-chave, parâmetros, argumentos ou variáveis uns dos outros.
Delimitadores de Aspas
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-­d-- --"--ess--=--EssId--host--=--'Host Name'-- --perfil----->

>--=--ProfileName--"-------------------------------------------><

Indicam o começo e o final de um parâmetro ou argumento que contém diversos valores. Coloque um ou mais pares nome-valor em um conjunto de aspas duplas para um determinado parâmetro ou argumento. Se o valor de um parâmetro ou par nome-valor contiver um espaço em branco, coloque o valor inteiro em um conjunto de aspas simples.
Operador de sinal de igual
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-"--ess--=--EssId-- --perfil -=--ProfileName--"--------------><

Separe um nome de seu valor em um par nome-valor.
Fragmento de sintaxe
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-Fragment Name-----------------------------------------------><

Nome do Fragmento

|--(--fragment details--)---------------------------------------|

Divide diagramas de sintaxe que são muito longos, muito complexos ou repetitivos. O nome do fragmento é inserido no diagrama principal e o fragmento real é mostrado abaixo do diagrama principal.