Não consegui entender a seção SYNOPSIS na página de manual de um comando. Por exemplo, vamos ver a página de manual em man
si. Por 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]
- A seção SYNOPSIS descreve a sintaxe do comando?
- o que aqueles
[...]
e[...]
dentro[...]
significam? Eles significam algo opcional? - Será que
|
significa OR? - O que
,
significa[-m system[,...]]
? - A seção SINOPSE segue as regras usadas para expressões regulares?
Respostas:
[]
sempre indicam opções, argumentos, opções etc.|
significa ou, principalmente quando dentro de colchetes ou parênteses.fonte
Se você deseja uma referência, eles são vagamente baseados no EBNF .
fonte
Na
man
página do manual:fonte
Outra fonte para entender o significado da sintaxe do argumento do utilitário da linha de comando seria as convenções da sintaxe do argumento do utilitário documentadas no capítulo 12 e expressões regulares documentadas no capítulo 9 do padrão POSIX.1-2008 (edição de 2013).
fonte