No he podido entender la sección SINOPSIS en la página de manual de un comando. Por ejemplo, veamos la página de manual de man
sí mismo. 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]
- ¿La sección SINOPSIS describe la sintaxis del comando?
- ¿Qué significan esos
[...]
y el[...]
interior[...]
? ¿Significan algo opcional? - ¿
|
Significa OR? - ¿Qué
,
significa en[-m system[,...]]
? - ¿La sección SINOPSIS sigue las reglas utilizadas para las expresiones regulares?
Respuestas:
[]
siempre indican interruptores opcionales, argumentos, opciones, etc.|
significa o, particularmente cuando está dentro de corchetes o paréntesis.fuente
Si desea una referencia, se basan libremente en EBNF .
fuente
Desde la
man
página del manual:fuente
Otra fuente para comprender el significado de la sintaxis del argumento de utilidad de la línea de comandos serían las convenciones de sintaxis de argumentos de utilidad documentadas en el Capítulo 12 y las Expresiones regulares documentadas en el Capítulo 9 del estándar POSIX.1-2008 (Edición 2013).
fuente