Noot: Dit is een sectie die je over kunt slaan, voor het geval je verder wilt gaan.
Er is volgens traditie een beknopte wijze voor het beschrijven van de opdrachten-syntax [1] die je zou moeten kennen. Als voorbeeld, als je man man intikt om de manual page over man te krijgen, zal je verscheidene syntax-beschrijvingen te zien krijgen die beginnen met de opdrachtnaam man. Één daarvan ziet er ongeveer zo uit:
man -k [-M path] keyword ... |
Alles tussen blokhaken ([]) is een optionele eenheid. Dus je hoeft de optie -M niet te gebruiken, maar als je het doet, moet je een path argument gebruiken. Je moet de optie -k en het keyword argument gebruiken. De ... betekent dat je meer kunt hebben van hetgeen ervoor kwam, dus je zou verscheidene sleutelwoorden op kunnen zoeken.
Laten we eens kijken naar één van de complexere beschrijvingen van de manual page van man:
man [-c|-w|-tZT device] [-adhu7V] [-m system[,...]] [-L locale] [-para string] [-M path] [-P pager] [-r prompt] [-S list] [-e extension] [[section] page ...] ... |
Ten eerste, betekenen clusters met opties gewoonlijk dat je één of meer ervan in verschillende combinaties kunt gebruiken, dus -adhu7V betekent dat je ook -h kunt gebruiken. Je kunt echter niet altijd alle combinaties gebruiken; deze beschrijving maakt dat niet duidelijk. -h is bijvoorbeeld incompatibel met andere opties, maar je zou man -du kunnen gebruiken. Helaas maakt het formaat van de beschrijving dit niet duidelijk.
Ten tweede betekent het symbool | "of". Dus je kunt óf de -c, de -w, óf de -tZT opties, gevolgd door een device-argument gebruiken.
Ten derde, kun je blokhaken nesten, aangezien ze een optionele eenheid aangeven. Dus als je een section hebt, moet je ook een page hebben, aangezien page niet optioneel is binnen de [[section] page] eenheid.
Het is niet nodig dit allemaal te onthouden, refereer gewoon naar deze sectie als je documentatie leest.
| [1] | Syntax betekent de correcte wijze om diverse opties en argumenten te combineren. |