MAN(7)

JMÉNO
man - makra pro formátování manuálových stránek.

SYNTAXE
groff -Tascii -man file ...

groff -Tps -man file ...

man [sekce] název

POPIS
Tato manuálová stránka popisuje makro balík tmac.an programu groff. Tento balík maker by měli používat vývojáři při psaní nebo přenosu manuálových stránek pro Linux. Je celkem kompatibilní s ostatními verzemi tohoto balíku a proto by přenos manuálových stránek z jiných systémů neměl být problémem (výjimkou je NET-2 BSD, který používá úplně jiný makro balík). NET-2 BSD manuálové stránky mohou být používány programem groff jednoduše, pokud použijeme volbu -mdoc místo standardní volby -man . Doporučujeme ale používat volbu -mandoc , protože ta automaticky rozezná, který makro balík má použít.

PREAMBULE
První příkaz manuálové stránky by měl být

    .TH titulek sekce datum zdroj manuál,

kde:

    titulek
        Titulek manuálové stránky (např. MAN).

    sekce
        Číslo sekce, ve které by měla být stránka uložena (např. 7).

    datum
        Datum poslední opravy manuálové stránky (nezapomeňte jej změnit po každé provedené změně, neboť je to nejobvyklejší cesta k rozpoznání verze manuálové stránky.)

    zdroj
        Zdroj příkazu.

        Pro programy používejte něco jako: GNU, NET-2, SLS Distribution, MCC Distribution.

        Pro systémová volání použijte verzi kernelu, na kterou se právě díváte: Linux 2.0.27.

        Pro knihovní volání použijte zdroj funkce: GNU, BSD 4.3, Linux DLL 4.4.1.

    manuál
        Titulek manuálu (např. Linux - Manuál programátora).

Manuálové sekce jsou podle tradice rozděleny takto:

    1 Příkazy
        Tyto příkazy může uživatel spouštět z shellu.

    2 Systémová volání
        Ty funkce, které musí být prováděny kernelem.

    3 Knihovní funkce
        Většina funkcí z knihovny libc , jako např. sort(3)

    4 Speciální soubory
        Soubory nacházející se v /dev

    5 Formáty souborů a konvence
        Formát souboru /etc/passwd a jiných čitelných souborů.

    6 Hry

    7 Makro balíky a konvence
        Popis standardní struktury systému souborů, tato manuálová stránka a další věci.

    8 Příkazy administrátora
        Příkazy jako mount(8), které může spouštět pouze root .

    9 Rutiny jádra
        Toto je nestandardní sekce manuálu a je tu proto, že zdrojové texty jádra Linuxu jsou volně šiřitelné za podmínek stanovených v GNU Public License a mnoho nadšenců pracuje na změnách v jádře).

FONTY
Ačkoliv již existuje mnoho konvencí pro manuálové stránky v UNIXovém světě, existence několika stovek manuálových stránek specifických pro Linux definovala naše standardy:

    Argumenty funkcí jsou vždy kurzívou, i v sekci SYNTAXE, kde je zbytek funkce napsán tučně:
    int myfunction(int argc, char **argv);

    Jména souborů jsou vždy kurzívou (např. /usr/include/stdio.h), kromě sekce SYNTAXE, kde jsou hlavičkové soubory tučně (např. #include <stdio.h>).

    Speciální makra, která jsou většinou psána velkými písmeny jsou tučně (např. MAXINT).

    Ve výčtu chybových kódů jsou tyto tučně (tento seznam obvykle používá makra .TP ).

    Všechny odkazy na jiné manuálové stránky jsou tučně. Je-li udáno i číslo sekce v manuálových stránkách, je napsáno hned za odkaz (např. man(7)). Příkazy pro nastavení řezu písma:

.B  Tučné

.BI Tučná kurzíva

.BR Tučné roman

.I  Kurzíva

.IB Italika tučně

.IR Italika s roman

.RB Roman tučné

.RI Roman italika

.SB Malé tučné

.SM Malé

Tradicí bylo, že každý příkaz mohl mít až šest argumentů, ale GNU verze odstranila toto omezení. Argumenty jsou odděleny mezerami. Uvozovky použijeme chceme-li specifikovat argument, který obsahuje mezery. Všechny argumenty budou vytištěny hned za sebe, a proto může být příkaz .BR použit pro vytištění slova následovaného interpunkční značkou ve fontu roman.

SEKCE
Sekce začínají příkazem .SH následovaným názvem dané sekce. Jestliže jméno obsahuje mezery a je na stejné řádce jako .SH, potom jej umístěte do uvozovek. Tradiční názvy sekcí jsou: JMÉNO, SYNTAXE, POPIS, VOLBY, SOUBORY, DALŠÍ INFORMACE, DIAGNÓZA, CHYBY, a AUTOR. Jediná povinná sekce je JMÉNO, za kterou by měl následovat jednořádkový popis programu:

    .SH JMÉNO
    šachy \- hra šachy

Je velmi důležité dodržet tento formát, protože je tato syntaxe použita programem makewhatis(8) k vytvoření databáze zkrácených popisů příkazů pro příkazy whatis(1) a apropos(1)

JINÁ MAKRA
Mezi tato makra patří např.:

.DT Standardní tabulátory

.HP Začátek odsazení

.IP Začátek odstavce s odsazením. Toto makro je stejné jako .TP, kromě toho, že je na stejné řádce a ne až na řádce následující.

.LP Totéž jako .PP

.PD Nastav meziodstavcové odsazení na hodnotu argumentu

.PP Začni odstavec

.RE Konec relativního odsazení (odsazený odstavec)

.RS Začátek relativního odsazení (odsazený odstavec)

.SS Hlavička (jako .SH, ale je používáno pro subsekce)

.TP Začni odstavec s `visící' značkou. Značka je na dalším řádku. Tento příkaz je podobný .IP

SOUBORY
/usr/lib/groff/tmac/tmac.an
/usr/man/whatis

DALŠÍ INFORMACE
groff(1), man(1), whatis(1), apropos(1), makewhatis(8)