Manpages

Manpage steht für „manual page“, also „Handbuchseite“ und ist unter UNIX und praktisch allen verwandten Systemen ein gängiges, standardisiertes System, um Hilfetexte zu Programmen bereitzustellen. In Manpages werden Informationen zu Programmen gegeben, und Optionen ausführlicher erläutert, als wenn man den Hilfe-Parameter eines Programmes verwendet.

Zur Ausgabe der Manpages wird das Systemprogramm „less“ verwendet, es können aber auch andere Ausgabeprozessoren verwendet werden (siehe Abschnitt Farbige Ausgabe).

Das Programm „man“

Standard-Ansicht der Manpage zu „man“ in der deutschen Übersetzung

Um Manpages zu lesen, wird das Programm „man“ verwendet. Standardmäßig zeigt „man“ die Manpage aus der ersten Sektion an. Es sind durch POSIX derzeit 12 Sektionen Standardisiert.

• Sektion 1: Nutzerbefehle
• Sektion 2: Systemaufrufe
• Sektion 3: Bibliotheksaufrufe
• Sektion 3p: Perl-Module
• Sektion 3tcl: Tcl-Module
• Sektion 4: Spezialdateien
• Sektion 5: Dateiformate
• Sektion 6: Spiele
• Sektion 7: Konventionen
• Sektion 8: Systemverwaltung
• Sektion 9: Kernelverwaltung
• Sektion n: Neu

Die Angabe der Sektionen ist allerdings nur von Bedeutung, wenn die Manpage in verscheidenen Sektionen unterschiedlich definiert ist. Standardmäßig wird immer die erste Sektion probiert. Dieses Verhalten ist anpassbar. Siehe Konfiguration

Ruft man nun die Manpage zu „man“ auf, also „man man“ erhält man eben diese Manpage. Mit den Pfeiltasten kann man hier umherscrollen. Wenn man einen bestimmten Begriff suchen möchte, geht dies mit einem vorangestellten Slash.

/begriff

Dies durchsucht die aktuell angezeigte Manpage ab der aktuellen Position nach der Zeichenfolge „begriff“. Die Suche ist schreibungsabhängig. „begriff“ wird also nur gefunden, wenn in der Manpage auch „begriff“ steht, steht dort nur „BEGRIFF“, wird er nicht gefunden.

Verlassen wird das Programm mittels „q“. Mittels „h“ erscheint eine Zusammenfassung weiterer verfügbarer Befehle, diese Liste kann man ebenfalls mittels „q“ verlassen.

Will man sich die Manpage nicht anzeigen, sondern ausgeben lassen, benutzt man beim Aufruf zum Beispiel den Parameter „-P“. Durch diesen Parameter kann man den Pager definieren. Der Pager dient zur Anzeige.

man -P cat man

Dies Zeigt die Manpage von „man“ mittels „cat“ an. Mittels „man -t man > manpage.ps“ generiert man eine PostScript-Datei (Parameter „-t“), und gibt sie in die Datei „manpage.ps“ aus. Diese kann man nun mit einem PostScript-Fähigen Programm weiterverarbeiten.

Konfiguration

Die Konfiguration von „man“ geschieht in der Datei „/etc/man.conf“. Die Standard-Einstellungen sind sinnvoll gewählt, und sollten nur angepasst werden, wenn man weiß, was man tut, da sich die Änderungen an dieser Datei für alle User auf dem System bemerkbar machen.

Einige Parameter, deren Änderung mitunter sinnvoll sein kann, sind

• MANPATH Definiert den Pfad, an dem nach Manpages gesucht wird. Hier kann man zum Beispiel eine neue Definition „MANPATH /home/user/.manpages“ hinzufügen, wenn man in diesem Verzeichnis eigene Manpages liegen hat.
• MANSELECT Dies bestimmt die Reihenfolge, in der automatisch die Manpage einer Sektion ausgewählt wird, wenn die Sektion nicht beim Starten angegeben wird. Möchte man – wenn möglich – immer die Manpage der dritten sektion haben, und danach erst die der ersten Sektion, setzt man MANSELECT z.B. auf „2:1:x:y:z“. x, y und z sind dabei weitere Sektionsangaben.
• MANDEFOPTIONS Möchte man keine konfigurationsdatei erstellen, und auch an den Standardoptionen nichts ändern, kann man hier Optionen angeben, die automatisch bei jedem „man“-Aufruf verwendet werden sollen.
• PAGER Siehe Farbige Ausgabe

Persönliche Einstellungen

Wenn man die Einstellungen User-Bezogen machen möchte, muss man sich eines kleinen Tricks bedienen. Zuerst kopiert man die Original-Datei in das Benutzerverzeichnis, und passt sie dann an. Wenn man „man“ nun mit dem Parameter „-C“ aufruft, kann man hier eine Konfigurationsdatei Angeben, die verwendet werden soll.

man -C /home/user/.manconfig

Dies startet „man“ mit der Konfigurationsdatei „/home/user/.manconfig“. Der Dateiname ist hier beispielhaft „.manconfig“, kann aber auch anders lauten. Wenn man die Änderung dauerhaft machen möchte, muss man sich für den Aufruf einen Alias anlegen.

alias man='man -C /home/user/.manconfig'

Diesen Alias kann man sich, wenn man ihn dauerhaft verwenden möchte, in die .bashrc schreiben.

Siehe auch Todo

Farbige Ausgabe

Die Manpage von „man“ in der deutschen Übersetzung, durch „most“ geparst

Der von „man“ standardmäßig verwendete Pager ist „less“, dieses bietet nur sehr geringe Möglichkeiten, die Ausgabe grafisch zu gestalten. Wer häufig manpages liest, hätte eventuell gerne eine etwas ansprechendere Ausgabe der Manpages. Dies ist mit dem Programm „most“ möglich, welches zuerst installiert werden muss

pacman -Sy most

Nun ändert man – entweder wie oben beschrieben in der persönlichen Konfigurationsdatei oder in der Systemweiten Konfigurationsdatei die Angaben PAGER auf „/usr/bin/most -s“. Wenn man nun eine Manpage aufruft, werden verschiedene Dinge farbig hervorgehoben.

Farben anpassen

Die Farben, die „most“ verwendet, werden Systemweit in der Datei „/etc/most.conf“, oder benutzerabhängig in „/home/user/.mostrc“ definiert.

color normal fg bg
color status fg bg
color underline fg bg
color overstrike fg bg

„fg“ und „hg“ definieren die Vordergrundfarge (fg – foreground) und die Hintergrundfarbe (bg – background) des jeweiligen Objektes. Welche Farben möglich sind, erwährt man über „man colors“.

Todo

• Persönliche Einstellungen Besteht die Möglichkeit, das auch ohne Alias zu lösen?
• Farbige Ausgabe vi(m) bietet ebenfalls die Möglichkeit, Manpages auszugeben. Das hat allerdings bei mir nicht sonderlich schön funktioniert.

Weblinks

• POSIX-FAQ
• Manpages online lesen