Bei der Recherche zu Fragen der Bedienung von Anwendungen oder Systemkomponenten lässt sich oft schwer erkennen, ob gefundene Antworten für die eigene Programmversion oder Distribution gelten. Daher liegt es nahe, zuerst die mitgelieferten Handbücher zu konsultieren.

Nicht in allen Programmen findet sich ein Menüpunkt Hilfe, und falls doch, verweist er oft nicht auf ein Handbuch zur Anwendung. Nicht nur für die Bedienung von Programmen suchen Anwender nach Hilfe: Wo gibt es etwa das umfassende Handbuch, das die Feinheiten eines OpenSuse-Systems erläutert?

Tatsächlich ergab eine Ende 2020 vom OpenSuse-Projekt organisierte Benutzerumfrage [1] als größte Schwierigkeit beim Umgang mit OpenSuse das Problem, Dokumentationen zu finden. Darum widmen sich diese OpenSuse-Tipps dem Thema offizielle Handbücher und Anleitungen.

Man-Power

Beginnen wir mit dem uralten Kommandozeilendokumentationssystem man, das Linux von seinem Vorgänger Unix erbte: Diese jedem Systemadministrator wohlbekannte Systemkomponente entstand bereits 1971 (Abbildung 1). Ihre Hilfeseiten beziehen sich generell auf Kommandozeilenbefehle und lassen sich mit dem Aufruf man Programm auf der Konsole anzeigen.

Abbildung 1: Das aus der Unix-Urzeit stammende Manpage-System ist bis heute ein so wichtiger Informationslieferant, dass die Hilfezentren von Gnome und KDE (links: das KHelpcenter) es integrieren.

Ein Druck auf die Tabulatortaste löst nach Tippen einiger Buchstaben hinter dem man-Befehl das automatische Vervollständigen des Manpage-Namens aus, ein Druck auf [Q] beendet die Ansicht einer Manpage. Auch heute noch liefern die Autoren der meisten Kommandozeilenprogramme Manpages mit. Sie stellen nach wie vor die primäre und oft einzige Informationsquelle für diesen Programmtyp dar.

Auch für einige grafische Programme, zum Beispiel Gimp, existieren Manpages. Die thematisieren dann allerdings lediglich die Startoptionen beim Aufruf auf der Kommandozeile, wie Sie sie auch per Aufruf mit den Parametern -h oder --help, manchmal auch --usage oder -? erfahren. Doch die Manpage fällt meist ausführlicher aus und lässt sich besser lesen. Zudem können Sie die Manpages über das Tastenkürzel [Umschalt]+[7] nach Schlagworten durchsuchen.

Apropos durchsuchen: Der Kommandozeilenbefehl apropos durchkämmt die Kurzbeschreibungen der Manpages. So liefert apropos gimp außer der Gimp-Manpage Einträge für gimp-console, eine Kommandozeilenversion von Gimp, gimprc, die Gimp-Konfigurationsdatei sowie gimptool-2.0, ein Werkzeug zur Installation von Gimp-Plugins. Sollten Sie den Namen einer Manpage wie gimprc nicht gleich zuordnen können, hilft der Befehl whatis. So listet whatis gimprc die Kurzbeschreibung der zugehörigen Manpage (gimp configuration file) auf.

Manpages untergliedern sich in Sektionen (Abbildung 2), zusätzliche Unterkategorien verkomplizieren gelegentlich diese eigentlich klare Einteilung. Durchschnittliche Anwender brauchen sich damit jedoch normalerweise nicht zu belasten. Sie drücken, sobald man die Frage Welche Handbuchseiten möchten Sie haben? stellt, im Zweifelsfall einfach [Eingabe] oder warten ein paar Sekunden. Das Kommando man -a Programm zeigt Suchergebnisse aus allen Kategorien. Sie schließen die erste Seite mit [Q]+[Eingabe] öffnet dann den nächsten Treffer.

Abbildung 2: Von den Manpage-(Unter-)Kategorien sind für durchschnittliche Anwender meist nur die Abschnitte 1 und 8 relevant.

Jede Menge Info

