Esiste una specifica per la sezione SYNOPSIS di una pagina man?

Question

Sto provando a scrivere alcune specifiche da condividere tra una piccola squadra e ad essere schizzinoso sul formato in cui inserisco alcune voci di comando. C'è qualche formale definizione della sintassi utilizzata nella sezione SYNOPSIS delle pagine man?

Da Wikimedia Commons, ecco un esempio di una pagina man con la sezione SYNOPSIS di cui sto parlando, in cui il comando è elencato con gli argomenti richiesti e opzionali che comprende.

Answer 1

Non c'è definizione formale di una pagina di manuale da nessuna parte, nemmeno nello standard POSIX. La manpage di man(1) nell'esempio è piuttosto tipica: si scrivono i vari modi in cui un programma può essere utilizzato (spesso solo uno) con [] denotando il carattere opzionale, grassetto (o macchina da scrivere con i macro mdoc) che denota letterale input da riga di comando e corsivo che denota variabili .

Le pagine di manuale man(7) e mdoc(7) spiegheranno le convenzioni più importanti. man(7) è per le manpage Unix vecchio stile ed è ancora popolare su Linux (vedere man-pages(7)); mdoc(7) deriva da 4.4BSD ed è popolare nei suoi derivati. Quest'ultimo mantiene una separazione più rigorosa di contenuto e presentazione e può produrre (IMHO) un'uscita PDF/HTML più carina

Answer 2

Le convenzioni di utilità per le utilità sono documentate in Chapter 12. Utility conventions of the IEEE Std 1003.1, 2004 Edition.

Una nuova edizione di questo documento esiste here

Answer 3

man 7 l'uomo:

descrive brevemente il comando o l'interfaccia della funzione. Per i comandi, mostra la sintassi del comando e dei relativi argomenti (incluse le opzioni ); grassetto viene utilizzato per as-is text e il corsivo viene utilizzato per indica argomenti sostituibili. Le parentesi ([]) circondano gli argomenti opzionali , le barre verticali (|) le scelte separate e le ellissi (...) possono essere ripetute . Per le funzioni, mostra le dichiarazioni dei dati richieste o le direttive #include, seguite dalla dichiarazione delle funzioni.