Il diagramma delle sintassi mostra come specificare un comando in modo che il sistema interpreti correttamente ciò che è stato digitato. Leggere il diagramma delle sintassi da sinistra verso destra e dall'alto verso il basso, seguendo la riga orizzontale (il percorso principale).
Nei diagrammi della sintassi vengono utilizzati i seguenti simboli:
Inserire tutta la punteggiatura, ad esempio, due punti, virgolette e segni di sottrazione, come mostrato nel diagramma della sintassi.
Nei diagrammi della sintassi vengono utilizzati i seguenti parametri
I parametri sono classificati come parole chiave o variabili. Le parole chiave sono visualizzate in minuscolo e quindi possono essere inserite in minuscolo. Ad esempio, un nome di un comando è una parola chiave. Le variabili sono in corsivo e rappresentano i nomi o i valori forniti.
Nell'esempio riportato di seguito, il comando user è una parola chiave. La variabile obbligatoria è user_id e la variabile facoltativa è password. Sostituire le variabili con i propri valori.
>>-user--user_id--+----------+--------------------------------->< '-password-'
Parole chiave obbligatorie: le parole chiave e le variabili obbligatorie vengono visualizzate nella riga del percorso principale.
>>-required_keyword--------------------------------------------><
È necessario codificare le parole chiave e i valori obbligatori.
Scegliere una delle voci obbligatorie da uno stack: se è disponibile più di una parola chiave o variabile obbligatoria la cui presenza esclude la presenza di un'altra, queste vengono raggruppate in verticale nell'ordine alfanumerico.
>>-+-required_parameter_1-+------------------------------------>< '-required_parameter_2-'
Valori facoltativi: le parole chiave e le variabili facoltative vengono visualizzate sotto la riga del percorso principale.
>>-+---------+------------------------------------------------->< '-keyword-'
È possibile scegliere di non codificare le parole chiave e le variabili facoltative.
Scegliere una parola chiave facoltativa da uno stack: se è disponibile più di una parola chiave o variabile facoltativa la cui presenza esclude la presenza di un'altra, queste vengono raggruppate in verticale in ordine alfanumerico sotto la riga del percorso principale.
>>-+-------------+--------------------------------------------->< +-parameter_1-+ '-parameter_2-'
Variabili: una parola interamente in corsivo è una variabile. Quando è presente una variabile nella sintassi, sostituirla con uno dei nomi o dei valori possibili, come indicato nel testo.
>>-variable----------------------------------------------------><
Caratteri non alfanumerici: se un diagramma mostra un carattere non alfanumerico (punti, virgolette o segni di sottrazione) è necessario codificare il carattere come parte della sintassi. In questo esempio, codificare cluster:port.
>>-cluster:porta-----------------------------------------------><