Startseite>Dokumentation mit Man und Info lesen
Aus Raspberry Pi Geek 06/2018

Dokumentation mit Man und Info lesen

© Oleandra, 123RF

Alles inklusive

Roman Jordan

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.

Eingeteilt

Abschnitt

Beschreibung

1

ausführbare Programme, Shell-Befehle

2

Systemaufrufe (Kernel-Funktionen)

3

Bibliotheksaufrufe (Funktionen in Programmbibliotheken)

4

spezielle Dateien (gewöhnlich in /dev/)

5

Dateiformate und Konventionen, etwa /etc/passwd

6

Spiele

7

Diverses (einschließlich Makropaketen und Konventionen)

8

Systemverwaltung (typische Befehle für root)

9

Kernel-Routinen

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).

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.

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.

Listing 2

 

$ 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).

DIESEN ARTIKEL ALS PDF KAUFEN
EXPRESS-KAUF ALS PDFUmfang: 5 HeftseitenPreis €0,99
(inkl. 19% MwSt.)
€0,99 – Kaufen
RASPBERRY PI GEEK KAUFEN
EINZELNE AUSGABE Print-Ausgaben Digitale Ausgaben
ABONNEMENTS Print-Abos Digitales Abo
TABLET & SMARTPHONE APPS
Deutschland