Sollte einmal eine Manpage für ein Programm fehlen, dann haben seine Autoren vielleicht dem zweiten klassischen Unix-Dokumentationssystem info den Vorzug gegeben (Abbildung 3). Info-Seiten öffnen Sie auf der Konsole mit info Programm. Das Kommando kannte bereits 1977 Hyperlinks, fand aber dennoch nie dieselbe Verbreitung wie Manpages.

Abbildung 3: Für die Linux-Shell Bash gibt es nicht nur eine Manpage, sondern auch ein per Links (unterstrichener Text unten) durchblätterbares Info-Handbuch.

Den in einer geöffneten Info-Seite als schwarzen Block sichtbaren Cursor bewegen Sie mit den Pfeiltasten. Befindet er sich in einem durch Sternchen und Unterstreichung gekennzeichneten Link, drücken Sie [Eingabe]+, um ihm zu folgen. [U]+ springt eine Ebene in der Aufrufhierarchie zurück. [N]+ wechselt zur thematisch folgenden, [P] zur vorausgehenden Seite.

Hilfezentrum

Das 50 Jahre alte Man-Dokumentationssystem ist eines der ältesten genutzten Programme auf einem Linux-Rechner. An Basics wie Lesbarkeit und Durchsuchbarkeit haben seine Autoren schon zu einer Zeit gedacht, als eine Magazinseite voll Text den Speicher eines Computers noch nennenswert fordere. Die Hilfezentren der Desktop-Umgebungen KDE und Gnome zeigen die Manpages heute zeitgemäßer in proportionaler statt in Schreibmaschinenschrift.

Das im KDE-Startmenü schlicht Hilfe genannte Programm KHelpcenter (Abbildung 4) bietet eine Suchfunktion, die Manpages nach Namen und Schlagwörtern in der Kurzbeschreibung auffindet, also die Funktion der Kommandos man und apropos zusammenfasst. Es existiert auch eine Suche innerhalb der gerade geöffneten Seite (Suchen in der Schalterleiste). Über die Optik hinausgehende Vorteile gibt es jedoch nicht, weswegen viele Linux-Anwender die Manpages nach wie vor direkt im Terminal konsultieren.

Abbildung 4: Die Hauptaufgabe des KDE-Hilfezentrums besteht darin, die modern strukturierten und bebilderten Handbücher für KDE und die assoziierten Programme anzuzeigen.

Das KDE-Hilfezentrum führt im Reiter Inhalt sowohl UNIX-Hilfeseiten (also Manpages) als auch Infoseiten auf, die Suchfunktion erfasst allerdings nur Erstere. Info-Seiten finden Sie in einer alphabetischen und thematischen Übersicht unterhalb des Eintrags Inhalt | Infoseiten durchsehen. Dort finden Sie auch die Kategorien Grundlagen (von KDE) und das Handbuch zu Plasma. Letztere erklärt den Umgang mit KDE-Besonderheiten wie Applets auf der Desktop-Oberfläche oder die Konfiguration der Kontrollleisten, ohne Vorwissen vorauszusetzen, und empfiehlt sich speziell KDE-Einsteigern als Lektüre. Der Menüpunkt Online-Hilfe nennt Links zu den KDE-Hilfeseiten im Internet, die teilweise aktueller ausfallen als die mitgelieferten Handbücher, aber auch nicht zwangsläufig zur installierten KDE-Version passen.

Die umfangreichste Sparte in KHelpcenter sind die Anwendungshandbücher, die das Inhaltsverzeichnis in dieselben Kategorien gliedert wie das KDE-Startmenü. Sie erläutern viele, aber längst nicht alle Programme anschaulich auf Deutsch mit Screenshots. Der umfangreiche Videoeditor Kdenlive zum Beispiel kommt eindeutig zu kurz, obwohl man online eine praktisch lückenlose Dokumentation findet [2]. Normalerweise erreichen Sie die Anwendungshandbücher im Hilfezentrum auch aus dem Menü Hilfe der jeweiligen Anwendung.

