Svobodný software 18 – Dokumentace GNU/Linuxu

Když půjdete do knihkupectví a pohlédnete do regálu s počítačovou literaturou, určitě zahlédnete jen pár knih zabývajících se GNU/Linuxem a různými aplikacemi pro něj. Je to znamení, že se vám žádné nápovědy nedostane a budete muset vše pochopit za běhu?

GNU/Linux má několik různých přístupů k dokumentaci. Abychom se v tom trošku orientovali, rozdělíme si ji na elektronickou offline, elektronickou online a na tištěnou.

S tímto typem dokumentace se uživatel setkává asi nejčastěji, V zásadě ji můžeme dále členit na několik různých typů, to si ale ještě nechme na později. Filozofie organizace dokumentace v GNU je poněkud jiná, než například ta, se kterou jsem se setkal pod Microsoft Windows či pod DOSem. Dalo by se říci, že je se samotným systémem daleko více provázána.

Hned při instalaci distribuce se na váš disk přenese velké množství nejrůznější dokumentace. Vpodstatě každý instalovaný program si s sebou nese také dokumentaci k umístění do globálního repozitáře odkud je vám kdykoliv okamžitě příslušná.

Jedním z takových repozitářů je systém manuálových stránek *man*. Kdykoliv na vašem GNU/Linuxovém stroji napíšete

man program

zobrazí se vám manuálová stránka k danému programu. Stačí si na takový systém trošku zvyknout a hned poznáte výhody. Pokud pracujete v příkazové řádce, nemusíte otevírat knihy, nemusíte spouštět program a hledat jak se podívat do nápovědy, prostě použijete man a hned vidíte, co potřebujete.

Man je samodokumentující. Pokud by vám něco nebylo jasné, začněte takto:

man man

Systém man se dá používat i jako skvělá referenční příručka k funkcím jazyka C. Jejich popis se nalézá v oddělení 3. Celá kolekce man stránek je totiž dělena do různých sekcí. Příkazy shellu spadají do kategorie 1, oproti tomu třeba v kategorii l naleznu na svém systému popis příkazů SQL92.

man l select

man 3 printf

Poněkud vyspělejším systémem je info, které oproti manu dovoluje vícestránkové hierarchicky uspořádané manuály s křížovými odkazy. Syntaxe je obdobná. Pro začátek zkusíme

info info

Na první pohled vás čeká změna. Dalo by se říci, že struktura dokumentace v info je úplným opakem struktury v systému man. Man se snaží poskytnout rychlé a stručné informace a hlavně vyjmenování všech parametrů a ovládacích mechanismů. To je i důležitou součástí infa, ne ale tou hlavní. Info většinou předpokládá, že uživatel neví téměř nic a snaží se mu jednoduše vysvětlit na co se dá program používat, jak jej používat, dokumentace je doplněna příklady.

Pokud bych to měl shrnout, starší man je takovou referenční příručkou zatímco modernější info inklinuje spíše k tutoriálu doplněnému o referenční přehled. Jak se ukazuje, oba systémy mají své místo. Info také zobrazuje stránky z man tam, kde nemá pro daný záznam vlastní.

Dalším způsobem dokumentace, na který se můžete spolehnout, je -h resp. --help. Téměř u každého příkazu můžete zadat jeden z těchto dvou parametrů a dostane se vám stručného výpisu jeho možností.

Dobrým zdrojem dokumentace je i adresář doc, na mém RedHat Linux systému v /usr/share/doc. Naleznete zde mnoho adresářů s názvy programů včetně jejich verzí. Vyhledejte program, kterého se týká váš dotaz, a v adresáři s trochou štěstí najdete nějakou dokumentaci. Ta může být v různých formátech, nejpoužívanější je ale HTML. Občas si budete muset vystačit s prostým README.

Dosud jsme mluvili o přístupu ,,mám program a nevím jak s ním udělat X`` či ,,co že to dělá program Y?`` Velmi často ale budete řešit i problém ve stylu ,,potřebuji udělat Z, ale netuším jak.`` K tomu vám poslouží soubory HOWTO. Naleznete je buď v adresáři doc nebo na CD vaší distribuce. Obsahuje soubory jako

• Software-RAID-HOWTO.html
• Quake-HOWTO.html
• Astronomy-HOWTO.html

Dle názvu vyberete téma, které vás zajímá a prohlédnete si přehled možných řešení a postupů.

V případě nějaké konkrétní otázky byste neměli zapomenout na FAQ (Frequently Asked Questions – Otázky, na které se lidé často ptají). Opět jej naleznete v adresáři DOC či na instalačním CD.

