man(1)

JMÉNO
man - zformátuje a zobrazí on-line manuálové stránky
manpath - vypíše seznam adresářů, v nichž se hledají manuálové stránky

POUŽITÍ
man [-adfhkKtwW] [-m systém] [-p řetězec] [-C konfig_soubor] [-M seznam] [-P stránkovací_program] [-S seznam_sekcí] [sekce] jméno ...

POPIS
Příkaz man zformátuje a zobrazí on-line manuálové stránky. Tato verze používá proměnné prostředí MANPATH a (MAN)PAGER, takže uživatel může mít vlastní sady manuálových stránek a může si vybrat, pomocí jakého programu chce zobrazovat zformátované stránky. Jestliže je zadán parametr sekce, příkaz man prohledává pouze zadanou sekci manuálů. Pomocí voleb v příkazovém řádku nebo proměnných prostředí je možné zadat pořadí prohledávání sekcí a jméno programu, který bude používán pro zformátování manuálových stránek. Jestliže jméno obsahuje znak `/', příkaz man nejdříve zkusí otevřít soubor daného jména, takže je možné zadat man ./foo.5 nebo dokonce man /cd/foo/bar.1.gz.

VOLBY

-C  konfig_soubor
    Určuje jméno konfiguračního souboru pro program man. Implicitní hodnota je /etc/man.config -- viz man.config(5).

-M  seznam
    Definuje seznam adresářů, v nichž se hledají manuálové stránky. Jestliže není tato volba použita, příkaz man použije hodnotu proměnné prostředí MANPATH. Jestliže tato proměnná prostředí neexistuje, je použit implicitní seznam definovaný v /etc/man.config. Je-li v MANPATH prázdný podřetězec, dosadí se na jeho místo implicitní seznam.

-P  stránkovací_program
    Definuje jméno programu, který bude zobrazovat zformátované stránky. Tato volba má přednost před hodnotou proměnné prostředí MANPAGER, která má přednost před hodnotou proměnné PAGER. Implicitně používá man příkaz /usr/bin/less -je.

-S  seznam_sekcí
    Definuje pořadí prohledávání manuálových sekcí. Jména sekcí jsou oddělována dvojtečkami. Tato volba má přednost před proměnnou prostředí MANSECT.

-a  Implicitně program man zobrazí pouze první manuálovou stránka daného jména. Při použití této volby man zobrazí všechny manuálové stránky zadaného jména.

-c  Přeformátuje zdrojovou manuálovou stránku, i když je předformátovaná stránka k dispozici. Může být užitečné, pokud předformátovaná manuálová stránka byla zformátována pro obrazovku s jinou délkou řádku.

-d  Nezobrazí manuálovou stránku, ale vypíše množství ladících informací.

-D  Vypíše ladící informace a zobrazí stránku.

-f  Ekvivalent příkazu whatis.

-h  Vypíše návod k použití na standardní chybový výstup a skončí.

-k  Ekvivalent příkazu apropos.

-K  Vyhledá všechny manuálové stránky obsahující zadaný řetězec. Varování: může být velmi pomalé! Je možné urychlit zadáním čísla sekce. (Pouze pro hrubou představu, na mém počítači trvá prohledání 500 manuálových stránek přibližně minutu.)

-m  systém
    Definuje alternativní sadu manuálových stránek pro vyhledání omezené na systém zadaného jména.

-p  řetězec
    Definuje, kterými preprocesory se má stránka zpracovat před programem nroff nebo troff. Na některých systémech nemusí být všechny preprocesory k dispozici. Mezi používané preprocesory patří: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). V řetězci se použije písmeno uvedené v závorce. Tato volba má přednost před hodnotou proměnné prostředí MANROFFSEQ.

-t  Pro zformátování manuálové stránky se použije příkaz /usr/bin/groff -Tps -mandoc, pro výstup se použije standardní výstup. Výstup příkazu /usr/bin/groff -Tps -mandoc je možné před tiskem zpracovat dalšími filtry.

-w nebo --path
    Nezobrazí manuálovou stránku, ale pouze vypíše jméno nebo jména souborů, které by byly formátovány nebo zobrazeny. Jestliže nebyl zadán žádný argument, vypíše na standardní výstup seznam adresářů, ve kterých program man hledá manuálové stránky. Jestliže manpath je odkaz na man, potom "manpath" bude fungovat jako "man --path".

-W  Jako -w, ale vypisuje adresáře po jednom na řádek. Užitečné pro použití v konstrukcích jako man -aW man | xargs ls -l

PŘEDFORMÁTOVANÉ STRÁNKY
Program man se pokouší ukládat zformátované manuálové stránky, aby je nebylo nutné při dalším prohlížení znovu formátovat. Tradičně jsou zformátované verze stránek z DIR/manX uloženy v adresáři DIR/catX, ale v souboru /etc/man.config je možné zadat jiné mapovaní mezi adresáři pro nezformátované a zformátované stránky. Pokud adresář pro předformátované stránky neexistuje, nebudou zformátované stránky nikam ukládány.

Program man je možné nastavit setuid na uživatele man. Pak může mít adresář pro zformátované stránky práva 0755 a vlastníka man (tj. je zapisovatelný pouze uživatelem man) a zformátované stránky práva 0644 nebo 0444 s vlastníkem man (zapisovatelné pouze uživatelem man, nebo nezapisovatelné vůbec), a žádný normální uživatel nemůže změnit předformátované manuálové stránky nebo do adresáře umisťovat jiné soubory. Pokud příkaz man není sutuid, potom adresář pro zformátované stránky by měl mít práva 0777, aby v něm všichni uživatelé měli možnost zanechávat předformátované manuálové stránky.

Volba -c způsobí přeformátování stránky, i když již předformátovaná stránka existuje.

PROSTŘEDÍ

MANPATH
    Jestliže je nastavena proměnná prostředí MANPATH, její hodnota bude použita jako seznam adresářů, v nichž se budou vyhledávat manuálové stránky.

MANROFFSEQ
    Jestliže je nastavena proměnná prostředí MANROFFSEQ, její hodnota stanovuje, kterými preprocesory se má stránka zpracovat před zpracováním programem nroff nebo troff. Implicitně jsou stránky zpracovány tabulkovým preprocessor před programem nroff.

MANSECT
    Jestliže je nastavena proměnná prostředí MANSECT, její hodnota udává, které manuálové sekce se mají prohledávat.

MANWIDTH
    Jestliže je nastavena proměnná prostředí MANWIDTH, její hodnota udává šířku stránky (počet znaků na řádek), pro níž se má provést formátování. Jinak mohou být stránky zobrazeny přes celou šířku obrazovky.

MANPAGER
    Jestliže je nastavena proměnná prostředí MANPAGER, udává jaký program bude použit pro zobrazení manuálové stránky. Jestliže není nastavena, pak se použije hodnota proměnné PAGER. Jestliže ani ta není nastavena, použije se /usr/bin/less -je.

LANG
    Jestliže je nastavena proměnná prostředí LANG její hodnota definuje jméno podadresáře, v nichž jsou hledány manuálové stránky. Díky tomu příkaz `LANG=dk man 1 foo' způsobí, že příkaz man bude hledat manuálovou stránku pro foo v .../dk/man1/foo.1, a jestliže tento soubor nemůže nalézt, pak hledá v .../man1/foo.1, kde ... je adresář uvedený ve vyhledávací cestě.

NLSPATH, LC_MESSAGES, LANG
    Proměnné prostředí NLSPATH a LC_MESSAGES (nebo LANG když LC_MESSAGES neexistuje) hrají roli při hledání katalogu zpráv. (Pro angličtinu není žádný katalog potřeba, protože anglické zprávy jsou zakompilované v programu.) Pamatujte, že programy jako col(1) vyvolávané příkazem man používají také další proměnné prostředí jako LC_CTYPE.

PATH
    Proměnná prostředí PATH je použita pro vytvoření implicitní vyhledávací cesty pro manuálové stránky.

SYSTEM
    Proměnná prostředí SYSTEM je použita pro získání implicitního alternativního jména systému (pro použití s volbou -m).

VIZ TAKÉ
apropos(1), whatis(1), less(1), groff(1).

CHYBY
Volba -t pracuje pouze pokud je nainstalován program fungující jako troff.
Jestliže příkaz man vypisuje blikající \255 nebo <AD> místo národních znaků a pomlček, nastavte proměnnou prostředí `LESSCHARSET=latin1'.