Informationen zu Kommandos oder zu Systemfunktionen finden sich im Zweifelsfall per Suchmaschine im Internet. Schneller und zuverlässiger helfen aber Man und Info weiter, auch wenn Sie gerade offline arbeiten.

Sie suchen nach einem Kommando oder einer Option? Sie schreiben ein Programm und möchten die Funktion einer Bibliothek verwenden, kennen aber deren Parameter nicht? Dann werfen Sie einfach einen Blick auf die entsprechende Manpage oder Info-Seite: Hier finden Sie detaillierte Informationen über Kommandos, über das Linux-System sowie dessen Administration und grundlegende Wirkungsweise – und das ist bei Weitem noch nicht alles.

Man – das Manual

Das Handbuch, also die Sammlung aller Manpages, enthält unter anderem detaillierte Texte über die Funktionen der Libc [1], die Parameter von Systemaufrufen, allgemeine Systemkommandos sowie vieles andere mehr. Eine Seite bezieht sich immer auf ein einzelnes Thema wie etwa ein Kommando oder eine Funktion.

Die Manpages gehören jeweils zu einem Programmpaket und gelangen bei dessen Installation ins System. Der Umfang des installierten Handbuchs hängt also vom jeweiligen System ab. Die Manpages für die gängigsten Kommandos, für Systemaufrufe sowie für die Libc-Funktionen gehören typischerweise zur Standardinstallation.

Das Programm zum Anzeigen der Handbuchseiten ist Man, das Sie nach dem Schema man [Abschnitt] Begriff ... aufrufen. Der Abschnitt verweist auf einen spezifischen Teil innerhalb des Handbuchs, auf den sich Man dann bei der Suche nach einer passenden Manpage beschränkt. Die Tabelle “Eingeteilt” zeigt die grundlegenden Abschnitte. Darüber hinaus gibt es Abschnitte mit einem zusätzlichen Buchstaben im Namen. Der geläufigste davon ist sicherlich der Abschnitt 3p, wobei das p für Posix steht. Hier finden Sie Bibliotheksaufrufe im entsprechenden Format.

Sie müssen keinen Abschnitt angeben; Man durchstöbert die Abschnitte dann der Reihe nach und zeigt die erste gefundene Seite an. Rufen Sie Man mit mehreren Begriffen auf, durchstöbert es die Abschnitte nach allen davon und zeigt die Ergebnisse eines nach dem anderen an.

Jede Manpage umfasst mehrere durch Überschriften in Großbuchstaben getrennte Bereiche. Welche Bereiche eine Seite enthält, hängt vom jeweiligen Abschnitt ab, einige grundlegende Typen finden sich aber in fast allen Manpages wieder.

Auf jeder Seite gibt es den Bereich BEZEICHNUNG (englisch: NAME). Er enthält den Namen des entsprechenden Kommandos beziehungsweise der betreffenden Funktion sowie eine kurze Beschreibung. Letztere nutzt unter anderem das Kommando whatis für die Ausgabe (Listing 1).

$ whatis man
man (1)         - eine Oberfläche für die Online-Referenzhandbücher
man (7)         - macros to format man pages

Der Bereich ÜBERSICHT (englisch: SYNOPSIS) vermittelt einen Überblick zu den Einsatzmöglichkeiten eines Kommandos. Dazu gehören nach einem definierten Schema gegliederte Angaben über mögliche oder zwingend notwendige Argumente.

Alles, was nicht in eckigen Klammern steht, müssen Sie angeben. Im Beispiel aus Abbildung 1 gehören dazu das Kommando whatis und das Argument Name. Unterstrichene oder kursiv ausgezeichnete Teile ersetzen Sie durch ein eigenes Argument. Im Beispiel betrifft das unter anderem das Argument Name.

Abbildung 1: Die Übersicht auf der Manpage zu whatis beschreibt die möglichen Aufrufparameter.

Argumente innerhalb eckiger Klammern können Sie angeben, Sie müssen aber nicht. Hierunter fallen oft Optionen, die das Verhalten des Kommandos steuern. Durch einen vertikalen Strich (Pipe) abgetrennte Angaben schließen sich gegenseitig aus. Auslassungspunkte besagen, dass Sie mehrere Argumente angeben dürfen, in unserem Beispiel also, dass Sie mehrere Begriffe als Name übergeben können. Das bedeutet im konkreten Fall, dass das Kommando whatis bei Bedarf mehrere Stichwörter verarbeitet.

Für einen schnellen Blick fasst die Übersicht gemeinsam einsetzbare parameterlose Kurzoptionen (Schalter) typischerweise in eckigen Klammern zusammen. Nur Optionen, die ein Argument benötigen, sich gegenseitig ausschließen oder für die es keine Kurzform gibt, tauchen separat auf. Gemäß der Übersicht aus Abbildung 1 handelt es sich also beim Aufruf von Whatis aus Listing 2 um ein valides Kommando.

$ whatis -v -L en whatis ls
whatis (1)      - display one-line manual page descriptions
ls (1p)         - list directory contents
ls (1)          - list directory contents
----

