Nápověda

Manuálové stránky

Nejvíce informací o příkazech najdete v manuálových stránkách. Manuálovou stránku otevřete příkazem man nazevProgramu.

Otevření manuálové stránky k manuálové stránce:

$ man man

Manuálové stránky jsou rozděleny do sekcí. Pokud má program manuálovou stránku ve více sekcích, můžete vybranou sekci zadat jako první argument příkazu man. Pokud sekci nezadáte, budete o ni požádáni interaktivně.

$ man 1 man
Sekce manuálových stránek
SekceCo se v sekci popisuje
0 Hlavičkové soubory (obvykle z /usr/include) - hodí se programátorům v C
1 Spustitelné programy nebo příkazy shellu - hodí se běžným uživatelům
2 System calls (functions provided by the kernel)
3 Library calls (functions within program libraries) - hodí se programátorům
4 Special files (usually found in /dev) - hodí se systémovým administrátorům
5 Popis formátu konfiguračních souborů, např. /etc/passwd - pro systémové administrátory
6 Hry
7 Různé (including macro packages and conventions), e.g. man(7), groff(7)
8 Spustitelné programy pro správu systému - obvykle pouze pro roota
9 Kernel routines [Non standard]
Klávesy pro ovládání man pages
KlávesyVýznam
h HZobrazí všechny klávesy pro ovládání manuálových stránek a jejich význam
q :q Q :QUkončí prohlížení manuálové stránky
/řetězecVyhledá řetězec v manuálové stránce
g GPřesun na začátek a konec manuálové stránky.
Manuálové stránky jsou nejdůležitějším zdrojem informací o programech a příkazech linuxu. Většinu příkazů v tomto kurzu popíši jen stručně a budu předpokládat, že si podrobnosti najdete v manuálových stránkách.
man -k slovo     - vyhledává v nápovědě klíčové slovo (nerozlišuje malá a velká
                   písmena)
man -f prikaz(y) - jednořádkový popis příkazu
whatis prikaz    - jednořádkový popis příkazu
which  prikaz    - napíše úplnou adresářovou cestu k zadanému příkazu
whereis prikaz   - napíše úplnou adresářovou cestu k zadanému příkazu,
                   k manuálovým stránkám a adresářům stejného jména
                   v systémových adresářích
apropos          - to same jako man -f

help prikaz(y)   - jednoduchá nápověda k příkazům bashe. man help zobrazí,
                   které příkazy help popisuje

Zábavné manuálové stránky

Pokud chcete, můžete si nainstalovat zábavné manuálové stránky a pak si číst manuálové stránky jako např. sex, baby, celibacy, condom … :) Je to dobrý způsob, jak se s manuálovými stránkami zžít.

Instalace balíčku funny-manpages v distribuci Debian/Ubuntu:

$ su -c "apt-get install funny-manpages"

Instalace balíčku funny-manpages v distribuci OpenSuSE:

$ su -c "zypper install funny-manpages"

Kompletní výpis 'funny manpages' (v Debianu/Ubuntu):

$ dpkg -L funny-manpages

Popis manuálové stránky

Manuálové stránky bývají rozděleny do sekci. Sekce bývají různe, ale základem bývají následující.

NAME

man - an interface to the on-line reference manuals

Jméno příkazu ke kterému se manuálová stránka váže a jednořádkový popis (který zobrazuje příkaz whatis.

SYNOPSIS

man  [-C  file]  [-d]  [-D]  [--warnings[=warnings]]  [-R  encoding]
       [-L  locale]  [-m  system[,...]]  [-M  path]  [-S  list]
       [-e extension] [-i|-I] [--regex|--wildcard] [--names-only] [-a]
       [-u] [--no-subpages] [-P pager] [-r prompt] [-7] [-E encoding]
       [--no-hyphenation]  [--no-justification]  [-p string] [-t]
       [-T[device]] [-H[browser]] [-X[dpi]] [-Z] [[section] page ...] ...

Ukazuje jak se příkaz spouští a s jakými argumenty. Význam jednotlivých voleb je popsán ve zbytku manuálových stránek.

V hranatých závorkách [] jsou nepovinné argumenty. Například [-C file] říká, že můžete libovoln2 použít volbu -C, ale když už jí použijete, musíte jí použít se jménem souboru. K čemu -C slouží a co se souborem udělá, se dočtete dále v manuálové stránce.

Znak | slouží jako "nebo". Volba [-i|-I] říká, že můžete použít -i nebo -I (ale ne oboje).

Tři tečky ... znamenají libovolný počet opakování. Například [[section] page ...] znamená, že můžete zadat sekci a pak musíte zadat alespoň jeden název manuálové stránky (název programu) a pak libovolný počet dalších manuálových stránek. (Všimněte si, že není možné zadat sekci bez manuálové stránky, protože page není v []).
[-m system[,...]] volba -m očekává, že budou názvy systémů (pokud jich bude víc než jeden) oddělené čárkou.

Někdy se v manuálových stránkách objeví {}, ve kterých jsou volby oddělené pomocí |. To znamená, že jedna z voleb oddělených | je povinná.

DESCRIPTION

Popisuje, k čemu vlastně příkaz je.

OPTIONS

Popisuje význam a možné hodnoty argumentů. Asi nejdůležitější a většinou nejdelší část manuálové stránky.

EXAMPLES

Ukázky použití.

ENVIRONMENT

Popisuje nastavení systému, které ovlivňujě běh programu.

FILES

Konfigurační a jiné soubory, které s programem souvisí.

SEE ALSO

Programy, které s programem souvisí a jejichž manuálové stránky vás mohou zajímat.

Barvy

Pokud chcete mít manuálové stránky trochu barevné, nainstalujte si program most a přidejte si do ~/.bashrc řádku:

export PAGER=most

Info stránky

Info stránky se měli stát nástupcem manuálových stránek. Zatímco manuálová stránka je jen jedna dlouhá všeobsahující stránka, infostránky strukturují informace do kapitol a podkapitol. Většina programů má však stále jen manuálové stránky. Pokud info stránky neexistují, info místo nich otevře manuálovou stránku.

$ info info

Kapitola, do které můžete v info stránkách vkročit, vypadá tatko:

* Getting Started:                 Getting started using an Info reader.

Pro přechod do podkapitoly stačí najet kurzrem na tuto řádku a stisknout Enter.

Všechny klávesy potřebné pro pohyb v info stránkách zjistíte klávesou h.
Info stránky ukončíte klávesou q.

Zkuste si porovnat manuálové stránky bash a info stránky bash. Co se vám zdá přehlednější?
Komentář Hlášení chyby
Created: 31.7.2013
Last updated: 3.6.2015