Manuálové stránky

27. 1. 2005 | Martin Podhola | Návody | 12232×

Když si člověk s příkazem, programem nebo konfigurací neví rady, je pomoc často na dosah ruky. Jak číst a používat manuálové stránky. Ovládání programu man.

Co se zde dočtete

Pro Linux existuje mnoho zdrojů informací. Spousta vlastností nebo konfiguračních nastavení není vždy intuitivní a jednoduchá. Naopak většina linuxových programů má desítky, a troufám si říci, že některé i stovky, voleb. Proto je potřeba podrobná dokumentace. Máme řadu možností, jak se k ní dostat. Především prostřednictvím internetu, v knižní podobě nebo přímo ve své nainstalované distribuci; to jsou právě manuálové stránky a návody HOWTO. Internet nemáme vždy po ruce, v knížkách není vše a často potřebujeme mít vše k hned k dispozici. Právě k tomu nám slouží manuálové stránky, o nichž si budeme povídat trochu podrobněji.

Jak to vypadá v praxi

Každý "kloudný" program má svou manuálovou stránku, kde jsou popsány jeho funkce a možnosti. Každý příkaz má svou stránku, jakož i většina konfiguračních souborů. Procházení manuálové stránky je velmi jednoduché a říká se, že "man" je nejčastěji používaný příkaz v unixových systémech.

Manuálovou stránku otevřeme příkazem man. Tento krátký příkaz vám nabídne manuál ke konkrétnímu příkazu, funkci, aplikaci, atd. Spuštění vypadá takto:

man vim

Vypíše manuálovou stránku editoru vim. Ze začátku se zdá manuálová stránka zvláštní, ale brzy zjistíte, že je velice přehledná a většinu základních informací lze snadno časem vyčíst z první obrazovky. Nevýhodou však je, že většina man stránek je doposud v anglickém jazyce. Pracuje se na jejich počeštění a nové překlady jsou neustále přidávány. Je ovšem složité přeložit takové množství dokumentace, kterou Linux ve formě man stránek obsahuje. Tyto stránky se navíc neustále mění a rozrůstají (aktualizují s novou verzí programu), a proto bych osobně dal přednost verzi anglické, která by měla být oproti české aktuálnější.

Nutno podotknout, že i vy se můžete podílet na počeštění dalších stránek. Stačí jen zkontaktovat správce projektu, nebo se připojit k lokalizaci konkrétních aplikací.

Základní čtení manuálových stránek

Hned na začátku můžeme poznat, o jakou sekci manuálových stránek se jedná. Na prvním řádku se vyskytuje toto (použijeme-li man gzip):

GZIP(1)

To znamená, že se jedná o man page o programu gzip, patřící do sekce 1.

1. Sekce 1 se zabývá spustitelnými programy a příkazy shellu. Je to asi nejvíce používaná sekce.
2. Sekce 2 popisuje systémová volání (funkce poskytované jádrem). To se hodí při programování (a pokud víte, o co jde). Jinak vám moc užitečná při běžné práci nebude.
3. Sekce 3 obsahuje volání knihoven (funkce z knihoven programů). V podstatě navazuje na předchozí sekci a rozšiřuje dokumentaci pro programátory.
4. Sekce 4 popisuje speciální soubory, většinou soubory zařízení v /dev. Hodí se nejen při programování, ale i při různých poněkud složitějších systémových konfiguracích.
5. Sekce 5 popisuje formát a syntaxi konfiguračních souborů, což je velmi užitečné pro každého. I tak je ale nutné znát alespoň název souboru. V některých distribucích jsou sekce 4 a 5 prohozeny.
6. Sekce 6 má manuály k několika hrám, avšak z důvodů nedůsledné dokumentace došlo k tomu, že většina her má manuál stejně v 1. sekci.
7. Sekce 7 obsahuje rozdílný obsah dle distribuce. Ale většinou to jsou různé dodatky nebo licence (GNU GPL), informace o X nebo LDP (Linux dokumentační projekt^*).
8. Sekce 8 se týká systémové administrace.
9. Poslední sekce se jmenuje "n", což značí slovo "new". To jsou v podstatě nově přiinstalované aplikace, které se nepodařilo zařadit. Jinak, pokud něco nenajdete v jiných sekcích, hledejte to zde.