Die Bereiche BESCHREIBUNG (DESCRIPTION) und OPTIONEN (OPTIONS) enthalten eine detaillierte Beschreibung des Kommandos sowie eine nähere Erläuterung der Optionen sowohl in der Kurz- als auch, sofern existent, in der Langform (Beispiel: -v und --verbose).

Die Tabelle “Man: Tastaturbefehle” zeigt einige nützliche Tastenkombinationen zum schnellen Navigieren innerhalb einer Manpage. Weitere Tastenkombinationen erhalten Sie, wenn Sie nach dem Start von Man [H] drücken. Einige interessante Optionen von Man fasst die Tabelle “Man: Nützliche Optionen” zusammen.

Handelt es sich beim gesuchten Begriff nicht um ein Kommando, sondern um eine Libc-Funktion, enthält der Bereich ÜBERSICHT die zugehörige Header-Datei sowie die entsprechenden Parameter der Funktion. Die bei den Kommandos aufgeführten Regeln gelten auch hier. Die Beschreibung der Parameter sowie eventuelle Besonderheiten finden sich in weiteren Bereichen der Manpage.

Abbildung 2: Bei der Eingabe des gesuchten Begriffs hilft die automatische Vervollständigung weiter.

Info

Das Info-Dokumentationssystem, im Folgenden kurz Info genannt, zählt zu den festen Bestandteilen der Dokumentation auf Linux-Systemen. Es steht bei den meisten Desktop-Distributionen direkt nach der Installation bereit. Der Kasten “Debian und die Hilfe” beschreibt einige Besonderheiten dieser Distribution und ihrer Ableger.

Abbildung 3: Einige Info-Seiten gibt es bei Debian nur in den Repo-Zweigen contrib und non-free.

$ sudo apt-update
$ sudo apt-get install gcc-6-doc
$ sudo apt-get install texinfo-doc-nonfree

Die Info-Seiten basieren auf einem Hypertext-Format namens Texinfo, das ähnlich wie HTML ein Verlinken der Seiten erlaubt. Eine einzelne Seite heißt hier Knoten, englisch Node. Die Anzeige der Seiten erfolgt entweder mit dem eigenständigen Programm Info im Terminal oder innerhalb des Texteditors Emacs. Bei Letzterem erhalten Sie die Info-Seiten mit [Alt]+[X] oder [Strg]+[H][I].

Der Aufruf des eigenständigen Leseprogramms erfolgt nach dem Schema info Option Eintrag. Der Parameter Eintrag enthält entweder das gesuchte Schlüsselwort oder den Bereich, den Sie einsehen möchten. Dabei können Sie auch Unterbereiche angeben. Der Aufruf von Info ohne Parameter bringt Sie in ein Hauptmenü, das die vorhandenen Themen anzeigt.

Die Navigation innerhalb der Seiten erfolgt auf eine für Nicht-Emacs-Benutzer ein wenig gewöhnungsbedürftige Weise. Je nach Distribution bringen die Tastenkombination [Umschalt]+[H] oder [Umschalt]+[ß] eine ellenlange Liste der Tastenbelegungen auf den Bildschirm. Die meisten davon benötigen Sie jedoch für den täglichen Gebrauch nicht. Die typischen Navigationstasten funktionieren wie erwartet; die Tabelle “Info: Navigation” fasst eine Handvoll weiterer wichtiger Tasten und Tastenkombinationen zusammen.

Das Info-System zeigt sich für Erweiterungen offen: Bringen nachträglich installierte Programmpakete entsprechende Info-Dateien mit, lassen diese sich ebenfalls ins System integrieren. Abbildung 4 zeigt das am Beispiel jener des On-Chip-Debuggers OpenOCD. Existiert zu einem Programm oder einem Paket nur eine entsprechende Manpage, zeigt Info diese an.

Abbildung 4: Nach der Installation von OpenOCD gibt es eine neue Info-Seite, die Sie mit info openocd aufrufen.

Die Eigenschaft des Info-Browsers, mit mehreren Fenstern zu arbeiten, erweist sich bei umfangreicheren Recherchen oder beim Stöbern in der Dokumentation als sehr hilfreich (Abbildung 5).

Abbildung 5: Der Info-Browser info ist in der Lage, mehr als ein Fenster zu öffnen, was die parallele Lektüre von Informationen ermöglicht.

Fazit

Der Blick auf die Informationen in den Manpages und auf den Info-Seiten lohnt sich fast immer: Die hier gebotenen Informationen sind aktuell und übersichtlich. Viele Manpages liegen in deutscher Sprache vor, bei den Info-Seiten lieferten allerdings alle getesteten Distributionen ausschließlich englischsprachige Texte.

Man und Info verwenden einen unterschiedlichen Ansatz: Während sich Man schwerpunktmäßig an einem konkreten Sachverhalt orientiert, wie etwa einem Kommando, hangelt sich Info mehr an Themenbereichen entlang und liefert dazu umfangreiche Beschreibungen. Die Info-Seiten eignen sich also hervorragend für einen Leseabend.