Než budete schopni porozumět tomu, co se opravdu děje, když se vyskytne problém, potřebujete znát teoretické role, které hraje každý problém, který je do problému zahrnutý. Nejlepší reakcí k tomu tak učinit je nahlédnout do jejich dokumentace; ale protože této dokumentace je tolik a může být rozptýlená daleko široko, měli by jste znát všechna místa, kde může být nalezena.
Manual pages, while relatively terse in style, contain a great deal of essential information. We will quickly go over the command for viewing them, provided by the
man-db package. Simply type
man manual-page — the manual page usually goes by the same name as the command whose documentation is sought. For example, to learn about the possible options for the
cp command, you would type the
man cp command at the shell prompt (see sidebar
ZPĚT K ZÁKLADŮM Shell, rozhraní příkazové řádky).
Man pages not only document commands and programs accessible from the command line, but also configuration files, system calls, library functions, and so forth. Sometimes names can collide. For example, the shell's read command has the same name as the read system call. This is why manual pages are organized in numbered sections:
- 1
příkazy, které mohou být spuštěny z příkazové řádky;
- 2
volání systému (funkce poskytované jádrem);
- 3
funkce knihoven (poskytované systémovými knihovnami);
- 4
zařízení (na Unixových systémech jsou speciální soubory, obvykle umístěné v adresáři /dev/);
- 5
soubory nastavení (formáty a konvence);
- 6
hry
- 7
soubory maker a standardů;
- 8
systém administrátorských příkazů;
- 9
rutiny jádra
Je možné specifikovat sekci manuálové stránky, kterou hledáte: k nahlédnutí do dokumentace systémového volání read napíšete man 2 read. Pokud žádná sekce není explicitně specifikována, ukáže se první sekce, která má manuálovou stránku s požadovaným jménem. Takže, man shadow vrátí shadow(5), protože zde nejdou žádné manuálové stránky pro shadow v sekcích 1 až 4.
Samozřejmě, pokud neznáte jména příkazů, nebudete mít příliš mnoho užitku z manuálu. Toto je účel příkazu apropos, který pomáhá řídit vyhledávání v manuálových stránkách, nebo přesněji v jejich krátkých popisech. Každá manuálová stránka začíná v podstatě jedním řádkem stručného přehledu. apropos vrací seznam manuálových stránek, jejichž stručný přehled zmiňuje požadované klíčové slovo (slova). Pokud je dobře zvolíte, naleznete jméno příkazu, který hledáte.
Příklad 7.1. Nalezení cp pomocí apropos
$ apropos "copy file"
cp (1) - copy files and directories
cp (1posix) - copy files
cpio (1) - copy files to and from archives
exec (1posix) - execute commands and open, close, or copy file descriptors
install (1) - copy files and set attributes
ntfscp (8) - copy file to an NTFS volume.
The
man command is not the only means of consulting the manual pages, since
khelpcenter and
konqueror (by KDE) and
yelp (under GNOME) programs also offer this possibility. There is also a web interface, provided by the
man2html package, which allows you to view manual pages in a web browser. On a computer where this package is installed, use this URL after following the instructions in
/usr/share/doc/man2html/README.Debian:
Tento program vyžaduje webový prohlížeč. To je důvod, proč by jste měli zvolit instalaci balíčku na jeden z vašich serverů: všichni uživatelé lokální sítě mohou profitovat z této služby (včetně zařízení bez Linuxu) a toto vám umožní to, že nebudete muset nastavovat HTTP server na každou pracovní stanici. Pokud je váš server také dostupný z ostatních sítí, může být vhodné omezit přístup k této službě pouze na uživatele lokální sítě.
Last but not least, you can view all manual pages available in Debian (even those that are not installed on your machine) on the
manpages.debian.org service. It offers each manual page in multiple versions, one for each Debian release.
Projekt GNU napsal manuály pro většinu svých programů ve formátu info; to je důvod, proč hodně manuálových stránek odkazuje na odpovídající info dokumentaci. Tento formát nabízí některé výhody, ale přednastavený program pro zobrazení těchto dokumentů (nazývá se info) je také trochu více komplexní. Doporučuje se namísto toho použití pinfo (z balíčku pinfo).
info dokumentace má hierarchickou strukturu a pokud spustíte pinfo bez parametrů, zobrazí seznam dostupných uzlů na první úrovni. Obyčejně, uzly nesou jméno odpovídajících příkazů.
With
pinfo navigating between these nodes is easy to achieve with the arrow keys. Alternatively, you could also use a graphical browser, which is a lot more user-friendly. Again,
konqueror and
yelp work; the
info2www package also provides a web interface.
Mějte na paměti, že systém info není vhodný pro překlad, na rozdíl od stránkového systému man. Dokumenty info jsou také skoro téměř vždy v angličtině. Každopádně, pokud se dotážete programu pinfo na zobrazení neexistující info stránky, spadne zpět do stránky man stejného jména (pokud existuje), která může být přeložená.
7.1.3. Specifická dokumentace
Každý balíček obsahuje svoji vlastní dokumentaci. I ty nejméně zdokumentované programy obyčejně mají soubor README obsahující některé zajímavé a/nebo důležité informace. Tato dokumentace je nainstalovaná v adresáři /usr/share/doc/balíček/ (kde balíček představuje jméno balíčku). Pokud je dokumentace mimořádně obsáhlá, nemusí být obsažena v hlavním balíčku programu, ale může být přemístěna do speciálně jí věnovaného balíčku, který se většinou jmenuje balíček-doc. Hlavní balíček většinou doporučuje dokumentační balíček, takže ho můžete snadno nalézt.
The
/usr/share/doc/package/ directory also contains some files provided by Debian which complete the documentation by specifying the package's particularities or improvements compared to a traditional installation of the software. The
README.Debian file also indicates all of the adaptations that were made to comply with the Debian Policy. The
changelog.Debian.gz file allows the user to follow the modifications made to the package over time: it is very useful to try to understand what has changed between two installed versions that do not have the same behavior. Finally, there is sometimes a
NEWS.Debian.gz file which documents the major changes in the program that may directly concern the administrator (see
6.7.2 – „Řešení problémů po upgradu“).
7.1.4. Internetové stránky
In most cases, free software programs have websites that are used to distribute it and to bring together the community of its developers and users. These sites are frequently loaded with relevant information in various forms: official documentation,
FAQ (Frequently Asked Questions), mailing list archives, etc. Problems that you may encounter have often already been the subject of many questions; the FAQ or mailing list archives may have a solution for it. A good mastery of search engines will prove immensely valuable to find relevant pages quickly (by restricting the search to the Internet domain or sub-domain dedicated to the program). If the search returns too many pages or if the results do not match what you seek, you can add the keyword
debian to limit results and target relevant information.
If you do not know the address for the software's website, there are various means of getting it. First, check if there is a
Homepage field in the package's meta-information (
apt show package). Alternately, the package description may contain a link to the program's official website. If no URL is indicated, look at
/usr/share/doc/package/copyright. The Debian maintainer generally indicates in this file where they got the program's source code, and this is likely to be the website that you need to find. If at this stage your search is still unfruitful, consult a free software directory, such as FSF's Free Software Directory, or search directly with a search engine, such as Google, DuckDuckGo, Yahoo, etc.
You might also want to check the Debian wiki, a collaborative website where anybody, even new visitors, can make suggestions directly from their browsers. It is used equally by developers who design and specify their projects, and by users who share their knowledge by writing documents collaboratively.
A HOWTO is a document that describes, in concrete terms and step by step, “how to” reach a predefined goal. The covered goals are relatively varied, but often technical in nature: for example, setting up IP Masquerading, configuring software RAID, installing a Samba server, etc. These documents often attempt to cover all of the potential problems likely to occur during the implementation of a given technology.
Many such tutorials are managed by the Linux Documentation Project (
LDP), whose website hosts all of these documents:
Debian also provides tutorials for its users:
All these documents should be taken with a grain of salt. They are often several years old; the information they contain is sometimes obsolete. This phenomenon is even more frequent for their translations, since updates are neither systematic nor instant after the publication of a new version of the original documents. Further many tutorials nowadays are provided by bloggers, sharing their individual solution with the interested reader. They often lack important information, i.e. the reason why some configuration has been chosen over another, or why some option has been enabled or disabled. Because blogging and creating personal websites made it so easy to share, many of these often short tutorials exist, but only a few are actively maintained and well-kept. This can make it hard to find the "right" one for you. This is all part of the joys of working in a volunteer environment and without constraints…