^*LDP - Linux dokumentační projekt, je velmi propracovaná publikace, která má ve svém třetím českém vydání více než 1 000 stránek. Podle mého názoru je jednou z nejkvalitnějších knih o Linuxu pro začátečníka i pokročilého uživatele. Kromě originální online podoby na http://www.tldp.org je dostupná zadarmo ke stažení ve formátu PDF na stránkách nakladatelství Computer Press. A to konkrétně zde: www.cpress.cz/knihy/ldp2.

Dále v manuálové stránce uvidíte část NAME. Ta obsahuje název programu nebo jeho možné varianty a krátký, jednořádkový popis, který stručně vystihuje jeho účel.

NAME
    gzip, gunzip, zcat - compress or expand file

Teď můžeme poznat, že se jedná o program pro komprimaci a dekomprimaci souborů.

Část SYNOPSIS je mnohdy nejdůležitější. Obsahuje informace o použití aplikace. Linuxové programy mívají řadu voleb a přepínačů a pak spousty možných parametrů. Některé z nich jsou volitelné, jiné povinné.

SYNOPSIS
    gzip [ -acdfhlLnNrtvV19] [ -S suffix] [ name ... ]

Argumenty a volby v hranatých závorkách jsou volitelné. Občas můžeme vidět "vnořenou volitelnou volbu". Vypadá takto: [ -x [-y] ] a znamená, že volby x i y jsou volitelné, ale y může být zvoleno pouze v případě, že je zvoleno x.

Řetězec suffix čeká, že bude v případě výběru volby nahrazen nějakým tím suffixem ;). Suffix je koncovka, kterou má výsledný zkomprimovaný program dostat. A name je stejný případ, ale pro něj není zapotřebí parametr.

Pokud bude však mezi argumenty uvidíte rouru |, znamená to, že jsou použitelné oba argumenty, ale vždy právě jeden (tedy nikdy ne oba současně).

[ -x | -y]

Další část DESCRIPTION obsahuje již vyčerpávající popis aplikace a jejích vlastností.

V části OPTIONS je popis všech parametrů a vůbec všeho, co program může přebírat, je zde uvedeno - i více možností zadávání parametrů. Např. tyto dva zápisy jsou ekvivalentní:

-f
--force

Dále může být několik nepovinných částí, které se mohou u různých man stránek lišit. Často obsahují ukázky použití a další informace.

Poté je zde část SEE ALSO, která obsahuje seznam souvisejících manuálových stránek. Často je budete prohledávat, když v právě čtené nenajdete to, co zrovna potřebujete.

V sekci AUTHOR se dozvíme něco o autorovi, případně i o překladateli.

Ke konci, v sekci BUGS, najdete popis známých chyb.

Ovládání

• Ukončuje se stiskem klávesy q.
• Nahoru a dolů o jeden řádek se v něm pohybujeme pomocí kurzorových kláves.
• Mezerníkem skočíme o obrazovku dolů.
• Klávesy Page Up a Page Down skáčí, jak jinak, o obrazovku nahoru a dolu.
• Lomítko / umožňuje vyhledávat. Na další nalezený výskyt přeskočíte stisknutím n.

V dolní části obrazovky se nám ukazuje rozsah řádků, který je zobrazován (lines 1 - 49). Pro pohyb po jednotlivých řádcích nahoru a dolu je nutné mít nainstalovaný program less.

Pro čtení manuálových stránek v X (v grafickém rozhraní, správci oken) se dá použít program xman, který vám otevře malé okénko s nabídkou. V něm klikneme na manual page a v menu již můžeme přepínat přímo mezi sekcemi manuálových stránek.

Vyhledávání v man stránkách

