Els diagrames de sintaxi descriuen com heu d'introduir les ordres i quines són les opcions disponibles.
Els temes de sintaxi utilitza diverses convencions per indicar elements necessaris, opcionals, de paràmetres i variables. Introduïu totes es ordres en una sola línia, inclòs si l'ordre o els exemples de sintaxi s'ajusten a la llista següent.
command_name -option_1 variable_1 [-option_2 variable_2]
[-option_3 variable_3 | -option_4]
On:
- command_name
- Es necessita command_name.
- -option_1
- El paràmetre -option_1 és un paràmetre necessari.
- variable_1
- El valor de variable_1 és una variable necessària per al paràmetre -option_1.
- [-option_2 variable_2]
- El claudàtors [] indiquen els elements opcionals. El paràmetre -option_2 i el seu valor són opcionals.
- -option_3 variable_3 | -option_4
- Una barra vertical indica una tria de paràmetres. Utilitzeu el paràmetre -option_3 amb el seu valor o utilitzeu el paràmetre -option_4.
En aquest exemple, tots dos elements són opcionals i només en podeu utilitzar un.