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.

A Tabela 1 explica como ler os diagramas de sintaxe que representam os comandos da interface da 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 >>><>() () () >>Começa à esquerda com duas pontas ()>< e termina à direita com duas pontas voltadas uma para a outra (). Se um diagrama for mais longo que uma linha, cada linha a ser continuada terminará com uma única> ponta de seta () e a linha seguinte começará com uma ponta de seta única. Leia os diagramas da left­to­right,, seguindo a linha do 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 exatamente como está mostrado no diagrama de sintaxe.
As palavras-chave Obrigatório
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-+-­a--AccessFile-+------------------------------------------><
   +-­u--ID---------+   
   '-­p--Senha------'   

Indicam os parâmetros ou argumentos que devem ser especificados para o comando. As palavras-chave obrigatórias aparecem na linha do caminho principal. Palavras-chave que não podem ser utilizadas juntas são empilhadas verticalmente.
As 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. palavras-chave opcionais aparecem abaixo da linha do caminho principal. Palavras-chave opcionais mutuamente exclusivas são empilhadas verticalmente.
Valor padrão
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
                 .-FCP---.   
>>-protocolo--=--+-FICON-+-------------------------------------><

Aparecem acima da linha do caminho principal.
Palavra-chave ou valor repetível
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-newport--=--+-TODOS---------------+-------------------------><
               '-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 da palavra-chave ou valor.
Variável
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-AccessFile--------------------------------------------------><

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

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--do host--=--' Nome Host '------------>

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

Indicam o começo e o final de um parâmetro ou argumento que contém vários valores. Coloque um ou mais pares de um conjunto de aspas duplas para determinado parâmetro ou argumento. Se o valor de um parâmetro ou par de contiver um espaço vazio ou em branco, coloque o valor inteiro entre um conjunto de aspas simples.
Equal­sign operador
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-"--ess--=--EssId-- -perfil--=--ProfileName--"---------------><

Separa um nome de seu valor em um par de nome-valor.
fragmento de sintaxe
Ler diagrama de sintaxeManter visual do diagrama de sintaxe
>>-Nome do Fragmento-------------------------------------------><

nome do fragmento

|--(--fragmento detalhes--)-------------------------------------|

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.