10.7    Manpages

Manpages (kurz für Manual Pages) enthalten eigentlich alle Informationen zu allen Programmen und Libraryfunktionen des Basissystems. Manpages sind zwar sehr kurz gehalten, dafür aber äußerst übersichtlich und sparen Ihnen oftmals viel Zeit, wenn es darum geht, herauszufinden, wie Sie ein Programm Y dazu bewegen können, X zu tun.

Anschauen können Sie sich diese Manual Pages mit dem Programm man. Das Kommando oder die Funktion, zu dem bzw. der Sie eine Hilfe benötigen, wird dabei einfach als Parameter übergeben: man ls.

Abbildung 10.2     Eine Manpage

Manpages können über den Parameter -k (keyword) gesucht werden. Die Ausgabe der Suchergebnisse erfolgt spaltenweise. Die erste Spalte gibt das Kommando bzw. die Funktion oder das Programm aus, Spalte 3 enthält seine Beschreibung, und die mittlere Spalte enthält die Sektion.

$ man -k uptime
uptime(1)- Tell how long the system has been running.

Listing 10.41     Manpages suchen

Manpage-Sektionen wurden erstellt, um eine einfachere Suche nach den Manpages zu gestalten und gleichnamige Themen mit unterschiedlichen Bedeutungen voneinander zu trennen. Das Kommando printf etwa ist zwar einerseits für die Shell (Sektion 1), andererseits aber auch für die C-Library (3) zu finden.

Sektion	Beschreibung
1	Diese Sektion enthält die Benutzerkommandos.
2	In Sektion 2 sind Syscalls untergebracht. Das sind Beschreibungen von Funktionen, die mithilfe der Sprache C auf den Kernel zugreifen.
3	Diese Sektion beschreibt die Subroutinen. Dabei handelt es sich um Funktionen, die keine Syscalls sind, wie printf().
4	Diese Sektion enthält Beschreibungen zu den Gerätedateien und Treibern.
5	Die fünfte Sektion beinhaltet die Beschreibungen zu den Dateiformaten.
6	Diese Sektion beschreibt die einzelnen installierten Spiele.
7	Alles, was keiner anderen Sektion zugeordnet werden konnte, findet in dieser Sektion ein Zuhause.
8	In dieser Sektion dreht sich alles um das Thema Systemadministration – sie enthält Beschreibungen der entsprechenden Programme.
9	Für Kernelhacker immer wieder interessant: die Kernelsektion.

Tabelle 10.2     Manpage-Sektionen

Wollen Sie nun eine Manpage aus Sektion 1 aufrufen, geben Sie die Nummer entweder vor dem Suchbegriff oder explizit über den -s-Parameter an:

man 1 ls.

Damit alle installierten Manpages gefunden werden, muss die Shell wissen, wo sich die Manpages überhaupt befinden. Für diese Aufgabe wird die MANPATH-Variable gesetzt. Sie enthält alle Verzeichnisse, in denen nach Manpages gesucht werden soll.

Alternative Verzeichnisse für Manpages

Im Normalfall befinden sich die Manpages in /usr/man oder /usr/share/man. Bei manuell installierter Drittsoftware werden Manpages aber gern in /usr/local/man oder /usr/local/share/man platziert.