Kodovani Předchozí Následující Obsah
Ačkoliv je to u volně šiřitelného softwaru neobvyklé, GNU programy většinou mají velmi rozsáhlou a kvalitní dokumentaci. Ta je přístupná samozřejmě zdarma na internetu ale i v tištěné formě. Navíc každý má právo ji kopírovat, distribuovat a tisknout. Dokumentace jde rozdělit do několika kategorií.
Standardně se v UNIXu používají manuálové stránky. Pokud napíšete man
<jméno> vypíše se Vám dokumentace k danému programu, funkci, volání
jádra, formátu souboru apod.
Manuálové stránky jsou ve formátu nroff a je samozřejmě možné je sformátovat
s proporcionálnímy fonty a vytisknout. (Komerční UNIXy jsou většinou dodávány
s manuály obsahujícími tyto stránky, podobné knihy lze zakopit i pro Linux)
Jejich problémem je, že musíte celkem přesně vědět, co hledáte a jak se to jmenuje. Navíc manuálová stránka k danému programu je většinou jen dlouhý výpis všech přepínačů, příkazů apod. a tak musíte dokonce vědět, co přesně chcete z daným programem dělat. Pokud se chcete nějaký program naučit, manuálové stránky se na to nehodí. Jsou ale nenahraditelným pomocníkem těch, kteří už program znají a jenom si nemůžou spomenout na nějaké detaily, jako je syntaxe, volání funkce apod.
Většina GNU programů má detailně zpracovanou manuálovou stránku. (stránka k překladači je dlouhá cca 70 stran). Jsou většinou dodávány rovnou s programem. Pokud používate Linux nebo jiný UNIXový operační systém, budete mít stránky pravděpodobně už nainstalovány.
Pokud stránky nemáte kdispozici, je možné je prostudovat na internetu na následujících adresách:
K manuálovým stránkám GNU přidává další dokumentaci. GNU manuály jsou psány ve formátu TeXinfo. Jeho výhodou je, že je možné z jednoho zdrojového souboru vygenerovat hypertextový online help a nebo sázet tištěné manuály pomocí systému TeX. Tištěné manuály ale nejsou jednodušše vytištěné hypertextové stránky, ale plnohodnotné knihy dělené na kapitoly s obsahem, indexem apod. Navíc existují programy pro konverzi do HTML formátu a normálního textu.
Tyto manály už jsou určeny i těm, kteří se chtějí daný program naučit. Většinou obsahují kapitolu "Overview", která vysvětluje, co program dělá, jak přibližně funguje a základní pojmy pro naprostého začátečníka. Dále často obsahují nějaké příklady a krátký tutoriál. Nejdelší část je ale kompletní popis všech funkcí programu. Oproti dokumentaci ke komerčním produktům většinou navíc obsahují specifikace formátu souborů, popis algoritmu, který program používá, a popis zdrojových kódů. Každý takový manuál mívá hned několik indexů. (Index funkcí, pojmů apod.)
Například s balíkem DJGPP (překladač pro DOS) se dodává cca 7MB této dokumentace.
Ve zdrojové formě jsou obsaženy hned ve zdrojových verzích jednotlivých balíků (soubory s příponou .texinfo, .texi, .txi (pod DOSem), nebo .tex).
V binárních distribucích většinou najdete tyto manuály v hypertextové podobě v souborech s příponou .info, info-číslo, nebo .info.gz, pokud jsou zabalené. V DOSu se přípona většinou zkracuje na .i*. Tyto soubory lze potom prohlížet editorem EMACS, nebo samostatným programem info. V Linuxu je tento program obsažen ve stanardních distribucích. Jeho DOSová verze je u balíku DJGPP, verze pro DOS, Windows a OS/2 v balíku EMX. Protože je ale formát velmi jednoduchý, existují i další prohlížeče. (Jeden je obsažen pod klávesou F1 v editoru RHIDE)
Pomocí TeXu a soboru texinfo.sty jde potom tyto manuály sformátovat do dvi a potom do všech formátů, které TeX podporuje.
Jsou dostupné následující manualy.
HTML verze těchto manuálů je možné nahlédnout na adresách:
Tištěné verze manuálů je možné objednat od FSF (Free Software Foundation).
Další formou dokumentace je FAQ - Freqency Asked Question - odpovědi na často kladené otázky. Některé balíky obsahují tyto soubory. Také jsou periodicky zasílany do usenet diskuzních skupin o daném programu. Většinou je velmi užitečné si je přečíst.
Mnoho užitečné dokumentace vzniklo pod tímto projektem. GNU manuály stále nejsou příliš přístupné pro začátečníky - jsou dost obsáhlé a pokud to z daným programem nemyslíte příliš vážně, asi nebudete chtít strávit tolik času jejich studováním. Proto vznikly tzv. guides (průvodci), kteří vám vysvětlí jak například instalovat a používat Linux, aniž byste museli znát všechny programy, se kterých se skládá.
Pod Linux Documentation Projectem vznikly tyto knihy.
Navíc vznikly tzv. HOWTO. To jsou dokumenty popisující jak udělat tu danou věc. Pokud například chcete připojit svůj počítač do internetu pomocí PPP, přečtete si PPP-HOWTO, které obsahuje stručný úvod do problematiky a soupis věci, které je nutné udělat.
Linux Documentation Project také vytváří Info-sheet, který obsahuje nejzákladnější informace o Linuxu a MetaFAQ, obsahující seznam zdrojů informací jako jsou FTP servery, dokumenty apod, FAQ pro Linux, manuálové stránky k Jádru a další dokumentaci. Také vydává časopis Linux gazette.
Český mirror stránek Linux Documentation Projectu najdeta na stránkách:
Linux Documentation Project používá formát linuxdoc-sgml, jehož modifikovaná verze je například použita i pro tento text. Linuxdoc-sgml jde převédst do mnoha formátů - LaTeX pro sázení manálů, texinfo pro hypertextový help, html, čistý text, postscript, PDF apod.
tištěné verze těchto manuálů jsou také k dispozici. Nejznámější je Linux Bible, která obsahuje většinu této dokumentace. Vydává ji firma Yggrasil. Tyto knihy lze v Čechách objendat například od firem APS a Ipex.
Vzhledem k rozsahu originální Anglické dokumentace většinou neexistují doslovné české překlady. Vzniklo ale mnoho dokumentace od různých programů. Největši servery obsahující Českou dokumentaci k GNU a UNIXU jsou:
Vyšlo i několik Českých knih jako například:
České manuálové stránky
Slovenské manuálové stránky
O GNU, Linuxu a UNIXu bylo napsáno samozřejmě mnohem více a není v mých silách zde napsat úplný přehled. Mezi nejzajímavější například patří RFC dokumenty, které obsahují specifikace různých internetových protokolů apod.
Dotazy a připomínky ohledně stránky posílejte na hubicka@paru.cas.cz