Kapitel 12. Hilfe und Dokumentation

Inhaltsverzeichnis

12.1. Im Lieferumfang enthaltene Hilfe-Ressourcen
12.2. Weitere Hilferessourcen
12.3. Weiterführende Informationen

Zusammenfassung

Im Lieferumfang von openSUSE® sind verschiedene Informationen und Dokumentationen enthalten, viele davon bereits integriert in Ihr installiertes System. Beispielsweise enthält sowohl der KDE- als auch der GNOME-Desktop eine Hilfe, die Ihnen für das entsprechende Produkt ein breites Spektrum an Online-Dokumentationen bietet. Hier haben Sie Zugriff auf openSUSE-spezifische Handbücher von Novell/SUSE sowie Dokumentationen der Open Source-Community. Erkunden Sie Ihre Hilfe am Desktop und lesen Sie, wo Sie weitere im Lieferumfang Ihres Produkts enthaltene Dokumentationen oder zusätzliche Informationen im Web finden können.

12.1. Im Lieferumfang enthaltene Hilfe-Ressourcen

Es gibt mehrere Stellen, an denen Sie Online-Dokumentation finden können, die in Ihrem Produkt inbegriffen ist:

Desktop-Hilfezentren

Die Hilfezentren sowohl des KDE-Desktops (KDE-Hilfezentrum) als auch des GNOME-Desktops (Yelp) bieten zentralen Zugriff auf die wichtigsten Dokumentationsressourcen auf Ihrem System in durchsuchbarer Form. Zu diesen Ressourcen zählen die Online-Hilfe für installierte Anwendungen, man-Seiten, Infoseiten sowie die mit Ihrem Produkt gelieferten Novell/SUSE-Handbücher. Weitere Informationen zur Hilfe auf Ihrem Desktop erhalten Sie unter Abschnitt 12.1.1, „Verwenden des KDE-Hilfezentrums“ und Abschnitt 12.1.2, „Verwenden von GNOME Yelp“.

Dokumentation unter /usr/share/doc

Dieses traditionelle Hilfe-Verzeichnis enthält verschiedene Dokumentationsdateien sowie Hinweise zur Version Ihres Systems. Weitere Informationen finden Sie unter Abschnitt 12.1.3, „Dokumentationsverzeichnis“.

man-Seiten und Infoseiten für Shell-Befehle

Wenn Sie mit der Shell arbeiten, brauchen Sie die Optionen der Befehle nicht auswendig zu kennen. Die Shell bietet normalerweise eine integrierte Hilfefunktion mit man-Seiten und Infoseiten. Weitere Informationen dazu finden Sie unter Abschnitt 12.1.4, „man-Seiten“ und Abschnitt 12.1.5, „Infoseiten“.

Separate Hilfepakete für einige Anwendungen

Beim Installieren von neuer Software mit YaST wird die Software-Dokumentation in den meisten Fällen automatisch installiert und gewöhnlich in der Hilfe auf Ihrem KDE-Desktop angezeigt. Jedoch können einige Anwendungen, beispielsweise The GIMP, über andere Online-Hilfepakete verfügen, die separat mit YaST installiert werden können und nicht in die Hilfe integriert werden.

12.1.1. Verwenden des KDE-Hilfezentrums

Am KDE-Desktop können Sie auf verschiedene Weise auf KDE-Hilfezentrum zugreifen: Wenn Sie in einer Anwendung Hilfe benötigen, klicken Sie einfach in der Anwendung auf die Schaltfläche Hilfe oder drücken Sie F1, um die Dokumentation der Anwendung in der Hilfe zu öffnen. Wenn Sie die Hilfe vom Hauptmenü aus starten bzw. von der Kommandozeile aus mit susehelp, gelangen Sie in das Hauptfenster der Hilfe, in dem Sie nach den Hilfethemen suchen können.