Viel Raum widmet KHelpcenter auch den Systemeinstellungs-Modulen sowie dem KDE-Dateimanager Dolphin. Die Hilfe zu Letzterem verbirgt sich hinter dem ungeschickt benannten Menüpunkt Dateiverwaltungs-Einstellungsmodule. Unter der ebenso sperrigen Bezeichnung Browser-Einstellungsmodule versteckt sich der alte KDE-Browser und -Dateimanager Konqueror.

Yelp

Gnome-Anwendungen fehlen im KDE-Hilfezentrum schon aus technischen Gründen: Die Gnome-Dokumentation liegt weitgehend in Mallard vor, einem Gnome-spezifischen XML-Dateiformat, während KDE auf das in und außerhalb der IT weitverbreitete Docbook [3] setzt.

Das Gnome-Gegenstück zum KHelpcenter, Yelp, zeigt nach dem Start ausschließlich Hilfeseiten für die Desktop-Umgebung Gnome an (Abbildung 5). Erst das Tastenkürzel [L] öffnet eine Adressleiste, die Eingaben der Form man:Programm oder info:Programm akzeptiert (Abbildung 6). Auch ein Start auf der Kommandozeile mit yelp man:Programm oder info:Programm funktioniert – zumindest theoretisch: Unglücklicherweise ist die Suche nach Programmnamen offenbar seit Jahren kaputt und quittiert jede Eingabe mit einem Fehler.

Abbildung 5: Nach dem Start wirkt das Gnome-Programm Yelp wie eine reine Gnome-Hilfe. Erst ein undokumentierter Shortcut bringt weitere Funktionen zum Vorschein (Abbildung 6).

Abbildung 6: Die Tastenkombination [Strg]+[L] blendet in Yelp ein Eingabefeld ein, das neben Man- und Info-Seiten sogar die Docbook-Dateien der KDE-Handbücher öffnet.

Der Eintrag Alle Hilfedokumente im Hamburger-Menü rechts oben öffnet eine Übersicht aller Hilfeseiten für Gnome-Programme und die Desktop-Umgebung (Gnome-Hilfe). Die Suche innerhalb der angezeigten Seite (Suche im Hamburger-Menü) funktioniert zum Glück. Sie können sie nutzen, um die Seite Alle Hilfedokumente nach Programmnamen zu durchforsten.

In dieser Übersicht ignoriert Yelp KDE-Programme ebenso wie umgekehrt das KHelpcenter die Gnome-Anwendungen. Immerhin lassen sich die im Docbook-Standard vorliegenden KDE-Hilfeseiten in Yelp zumindest manuell öffnen: Ihre deutschen Fassungen liegen im Verzeichnis /usr/share/doc/HTML/de/, die Unterordnernamen dort entsprechen dem Programmnamen. Yelp erwartet den vollen Pfad zu einer Docbook-Datei, zum Beispiel /usr/share/doc/HTML/de/konsole/index.docbook.

Wer Programme beider Desktop-Umgebungen nutzt, sollte auch das jeweilige Hilfezentrum mit installieren: Die für sich genommen recht umfangreichen Abhängigkeiten sind dann ohnehin schon vorhanden. Die Programmpakete hierfür heißen khelpcenter5 und yelp.

Handbücher

Suse versucht traditionell mit professionell gestalteter Dokumentation zu punkten. Alte Hasen erinnern sich noch an die dicken, den käuflich zu erwerbenden Installationsmedien beiliegenden weiß-grünen Wälzer.

Deren Nachfolger finden sich für die aktuell unterstützten Leap-Ausgaben (im Moment 15.3 und 15.2) online [4]. Alle Texte liegen auf Englisch vor, es gibt lediglich eine deutsche Übersichtsseite (Abbildung 7). Die Handbücher stehen für den Abruf per Internet als in Unterseiten aufgeteilte Version, als einzelne HTML-Datei sowie als PDF- und EPUB-Dokument bereit.

Abbildung 7: Die Handbücher für die aktuellen Leap-Versionen erben ihren Aufbau teilweise bis heute von der alten Paperback-Handbüchern. Der aktuelle Praxisbezug leidet unter der langen Ahnenreihe manchmal etwas.