K vyhledání manuálových stránek můžeme použít příkaz apropos. Jedná se o program, který prohledává názvy a popisy manuálových stránek. Hledá klíčové slovo (i regulární výraz), a pokud není nalezeno, vypíše xyz: Nothing to appropriate a skončí. Je-li úspěšný, vypíše výsledek. apropos se hodí, neznáme-li název aplikace pro něco, co potřebujeme udělat - vypíše nám možnosti. Pokud vypsaný program neznáme, měli bychom si prostudovat jeho manuálové stránky před tím, než ho použijeme metodou pokusu a omylu. To by mohla být veliká chyba, protože spousta příkazů je při špatném užití destruktivní.

Při hledání máme k dispozici ještě příkaz whatis, který také zachází s databází whatis. Rozdíl od apropos je ten, že whatis vyhledává pouze v názvech manuálových stránek.

Například:

apropos ncurses
alsamixer (1) - soundcard mixer for ALSA soundcard driver, with ncurses interface
ncurses (3x)  - CRT screen handling and optimization package

whatis ncurses
ncurses (3x)  - CRT screen handling and optimization package

Pokročilé vyhledávání

Pokud hledáme pouze konkrétní parametr ke konkrétní aplikaci, můžeme využít jedné z možností unixového systému. Použijeme tzv. rouru.

man man | grep Executable

Jak to funguje? Výstup z příkazu man man je pomocí roury | poslán ke zpracování programu grep. Tento program prochází vstupní text a vrací řádky obsahující zadaný výraz. Pokud chceme zobrazit i řádky následující po řádku s výskytem výrazu, použijeme přepínač -An, kde n je počet řádků, které se mají po výsledku vypsat:

man xyz | grep -A 15 něco

Naopak, chceme-li vypsat řádky výše od výsledku hledání, použijeme přepínač -B. Tyto parametry lze použít současně.

Závěr

Doufám, že vám tento článek pomohl a dozvěděli jste se něco nového, zajímavého a užitečného.

       

Komentáře

[Mortal]

fakt jsem nečekal, že se v článku s názvem manualové stránky dozvím něco nového.
no jo, člověk se furt učí...

[xkesh]

"*LDP - Linux dokumentační projekt, je velmi propracovaná publikace ... Podle mého názoru je jednou z nejkvalitnějších knih o Linuxu pro začátečníka..."

Mohu se zeptat autora, co ho KONKRETNE k tomuto hodnoceni vedlo?

Ja treba si ji stahl a procetl... bohuzel se neustale venuje uz davno neaktualnimu srovnavani s MS DOS, rozplyva se nad funkcemi jadra 2.2 (nebo jeste nizsiho), obsahuje minimum praktickych prikladu, a to jeste na verze, ktere uz snad nikdo nepouziva... jen obcas se to (dost marne) snazi aktualizovat poznamky prekladatelu...

Jedine, ceho je tam hodne, jsou na muj vkus hodne ukecane pasaze o historii a ruznych etapach Linuxu, psane (soude podle ceskeho prekladu) silenym slohem (tj. nudne).

Podle meho nazoru (prakticky zacatecnika) je tato kniha vhodna akorat tak pro sentimentalni vzpominani, jak to tehdy bylo, pripadne pro stouraly v historii operacnich systemu. Coz by se dalo napsat vecneji a strucneji. Tech 1000 stranek opravdu nema opodstatneni, protoze PRAKTICKEHO jsem se o Linuxu dozvedel minimum a uz vubec ne o tom, ktery pouzivam.

Netvrdim, ze existuje takto komplexne neco lepsiho, nebo ze nemela ci pro nekoho nema tato verze povidani o Linuxu nejaky uzitek.

Opravdu ale nechapu, proc je tato kniha stale doporucovana zacatecnikum a co jim ma krome historickych zajimavosti prinest - snad mi to tu nekdo v diskusi objasni, dekuji.

[xkesh]

btw tady je odkaz na 3. aktualizovane vydani - v clanku je na druhe. i kdyz netusim, v cem ta aktualizace spociva a jestli neco prinese (kazdopadne je o 4 MB nafouklejsi - ten soubor :)