Das Menü und die Werkzeugleiste bieten Optionen zum Drucken des Inhalts aus der Hilfe, zum Durchsuchen der aktuell angezeigten Seite, zur Navigation in der Hilfe und zur Anpassung der Hilfe. Das Anzeigefeld im rechten Fensterbereich zeigt immer den aktuell ausgewählten Inhalt, beispielsweise Online-Handbücher, Suchergebnisse oder Webseiten.

Abbildung 12.1. Hauptfenster des KDE-Hilfezentrums

Hauptfenster des KDE-Hilfezentrums

Der Navigationsbereich im linken Fensterbereich enthält mehrere Registerkarten:

Inhalt

Zeigt eine Baumansicht aller verfügbaren Informationsquellen. Die Hilfe richtet sich an zahlreiche Zielgruppen, beispielsweise Endanwender, Administratoren und Entwickler. Klicken Sie auf die Buchsymbole, um die einzelnen Kategorien zu öffnen und zu durchsuchen. Unter der Überschrift Administration beispielsweise können Sie durch Manualpages und Informationsseiten zu Kommandozeilenprogrammen blättern. Die Hilfe bietet auch Zugriff auf einige Online-Datenbanken, die spezielle Hardware- und Software-Themen zu Ihrem Produkt behandeln. Alle diese Informationsquellen lassen sich problemlos durchsuchen, sobald der Suchindex generiert ist.

Der Inhalt Ihrer Hilfe hängt davon ab, welche Software-Pakete installiert sind und welche Sprachen als Ihre Systemsprachen ausgewählt sind.

Glossary

Bietet eine Kurzreferenz, in der Sie Definitionen von Wörtern nachschlagen können, die Ihnen nicht vertraut sind.

Optionen für die Suche

Enthält Optionen für die Volltextsuche in der Hilfe. Sie können mehrere Suchkriterien kombinieren.

Prozedur 12.1. Durchsuchen der Hilfe

Um die Volltextsuche KDE-Hilfezentrum offers zu verwenden, müssen Sie einen Suchindex generieren und die Suchparameter festlegen. Wenn der Suchindex noch nicht generiert wurde, werden Sie dazu automatisch durch das System aufgefordert, sobald Sie auf den Karteireiter Suchen klicken.

  1. Um nach einen Begriff zu suchen, klicken Sie auf Optionen für die Suche und geben Sie die Suchzeichenkette ein.

  2. Um Ihre Suchzeichenfolgen mit Operanden zu kombinieren, klicken Sie auf Methode und wählen Sie den gewünschten Operanden aus.

  3. Wählen Sie eine Option unter Max. Anzahl Ergebnisse, um die Anzahl der anzuzeigenden Treffer einzugrenzen.

  4. Wenn Ihre Suche auf bestimmte Dokumentationstypen beschränkt werden soll, wählen Sie eine Option aus Umfang. Mit Standard wird eine vordefinierte Auswahl an Dokumenten durchsucht. Alle berücksichtigt bei der Suche alle Dokumenttypen. Mit Benutzerdefiniert können Sie definieren, welche Dokumente bei der Suche berücksichtigt werden. Aktivieren Sie einfach die gewünschten Dokumente in der Liste.

  5. Klicken Sie auf Suchen, nachdem Sie die Optionen Ihren Wünschen entsprechend festgelegt haben. Das Suchergebnis wird im Anzeigefeld als Liste von Links aufgeführt, die per Mausklick geöffnet werden können.

Prozedur 12.2. Generieren eines neuen Suchindex

  1. Wählen Sie zum Erstellen eines neuen Suchindex Einstellungen+Suchindex erstellen aus dem Menü. Ein Fenster wird geöffnet, das die aktuell in der Hilfe verfügbare Dokumentation auflistet.

  2. Wählen Sie die Dokumente aus, die im Suchindex integriert werden sollen, und klicken Sie auf Index erstellen. Nachdem der Index generiert wurde, können Sie die Volltextsuche verwenden.

12.1.2. Verwenden von GNOME Yelp

