Online referenc manuals

Online Reference Manuals

Mit dem Kommando man oder xman kann man sich Informationen aus den online reference manuals anzeigen lassen. Dort existiert normalerweise zu jedem installierten UNIX-Kommando auch eine manpage, die genau dieselben Informationen enthält wie die gedruckten Nachschlagewerke - sie sind eher ausführlicher und dazu noch auf dem neuesten Stand.

Deshalb sollten UNIX-Anfänger sich überwinden und das Bedürfnis nach gedruckten Manuals ablegen - man kann mit den online-manuals mindestens genauso gut, wenn nicht sogar schneller arbeiten.

Man erhält die Manpage zu einem bestimmten Kommando (oder sonstigem Schlagwort mit dem Aufruf man item.

Der Pool aller Manuals ist in Sektionen aufgeteilt. Man kann beim Suchen nach einer manpage angeben, welche Sektionen durchsucht werden sollen: man sectioncode item, dies bringt in der Regel Geschwindigkeitsvorteile. Zu jeder Sektion gibt es eine Einführung unter dem Schlagwort intro, dort stehen wichtige Dinge für alle enthaltenen Kommandos; z.B. beschreibt man 3m intro die Handhabung der Mathe-Library.

Liste der Sektionen für SunOS:

   1  USER COMMANDS
   2  SYSTEM CALLS
   3  C LIBRARY FUNCTIONS
   4  DEVICES AND NETWORK INTERFACES
   5  FILE FORMATS
   6  GAMES AND DEMOS
   7  ENVIRONMENTS, TABLES, AND TROFF MACROS
   8  SYSTEM ADMINISTRATION
   L  LOCAL COMMANDS
   N  NEW COMMANDS

Abweichend davon ist bei System-V (HP-UX und IRIX):

   4  FILE FORMATS
   5  MISCALLANCOUS
   7  SPECIAL FILES
   8  --> 1M

Die Formatierung der Manuals ist von Rechner zu Rechner verschieden. Auf HPs wird die Überschrift von Sektionen fett gedruckt, wozu Formatierungsanweisungen vor jedem Zeichen erforderlich sind. Deshalb kann man auf HP nicht so einfach nach Wörtern aus der Überschrift suchen (mittels des "/"-Kommandos im Pager, siehe auch den Tip zur Suche in manpages).

Wo man überall nach manpages sucht, kann man selbst durch die Environment-Variable MANPATH bestimmen (siehe Abschnitt Wichtige Environment-Variable). Diese Variable sollte mindestens die Verzeichnisse

   /local/man:/usr/man:/usr/catman:/local/X11R5/man

umfassen. Welcher Pager zur Darstellung benutzt wird, bestimmt die Variable PAGER.

CIP-Manual-Browser

Speziell für den CIP-Pool habe ich einen eigenen Manual-Browser geschrieben. Über ihn kann jede SunOS, HP-UX und IRIX Manual-Page erreicht werden, Übersichtsseiten aller Sektionen und Pakete abgerufen werden und für jede Manpage zwischen den Architekturen umgeschaltet werden. Die Haupt-Abfrageroutine und Verweise auf ausführliche Bedienungsanleitungen befinden sich auf der Manual toplevel page.

Gliederung von manpages

Nicht alle der im folgenden genannten Punkte sind auf jeder manpage enthalten, aber wenn sie erscheinen ist die generalisierte Bedeutung die folgende:

Überschrift (alle 52 Zeilen): nennt Sektion und Titel der Manpage - der nicht unbedingt mit dem gesuchten Schlagwort identisch sein muß, da oft mehrere Begriffe auf einer Seite zusammengefaßt werden.
NAME: listet alle Schlagwörter und eine Kurzbeschreibung
SYNOPSIS: Definiert die Syntax des Kommandos, d.h. listet alle möglichen Optionen und Parameter. Diese werden im Abschnitt OPTIONS dann beschrieben.
DESCRIPTION: Ausführliche Beschreibung der Semantik, d.h. dessen was mit dem Kommando/der Funktion bewirkt werden kann.
OPTIONS: Jede in der Kommandozeile angebbare Option wird hisichtlich ihrer Bedeutung erläutert.
RETURN VALUES: Im Falle von Funktionen wird hier angegeben, welcher Funktionswert in welchen Situationen zurückgegeben wird. Es gehört zum guten Programmierstil, das man immer den Returnwert abfragt, ganz besonders bei System calls.
ERRORS: Bei manpages zu Funktionen werden hier alle möglichen Fehlercodes angegeben, die in C in der Regel in der globalen Variablen perror abgelegt werden.
FILES: Alle Dateien oder Pfade, auf die das Kommando/die Funktion auf irgendeine Weise zugreift.
SEE ALSO: Dies ist ein sehr wichtiger Abschnitt: es wird auf andere manpages zu ähnlichen Themen hingewiesen und auf die manpages zu allen in der Manpage referenzierten Kommandos bzw. Themen.
BUGS: Hier wird auf Fehler im Programm oder auf sonstwie überraschende Verhaltensweisen hingewiesen.

Siehe auch:: Manual-Utilities; Pager zum Anzeigen von Texten; CIP-Manual Browser; Übersicht aller intro Seiten