Portál AbcLinuxu, 25. dubna 2024 18:01
Manuálové stránky
Články
-
Manuálové stránky
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.
- Sekce 1 se zabývá spustitelnými programy a příkazy shellu. Je to asi
nejvíce používaná sekce.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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*).
- Sekce 8 se týká systémové administrace.
- 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.
Související články
Odkazy a zdroje
Další články z této rubriky
Diskuse k tomuto článku
27.1.2005 06:48
Leoš Literák | skóre: 74
| blog:
LL
| Praha
lokalizace
27.1.2005 06:52
naše jméno
tisk man stránek
27.1.2005 10:15
8an | skóre: 30
man | grep
27.1.2005 11:53
ivok
man má konfigurační soubor...
31.1.2005 21:45
User682 | skóre: 38
| blog:
aqarium
| Praha
man stranky pro classy z javy
8.8.2005 15:40
Honza
man man vs man woman
ISSN 1214-1267, (c) 1999-2007 Stickfish s.r.o.
27.1.2005 11:45
27.1.2005 13:39
28.1.2005 13:22
