Zu Befehl
Auch wenn sich viele Dinge bequem über grafische Oberflächen wie KDE oder GNOME regeln lassen – wer sein Linux-System richtig ausreizen möchte, kommt um die Kommandozeile nicht herum. Abgesehen davon gibt es auch sonst viele Situationen, in denen es gut ist, sich im Befehlszeilendschungel ein wenig auszukennen.
Eine gute Dokumentation ist fast so wichtig wie das Programm. Auch für kleine selbstgestrickte Skripte ist es sinnvoll, die wichtigsten Funktionen strukturiert aufzuschreiben, damit man sich später noch an die Features erinnert. Auf Linux-Systemen bietet es sich an, das vorhandene Dokumentationssystem zu nutzen: In Manpages finden Sie zu den meisten Befehlen Erklärungen der Funktionsweise, möglicher Optionen und manchmal auch Anwendungsbeispiele oder Hinweise auf verwandte Programme.
Manpages haben den Vorteil, dass man sie nicht nur im Terminal-Fenster lesen, sondern ebenso schnell und einfach in andere Formate wie HTML, PostScript oder PDF konvertieren kann. Traditionell werden die Handbuchseiten mit dem Textformatierungs-Tool groff erstellt. Eine erste Version dieses Programm gab es schon auf ganz alten Unix-Systemen unter dem Namen roff (= "run off"). Spätere Erweiterungen des Dokumentenformatierers waren nroff und troff; groff ist die GNU-Version, die auch auf aktuellen Linux-Systemen zum Einsatz kommt. Dieser Artikel zeigt, wie Sie mit groff eine Manpage schreiben und diese in verschiedene Formate umwandeln.
Ein "man" für alle Fälle
Sämtliche Manpages eines Linux-Systems liegen unterhalb des Verzeichnisses /usr/share/man – hier liegen u. a. übersetzte Handbuchseiten und die Unterverzeichnisse man1 bis man9. Die Ziffer verrät den thematischen Bereich, dem die Manpage zugeordnet ist: So liegen in Abschnitt 1 beispielsweise Beschreibungen zu Benutzerkommandos, in 5 Manpages, welche die Formate wichtiger Dateien erklären, und 8 bezieht sich auf Kommandos für den Systemverwalter. Eine gute Übersicht und stichwortartige Erklärungen der einzelnen Abteilungen zeigt das KDE-Hilfezentrum im Bereich Linux-Dokumentation / Man-Pages (Abbildung 1).
Abbildung 1: Manpages nach Abteilungen geordnet gibt's auch im KDE-Hilfezentrum.
Normalerweise muss man die Sektion beim Aufruf des man-Kommandos nicht mit angeben – nur, wenn es mehrere gleichnamige Manpages in verschiedenen Abteilungen gibt, müssen Sie genau definieren, welche Handbuchseite Sie meinen. Um beispielsweise die Manpage des Benutzerkommandos printf zu lesen, tippen Sie am Prompt
man 1 printf
Wer hingegen die C-Library-Funktion aus Abteilung 3 meint, tippt stattdessen:
man 3 printf
Ob es mehrere Manpages gibt, können Sie übrigens schnell über KDEs Konqueror herausfinden: Tippen Sie in die Adresszeile einfach man: gefolgt von dem Kommando, das Sie nachschlagen wollen. Gibt es nur eine Manpage, zeigt Konqueror diese direkt an; gibt es hingegen mehrere Möglichkeiten, stehen diese zur Auswahl (Abbildung 2).
Abbildung 2: Per Klick zur richtigen Manpage im Konqueror.
Struktur einer Manpage
Eine Manpage ist in der Regel in verschiedene Kapitel unterteilt – ganz oben sehen Sie den Namen des Befehls und die Sektion, der das Kommando zugeordnet ist. Im Bereich NAME finden Sie eine Kurzbeschreibung des Befehls, SYNOPSIS zeigt das Kommando mit den möglichen Argumenten an, und DESCRIPTION beschreibt, wie der Befehl funktioniert.
Danach geht's ins Detail: Es folgt eine vollständige Auflistung aller Parameter. Einige Handbuchseiten bieten unter EXAMPLES mehr oder weniger ausführliche Beispiele für die Benutzung des Kommandos. Am Ende der Manpage finden Sie Hinweise auf eventuelle bekannte Programmfehler (BUGS), den Autor der Handbuchseite (AUTHOR) und verwandte Programme (SEE ALSO).
Einem Freund empfehlen
