Hilfe unter Unix

• Manualseiten
• ausführliche Dokumentationen

Manualseiten

Wenn man nur eine kurze, für die meisten Fälle ausreichende Info über ein bestimmtes Programm benötigt, ruft man dieses Programm mit einem der folgenden Parameter auf: -h, -? oder --help. Der letztere dürfte am verbreitensten sein.

Ausführlicher hingegen sind die Manual- oder Info-Seiten:

man <Programm>

ruft die Manual für [Programm] auf (xterm). Grafische Varianten sind xman oder hilfe. Bei Handbüchern mit mehreren Kapiteln kann man das Kapitel gleich mit angeben: man 5 hallo ruft das 5te Kapitel von hallo auf.

xman <Programm>

wie man, nur für die X-Window-Umgebung mit komfortabler Auswahl sämtlicher Manualseiten

info

analog zu man, nur hyptertext-basiert

Die Unix-Manpages und Infoseiten sind in sogenannte Sektionen gegliedert, wobei die Programme lediglich in Sektion 1 aufgeführt sind. In den anderen Sektionen sind unter anderem alle Funktionen des Betriebssystems sowie der C-Bibliothek aufgeführt, Dateiformate erläutert und vieles mehr. Mit xman kann man sich alle verfügbaren Manpages in allen Sektionen anzeigen lassen.

Sucht man die Manual zu einem Programm oder sucht einen bestimmten Begriff in den Manualseiten, sollte man das Programm apropos verwenden:
apropos <Begriff>

Weiterhin steht auch die Funktionalität des Browser Konqueror zur Verfügung: Manualseiten als Hyptertext kann man sich durch Angabe von man: gefolgt vom Programmnamen in der Adresszeile anzeigen lassen. (Dies errreicht man auch durch Eingabe von #[Programm] in der Ausführen-Befehlszeile von [ALT]+[F2].)

Zur Ausgabe der Hilfeseiten in externe Dateien stehen dem Anwender mehrere Programme und damit Möglichkeiten zur Seite:

groff

Dieses Programm kann Manualseiten in verschiedene Ausgabeformate konvertieren.

col

Dieses Programm besitzt einen Filter, mit dem man Ausgaben von Programmen filtern kann, z.B. Entfernung aller Escape-Sequenzen. Das Aufrufmuster zur Konvertierung von Manualseiten ins ASCII-Format sieht folgendermaßen aus:
man [Programm] | col -b > [Programm].txt

ausführliche Dokumentationen

Die oben beschriebenen Manualseiten dienen meist zur Beschreibung eines Programmes, so dass man es nach dem Lesen einfach benutzen kann. Größere Softwaresysteme oder Bibliotheken, die z.B. mehr als ein oder gar keine Programme installieren, bringen aber trotzdem häufig eine umfassende Dokumentation mit sich. Diese Dateien werden standardmäßig unter /usr/share/doc/ abgelegt. Dort befinden sich auch – im Unterverzeichnis howto/ – die (Linux-)Howtos — sofern diese installiert sind. Bei Problemen z.B. mit MySQL schaut man also zuerst dort nach der Manual, bevor man sich diese megabyte-weise ein zweites Mal besorgt. In /usr/share/doc/ habe ich auch zusätzliche Dokumentationen, z.B. Selfhtml installiert. Wenn man möchte und Zugriff auf einen lokal installierten Apache-Webserver hat, kann man einen Alias, z.B. doc/, definieren, der nach /usr/share/doc/ zeigt.

Copyright © 2003 - 2006 Robert Bienert