Um Yelp direkt aus einer Anwendung zu starten, klicken Sie am GNOME-Desktop entweder auf die Schaltfläche Hilfe oder drücken Sie F1. Mit beiden Optionen gelangen Sie direkt zur Dokumentation der Anwendung in der Hilfe. Sie können jedoch auch Yelp vom Hauptmenü aus starten, oder Sie starten es von der Kommandozeile aus mit yelp und durchsuchen anschließend das Hauptfenster der Hilfe.

Abbildung 12.2. Hauptfenster von Yelp

Hauptfenster von Yelp

Das Menü und die Symbolleiste bieten Optionen zum Navigieren und Anpassen der Hilfe sowie zum Suchen und Ausdrucken der Inhalte von Yelp. Zum Anzeigen eines Inhaltsverzeichnisses klicken Sie auf Hilfethemen. Die Hilfethemen sind in Kategorien gruppiert, die als Links dargestellt werden. Klicken Sie auf einen der Links, um eine Liste der Themen dieser Kategorie zu öffnen. Geben Sie zum Suchen eines Elements einfach die Suchzeichenkette in das Suchfeld oben im Fenster ein.

12.1.3. Dokumentationsverzeichnis

Das traditionelle Verzeichnis zum Suchen von Dokumentationen in Ihrem installierten Linux-System finden Sie unter /usr/share/doc. Das Verzeichnis enthält normalerweise Informationen zu den auf Ihrem System installierten Paketen, Versionshinweise, Handbücher etc.

[Note]Inhalte abhängig von installierten Paketen

In der Linux-Welt stehen Handbücher und andere Dokumentationen in Form von Paketen zur Verfügung, ähnlich wie Software. Wie viele und welche Informationen Sie unter /usr/share/docs finden, hängt auch von den installierten (Dokumentations-) Paketen ab. Wenn Sie die hier genannten Unterverzeichnisse nicht finden können, prüfen Sie, ob die entsprechenden Pakete auf Ihrem System installiert sind und fügen Sie sie gegebenenfalls mithilfe von YaST hinzu.

12.1.3.1. Novell/SUSE-Handbücher

Wir bieten unsere Handbücher im HTML- und PDF-Format in verschiedenen Sprachen an. Im Unterverzeichnis Handbuch finden Sie HTML-Versionen der meisten für Ihr Produkt verfügbaren Novell/SUSE-Handbücher:

Start

Führt Sie durch die Installation und die grundlegende Konfiguration Ihres Systems. Für Neulinge behandelt das Handbuch auch grundlegende Linux-Konzepte, wie zum Beispiel das Dateisystem, das Benutzerkonzept und Zugriffsberechtigungen und bietet einen Überblick über die Features von openSUSE für die Unterstützung tragbarer Computer. Stellt Hilfe und Rat bei Problemlösungen bereit.

KDE Quick Start

Bietet eine kurze Einführung in den KDE-Desktop und einige wichtige Anwendungen, die darauf ausgeführt werden.

KDE User Guide

Gibt eine Einführung in den KDE-Desktop von openSUSE und in die verschiedenen darin enthaltenen Anwendungen. Es begleitet Sie durch die Nutzung dieser Anwendungen und hilft Ihnen bei der Erledigung von wichtigen Aufgaben. Es richtet sich in erster Linie an Endbenutzer, die KDE effizient im Alltag nutzen möchten.

GNOME Quick Start

Bietet eine kurze Einführung in den GNOME-Desktop und einige wichtige Anwendungen, die darauf ausgeführt werden.

GNOME User Guide

Stellt den GNOME-Desktop für openSUSE sowie eine vielzahl von Anwendungen vor, die Ihnen bei der Arbeit mit dem GNOME-Desktop begegnen. Es begleitet Sie durch die Nutzung dieser Anwendungen und hilft Ihnen bei der Erledigung von wichtigen Aufgaben. Es richtet sich in erster Linie an Endbenutzer, die den GNOME-Desktop und darauf ausgeführte Anwendungen effizient im Alltag nutzen möchten.

Referenz

