Zrozumienie streszczenia na stronie podręcznika

Nie udało mi się zrozumieć sekcji SYNOPSIS na stronie polecenia. Na przykład zobaczmy stronę podręcznika man. Przez man man:

SYNOPSIS
       man  [-C  file]  [-d]  [-D]  [--warnings[=warnings]]  [-R encoding] [-L
       locale] [-m system[,...]] [-M path] [-S list]  [-e  extension]  [-i|-I]
       [--regex|--wildcard]   [--names-only]  [-a]  [-u]  [--no-subpages]  [-P
       pager] [-r prompt] [-7] [-E encoding] [--no-hyphenation] [--no-justifi‐
       cation]  [-p  string]  [-t]  [-T[device]]  [-H[browser]] [-X[dpi]] [-Z]
       [[section] page ...] ...
       man -k [apropos options] regexp ...
       man -K [-w|-W] [-S list] [-i|-I] [--regex] [section] term ...
       man -f [whatis options] page ...
       man -l [-C file] [-d] [-D] [--warnings[=warnings]]  [-R  encoding]  [-L
       locale]  [-P  pager]  [-r  prompt]  [-7] [-E encoding] [-p string] [-t]
       [-T[device]] [-H[browser]] [-X[dpi]] [-Z] file ...
       man -w|-W [-C file] [-d] [-D] page ...
       man -c [-C file] [-d] [-D] page ...
       man [-hV]

1. Czy sekcja SYNOPSIS opisuje składnię polecenia?
2. co oznaczają te [...]i [...]wnętrze [...]? Czy mają na myśli coś opcjonalnego?
3. Czy |oznacza OR?
4. Co ,oznacza w [-m system[,...]]?
5. Czy sekcja SYNOPSIS jest zgodna z regułami używanymi do wyrażeń regularnych?

1. Sekcja streszczenia zazwyczaj podaje kilka przykładowych przypadków użycia. Czasami polecenia podrzędne mają różne opcje, dlatego można wyświetlić kilka przykładów.
2. Nawiasy []zawsze oznaczają opcjonalne przełączniki, argumenty, opcje itp.
3. Tak, rura |oznacza lub, szczególnie gdy jest w nawiasach lub nawiasach.
4. Nawiasy w nawiasach oznaczają, że druga część zależy od pierwszej, a także sama jest opcjonalna. Niektórych przełączników możesz używać samodzielnie lub dodawać do nich wartość. Przecinki na początku nawiasu wskazują, że może istnieć wiele wartości oddzielonych przecinkami.
5. Opierają się na koncepcjach Regex, ale mają być czytelne dla ludzi, więc nie przestrzegaj wszystkich uciekających zasad itp.

Jeśli potrzebujesz referencji, są one luźno oparte na EBNF .

Ze manstrony podręcznika:

Poniższe konwencje mają zastosowanie do sekcji SYNOPSIS i mogą być wykorzystane jako przewodnik w innych sekcjach.

Dokładne renderowanie może się różnić w zależności od urządzenia wyjściowego. Na przykład man zwykle nie będzie w stanie renderować kursywą podczas uruchamiania w terminalu i zwykle zamiast tego użyje podkreślonego lub kolorowego tekstu.

Ilustracja polecenia lub funkcji jest wzorcem, który powinien pasować do wszystkich możliwych wywołań. W niektórych przypadkach wskazane jest zilustrowanie kilku wyłącznych wywołań, jak pokazano w sekcji SYNOPSIS tej strony podręcznika.

Innym źródłem zrozumienia znaczenia składni argumentów narzędzia wiersza poleceń byłyby konwencje składni argumentów narzędzia udokumentowane w rozdziale 12 i wyrażenia regularne udokumentowane w rozdziale 9 standardu POSIX.1-2008 (edycja 2013).