Poslední, co zde uvedu, není ani tak dokumentační systém jako spíše kniha. V předchozím textu jsme řešili jak použít nějaký konkrétní program nebo jak provést nějakou konkrétní činnost. Co ale pokud jsme v GNU/Linuxu úplně noví? Jak se zorientovat? Zde přichází na řadu kniha s názvem Linux Dokumentační projekt (naprostá většina textu ale navzdory jejímu jménu nepopisuje Linux, ale GNU), která je v elektronické podobě přikládána k většině distribucí.

Provede vás úplnými základy používání systému, poté vám ukáže pokročilejší věci a skončíte až u administrace systému a programování. Nepředpokládá se, že tuto více než tisícistránkovou knihu budete číst od začátku až do konce, každý si v ní najde kapitolky, které ho zajímají.

Tím náš výčet offline dokumentace v podstatě skončil. Samozřejmě má téměř každý program i nápovědu zabudovanou v sobě, ať se jedná o používání znaku `?` či `h` v programech s řádkovým vstupem, či jde o stisk F1 v aplikacích pro okenní systémy až po bublinkovou nápovědu různných okenních manažerů. Najdete samozřejmě i HTML tutoriály ke GNOME, KDE či dalším; speciální příručky pro úplné začátečníky často přikládají i tvůrci distribucí.

Určitě vás potěší, že velká část takto získané dokumentace je v češtině. Bohužel ještě ne úplně všechno, usilovně se na tom pracuje.

Na internetu najdete nepřeberné množství dokumentace, bohužel většinu v angličtině. Pro českou dokumentaci se podívejte třeba na stránky Českého sdružení uživatel Linuxu (CZLUG)

Mnoho českých manuálů najdete i v rozsáhlém archivu na www.manualy.sk

Jednou z centrál dokumetace pro GNU/Linux je i web www.linuxdoc.org

Určitě se na něj podívejte. Nezaměňte ale koncovku, protože téměř stejné jméno má i www.linuxdoc.com, kde najdete informace o tištěných knihách.

Je užitečné některé z těchto adres znát, pamatujte však, že zdaleka největším archivem dokumentace ke GNU/Linuxu, stejně tak jako k čemukoliv jinému, jsou internetové vyhledávače Třeba www.google.com.

Velmi dobrým zdrojem dokumentace ke konkrétním produktům jsou jejich weby. Většina větších projektů má adresu ve tvaru www.jmenoprojektu.org

Obecně o různých způsobech jak získat dokumentaci si můžete počíst přímo na stránkách projektu GNU (česky):

Je pravda, že těch není tak moc. Dle mého názoru to není na škodu věci. Když si uvědomíte, kolik dokumentace jste získali v rámci distribuce a kolik jí můžete získat z internetu, nebude se vám již po tištěných knihách tak stýskat. Přesto má ale tištěná kniha některé své výhody (např. že si můžete číst o administraci GNU/Linuxu v posteli před spaním).

Zde nezbývá než konstatovat, že počet takových knih rychle stoupá, a držet palce. Je třeba si uvědomit velkou jazykovou bariéru a menšinová komunita v již tak malém státě asi moc k překladu a vydávání knih neláká. Přesto se ale situace (spíše překvapivě) zlepšuje.

Co se týče knih, je dobré mít na paměti, že nemusíme hledat jen knihy o samotném GNU/Linuxu, ale zřejmě se nepřehmátneme ani pokud z regálu vytáhneme titul s velkými písmeny UNIX. Pro úvod do příkazové řádky bych např. doporučil knihu ,,Jemný úvod do systému UNIX`` z nakladatelství KOPP. Neoddiskutovatelným faktem ale je, že anglicky mluvící země jsou na tom co se týče knih o několik řádů lépe. Hodně tomu pomohlo třeba počítačové nakladatelství O`Reilly a jeho zakladatel – velký fanoušek Open Source. Knihy od O`Reilly překládá Computer Press, jsou tedy i v češtině.

Kvalitní dokumentaci můžete dostat i spolu s distribucí, jak to dělá třeba SuSE. Naopak k českým verzím RedHat Linuxu je přikládána pouze tenká příručka, zákazník zase ale jistě ocení cenu a možnost vybrat si v knihkupectví manuál zvlášť.

Doufám, že se mi povedlo demonstrovat styl, jakým GNU opační systémy přistupují k dokumentaci. Osobně mi to velmi vyhovuje. Dokumentace je v každém případě dostatek pro téměř vše, nicméně někdy může být problémem její lokalizace. Velkou výhodu bych viděl v tom, že díky využití velmi dobrých svobodných programů či formátů pro její tvorbu (LaTeX, Texinfo, DocBook) je často dostupná v mnoha formátech (info, HTML, pdf) a je na uživateli, kterou si vybere.

PS: Ačkoliv toto přímo s článkem nesouvisí, také si trošku přihřeju polívčičku. Právě jsme dokončili překlad většiny zajímavých dokumentů na webové centrále projektu GNU. Přijďte se podívat.