Compreender a sinopse na página de manual

27

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 mansi. 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 SYNOPSIS descreve a sintaxe do comando?
  2. o que aqueles [...]e [...]dentro [...] significam? Eles significam algo opcional?
  3. Será que |significa OR?
  4. O que ,significa [-m system[,...]]?
  5. A seção SINOPSE segue as regras usadas para expressões regulares?
Tim
fonte
Relacionado: "Convenções de utilidade" no padrão POSIX: pubs.opengroup.org/onlinepubs/9699919799/basedefs/…
Kusalananda

Respostas:

25
  1. A seção de sinopse geralmente fornece alguns casos de uso de exemplo. Às vezes, os subcomandos têm opções diferentes, portanto, vários exemplos podem ser mostrados.
  2. Parênteses []sempre indicam opções, argumentos, opções etc.
  3. Sim, o tubo |significa ou, principalmente quando dentro de colchetes ou parênteses.
  4. Parênteses entre parênteses significa apenas que a segunda parte é dependente da primeira e também é opcional. Algumas opções que você pode usar por conta própria ou agregar um valor a elas. Vírgulas no início de um colchete indicariam que pode haver vários valores separados por vírgula.
  5. Eles se apóiam nos conceitos do Regex, mas devem ser legíveis por humanos, portanto, não sigam todas as regras de escape, etc.
Caleb
fonte
Obrigado! Existem algumas referências que explicam a sintaxe da sinopse?
Tim
@ Tim: Esse é um dos mais loucos que eu já vi, acho que se você ler mais um pouco, entenderá. É apenas convenção, não mágica.
Caleb
9

Se você deseja uma referência, eles são vagamente baseados no EBNF .

Kim
fonte
3

Na manpágina do manual:


As convenções a seguir se aplicam à seção SYNOPSIS e podem ser usadas como guia em outras seções. descrição da sinopse do homem

A renderização exata pode variar dependendo do dispositivo de saída. Por exemplo, o homem geralmente não será capaz de render itálico ao executar em um terminal e, normalmente, usará texto sublinhado ou colorido.

A ilustração de comando ou função é um padrão que deve corresponder a todas as invocações possíveis. Em alguns casos, é aconselhável ilustrar várias invocações exclusivas, como é mostrado na seção SINOPSE deste manual.

Jules Randolph
fonte
3

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).

Preguiça
fonte