Logo GNU
Kodovani P°edchozφ Nßsledujφcφ Obsah

17. Dokumentace

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φ.

17.1 ManußlovΘ strßnky

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:

17.2 GNU manußly

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).

17.3 FAQ

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.

17.4 Linux Documentation Project

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.

17.5 ╚eskß dokumentace

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:

N∞kterΘ dal╣φ zajφmavΘ zdroje:

www.inet.cz/~pjanik/man/

╚eskΘ manußlovΘ strßnky

ftp.ttc.cz/pub/win/man

SlovenskΘ manußlovΘ strßnky

17.6 Ostatnφ

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.


P°edchozφ Nßsledujφcφ Obsah

Dotazy a p°ipomφnky ohledn∞ strßnky posφlejte na hubicka@paru.cas.cz