Esiste uno standard per scrivere una sinossi di comando?

Mi sembra che ognuno abbia la propria idea su come scrivere una sinossi che descriva l' utilizzo dei comandi per l'utente finale.

Ad esempio, questo è il formato da man grep:

grep [OPTIONS] PATTERN [FILE...]
grep [OPTIONS] [-e PATTERN | -f FILE] [FILE...]

Ora questo ha una sintassi che appare in altre manpage. []è riconosciuto come facoltativo e ...ha senso come multiplo dello stesso input.

Ma la gente usa |o /per OR e ce ne sono altri che annulleranno il []significato. Oppure non danno alcuna indicazione su dove [OPTIONS]vada.

Vorrei seguire uno standard per quello che scrivo, ma ogni sito web che guardo mi dice qualcosa di diverso.

Esiste un modo standard per scrivere sinossi o la convenzione è esattamente ciò che le persone hanno fatto nel tempo?

command-line man

— Tormyst
fonte

Scegline uno e mantienilo.

— Kevin,

Per qualche ragione non penso che sarebbe di aiuto. Ogni persona avrebbe il proprio standard e quindi non si sarebbe mai fatto nulla al riguardo.

— Tormyst,

È questo il tipo di standard che intendi? pubs.opengroup.org/onlinepubs/009695399/basedefs/…

— Mark Plotnick,

Sì, questo è esattamente quello che stavo cercando. Grazie.

— Tormyst,

@MarkPlotnick - Vorrei che un A in modo che l'OP potesse accettarlo. Questo è lo standard se mai ce n'è stato uno. Fare riferimento al collegamento a cui fa riferimento illuminÉ.

— slm

Lo standard classico per questo è da POSIX, sintassi dell'argomento Utility (grazie a @ illuminÉ per il link aggiornato). Descrive ad esempio la sintassi da usare nelle pagine man

utility_name[-a][-b][-c option_argument]
    [-d|-e][-f[option_argument]][operand...]

Essendo classico, raccomanda di utilizzare le opzioni a carattere singolo, con quelle -Wconsigliate dai fornitori, ed è così che vengono ospitate le opzioni a più caratteri (vedere, ad esempio, Riepilogo delle opzioni di gcc ).

Il software GNU ha introdotto opzioni multi-carattere che iniziano con --. Alcune linee guida di GNU per la formattazione delle pagine man con quelle opzioni sono disponibili nel riferimento help2man .

— Mark Plotnick
fonte