[Robert Krátký]

Opravil jsem odkaz v článku, díky.

[Petr Jakubec]

ok, tak si stahni lepsi knihu o linuxu...
(a dej mi link ja o zadne zatim nevim
pokud vsak nejde o to "zdarma" tak je velmi hezka kniha "Pouzivame Linux" je konzistentni a dobre se cte, budi dojem profesionalne udelane knihy pro zacatecniky a mirne pokrocile uzivatele linuxu.
--
PJ
PS: prosim nenapadat, vse je jen dle IMHO, zminene knihy mam samozrejme v knihovne (tecka)

[Keny]

Hodně zajímavá kniha dle mého soudu vhodná pro začátečníky vyšla poměrně nedávno Linux pro aministrátory Windows (Nakladatelství Computerpress 2004). Baťovská cena cca 499 Kč podle mne věru stojí za to. Přes drobné mouchy podává věci polopaticky, obsahuje spoustu komentářů a opravdu podstatné informace, hlavně pro ty uživatele co prozatím přišli do styku pouze s Windows. Hodně věcí na které jsem přišel metodou pokus omyl bych si mohl odpustit, kdyby byla k dispozici tak před třemi lety když jsem s Linuxem začínal. Ještě drobná poznámka: z textu knihy lze vycítit že knihu skutečně psali dva autoři, proto bych doporučoval některé pasáže brát trochu s rezervou..

[Leoš Literák]

Obcas pokulhava. Takze pokud se vam kvalita ci rozsah ceske manualove stranky nezda, original si vyvolate

LANG=C man wget

[Petr Jakubec]

Mozna je v nekterych pripadech* jednodudussi a vyhodnejsi
$ man -a wget
ktere zobrazi vsechno (postupne) co mame k dispozici?
* je to pouzitelne jen na systemech kde nejsou jine nez en a [local] jazyky... na systemech s nainstalovanym vsim moznym vcetne vsech man stranek be vas to akorat zblblo.
PJ

[Martin]

Mam dotaz k lokalizaci. na slackwaru 10 jsem zkousel lokalizovat (X jedou bez problemu), v shellu funguje cestina taky, ale treba pri vypisu manualovych stranek to mrsi cestinu. zkousel jsem to predelat podle Czech-HOWTO i podle navodu na lokalizaci slackwaru (navod je na starsi verzi), ale porad to tu cestinu mrsi. Nevite kde bych toho nasel vic? Dik za odpovedi, pro zacatecnika.

[DjAARA]

u sebe na gentoo sem musel jednu dobu v /etc/man.conf zmenit parametr k jednomu z tech programu na konci na -Tlatin1

[jan hluštík]

Řešení jsem viděl myslím někde na nějakých osobních stránkách, na které jsem našel odkaz na qwert.cz. Někde na stránce s návody. Akorát jsem si to vytiskl, ale ještě jsem to nečetl, takže nevím přesně princip řešení. Sorry jestli jsem příliš lakonickej, ale mám zrovna ruce od kuřete.

[ivok]

Tahle rada je dobrá, ale bohužel nefunguje vždycky... Aspoň na mém MDK 10.1 tohle nefunguje - dostanu _českou_ stránku, i kdyz nastavím locales na C. Bohužel jsem nepřišel na to, čím to je (a víc než pět minut jsem tomu věnovat nechtěl) - asi něco s MANPATH nebo tak...

[Hynek (Pichi) Vychodil]

Hmm, a co takhle nepoužívat MDK? Systém na kterém mám problém se dostat k man stránkám, je na ...

[ivok]

Hm, mě MDK vyhovuje, dostat se k těm man stránkám určitě jde, jen jsem nepřišel na to jak (a proč nestačí změna LANG - samo jsem zkoušel i LC_ALL). Dokonce ani netuším, jestli to není jen můj lokální problém... Tak jako tak distribuci rozhodně měnit nebudu

[Petr (DotaZ) Jakubec]

nejak se v tom ztracim Hynku, pomoz mi:
kdoze je tu ten zacatecnik a kdo potrebuje pomoci? rada tenhleten os je k nicemu nejlepsi je uplne jiny, nemuze byt dobrym projevem...
Dale nechapu jak si chtel svym prispevkem nebohemu zacatecnikovi pomoci. A zavrsim to posledni otazkou, zda se ze Ty to budes vedet - a kteryze je to ten spravny OS, ve kterem mi bude vsechno bezet a nejlepe "samo od sebe"?
doufam ze si jiz uvedomujes hloupost cele teto situace.
odpovedi netreba.
Pripadne me dohledej googlem a napis email.

[Hynek (Pichi) Vychodil]

Program který nemá man stránku napsal člověk, který na mě jako uživatele, nebo správce z vysoka co? se..e! Systém kterému nefungují po instalaci manuálové stránky je odfláknutý. To je základní funkčnost! Jak to mám opravit, když se nedostanu ani k návodu jak to mám opravit? Jak to mám používat, když se nedostanu ani k informaci k čemu to je a jak se to používá? S MDK jsem začínal a tímhle problémem trpěl už tehdy. Manové stránky jsou v něm neaktuální, nefunkční a ... Takový systém používat co? Nehodlám! Autoři té distribuce na mě jako na uživatele kašlou, takže já kašlu na ně.

[MaT]

Co proboha resite? Tady si uzivatel nestezoval na to, ze mu nejdou manualove stranky, ale ze mu podle toho tipu nechodi v anglictine... Jinak jestli vas to zajima, ted jsem to zkousel na jednom Gentoo Boxu a s tim LANG=C man wget se k anglicke verzi taky nedostanu. To je podle vas taky blba distribuce?

[podlesh]

Ja bych misto LANG=C (cimz se zmeni defaultni locale, ale pokud je nastavene LC_MESSAGES tak se pouzije to) dal LC_ALL=C (tim se vsechny locale nastavi na C).

[MOJE]

Ono je potreba tech promennych nastavit vic, protoze man kontroluje nejen LANG, ale taky LANGUAGE a LC_MESSAGES a pokud je aspon jedna z nich jina, nez C tak se zaridi podle ni. Jo a zbezny pohled do zdrojaku manu rika, ze se tak chova standardne a neni to vymysl MDK.

[zabza]

OK, věnoval jsem tomu dalších pět minut a přišel na to, jak to zařídit - takže pokud někomu nefunguje ten příkaz co psal Leoš:

/usr/share/man/cs:/usr/share/man:/usr/X11R6/man/cs:/usr/X11R6/man
[ivok@zero ivok]$ LANG= man -w
/usr/share/man/cs:/usr/share/man:/usr/X11R6/man/cs:/usr/X11R6/man
[ivok@zero ivok]$ LC_ALL= man -w
/usr/share/man:/usr/share/man/cs:/usr/X11R6/man:/usr/X11R6/man/cs
[ivok@zero ivok]$ LC_ALL=C man -w
/usr/share/man/cs:/usr/share/man:/usr/X11R6/man/cs:/usr/X11R6/man
[ivok@zero ivok]$ LANG=C man -w
/usr/share/man/cs:/usr/share/man:/usr/X11R6/man/cs:/usr/X11R6/man

[unchallenger]

pokud se vam kvalita ci rozsah ceske manualove stranky nezda

tak je neinstaluji. To pomáhá při libovolném nastavení locale.

Jsem šťastný jako blecha, když je aktuální a srozumitelná alespoň anglická manuálová stránka, protože ani ta často nebývá.

[naše jméno]

Jak jednoduše tisknout man stránku, včetně zvýrazněných částí?

[Honza "tux" Friesse]

No i když to vypadá trošku... zvláštně, tak za nejlepší považuji zobrazení v KDE a tisk tam. Prostě zadáte v konqueroru man:man (nebo obecně man:stránka_co_chcete_vidět) a je to zformátované v HTML...

[Honza "tux" Friesse]

Ještě, kdyby jste měl vyslovený odpor ke KDE, tak příkazy man2html, man2dvi. Z názvu je jasné, co dělají...

[jan hluštík]

Mně se osvědčilo zcat wget.1.gz | man2html. Jinak man2html protestoval.

[Hynek (Pichi) Vychodil]

man -Tps cosi|lpr

Já myslel, že tenhle článek byl o tom jak číst man stránky a taky o tom, že je to dobré. Než se blbě zeptám tak si přečtu man. Tak třeba man man.

[unchallenger]

Odstavec Ovládání mě tedy pobavil. Čekal bych, že tam bude bude alespoň napsáno, že vlastní prohlížení probíhá v lessu (resp. v MANPAGERu, což je obvykle less), tudíž uvedené klávesové zkratky jsou vybrané klávesové zkratky lessu a když chci nastavit věci typu aby stránka nezmizela po stisknutí q (zdravím Debian), tak konfiguruji pager, man sám s tím nemá nic společného.

[Jan Kundrát (jkt)]

a cim ukoncujes man/less ty? zdravi redhat, debian, gentoo, slackware,...

[unchallenger]

Ukončuji ho q, jako většina ostatních. Ale nezmizí mi přitom obsah manuálové stránky z terminálu.

[Robert Krátký]

Já to naopak považuji za výhodu, když mi obsah manuálové stránky nepřepíše to, co bylo v terminálu, než jsem ji prohlížel. V čem je výhoda opačného chování?

[unchallenger]

To je snad jasné -- ve chvíli, kdy to zmizí z terminálu, zapomenu, co se tam psalo ;-) Takže bych potřeboval dva: jeden s manem a jeden, kde skutečně něco dělám.