Das erste Dokument dort nennt sich Startup Guide. Es beschreibt den Installationsvorgang sowie die beim Einrichten eines neuen Systems anfallenden Administrationsaufgaben und deckt auch einige für Linux-Einsteiger neue Systemeigenschaften ab, wie die Shell und Dateizugriffsrechte. Dieses Handbuch ist aktuell, umfassend, übersichtlich und anschaulich gestaltet.

Für das allgemeine Distributionshandbuch Reference Guide gilt dieses Lob nicht uneingeschränkt: Ein Dokument, das zum Beispiel aus der OpenSuse-Anfangszeit ein umfangreiches Kapitel über die Einrichtung eines FTP-Servers mitschleppt, lässt die Frage aufkommen, ob die inhaltliche Auswahl seit der Zeit der gedruckten Handbücher überhaupt einmal neu durchdacht wurde.

Viel näher am (noch unerfahrenen) Benutzer agiert der GNOME User Guide, für den KDE kein Gegenstück anbietet. Doch schon der Security and Hardening Guide dürfte wieder an der Realität der meisten OpenSuse-Anwender vorbeigehen: Professionelle Linux-Administratoren sollten sich mit Themen wie dem dort in der Tiefe erklärten System der Pluggable Authentication Modules auskennen. Die meisten OpenSuse-Anwender haben eher Fragen zur – hier gänzlich ignorierten – Sicherheit des Browsers oder von E-Mails.

Die teilweise auf Deutsch vorliegenden Release Notes (Versionshinweise [5]), die auch schon der Installer einblendet, enthalten eine Handvoll nützlicher Tipps zum Upgrade von Leap 15.2 auf Systemebene. Auf Probleme von Anwendern mit neuen Versionen der mitgelieferten Software gehen sie allerdings nicht ein.

Github und Wiki

Dass das Konzept der bisherigen OpenSuse-Dokumentation in die Jahre gekommen ist, weiß sicher auch das OpenSuse-Team, das darum eine “aufgemöbelte” Dokumentation (OpenSuse Docs revamped) auf der Software-Hosting-Plattform Github eingerichtet hat [6]. Jeder Interessierte kann dort Verbesserungsvorschläge als Pull Request (Bitte um Übernahme [7]) einreichen, wie es auch beim Quellcode freier Software üblich ist.

Der aktuelle Stand des neuen Projekts lässt sich in Form einer übersichtlichen Webseite mit Suchfunktion einsehen [8] und wirkt vielversprechend: Viele aktuelle Themen wie Flatpak-Pakete [9], das neue Audio-Video-Framework Pipewire [10] oder das Tool Tumbleweed-cli [11] zum risikofreien Aktualisieren von Tumbleweed sind bereits eingearbeitet (Abbildung 8).

Abbildung 8: Das neue Dokumentationsprojekt “OpenSuse Docs revamped” ist bereits weit fortgeschritten und brauchbar.

Schon lange vor Github gab es Wikis, die externen Beitragenden die Mitarbeit niederschwellig ermöglichten. Im OpenSuse-Wiki finden sich neben uralten, ungepflegten Einträgen auch etliche aktuelle Information, organisiert in Portale genannten thematischen Kategorien [12]. Es gibt auch eine Suchfunktion. Die deutsche Fassung des Wikis, die Sie über den Eintrag In other languages im Ausklappmenü der Kopfzeile auswählen, hinkt allerdings in Sachen Aktualität der englischen Ausgabe deutlich hinterher.

Fazit

Unbezahlten Freiwilligen macht das Programmieren sicherlich mehr Spaß als das Schreiben trockener Hilfedokumente. Eine hundertprozentig aktuelle und lückenlose Dokumentation wird freie Software daher wohl nie erreichen. Es lohnt sich trotzdem, das Angebot an offiziellen Handbüchern zu den genutzten Programmen und zur Distribution OpenSuse zu kennen. Da es zu den installierten Softwareversionen passt, lässt es sich bei Fragen als erste Anlaufstelle nutzen. (cla)