Compreender a sinopse na manpage

Question

Eu não consegui entender a seção SINOPSE no manpage de um comando. Por exemplo, vamos ver a página de manual do man em 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]

1. A seção SINOPSE descreve a sintaxe do comando?
2. o que significam [...] e [...] dentro de [...] ? Eles significam algo opcional?
3. O | significa OR?
4. O que significa , em [-m system[,...]] ?
5. A seção SINOPSE segue as regras usadas para expressões regulares?

Answer 1

1. A seção de sinopses geralmente fornece exemplos de casos de uso. Às vezes, os subcomandos têm opções diferentes, portanto vários exemplos podem ser mostrados.
2. Os parênteses [] sempre denotam opções, argumentos, opções, etc.
3. Sim, o canal | significa, particularmente entre colchetes ou parênteses.
4. Os colchetes entre parênteses significam que a segunda parte depende do primeiro e também é opcional. Alguns switches podem ser usados sozinhos ou adicionar um valor a eles. Vírgulas no início de um colchete indicariam que pode haver vários valores separados por vírgula.
5. Eles se apóiam em conceitos Regex, mas devem ser legíveis por humanos, então não siga todas as regras de escape, etc.

Answer 2

Se você quer uma referência, eles são vagamente baseados em EBNF .

    

Answer 3

Outra fonte para entender o significado da sintaxe do argumento do utilitário de linha de comando seriam as convenções de Sintaxe do Argumento do Utilitário documentadas em Capítulo 12 e Expressões Regulares documentadas em Capítulo 9 do Padrão POSIX.1-2008 (2013 Edition).

    

Answer 4

Da página de manual man :

The following conventions apply to the SYNOPSIS section and can be used as a guide in other sections.

Exact rendering may vary depending on the output device. For instance, man will usually not be able to render italics when running in a terminal, and will typically use underlined or coloured text instead.

The command or function illustration is a pattern that should match all possible invocations. In some cases it is advisable to illustrate several exclusive invocations as is shown in the SYNOPSIS section of this manual page.