Vermittelt Ihnen ein grundlegendes Verständnis von openSUSE und behandelt erweiterte Aufgaben der Systemadministration. Es richtet sich in der Hauptsache an Systemadministratoren und andere Benutzer mit Grundkenntnissen der Systemadministration. Es enthält ausführliche Informationen über erweiterte Einsatzmöglichkeiten, Administration Ihres Systems, Interaktion von Schlüsselsystemkomponenten sowie die Einrichtung verschiedener Netzwerk- und Dateidienste, die openSUSE bietet.

Novell AppArmor Quick Start

Unterstützt Sie beim Verstehen der Hauptkonzepte von Novell® AppArmor.

Novell AppArmor Administration Guide

Enthält ausführliche Informationen zur Verwendung von AppArmor in Ihrer Umgebung.

Lessons For Lizards

Ein Community-Buchprojekt für die openSUSE-Distribution. Ein Snapshot des von der Open Source-Community verfassten Handbuchs wird zusammen mit den Novel/SUSE-Handbüchern veröffentlicht. Diese Lektionen wurden in Form eines Kochbuchs verfasst und behandelten besondere und exotischere Themen als die normalen Handbücher. Weitere Informationen finden Sie unter http://developer.novell.com/wiki/index.php/Lessons_for_Lizards.

Wenn mehr als eine Sprache installiert ist, enthält /usr/share/doc/manual möglicherweise verschiedene Sprachversionen der Handbücher. Die HTML-Versionen der Novell/SUSE-Handbücher stehen auch in der Hilfe an beiden Desktops zur Verfügung. Informationen zum Speicherort der PDF- und HTML-Versionen des Handbuchs auf Ihrem Installationsmedium finden Sie unter openSUSE Versionshinweise. Diese sind in Ihrem installierten System unter /usr/share/doc/release-notes/ verfügbar, bzw. online unter http://www.novell.com/documentation/opensuse103.

12.1.3.2. HOWTOs

Wenn das Paket howto auf Ihrem System installiert ist, enthält /usr/share/doc auch das Unterverzeichnis howto mit zusätzlicher Dokumentation zu vielen Aufgaben bei Setup und Betrieb von Linux-Software.

12.1.3.3. Dokumentation zu den einzelnen Paketen

Im Verzeichnis packages befindet sich die Dokumentation zu den auf Ihrem System installierten Software-Paketen. Für jedes Paket wird ein Unterverzeichnis /usr/share/doc/packages/Paketname angelegt, das häufig README-Dateien für das Paket und manchmal Beispiele, Konfigurationsdateien oder zusätzliche Skripten umfasst. In der folgenden Liste werden die typischen Dateien vorgestellt, die unter /usr/share/doc/packages zu finden sind. Diese Einträge sind nicht obligatorisch, und viele Pakete enthalten möglicherweise nur einige davon.

AUTOREN

Liste der wichtigsten Entwickler.

BUGS

Bekannte Programmfehler oder Fehlfunktionen. Enthält möglicherweise auch einen Link zur Bugzilla-Webseite, auf der alle Programmfehler aufgeführt sind.

CHANGES, ChangeLog

Diese Datei enthält eine Übersicht der in den einzelnen Versionen vorgenommenen Änderungen. Die Datei dürfte nur für Entwickler interessant sein, da sie sehr detailliert ist.

COPYING, LICENSE

Lizenzinformationen.

FAQ

Mailing-Listen und Newsgroups entnommene Fragen und Antworten.

INSTALL

So installieren Sie dieses Paket auf Ihrem System. Da das Paket bereits installiert ist, wenn Sie diese Datei lesen können, können Sie den Inhalt dieser Datei bedenkenlos ignorieren.

README, README.*

Allgemeine Informationen zur Software, zum Zweck und der Art ihrer Verwendung.

TODO

Diese Datei beschreibt Funktionen, die in diesem Paket noch nicht implementiert, jedoch für spätere Versionen vorgesehen sind.

MANIFEST