[Robert Krátký]

Pro mě bývá důležitější nezapomenout, co bylo na terminálu, než jsem man spustil ;-).

[Tom K]

Presne proto pouzivam nekolik terminalu, aby jich bulo dost i pro man, protoze vetsinou stihnu zapomenout to na terminalu i to v manu.

[8an]

Stálo by za to upozornit, že grep nefunguje pro slova, která jsou v manuálové stránce zvýrazněna tučně. Třeba:

man man | grep SEE

nic nenajde, i když nadpis SEE ALSO v manálové stránce je. Je to kvůli tomu, že zvýraznění je dělané tak, že ve stránce je znak, pak backspace a pak znovu tentýž znak. Víte někdo jak to odstranit jednodušeji než

sed 's/.'`echo -e '\b'`'//g'

?

[Petr Jakubec]

co pouzit jiny grep? ... trebas egrep, ci snad fgrep apod.
proste grep ktery umi regularni vyrazy
berte to jen jako typ nikdy jsem to nepotreboval. (kdyz mam / a n )
PJ

[Lucke]

man man | col -b | grep SEE

[Hynek (Pichi) Vychodil]

Safr, má hlava dubová. Já jsem to teď půl hodiny hledal a nemohl najít jak se ten program jmenuje. To je nejhorší, když člověk na tuty ví, že něco takového je, ale neví jak se to jmenuje.

[ivok]

man má konfigurační soubor (nemluvě o různých proměnných)... a o něm není v článku zmínka? Bude druhý díl?

[Endi]

a co znamená "Nothing to appropriate" ? :0)

[Petr Jakubec]

To je preci jasne! viz slovnik - tedy: "neni co dotovat"

[User682]

zdravim,
vcera me napadlo, zda existuji manualove stranky pro tridy a rozhrani v jave ? tak jako jsou manualove stranky treba na funkce C nebo sql prikazy .
je teda otazkou, zda by to bylo prakticky pouzitelne ci by se to dalo (asi urcite) nejak rozumne vygenerovat a dalo se to pouzivat ? mozna licence by take mohly byt problem.
gf

[Honza]

Tak nevim nevim, man man funguje docela dobre, ale man woman, mi vraci "No manual entry for woman". A zrovna tady bych nejakou manualovou stranku uvital. :o)

[Michal]

:D

[dajdou]

seznam linux man stránky