7.1. Dokumentationsquellen
Bevor Sie verstehen können, was tatsächlich vor sich geht, wenn Ihnen ein Problem begegnet, müssen Sie die theoretische Rolle kennen, die jedes an dem Problem beteiligte Programm spielt. Hierbei besteht die beste Reaktion darin, zunächst in ihrer Dokumentation nachzuschlagen; da diese Dokumentation jedoch umfangreich und weit verstreut ist, sollten Sie wissen, wo sie zu finden ist.
Handbuchseiten enthalten in knapper Form sehr viele grundlegende Informationen. Wir wollen kurz auf den Befehl eingehen, mit dem sie aufgerufen werden. Geben Sie einfach man handbuchseite ein - die Handbuchseite heißt normalerweise genauso wie der Befehl, dessen Dokumentation Sie suchen. Um zum Beispiel die möglichen Optionen des Befehls cp herauszufinden, geben Sie an der Eingabeaufforderung man cp ein (siehe Seitenleiste).
Handbuchseiten dokumentieren nicht nur Programme, die über die Befehlszeile erreichbar sind, sondern auch Konfigurationsdateien, Systemaufrufe, C-Bibliotheksfunktionen und so weiter. Manchmal kann es dabei zu Namenskollisionen kommen. Zum Beispiel hat der Shellbefehl read denselben Namen wie der Systemaufruf read. Daher sind Handbuchseiten in nummerierte Abschnitte gegliedert:
Befehle, die von der Befehlszeile aus ausgeführt werden können;
Systemaufrufe (vom Kernel bereitgestellte Funktionen);
Bibliotheksfunktionen (von Systembibliotheken bereitgestellt);
Geräte (bei Unix-ähnlichen Systemen sind dies besondere Dateien, die sich normalerweise im Verzeichnis /dev/ befinden);
Konfigurationsdateien (Formate und Konventionen);
Spiele;
Zusammenstellungen von Makros und Standards;
Systemverwaltungsbefehle;
Kernelroutinen.
Man kann den Abschnitt der Handbuchseite, nach dem man sucht, angeben: um die Dokumentation des Systemaufrufs read nachzuschlagen, geben Sie man 2 read ein. Wenn kein Abschnitt ausdrücklich angegeben wird, wird der erste Abschnitt, der eine Handbuchseite mit dem gesuchten Namen hat, angezeigt. So liefert man shadow die Ausgabe shadow(5), da es in den Abschnitten 1 bis 4 keine Handbuchseiten für shadow gibt.
Falls Sie die Namen der Befehle nicht kennen, ist das Handbuch für Sie natürlich nicht sehr nützlich. Hierfür gibt es den Befehl apropos, der Ihnen hilft, die Handbuchseiten, oder genauer gesagt, ihre Kurzbeschreibungen zu durchsuchen. Jede Handbuchseite beginnt grundsätzlich mit einer einzeiligen Zusammenfassung. Der Befehl apropos zeigt eine Liste derjenigen Handbuchseiten an, in deren Zusammenfassung die gesuchten Stichwörter enthalten sind. Wenn Sie sie gut auswählen, werden Sie den Namen des benötigten Befehls finden.
Beispiel 7.1. Den Befehl cp mit apropos finden
$ apropos "copy file"
cp (1) - copy files and directories
cpio (1) - copy files to and from archives
hcopy (1) - copy files from or to an HFS volume
install (1) - copy files and set attributes
Der Befehl
man ist nicht das einzige Mittel, um Handbuchseiten nachzuschlagen, da die Programme
konqueror (in KDE) und
yelp (unter GNOME) diese Möglichkeit ebenfalls bieten. Es gibt auch eine Web-Schnittstelle, die vom Paket
man2html bereitgestellt wird und es ermöglicht, Handbuchseiten in einem Webbrowser anzusehen. Auf einem Rechner, auf dem dieses Paket installiert ist, ist hierzu folgende URL zu benutzen:
Dieses Hilfsprogramm benötigt einen Webserver. Deshalb sollten Sie dieses Paket auf einem Ihrer Server installieren: Alle Nutzer des lokalen Netzwerks können so von diesem Dienst profitieren (auch Nicht-Linux-Rechner), und Sie ersparen es sich, auf jedem Arbeitsplatzrechner einen HTTP-Server einzurichten. Wenn Ihr Server auch von anderen Netzwerken aus erreichbar ist, sollten Sie den Zugriff auf diesen Dienst besser auf die Nutzer des lokalen Netzwerks beschränken.
Das GNU-Projekt hat für die meisten seiner Programme Handbücher im info-Format geschrieben. Deshalb beziehen sich viele Handbuchseiten auf die entsprechende info-Dokumentation. Dieses Format bietet einige Vorteile, jedoch ist das Programm zur Betrachtung dieser Dokumente etwas komplizierter.
Natürlich heißt der Befehl info, und er verwendet den Namen des „Knotens“, über den Rat eingeholt werden soll, als Argument. Die info-Dokumentation hat eine hierarchische Struktur, und wenn Sie info ohne Parameter aufrufen, zeigt es eine Liste der Knoten an, die auf der obersten Ebene verfügbar sind. Normalerweise tragen Knoten den Namen des dazugehörigen Befehls.
Die Steuerungselemente in der Dokumentation sind nicht besonders intuitiv. Am besten können Sie sich wohl mit dem Programm vertraut machen, indem Sie es aufrufen, dann
h (für „Hilfe“) eingeben und den Anweisungen folgen, um so durch Übung zu lernen. Stattdessen können Sie auch einen grafischen Browser benutzen, der wesentlich anwenderfreundlicher ist. Auch hier funktionieren
konqueror und
yelp; auch der Befehl
info2www stellt eine Web-Schnittstelle bereit.
Beachten Sie, dass das info-System anders als das man-System keine Übersetzungen ermöglicht. info-Dokumente sind daher stets in Englisch. Wenn Sie jedoch das info-Programm auffordern, eine nicht existierende info-Seite anzuzeigen, wird es auf die gleichnamige man-Seite zugreifen (falls es diese gibt), die möglicherweise übersetzt ist.
7.1.3. Konkrete Dokumentation
Jedes Paket verfügt über seine eigene Dokumentation. Sogar die am geringsten dokumentierten Programme haben wenigstens eine README-Datei, die einige interessante und wichtige Informationen enthält. Diese Dokumentation ist im Verzeichnis /usr/share/doc/paket/ installiert (wobei paket dem Namen des Pakets entspricht). Falls die Dokumentation außergewöhnlich groß ist, muss sie nicht unbedingt im Hauptpaket eines Programms enthalten sein, sondern kann in ein speziell hierfür vorgesehenes Paket ausgelagert sein, das dann üblicherweise paket-doc heißt. Das Hauptprogramm empfiehlt im Allgemeinen die Installation des Dokumentationspakets, so dass Sie es leicht finden können.
Das Verzeichnis /usr/share/doc/paket/ enthält auch einige von Debian bereitgestellte Dateien, die die Dokumentation vervollständigen, indem sie die Besonderheiten des Pakets genauer beschreiben oder seine Verbesserungen im Vergleich zu einer herkömmlichen Installation der Software. Die Datei README.Debian weist auf alle Anpassungen hin, die vorgenommen wurden, um den Debian-Richtlinien zu entsprechen. Die Datei changelog.Debian.gz gibt dem Anwender die Möglichkeit, die Veränderungen nachzuvollziehen, die an einem bestimmten Paket im Laufe der Zeit vorgenommen wurden: es ist sehr hilfreich, die Veränderungen zwischen zwei installierten Versionen, die sich nicht gleich verhalten, zu verstehen. Schließlich gibt es manchmal auch eine Datei namens NEWS.Debian.gz, die die wesentlichen für einen Administrator wichtigen Änderungen eines Programms erläutert.
In den meisten Fällen gibt es zu freien Software-Programmen Webseiten, die zu ihrer Veröffentlichung dienen und dazu, die Gemeinschaft ihrer Entwickler und Anwender zusammenzubringen. Diese Seiten sind häufig voll einschlägiger Informationen in verschiedener Form: offizieller Dokumentation, FAQ (häufig gestellte Fragen), Mailinglisten-Archiven usw. In vielen Fällen sind Probleme, die Sie haben, schon Gegenstand zahlreicher Fragen gewesen; die FAQ oder die Mailinglisten-Archive können dafür eine Lösung parat halten. Die gute Beherrschung von Suchmaschinen ist für das schnelle Auffinden relevanter Seiten äußerst nützlich (durch Einschränkung der Suche auf die Internet-Domain oder Sub-Domain, die dem Programm gewidmet ist). Falls die Suche zu viele Seiten ergibt, oder falls die Ergebnisse nicht dem entsprechen, was Sie suchen, können Sie das Stichwort debian hinzufügen, um so die Ergebnisse einzuschränken und genauer auf relevante Informationen abzuzielen.
Falls Sie die Adresse der Webseite einer Software nicht kennen, gibt es verschiedene Wege, sie zu finden. Zunächst überprüfen Sie, ob es eine
Homepage-Zeile in der Meta-Information des Pakets gibt (
apt-cache show paket). Daneben kann auch die Paketbeschreibung einen Verweis auf die offizielle Webseite des Programms enthalten. Falls keine URL angegeben ist, sehen Sie unter
/usr/share/doc/paket/copyright nach. Im Allgemeinen gibt der Debianbetreuer in dieser Datei an, woher er den Quellcode des Programms bezogen hat, und dies ist wahrscheinlich die Webseite, die Sie finden wollen. Falls Ihre Suche an dieser Stelle immer noch ergebnislos ist, können Sie ein Verzeichnis mit freier Software wie Freecode.com (früher Freshmeat.net) zu Rate ziehen oder direkt mit einer Suchmaschine wie Google oder Yahoo suchen.
Vielleicht möchten Sie auch im Debian-Wiki nachsehen, einer gemeinschaftlich geführten Webseite, auf der jeder, selbst ein einfacher Besucher, Vorschläge direkt von seinem Browser aus machen kann. Es wird gleichermaßen von Entwicklern für die Gestaltung und Konkretisierung ihre Projekte benutzt, wie auch von Anwendern, die ihr Wissen durch die gemeinsame Erstellung von Dokumenten weitergeben.
7.1.5. Anleitungen (HOWTO)
Ein „HowTo“ ist ein Dokument, das konkret und Schritt für Schritt beschreibt, wie man ein bestimmtes Ziel erreicht. Die behandelten Themen sind recht vielfältig, aber häufig technischer Natur: zum Beispiel das Einrichten eines IP-Masquerading, das Konfigurieren eines Software-RAIDs, das Installieren eines Samba-Servers usw. Diese Dokumente versuchen häufig, alle Probleme abzudecken, die während der Anwendung einer bestimmten Technologie möglicherweise auftreten könnten.
Viele solcher Anleitungen werden vom Linux Documentation Project (LDP) verwaltet, auf dessen Webseite alle diese Dokumente untergebracht sind:
Verwenden Sie diese Dokumente mit Vorsicht. Sie sind häufig mehrere Jahre alt; die darin enthaltene Information ist manchmal veraltet. Dieses Phänomen ist bei ihren Übersetzungen noch stärker verbreitet, da Aktualisierungen weder systematisch noch unmittelbar nach der Veröffentlichung einer neuen Version des ursprünglichen Dokuments erfolgen. Dies ist Teil des Vergnügens, in einer Freiwilligen-Umgebung und ohne Zwänge zu arbeiten…
