2013-03-17 13 views
6

Podczas czytania stron man, z mojego doświadczenia wynika, że ​​zawsze była sekcja synopsis. na przykładnotacja streszczenia strony man

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 

Jestem zainteresowany notacją stosowaną w sekcji synopsis. Jak się nazywa i gdzie mogę znaleźć więcej informacji na ten temat?

Ogólnie rzecz biorąc wydaje się to dość proste i zazwyczaj mogę się domyślić, co to znaczy, ale chciałbym zacząć używać go do własnej dokumentacji, więc myślę, że powinienem dowiedzieć się, co mogę na temat składni przed Zaczynam pisać własne strony man.

+0

'man man' rozpocznie grę. również wyszukać 'groff'. –

+2

@MarcB Gdzie na stronach man 'man' lub' groff' jest wyjaśnione takie rzeczy jak '[...]' wskazuje opcjonalne argumenty, a '|' wskazuje alternatywy? Myślę, że jest to wariacja na temat notacji składni Backusa-Naura. – Barmar

Odpowiedz

4

To qoute z 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. 

Więc myślę, że to notacja Fabuła została utworzona historycznie.