Linuxová dokumentace

Z Wikiknih

OS Linux a jeho programové vybavení je velice komplexní a rychle se vyvíjí. Dostupnost dokumentace k programům, k možnostem jejich konfigurace, k řešení možných problémů je velice důležitá. Je řada možností, jak nalézt pomoc a orientaci při řešení uživatelských, programátorských a správcovských problémů:

  • Programy samy jsou většinou schopny poskytnout základní nápovědu - programy pracující v grafickém režimu pod X-Window mohou mít tlačítko "Pomoc"/"Help", programy pracující s příkazovou řádkou mají většinou přepínač "-h" nebo "--help", při kterém vypíší syntaxi jejich použití; někdy stačí spustit program bez parametrů.
  • Programy pracující na příkazové řádce a popisy jejich konfiguračních souborů mají většinou dokumentaci ve formátu "man" (zkratka z manuál) stránek. Jsou rozděleny do několika sekcí označených jednou číslicí (nověji i písmenem). Nejznámější jsou: 1-uživatelské příkazy (bash,cat,du,find,grep,..), 2-systémová volání (fork(),open(), write(),..), 3-knihovní funkce (fopen(), malloc(), printf(),..), 5-formáty souborů (crontab, fstab, inittab,..), 8-nástroje pro údržbu systému (adduser, mount, pam, xinetd,..). Příkaz:
man -a jméno_programu
nebo
man -a jméno_konfiguračního_souboru
vypíše na terminál všechny nápovědy k danému předmětu.
Pozn.: Fyzicky jsou man stránky typicky uloženy v "/usr/share/man/manX", kde X je označení sekce. Národní man stránky jsou v "/usr/share/man/ŘEČ/manX", kde ŘEČ je označení jazyka (např. "cs", "pt_BR").
  • Pro nápovědu slouží i příkazy apropos a whatis. První prohledává informační databáze na zadané řetězce a druhý na zadané klíče.
  • Některé programy příkazové řádky nemají dokumentaci ve formátu "man" stránek ale ve formátu novějších "info" stránek (mj. umožňují křížové odkazy a bohatší způsob manipulace a dokumentem nápovědy). Příkaz:
info jméno_programu
vypíše na terminál nápovědu k danému předmětu. Pokud zadáme jen příkaz info , dostaneme výpis hlavní nabídky systému "info" v kterém můžeme hledat a vybírat.
  • V RedHat systémech jsou dokumentace k jednotlivým programovým balíkům uloženy v adresářích
/usr/share/doc/jméno_balíku.
Pozn.: Výpis souborů daného balíku včetně cesty (adresářů) získáme výpisem:
rpm -ql jméno_balíku
a jméno balíku, který obsahuje daný soubor získáme příkazem
rpm -qf plná_cesta_vč._jména_souboru
např.:
rpm -ql gpm
vypíše všechny soubory v balíku "gpm" - General Purpose Mouse = obecná podpora myši v textové konzoli
rpm -qf /usr/bin/bc
řekne v kterém balík je přesný kalkulátor pro příkazovou řádku "bc"
  • Pro řadu činností, subsystémů a úkonů lidé po světě napsali tzv. "HOWTO" - v překladu asi něco jako "JakNaTo". Jsou to dokumenty (dnes je jich několik set), v nichž je popsáno jak co v Linuxu nakonfigurovat, jak co funguje, jakou má co strukturu apod. Jsou dokumenty, kde je popsáno, jak nastavit připojení k Internetu (Unix-and-Internet-Fundamentals-HOWTO, PPP-HOWTO), jakou strukturu mají souborové systémy (Filesystems-HOWTO) apod.
  • Linux FAQ - (Frequently Asked Question = často kladené otázky) je soubor dotazů na nejčastější problémy okolo Linuxu a odpovědi na ně. Svoje FAQ mají často i jednotlivé programové balíky a jsou v dokumentaci balíku (tj. většinou v /usr/share/doc/jméno_balíku).
  • LDP - (Linux Documentation Project = Dokumentační projekt systému Linux) - je projekt s cílem popisu jednotlivých částí systému
  • Konference a mail-listy - řada větších projektů má na Internetu své domácí stránky a konference pro jejich uživatele, správce či vývojáře.

Kde hledat dokumentaci, nápovědu a pomoc[editovat | editovat zdroj]

Každopádně se podpora uvnitř Linuxové komunity nedá srovnat např. s podporou komerční firmy Microsoft, kde pomoc uživateli zpravidla končí větou "Naformátujte disk(y), přeinstalujte všechno, proveďte upgrade na novou (=dražší) verzi OS. V případě, že uživatel nemá značkový počítač, není podpora žádná.