notazione sinossi della pagina man

Question

Durante la lettura delle pagine man, nella mia esperienza c'è sempre stata una sezione synopsis. per esempio.

MV(1)      BSD General Commands Manual     MV(1) 

NAME 
mv -- move files 

SYNOPSIS 
mv [-f | -i | -n] [-v] source target 
mv [-f | -i | -n] [-v] source ... directory 

Mi interessa la notazione usata nella sezione synopsis. Come si chiama e dove posso trovare maggiori informazioni a riguardo?

In generale sembra abbastanza semplice, e di solito riesco a capire cosa significa, ma mi piacerebbe iniziare a usarlo per la mia documentazione, quindi penso che dovrei scoprire cosa posso fare riguardo la sintassi prima Inizio a scrivere le mie pagine man.

Answer 1

Questo è qoute da man man:

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

    bold text   type exactly as shown. 
    italic text  replace with appropriate argument. 
    [-abc]    any or all arguments within [ ] are optional. 
    -a|-b    options delimited by | cannot be used together. 
    argument ...  argument is repeatable. 
    [expression] ... entire expression within [ ] is repeatable. 

    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. 

Quindi penso che questo notazione sinossi si è formato storicamente.