Diese Datei enthält eine Übersicht über die im Paket enthaltenen Dateien.

NEWS

Beschreibung der Neuerungen in dieser Version.

12.1.4. man-Seiten

man-Seiten sind ein wichtiger Teil des Linux-Hilfesystems. Sie erklären die Verwendung der einzelnen Befehle und deren Optionen und Parameter. Sie greifen auf man-Seiten mit dem Befehl man gefolgt vom Namen des jeweiligen Befehls zu, z. B. man ls.

Die man-Seiten werden direkt in der Shell angezeigt. Blättern Sie mit den Tasten Bild ↑ und Bild ↓ nach oben bzw. unten. Mit Pos 1 und Ende gelangen Sie an den Anfang bzw. das Ende eines Dokuments. und mit Q schließen Sie die man-Seiten. Weitere Informationen über den Befehl man erhalten Sie durch Eingabe von man man. man-Seiten sind in Kategorien unterteilt, wie in Tabelle 12.1, „man-Seiten – Kategorien und Beschreibungen“ gezeigt (diese Einteilung wurde direkt von der Manualpage für den Befehl "man" übernommen).

Tabelle 12.1. man-Seiten – Kategorien und Beschreibungen

Nummer

Beschreibung

1

Ausführbare Programme oder Shell-Befehle

2

Systemaufrufe (vom Kernel bereitgestellte Funktionen)

3

Bibliotheksaufrufe (Funktionen in Programmbibliotheken)

4

Spezielle Dateien (gewöhnlich in /dev)

5

Dateiformate und Konventionen (/etc/fstab)

6

Spiele

7

Sonstiges (wie Makropakete und Konventionen), zum Beispiel man(7) oder groff(7)

8

Systemverwaltungsbefehle (in der Regel nur für "root")

9

Nicht standardgemäße Kernel-Routinen


Jede Manualpage besteht aus den Abschnitten NAME, SYNOPSIS, DESCRIPTION, SEE ALSO, LICENSING und AUTHOR. Je nach Befehlstyp stehen möglicherweise auch weitere Abschnitte zur Verfügung.

12.1.5. Infoseiten

Eine weitere wichtige Informationsquelle sind Infoseiten. Diese sind im Allgemeinen ausführlicher als man-Seiten. Die Infoseite für einen bestimmten Befehl zeigen Sie an, indem Sie info gefolgt vom Namen des Befehls eingeben, z. B. info ls. Infoseiten werden direkt in der Shell in einem Viewer angezeigt, in dem Sie zwischen den verschiedenen Abschnitten, sogenannten „Knoten, navigieren können.“ Mit Leertaste blättern Sie vorwärts und mit <— zurück. Innerhalb eines Knotens können Sie auch mit Bild ↑ und Bild ↓ navigieren, jedoch gelangen Sie nur mit Leertaste und <— zum vorherigen bzw. nächsten Knoten. Drücken Sie wie bei den man-Seiten Q, um den Anzeigemodus zu beenden. Nicht jede man-Seite enthält eine Infoseite und umgekehrt.

Auf dem KDE- oder GNOME-Desktop können Sie auch auf man-Seiten oder Infoseiten zugreifen (bzw. diese ausdrucken):

KDE

Geben Sie zur Anzeige der man-Seite für ls in Konqueror man:/ls in der Leiste mit den Speicherorten ein. Falls der Befehl in mehreren Kategorien beschrieben ist, werden die entsprechenden Links angezeigt. Um zum Beispiel die Infoseite für den Befehl grep anzuzeigen, geben Sie info:/grep ein.

Lagern Sie in KDE-Hilfezentrum die Option Administration aus dem Inhaltsverzeichnis aus, um die man-Seiten und Infoseiten zu durchsuchen.

GNOME

Führen Sie yelp man:ls oder yelp info:ls aus, um die man-Seite oder Infoseite anzuzeigen.

Abbildung 12.3. Anzeigen einer man-Seite mit Konqueror

Anzeigen einer man-Seite mit Konqueror