Hilfe |
| Manual Pages |
|
Unixe verfügen von Haus aus über ein ausgereiftes Hilfesystem, die Manual Pages. Zu nahezu jedem Kommando findet man dort eine ausführliche Beschreibung und jeder Programmierer ist dazu aufgefordert, zu seinen Programmen ebenfalls Manuals zu erstellen.
| user@sonne> man ls
LS(1) FSF LS(1) NAME ls - list directory contents SYNOPSIS ls [OPTION]... [FILE]... DESCRIPTION List information about the FILEs (the current directory by default). Sort entries alphabetically if none of -cftuSUX nor --sort. -a, --all do not hide entries starting with . -A, --almost-all do not list implied . and .. -b, --escape print octal escapes for nongraphic characters --block-size=SIZE use SIZE-byte blocks ... |
zeigt eine kompakte Beschreibung des Kommandos ls mit all seinen Optionen, Argumenten, Informationen zu bekannten Problemen, Verweisen zu verwandten Kommandos...
Selbstverständlich gibt es zur Bedienung von man selbst ein Manual.
Das Manual eines jeden Kommandos ist einer so genannten Sektion zugeordnet, die Auskunft über den ungefähren Verwendungszweck des Programms geben soll:
Section 1
Programme und Shellkommandos
Section 2
Systemaufrufe
Section 3
Bibliotheksfunktionen
Section 4
Spezialdateien (Gerätedateien)
Section 5
Dateiformate und -vereinbarungen
Section 6
Spiele
Section 7
Makropakete (z.B. Formatierer groff)
Section 8
Kommandos für Root
Section 9
Kernelroutinen
Die Manuals selbst folgen einem festgelegten Format:
NAME
Kommandoname (bzw. Dateiname...) und Kurzbeschreibung
SYNOPSIS
Aufrufsyntax
DESCRIPTION
Detaillierte Beschreibung der Wirkungsweise aller möglichen Optionen
FILES
Vom Kommando benötigte/modifizierte Dateien
SEE ALSO
Hinweise auf verwandte Kommandos
DIAGNOSTICS
Erläuterungen zu Fehlercodes, die das Kommando zurückliefert
BUGS
Bekannte Fehlverhalten des Kommandos, aber auch Hinweise auf Wirkungen, die gewollt aber ungewöhnlich sind
EXAMPLE
Beispiele zur Verwendung des Kommandos (fehlt leider oft)
So wie ein Fahrzeug ein Fahrrad, ein Mofa, ... oder auch einen 40 Tonnen schweren Brummi beschreiben kann - und man den wahren Sinn oftmals erst aus dem Zusammenhang erfährt -, so werden viele Begriffe auch unter Unix synonym benannt. So lässt ein Nutzer einem anderen eventuell mittels write eine Nachricht zukommen. Und das Betriebssystem verwendet write, um etwas in eine Datei zu schreiben... Wo finde ich nun die Beschreibung meines write?
Wenn ich weiß, dass die Betriebssystemfunktionen in der Sektion 2 enthalten sind, und ich eben diese Beschreibung von write benötige, so gebe ich die gewünschte Sektion gleich an:
| user@sonne> man -S 2 write # oder kurz user@sonne> man 2 write |
| apropos und whatis - Welches Manual weiß was? |
|
...doch oft ist man sich seiner Sache nicht so sicher - dann hilft einem das Kommando apropos auf die Sprünge:
| user@sonne> apropos write wall (1) - write a message to users write (1) - send a message to another user write (2) - write to a file descriptor writelog (8) - add a entry to an INN log file. ... |
Das Kommando durchsucht die Description-Zeilen aller Manuals und schreibt die übereinstimmenden Zeilen auf die Standardausgabe. Analog arbeitet man -k write.
Die meisten heutigen Linux-Distributionen beinhalten auch noch das Kommando whatis, das ähnliche Informationen wie apropos liefert, aber mittels einer kleinen Datenbank (oft »/usr/man/whatis« - eine sortierte Textdatei) arbeitet. whatis ist somit sehr schnell, bedarf aber einer ständigen Aktualisierung der Datenbasis.
| user@sonne> whatis write write (1) - send a message to another user write (2) - write to a file descriptor |
| help - Kurzbeschreibung zu builtin-Kommandos |
|
Ein Kommandozeileninterpreter besitzt, teils aus Notwendigkeit, teils wegen besserer Performance, einige integrierte Kommandos, zu denen man manchmal vergeblich nach Manuals suchen würde. Speziell für solche builtin-Kommandos existiert das (builtin-Kommando) help:
| user@sonne> help help help: help [pattern ...] Display helpful information about builtin commands. If PATTERN is specified, gives detailed help on all commands matching PATTERN, otherwise a list of the builtins is printed. |
| Info - die neuen Manuals? |
|
Andere Informationsquellen sind die Info-Seiten, die man durch Eingabe von
| user@sonne> info File: dir Node: Top This is the top of the INFO tree This (the Directory node) gives a menu of major topics. Usage in info-mode of EMACS: Typing "d" returns here, typing "?" lists all INFO commands, typing "q" exits, typing "h" gives a primer for first-timers, pressing 2nd button on a highlighted word follows cross-reference. ---- AUTOCONFIGURED BY SuSEConfig: EDIT WITH CARE: ---- ---- Only descriptive text for otherwise empty topics will survive ---- * Menu: The list of major topics begins on the next line. * a2ps: (a2ps). PostScript Generating Utility * PreScript: (a2ps) PreScript. Input language for a2ps ... |
erreicht. Die folgende Aufzählung fasst die wichtigsten Tastencodes zusammen, um innerhalb der Info-Seiten navigieren zu können. Zuerst sollte man sich der interaktiven Hilfe zu info widmen, um die Bedienung zu verstehen.
h
Startet die Hilfe zu info
?
Listet alle Kommandos von info auf (Ende mit »l«)
[Leertaste]
Im Text eine Seite nach unten scrollen
[Backspace]
Im Text eine Seite nach oben scrollen
n
Springt zum nächsten Thema
p
Kehrt zum letzten Thema zurück
m
Thema auswählen:
- Cursor auf einen Menüeintrag des aktuellen Themas setzen und »m« eingeben
- »m« eingeben gefolgt vom gewünschten Thema ([Ctrl]-[G] verwirft die Eingabe)
q
info beenden
Alternativen zum Konsolen-Info sind die grafischen Frontends xinfo bzw. tkinfo (Abbildung).
Abbildung 1: tkinfo
Die Info-Seiten selbst sind als Nachfolger der Manual Pages vorgesehen, in einigen Manuals findet man daher den Verweis auf ihre Info-Versionen. Trotz seiner erweiterten Möglichkeiten - wie einer Hypertext-artigen Verlinkung - hat sich info bislang nicht durchsetzen können.
| HowTo's - verschiedene Kochrezepte |
|
In den vom Linux Documentation Project gepflegten HOWTO's findet man Informationen zur Installation, Konfiguration, zu von Linux unterstützter Hardware usw.
Die komprimierten ASCII-Quellen finden sich nach der Installation meist im Verzeichnis »/usr/doc/howto/« oder »/usr/share/doc/howto« und lassen sich z.B. mit dem Pager less betrachten.
Darüber hinaus liegen zahlreiche HowTo's auch als HTML-, Postscript- oder PDF-Version vor. Ebenso existieren Übersetzungen der zumeist aus dem englischen Sprachraum stammenden Originale. Leider sind die deutschen Versionen oft veraltet und von teils krassen Übersetzungsfehlern durchzogen. Wer des Englischen mächtig ist, sollte deshalb den Originalen den Vorzug gewähren.
| Paketeigene Dokumentationen |
|
Viele Programmpakete bringen darüber hinaus eine eigene umfangreiche Dokumentation mit, die vor allem Neuerungen, Installationshinweise und Fehlerbehandlungen umfasst. Die entsprechenden Dateien finden sich meist in den jeweiligen Unterverzeichnissen in »/usr/doc/packages«.
| Hilfe aus dem Web |
|
Falls dennoch Probleme auftauchen, denen mit obigen Mitteln nicht beizukommen ist, kann eventuell eine Suche in den Archiven der zahlreichen Newsforen zu Linux helfen. Die Reaktionszeiten auf eigene Anfragen in manchen Foren würde vielen professionellen Supportern zu Ruhm und Ehre gereichen...
Auf der Linkseite der Linuxfibel finden Sie einige diesbezügliche Internetadressen.
Korrekturen, Hinweise?