Comprendi la sinossi nella manpage


27

Non sono stato in grado di comprendere la sezione SINOSSI nella pagina man di un comando. Ad esempio, vediamo la manpage di manse stessa. Di 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. La sezione SINOSSI descrive la sintassi del comando?
  2. cosa significano quelli [...]e [...]dentro [...] ? Significano qualcosa di facoltativo?
  3. Non |significa O?
  4. Cosa ,significa in [-m system[,...]]?
  5. La sezione SINOSSI segue le regole utilizzate per le espressioni regolari?

Correlati: "Convenzioni di utilità" nello standard POSIX: pubs.opengroup.org/onlinepubs/9699919799/basedefs/…
Kusalananda

Risposte:


25
  1. La sezione di sinossi in genere fornisce alcuni casi d'uso di esempio. A volte i comandi secondari hanno opzioni diverse, quindi potrebbero essere mostrati diversi esempi.
  2. Le parentesi []indicano sempre opzioni, argomenti, opzioni ecc.
  3. Sì, il tubo |significa o, in particolare quando si trova tra parentesi quadre o parentesi.
  4. Le parentesi tra parentesi indicano solo che la seconda parte dipende dalla prima, e anche essa stessa opzionale. Alcuni switch possono essere utilizzati singolarmente o aggiungere un valore ad essi. Le virgole all'inizio di una parentesi indicano che possono esserci più valori separati da virgola.
  5. Si appoggiano ai concetti di Regex, ma sono pensati per essere leggibili dall'uomo, quindi non seguire tutte le regole di fuga ecc.

Grazie! Ci sono alcuni riferimenti che spiegano la sintassi della sinossi?
Tim

@Tim: Questo è uno dei più folli che abbia mai visto, penso che se leggi qualche altro ne avrai la certezza. È solo una convenzione, non una magia.
Caleb,

9

Se si desidera un riferimento, sono vagamente basati su EBNF .


3

Dalla manpagina man:


Le seguenti convenzioni si applicano alla sezione SINOSSI e possono essere utilizzate come guida in altre sezioni. descrizione della sinossi dell'uomo

Il rendering esatto può variare in base al dispositivo di output. Ad esempio, man normalmente non sarà in grado di eseguire il rendering del corsivo durante l'esecuzione in un terminale e in genere utilizzerà invece testo sottolineato o colorato.

L'illustrazione del comando o della funzione è un modello che dovrebbe corrispondere a tutte le possibili invocazioni. In alcuni casi è consigliabile illustrare diverse invocazioni esclusive, come mostrato nella sezione SINOSSI di questa pagina di manuale.


3

Un'altra fonte per comprendere il significato della sintassi dell'argomento dell'utilità della riga di comando sarebbero le convenzioni sulla sintassi dell'argomento dell'utilità documentate nel capitolo 12 e le espressioni regolari documentate nel capitolo 9 dello standard POSIX.1-2008 (edizione 2013).

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.