Dokumentace

V běžné distribuci Linuxu naleznete stovky, nebo tisíce programů, které můžete použít. Nikdo není schopen si pamatovat, co přesně každý z nich dělá a jaké jsou všechny jeho parametry. Proto existuje dokumentace, do níž může člověk nahlédnout.

Manuálové stránky

Jsou standardní dokumentací. Pravděpodobně každý zkušenější uživatel se nejprve podívá sem. Ke čtení dokumentace slouží příkaz man. Manuálové stránky mají ustálenou strukturu, například upravený výpis man cp:

CP(1)                                                                    CP(1)

NAME
       cp - copy files and directories

SYNOPSIS
       cp [options] file path
       cp [options] file... directory

DESCRIPTION
       cp copies files (or, optionally, directories).  You can either copy one
       file to a given destination, or copy arbitrarily many files to a desti-
       nation directory.

ENVIRONMENT
       The  variables  LANG, LC_ALL, LC_COLLATE, LC_CTYPE and LC_MESSAGES have
       the  usual  meaning.  For  the  GNU   version,   the   variables   SIM-
       PLE_BACKUP_SUFFIX  and  VERSION_CONTROL  control backup file naming, as
       described above.

SEE ALSO
       mv(1)

První řádek označuje jméno příkazu (cp) a číslo sekce manuálových stránek. V části NAME (název) se dozvíte stručný popis činnosti programu. V tomto případě, že příkaz cp kopíruje soubory a adresáře. Zajímavější je část SYNOPSYS (stručný přehled), která označuje povinné a nepovinné parametry příkazu. Všechno v hranatých závorkách je nepovinné. Je nutné zadat buďto soubor a cestu, kam se zkopíruje, nebo více souborů a nakonec adresář, kam se soubory zkopírují. Část DESCRIPTION (popis) obsahuje podrobnější slovní popis funkce programu. V části ENVIRONMENT (prostředí) se dozvíte, které systémové proměnné ovlivňují běh tohoto programu. Užitečná je funkce SEE ALSO (vizte též), v níž se dozvíte o ostatních podobných programech.

Pokud chcete zobrazit informace k danému tématu, napište man -k jmeno_tematu , třeba informace o PostScriptu zobrazíte pomocí man -k ps.

Ovládání prohlížeče manuálových stránek

Ovládání vychází ze stejných principů jako editor vi. Prohlížeč manuálových stránek reaguje mimo jiné na následující klávesy:

• q ... ukončení prohlížení manuálové stránky,
• /hledaný_text ... vyhledávání zadané fráze v aktuální manuálové stránce,
• n ... další výskyt hledané fráze.

GNU info stránky

Formát manuálových stránek je nevhodný pro rozsáhlou dokumentaci, která je pro některé programy nutná. Lidé z GNU proto zavedli formát info, který se prohlíží stejnojmenným programem. Info stránky jsou rozsáhlejší, strukturované a podporují hypertextové odkazy. Spousta manuálových stránek obsahuje upozornění, že více toho je na info stránce programu.

Různé prohlížeče

Existuje více prohlížečů manuálových stránek, než klasický man:

Program Konqueror, který je součástí prostředí KDE, umožňuje prohlížení manuálových stránek v grafickém prostředí. Zadejte do adresního řádku #příkaz, nebo man:/příkaz a můžete prohlížet dokumentaci stejně komfortně, jako na webu. V sekci SEE ALSO dokonce najdete hypertextové odkazy na další manuálové stránky. Úplně stejně funguje i čtení GNU info stránek přes info:/příkaz.

Pokud vám víc vyhovuje prostředí konzole, ale standardní bílý text manu se vám zdá nepřehledný, můžete si manuálové stránky obarvit. A to buď náhradou standartního zobrazovače less za most, nebo konfigurací barviček pro samotný less.

Kde hledat dál

Velká část balíků nese také (někdy bohužel pouze) i jinou dokumentaci, než manuály a info stránky. Tato dokumentace se ve většině distribucí zpravidla nalezne v /usr/share/doc, popř. /usr/local/share/doc. Zde se povětšinou objeví dokumentace v prostém textu, HTML a občas i PDF.

Dokument vytvořil: vladka, 29.8.2005 11:49 | Poslední úprava: Nicky726, 26.2.2009 22:06 | Další přispěvatelé: simma, David Watzke | Historie změn | Zobrazeno: 13185×

Tiskni Sdílej: