Odczytywanie diagramów składni
Diagramy składni przedstawiają składnię komend. Zawierają różne symbole, takie jak nawiasy kwadratowe ([ ]), nawiasy klamrowe ({ }) oraz pionowe kreski (|). Poniżej podano przykład instrukcji prezentującej składnię komendy lsdev:
lsdev { -dev nazwa_urządzenia | -plc kod_położenia_fizycznego } [ -child ] [ -field nazwa_pola... ] [ -fmt ogranicznik ]
W instrukcjach prezentujących składnię komend przyjęto następującą konwencję:
- Elementy, które muszą zostać wprowadzone w wierszu komend dosłownie, są oznaczone pogrubieniem. Są to takie elementy, jak nazwa komendy, nazwy opcji, literały.
- Elementy reprezentujące zmienne, które należy zastąpić nazwą, są oznaczone kursywą. Są to między innymi parametry podawane po nazwach opcji oraz parametry odczytywane przez komendę, np. pliki i katalogi.
- Parametry ujęte w nawiasy kwadratowe są opcjonalne.
- Parametry ujęte w nawiasy klamrowe są wymagane.
- Parametry w ogóle nieujęte w nawiasy są wymagane.
- Pionowa kreska oznacza, że należy wybrać tylko jeden parametr. Na przykład fraza [ a | b ] oznacza, że można wybrać a, b lub nie wybrać nic. Podobnie fraza { a | b } oznacza, że trzeba wybrać albo a, albo b.
- Wielokropki ( ... ) oznaczają, że dany parametr można powtarzać w wierszu komend.
- Myślnik ( - ) reprezentuje wejście standardowe.