Standard UNIX Manual-Tools
CIP Index Up Left Right

Manual-Tools

Das meistgebrauchte Kommando zum Anzeigen von online reference Manuals heißt man und ist in der Einführung in Manualbenutzung beschrieben.

Ein Manual-Browser yambo (Yet another manual browser) ist auch von diesem WWW-Server aus zu erreichen. Er stellt alle Manual-Pages dar, die man durch anclicken der Hyperlinks in den Dokumenten erhält, kann aber auch interaktiv bedient werden. Eine Einführung in die Benutzung ist auf der Front page enthalten.

xman ist ein Manual-Browser in Form eines X-clients, der die ganze Manualhandhabung menügesteuert anbietet; so bekommmt man Listen aller Sektionen oder Kommandos einer Sektion und kann sich das gewünschte per Mausclick auswählen. Nach dem Programmstart bekommt man nur eine kleine Box mit 3 Knöpfen, man muß den Knopf "Manual Page" mit der Maus anclicken, um eine Manualseite zu öffnen. Dann kann man aus dem "Sections"-Menü eine Manual-Sektion auswählen. Dann bekommt man automatisch eine Übersicht über alle Kommandos bzw. Suchbegriffe in dieser Sektion, und kann sich die Erklärung dazu direkt per Mausclick auf den Namen holen.

whatis listet zu einem angegebenem Schlagwort nur die Titelzeile der zugehörigen manpage.

apropos oder man -k listet zu einem angegebenen Schlagwort alle Kommandos, die eine Funktion in dieser Richtung erfüllen. Im Prinzip wird nur nach dem Schlagwort in den Kurzbeschreibungen aller manpages gesucht. Dabei sind auch expressions erlaubt, d.h. Metazeichen wie "*". Näheres dazu in der manpage.

which und where (nicht auf HP) listet zu einem Programmnamen den Pfad bzw. alle Pfade über den es erreichbar ist. Dazu werden einfach alle in der Shell-Variablen PATH gelisteten Verzeichnisse durchsucht. Mit whereis bekommt man zusätzlich noch die Pfade zu den Manuals ausgegeben.

Suche in Manuals

Ein wichtiger Tip zur Suche nach bestimmten Wörtern in Manuals bei Anzeige mit less: normalerweise werden keine unterstrichenen oder fett gedruckten Wörter gefunden, da in diesen Fällen Formatierungszeichen zwischen den Buchstaben stehen, die von less nicht ignoriert werden. Schaltet man jedoch durch Eingabe von -i während der Anzeige des betreffenden Textes die Beachtung von Groß-/Kleinschreibung ab, dann werden auch solche Wörter gefunden! Dann muß man jedoch darauf achten, daß man in Suchstrings keine Großbuchstaben verwendet.

Eigene Manuals

Möchte man selber Manuals erstellen, so kann man einfach eine Textdatei schreiben und dann Formatierungskommandos für Invertierung, Fettdruck, Überschriften usw. einfügen, wie sie als nroff Makros in /usr/lib/tmac/tmac.an definiert sind. Die Datei kann man sich dann formatiert betrachten mit
   nroff -man file | less
Am besten spickt man aus den Dateien in /usr/man/man1.

nroff ist ein sehr mächtiges Formatierungstool, das man nicht nur für Manuals verwenden kann. Es beherrscht auf SUNs sogar (englische) Worttrennung und natürlich Blocksatz. D.h. man kann damit z.B. auch seine Newsartikel oder emails schöner formatieren. Dies geht vom vi aus mit !Gnroff und RETURN, um ab der aktuellen Zeile bis zum Textende alles per nroff formatieren zu lassen.

Siehe auch:
Einführung in Manualbenutzung
Pager zur Manualanzeige
Bedienungsanleitung zum CIP-Manual-Browser yambo