Handbuch eingebaut: Manpages unter Linux

Natürlich gibt es auch eine Manpage für den Befehl man. Diese wird einfach mit dem Kommando man man aufgerufen. Dann erscheinen Informationen zur Nutzung von man.

Die Manpage von man wird zunächst erklären, dass das Unix-Handbuch, das über den man-Befehl aufgerufen wird, aus neun Abschnitten oder Kapiteln zum Linux-Betriebssystem besteht. Diese tragen die folgenden Überschriften:

1. Ausführbare Programme oder Shell-Befehle
2. Systemaufrufe
3. Bibliotheksaufrufe
4. Spezialdateien
5. Dateiformate und -konventionen
6. Spiele
7. Verschiedenes
8. Systemverwaltung
9. Kernelverwaltung

Die Abschnitte 1 und 7 sind für die meisten Nutzer wahrscheinlich die wichtigsten, wenngleich Programmierer und Systemadministratoren auch andere Abschnitte intensiv nutzen. Wird ein man-Befehl ohne spezielle Angaben zum gewünschten Abschnitt aufgerufen, dann erscheint standardmäßig der Abschnitt mit der niedrigsten Nummer, sofern der gewünschte Begriff Einträge in mehr als einem Handbuchabschnitt hat. Um die Manpage eines Abschnitts mit höherer Nummer aufzurufen, wird die entsprechende Nummer im Befehl angegeben. Beispielsweise gibt es für den Befehl getopt Manpages in den Abschnitten 1 und 3. Um die Manpage in Abschnitt 3 aufzurufen, gibt man ein: man 3 getopt. In aller Regel erhält der Nutzer allerdings mit dem einfachen Befehl man foo alle Informationen, die er benötigt – egal, für welchen Befehl „foo“ nun gerade steht.

Manpages lesen

Die Manpages selbst sind in verschiedene Abschnitte gegliedert, die durch Überschriften angezeigt werden. Viele Überschriften innerhalb des Manpage-Texts sind bei den meisten Manpages die gleichen und werden jeweils in der gleichen Anordnung präsentiert. Hin und wieder fehlt eine Überschrift, weil sie für die entsprechende Manpage nicht relevant ist, oder es kommen zusätzliche Überschriften hinzu, um weiterführende Informationen zu einem bestimmten Thema zu geben. Sehr selten führt eine Manpage (eher zu Unterhaltungszwecken) auch eine einzigartige Überschrift. So findet sich in der Manpage für mutt, einem E-Mail-Programm, unter der Überschrift „BUGS“ der doppeldeutige Hinweis: „mutts don’t have bugs.“ (Dieser Satz kann heißen: „Mutt-Anwendungen haben keine Fehler“, aber auch: „Köter haben keine Wanzen.“) Dann heißt es aber weiter: „they have fleas“ („sie haben Flöhe“). Nun folgt die Überschrift FLEAS (Flöhe), unter der sämtliche Fehler (Bugs) des Programms aufgeführt werden.

Die häufigsten Überschriften innerhalb von Manpages sind:

NAME steht für den Namen des jeweiligen Objekts der Manpage, meist ein Befehl oder ein Dateiname, gefolgt von einer knapp gehaltenen Beschreibung des Themas.
SYNOPSIS enthält eine Zusammenfassung der Befehlssyntax, mit der der entsprechende Befehl aufgerufen werden kann.
DESCRIPTION erläutert ausführlicher, worum es geht und wozu der entsprechende Befehl dient, und nennt weitere Einzelheiten zum besseren Verständnis des Themas.
OPTIONS bietet Erklärungen der möglichen Ausführungsoptionen eines Befehls.
FILES nennt diejenigen Dateien, die mit dem Thema der Manpage in Beziehung stehen, beispielsweise Konfigurationsdateien.
SEE ALSO gibt eine Liste mit zum Thema verwandten Informationen aus, meist in der Form anderer Manpages, die mit dem aktuellen Thema in Zusammenhang stehen.
BUGS beschreibt bekannte Programmfehler, die in eben dieser Manpage dokumentiert werden. Anders als die Anbieter proprietärer Software gehen die Entwickler von Open-Source-Software sehr offenherzig und ausführlich auf die Fehler ihrer Anwendungen ein. Der Abschnitt BUGS bietet daher häufig eine überraschend tiefgründige Diskussion aktueller Entwicklungsprobleme. Auf einigen Manpages werden sogar Fehler wie „zu aufgedunsen“ genannt.
AUTHOR, manchmal auch HISTORY, gibt Informationen über den Autor und/oder andere Entwickler einer Anwendung aus. Zudem finden sich hier meist auch die Kontaktinformationen der entsprechenden Entwickler. Wer ihnen also zur gelungenen Programmierarbeit gratulieren oder sich gar mit einem Obolus bei ihnen bedanken will, findet hier die notwendigen Daten. Außerdem können die Entwickler so um Hilfe gebeten werden. Dabei gilt es allerdings zu beachten, dass es sich bei diesen Leuten um echte Menschen mit echten Berufen handelt, die nicht ihre gesamte Zeit damit verbringen können, Fragen zu beantworten – insbesondere nicht, wenn sich diese Fragen auch leicht über eine kurze Recherche im Internet beantworten lassen.

Manpages finden

Manchmal möchte man eine bestimmte Aufgabe ausführen, kennt aber das entsprechende Programm beziehungsweise die entsprechende Datei nicht. Es gibt eine einfache Möglichkeit, dieses Problem mithilfe von Manpages zu lösen:

Auf verwandte Manpages zurückgreifen
Wer wissen will, wie oder ob etwas getan werden kann, das mit einer gerade durchgeführten Aufgabe in Zusammenhang steht, wird möglicherweise über die entsprechende Manpage am schnellsten fündig werden.

Für jemanden, der Sinn und Zweck eines bestimmten Befehls abfragen möchte, aber nicht immer den gesamten Text einer Manpage vor sich haben will, könnte es sich bei der Suche nach einer knapperen Zusammenfassung zu einer Funktion lohnen, die Manpage für man aufzurufen. Hier findet sich unter der Überschrift SEE ALSO in der Tat ein Hinweis auf die Manpage von whatis. Jetzt fühlt sich der Nutzer aufgefordert, den Befehl man whatis einzugeben und stellt nun fest, dass er mit whatis tatsächlich die gesuchte Funktion gefunden hat. Wer also eine Manpage sucht, die er wirklich braucht, aber nicht finden kann, sucht auf einer Manpage, die er finden kann, aber nicht wirklich braucht.