Logo Wissenstransfer Gerhard at CichnaDotCom

>> Wissensdatenbank / Linux

Erste Schritte

Hilfe

Manpages

Diese sind das traditionelle Hilfesystem für Unix und somit in erster Linie über die Shell erreichbar.

Zu fast allen Befehlen und Programmen gibt es eine Handbuchseite (engl. manual page), die aus der Shell heraus mit dem man-Kommando betrachtet werden kann. Das Scrollen funktioniert dabei wie gewohnt und das Suchen erfolgt wie bei less oder auch beim vi über die /-Taste, gefolgt vom Suchausdruck.
Beispiel:
$ man ls

Manpages enthalten dabei üblicherweise eine kurze Beschreibung des Programms sowie eine komplette Referenz der verfügbaren Kommandozeilenoptionen.

Sections

Für manche Stichwörter gibt es mehr als nur ein Hilfethema und somit auch mehr als eine Manpage. Ein gutes Beispiel dafür ist das Programm man selbst: Es gibt zu diesem Thema einmal eine Hilfeseite zur Bedienung und eine Hilfeseite zur Erstellung von Manpages. Damit man Hilfeseiten zu unterschiedlichen Themenkomplexen unterscheiden kann, gibt es unterschiedliche Sections (Abschnitte), in die die Manpages eingeteilt werden:

  1. ausführbare Programme oder Shell-Befehle
  2. Systemaufrufe (Kernel-Funktionen)
  3. Bibliotheksaufrufe (Funktionen in Systembibliotheken)
  4. spezielle Dateien (gewöhnlich in /dev)
  5. Dateiformate und Konventionen, z.B. /etc/passwd
  6. Spiele
  7. Makropakete und Konventionen, z.B. man(7), groff(7)
  8. Systemadministrationsbefehle (in der Regel nur für root
  9. Kernel-Routinen (linux-spezifisch)

Die Sektionen sind im System als einfache Verzeichnisse realisiert, in denen dann jeweils die Manpages der entsprechenden Sektionen abgelegt sind. Die Manpages selbst sind wiederum nur Dateien in bestimmter Formatierung. Möchte man explizit auf eine Seite innerhalb einer Sektion zugreifen, so gibt man beim Aufruf von man einfach die Sektionsnummer des eigentlichen Hilfethemas an:
$ man 1 write
$ man 2 write

Lässt man die explizite Angabe der Sektionsnummer weg und tippt nur man write, so wird die Manpage aus der niedrigsten Sektion angezeigt. Um die Verwirrung zu reduzieren, wird für den Bezug auf eine bestimmte Sektion diese in Klammern nach dem Befehl angegeben, also beispielsweise write(2).

whatis

Das kleine Programm whatis hilt, alle Sektionen zu einem bestimmten Thema herauszufinden. Das Tool ist dabei lediglich ein Frontend für den Aufruf von man mit dem Parameter -f:
$ whatis write
write (1) - send a message to another user
write (2) - write to a file descriptor
$ man -f write
write (1) - send a message to another user
write (2) - write to a file descriptor

Angezeigt werden also der Titel der Manpage, die Sektionsnummer sowie eine kurze Beschreibung des Seiteninhalts.

apropos

Eine etwas weiter gefasste Suche ermöglicht das Tool apropos, das wiederum nur Frontend für man mit der Option -k ist: $ apropos write
... llseek (2) - reposition read/write file offset login (3) - write utmp and wtmp entries logout (3) - write utmp and wtmp entries

Hier werden alle Manpages angezeigt, bei denen im Namen der Seite oder in der Kurzbeschreibung auf das Suchwort Bezug genommen wird. Beide Tools - whatis und apropos - ergänzen somit das Manpage-Hilfesystem von Unix.

GNU info

Ähnlich wie man funktioniert das Programm info der GNU-Community. Die Bedienung ist etwas anders, aber eigentlich auch recht intuitiv.

Programmdokumentation

Eine Auflistung aller verfügbaren Optionen und damit eine ähnliche Ausgabe wie in den Manpages kann man oft durch die Angabe der Parameter --help oder -h auf der Kommandozeile erhalten.