V unixových a linuxových distribucích se programy příkazového řádku dodávají s vlastní dokumentací nazývanou manuálové stránky nebo manuálové stránky.
Manuálové stránky jsou obecně psány vývojářem odpovídajícího programu. Obecně jsou manuálové stránky rozděleny do několika sekcí.
Následuje seznam všech dostupných uživatelských sekcí. Každá sekce má jedinečné číslo a obsahuje pouze specifický typ manuálových stránek. Například manuálová sekce číslo 3 obsahuje pouze manuálové stránky volání knihovny.
- 1 – Spustitelné programy nebo příkazy
- 2 – Systémová volání (funkce poskytované jádrem)
- 3 – Volání knihovny (funkce poskytované knihovnou)
- 4 – Speciální soubory
- 5 – Formáty souborů a konvence ( konfigurační soubory )
- 6 – Hry
- 7 – Různé
- 8 – Příkazy správy systému
Syntaxe:
man <TOPICNAME>
1. Zobrazení manuálové stránky příkazu UNIX
Chcete-li si přečíst manuálovou stránku příkazu UNIX, předejte jméno příkazu jako argument man. Následující zobrazí manuálovou stránku pro příkaz passwd.
$ man passwd
PASSWD(1) User Commands PASSWD(1)
NAME
passwd - change user password
... Některá témata mohou mít dokonce manuálové stránky ve více než jedné sekci. V takovém případě příkaz man zobrazí stránku s nižším číslem sekce.
V tomto příkladu má příkaz passwd manuální stránky ve více sekcích. Ve výchozím nastavení však zobrazuje manuálovou stránku ze sekce 1.
„PASSWD(1)“ zobrazené na 1. řádku výstupu příkazu man znamená, že se zobrazuje manuálová stránka ze sekce 1. Výstup manuálové stránky zobrazuje název příkazu, syntaxi příkazů, popis toho, co příkaz dělá, možnosti poskytované příkazem atd…
2. Zobrazit manuálovou stránku z konkrétní sekce
Chcete-li si přečíst manuálovou stránku z určité sekce, zadejte číslo sekce následovně. Příkaz passwd má manuálovou stránku jak v sekci 1, tak v sekci 5. Ve výchozím nastavení, pokud nezadáte číslo sekce, zobrazí manuálovou stránku ze sekce 1.
Chcete-li zobrazit manuálovou stránku ze sekce 5, zadejte číslo sekce, jak je uvedeno níže.
$ man 5 passwd
Nyní se zobrazí manuálová stránka konfiguračního souboru /etc/passwd, protože sekce číslo 5 je pro formáty souborů a převody.
3. Vypsat dostupné sekce Man pro příkaz
Můžete také vypsat všechny dostupné sekce na určité téma pomocí volby -aw.
$ man -aw printf /usr/share/man/man1/printf.1.gz /usr/share/man/man3/printf.3.gz
Z výše uvedeného výstupu můžeme vědět, že existují 2 printf manuály, jeden v sekci „Příkazy“ a druhý v „Volání knihovny“. Můžete tedy provést následující příkaz man pro zobrazení obou manuálových stránek.
$ man printf $ man 3 printf
4. Zobrazit všechny manuálové stránky pro příkaz – Zobrazit všechny sekce
Chcete-li zobrazit všechny manuálové stránky pro určité téma, použijte volbu „-a“. Nejprve uvidíte manuálovou stránku s nejnižším číslem. Když tuto stránku opustíte a stisknete „Enter“, objeví se další manuálová stránka.
$ man -a printf
Výše uvedený příkaz nejprve zobrazí manuálovou stránku příkazu printf(1). Když stisknete „q“ a stisknete „Enter“, zobrazí se manuálová stránka funkce knihovny printf(3).
5. Prohlížení manuálové stránky ve formátu HTML v prohlížeči
Manuálovou stránku můžete také zobrazit ve formátu HTML pomocí libovolného prohlížeče podle vašeho přání s argumentem „-H“. Tím se otevře manuálová stránka pro příkaz printf ve firefoxu jako HTML stránka.
$ export BROWSER=/usr/bin/firefox $ man -H printf
6. Změňte výchozí Pager používaný Man Command
Ve výchozím nastavení příkaz man použije proměnnou prostředí $PAGER k identifikaci, který pager použít pro zobrazení výstupu. Uživatel může změnit pager, ve kterém preferuje zobrazení manuálové stránky, pomocí volby „-P“.
Následující příkaz zobrazí manuálovou stránku pomocí více příkazového pageru.
$ man -P more printf
7. Vyhledejte manuálovou stránku v sekci NAME
Chcete-li prohledávat manuálovou stránku podle sekce NAME, použijte volbu „-f“, jak je uvedeno níže.
$ man -f printf printf (3) - formatted output conversion printf (1) - format and print data
To je ekvivalentní použití příkazu whatis shell.
Výše uvedený příkaz vyhledá názvy manuálových stránek a zobrazí popis daného tématu, pokud se názvy manuálových stránek shodují s daným tématem. Můžete také předat více témat na stejném příkazovém řádku.
8. Vyhledejte manuálovou stránku podle NAME a sekce DESCRIPTION
Pro vyhledání manuálové stránky v sekci NAME &POPIS použijte volbu „-k“. Je to ekvivalentní použití příkazu shellu „apropos“.
$ man -k printf asprintf (3) - print to allocated string dprintf (3) - print to a file descriptor fprintf (3) - formatted output conversion fwprintf (3) - formatted wide-character output conversion printf (1) - format and print data printf (3) - formatted output conversion snprintf (3) - formatted output conversion sprintf (3) - formatted output conversion ... ...
Výše uvedený příkaz vyhledá klíčové slovo „printf“ jako regulární výraz a zobrazí všechny manuálové stránky, které tomuto klíčovému slovu odpovídají.