Man

Funkce

man: zformátuje a zobrazí on-line manuálové stránky

manpath: zobrazí manuálové cesty uživatele

Syntaxe

man [-acdfhkKtwW] [-m systém] [-p řetězec] [-C konfigurační soubor] [-M cesta] [-P stránkovač] [-S seznam_sekcí] [sekce] jméno ...

Popis

man zformátuje a zobrazí on-line manuálové stránky. Tato verze umí pracovat s proměnnými prostředí MANPATH a (MAN)PAGER, proto můžete mít i vlastní manuálové stránky a vlastní program určený ke stránkování zformátovaných manuálových stránek. Je-li specifikována sekce man hledá danou stránku pouze v této sekci. Samozřejmě můžete také specifikovat pořadí sekcí, které budou prohledávány a také můžete přímo na příkazové řádce nebo proměnnými prostředí určit, které preprocesory budou při formátování stránek použity. Obsahuje-li jméno znak /, je prvně vyzkoušeno jako jméno souboru, proto můžete udělat něco jako man ./něco.5 nebo man /cédéčko/něco/něco_jiného.1.gz.

Volby

-C konfigurační_soubor

Specifikujete jiný konfigurační soubor. Standardní je /etc/man.config. (Viz též man.conf(5).)

-M cesta

Specifikuje seznam manuálový cest (zde jsou hledány manuálové stránky). Není-li tato volba specifikována, je použita proměnná prostředí MANPATH /etc/man.config.

-P stránkovač

Specifikuje stránkovač, kterým budou stránky prohlíženy. Tato volba má přednost před MANPAGER, která má přednost před PAGER . Standardní stránkovač je /usr/bin/less-isR.

-S seznam_sekcí

Seznam_sekcí je čárkami oddělený seznam sekcí manuálových stránek. Tato volba má přednost před proměnnou prostředí MANSECT .

-a

Standardní nastavení ukončí man poté, co zobrazí první nalezenou manuálovou stránku. Tato volba umožní zobrazit všechny nalezené stránky, které vyhovují zadaným kritériím.

-c

Zformátuj zdroj manuálové stránky i když existuje již zformátovaná verze. Tato volba je významná. je-li zformátovaná stránka prohlížena na obrazovce s jiným počtem sloupců.

-d

Nezobrazuj zformátovanou stránku, pouze vytiskni ladící informace.

-D

Zobraz ladící informace i zformátovanou stránku.

-f

Totéž co whatis.

-h

Vytiskni krátkou pomoc a skonči.

-k

Totéž co apropos.

-K

Hledej specifikovaný řetěze ve *všech* manuálových stránkách.

Varování: tato funkce je pravděpodobně velmi pomalá! Specifikujete-li sekci, bude to rychlejší. (Jen pro zajímavost, na mém počítači to trvá přibližně minutu na 500 stránek).

-m systém: Specifikuje jinou sadu manuálových stránek závislou na zadaném systému.
-p řetězec: Specifikuje pořadí preprocesorů před nroff nebo troff. Ne všechny instalace mají plnou sadu preprocesorů. Některé preprocesory a písmena používaná pro jejich spouštění: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Tato volba má přednost před proměnnou prostředí MANROFFSEQ .
-t: Použij /usr/bin/groff -Tps -mandoc -c k formátování stránky a výstup zobraz na stdout. Výstup z /usr/bin/groff -Tps -mandoc -c je třeba před tiskem poslat přes nějaké filtry.
-w nebo --path: Nezobrazuj manuálové stránky, pouze vytiskni cestu(y) souborů, které bys zobrazil. Není-li zadán žádný argument: zobraz (na standardní výstup) seznam adresářů, které jsou programem man hledány. Je-li manpath link na man, potom je manpath totožné s "man --path".
-W: Podobné jako -w, ale tiskne jména souborů po jednom na řádek bez dalších informací. To je užitečné pro příkazy shellu jako např. man -aW man | xargs ls -l

Zformátované stránky

Man se snaží ukládat již zformátované manuálové stránky, aby ušetřil při jejich příštím zobrazení čas. Tradičně se zformátované stránky z DIR/manX ukládají do DIR/catX, ale jiná mapování z manuálového adresáře na adresář zformátovaných stránek je možné specifikovat v souboru /etc/man.config. Neexistuje-li adresář zformátovaných stránek, nejsou ukládány žádné zformátované stránky. Je možné nechat man suid pro uživatele man. Potom, je-li majitel adresáře zformátovaných stránek man a mód je 0755 (zapisovat může pouze vlastník), a zformátované stránky mají mód 0644 nebo 0444 (zapisovat může buď jenom majitel nebo vůbec nikdo), nemůže normální uživatel změnit zformátované stránky nebo umístit do adresáře zformátovaných stránek jiné soubory. Není-li man suid, potom by měl mít adresář zformátovaných stránek mód 0777 aby zde mohli všichni uživatelé zanechat jiř zformátované stránky. Volba -c způsobí reformátování stránky i když již existuje zformátovaná stránka.

Prostředí

MANPATH: Je-li nastavena proměnná MANPATH, její hodnota je využívána ke hledání zformátovaných stránek.
MANROFFSEQ: Je-li nastavena proměnná prostředí MANROFFSEQ je její hodnota využita pro určení pořadí spouštění preprocesorů před nroff nebo troff. Standardně jsou stránky formátovány prvně tabulkovým procesorem a teprve poté nroffem.
MANSECT: Je-li nastavena proměnná prostředí MANSECT je její hodnota využita k určení sekcí, které budou prohledávány.
MANWIDTH: Je-li nastavena proměnná prostředí MANWIDTH, tak její hodnota určuje počet sloupců, na které bude stránka zformátována. Jinak bude stránka zformátována na šířku obrazovky.
MANPAGER: Je-li nastavena proměnná prostředí MANPAGER její obsah určuje stránkovač, který bude použit při zobrazení zformátované stránky. Není-li nastavena, je použita proměnná PAGER . není-li ani tato proměnná nastavena, použije se /usr/bin/less -isR .
LANG: Je-li nastavena proměnná prostředí LANG její hodnota definuje podadresář, ve kterém budou hledány stránky. Potom příkaz 'LANG=cz man 1 manuálová_stránka' zobrazí stránku .../cz/man1/manuálová_stránka.1, nebo
NLSPATH, LC_MESSAGES, LANG: Proměnné prostředí NLSPATH a LC_MESSAGES (nebo LANG jestliže předchozí neexistují) hrají roli při hledání katalogu zpráv. (Anglické zprávy jsou zkompilovány a není pro ně třeba katalogu.) Dejte pozor na to, že programy jako col (1) volané programem man používají např. LC_CTYPE.
PATH: je používána při sestavení standardní manuálové cesty.
SYSTEM: je používána ke zjištění standardního jména systému (pro použití s volbou -m ).

Viz též

apropos, whatis, less, groff.

Chyby

Volba -t je funkční pouze, je-li instalován program podobný programu troff.

Uvidíte-li blikající \255 nebo <AD> místo oddělovátek, umístěte 'LESS-CHARSET=latin1' do Vašeho prostředí.