Wikiman bietet verschiedene Dokumentationen gebündelt zur Offline-Verwendung an.

Das Internet offeriert vielfältige Dokumentationen, teils mit allgemeiner und teils mit eher spezifischer Ausrichtung. Zu den bei Problemen am häufigsten herangezogenen Quellen zählen neben den etwas sperrigen Manpages das Arch-Wiki [1], die Wikis des Debian-Forums [2] und von Debian selbst [3] sowie das Wiki von Ubuntuusers [4]. Doch was tun, wenn es Probleme mit dem Internet gibt und diese Quellen nicht zugänglich sind? Es gibt zwar die Möglichkeit, Arch Wiki für die Offline-Nutzung zu installieren [5], aber es geht noch besser.

Hier kommt Wikiman ins Spiel. Dabei handelt es sich um eine Offline-Suchmaschine für Manpages, die die Wikis von Arch Linux und Gentoo sowie weitere Dokumentationsquellen wie etwa TLDR [6] für die Befehlszeile einbindet. Wikiman ermöglicht es Ihnen ähnlich wie eine Google-Suche, jede Art von Dokumentation aus mehreren Quellen zu finden, auch wenn Sie nicht genau wissen, wonach Sie suchen. Das Tool erreicht das durch eine Volltextsuche für Wikis, einen teilweisen Namens- und Beschreibungsabgleich für Manpages und das unscharfe Filtern der Suchergebnisse (“fuzzy search”).

Wikiman findet sich in den Paketquellen von Arch Linux und einigen seiner Derivate sowie bei FreeBSD. Darüber hinaus gibt es das Werkzeug auf Github im Quelltext, als Tarball sowie in den Paketformaten DEB, RPM und PKG [7]. Bei Redaktionsschluss war Version 2.13.2 aktuell. Listing 1 zeigt Kommandos zur Installation unter gängigen Distributionen.

### Arch Linux
$ pacman -S wikiman
### Manjaro
$ sudo pacman -U wikiman*.pkg.tar.zst
### Debian und Derivate
$ sudo apt install ./wikiman*.deb
### Fedora
$ sudo dnf install wikiman*.rpm
### OpenSuse
$ sudo zypper in wikiman*.rpm

Gebrauch

Nach der Installation hält Wikiman lediglich den Inhalt der auf dem System vorhandenen Manpages vor. Nach einem Aufruf ohne Parameter listet es bereits während der Eingabe des Suchbegriffs alle Treffer dazu auf (Abbildung 1).

Abbildung 1: Der Aufruf von Wikiman ohne Parameter listet rechts die Namen der verfügbaren Manpages in englischer Sprache auf. Die Auswahl einer Manpage listet deren Inhalt im Hauptfenster auf.

Bewegen Sie den Cursor mit der Pfeiltaste nach unten bis zum gewünschten Eintrag, so erscheint der zugehörige Text rechts im Fenster. In der rechten oberen Ecke zeigt das Wikiman neben der Gesamtzahl der Zeilen der Manpage auch die Nummer der Zeile an, in der sich der Cursor aktuell befindet. Die Eingabe von wikiman -h zeigt eine Hilfedatei mit den verfügbaren Optionen zum Filtern der Ausgabe an (Abbildung 2).

Abbildung 2: Über Kommandozeilenparameter lassen sich unter anderem verschiedene Sprachausgaben gleichzeitig anzeigen, die gewünschten Quellen angeben oder die Unschärfe der Suche über einen bestimmten fuzzy finder festlegen.

So zeigt etwa der Befehl wikiman -q install über die Schnellsuche alle verfügbaren Einträge an, die sich mit Installation befassen. Danach verfeinern Sie die Fundstellen, indem Sie etwa Begriffe wie arch oder deb hinzufügen.

Da die anderen verfügbaren Dokumentationen recht umfangreich ausfallen, fehlen sie im Paket. Es obliegt Ihnen, zu entscheiden, welche Sie nachinstallieren möchten. Wir empfehlen in jedem Fall die Installation des Arch-Wikis, selbst wenn Sie eine andere Distribution verwenden. Dabei handelt es sich um eine der besten Informationsquellen zu Linux im Netz, die ausführliche Informationen und gute Tipps liefert. Meist fällt es leicht, die Handreichungen für andere Distributionen umzustricken.

Weitere Dokus einrichten

Um weitere Dokumentationen einzubinden, laden Sie zunächst ein aktuelles Makefile von Wikiman herunter (Listing 2, erste Zeile). Danach binden Sie das Arch-Wiki mit den Befehlen aus den Zeilen 2 bis 4 ein. Die Eingabe von wikiman -S zeigt es danach mit derzeit rund 5200 Seiten als installiert an (Abbildung 3).

$ curl -L 'https://raw.githubusercontent.com/filiparag/wikiman/master/Makefile' -o 'wikiman-makefile'
$ make -f ./wikiman-makefile source-arch
$ sudo make -f ./wikiman-makefile source-install
$ sudo make -f ./wikiman-makefile clean

Abbildung 3: Nach dem Hinzufügen weiterer Quellen zeigt der Befehl wikiman -S die verfügbaren Quellen, deren Umfang sowie den Pfad im Dateisystem an.

Um TLDR [8] einzubinden, eine vereinfachte Form der Manpages, ersetzen Sie im zweiten Befehl aus Listing 2 source-arch durch source-tldr. Nach diesem Schema installieren Sie auch weitere Wikis, etwa das von Gentoo oder das von FreeBSD.

Die Konfigurationsdatei vom Wikiman finden Sie unter ~/.config/wikiman/wikiman.conf. Falls dieser Pfad nicht existiert, verwendet Ihre Distribution vermutlich die Umgebungsvariable XDG_CONFIG_HOME; Sie finden die Datei dann unter /etc/wikiman.conf. In diesem File ändern Sie beispielsweise die voreingestellte Sprache der Manpages (Englisch) oder geben zusätzliche Sprachen an (Abbildung 4).

Abbildung 4: In der Konfiguration legen Sie unter anderem die für die Anzeige gewünschten Sprachen für Manpages oder die Wikis fest.

Zunächst sollten Sie aber über die Befehle aus Listing 3 herausfinden, ob es die gewünschte Sprache für die jeweilige Dokumentation gibt. Für die deutsche Sprache trifft das sowohl für die Manpages als auch für TLDR zu, nicht aber für das eigentlich ebenfalls in deutscher Sprache vorliegende Arch-Wiki. Das liegt daran, dass es sich beim deutschen Arch-Wiki nicht um eine originale Übersetzung handelt, sondern um ein eigenes kuratiertes Projekt, das aber seit 2021 verwaist zu sein scheint.

Haben Sie in der Konfiguration keine weiteren Sprachen festgelegt, erledigen Sie das alternativ über die Option -l beim Aufruf des Befehls für einen bestimmten Suchbegriff.

### Manpages
$ find '/usr/share/man' -maxdepth 1 -type d -not -name 'man*' -printf '%P '
### Arch-Wiki
$ find '/usr/share/doc/arch-wiki/html' -maxdepth 1 -type d -printf '%P '
### TLDR
$ find '/usr/share/doc/tldr-pages' -maxdepth 1 -type d -printf '%P '

Fazit

Wikiman dient als nützliche Quelle für das Stöbern und Lesen in Dokumentationen zu Linux. Seine Offline-Funktionalität prädestiniert es zudem für Notfälle, in denen keine Internet-Verbindung zur Verfügung steht.

Der Nutzen ließe sich nochmals deutlich steigern, wenn es einfacher wäre, Wikis wie die von Debian oder Ubuntu einzubinden. Da die Möglichkeit der Aufnahme in das Projekt per Pull Request auf Github gegeben ist, käme das auch anderen Anwendern zugute. Auch eigene, über Jahre zusammengetragene Dokumentation böte sich zur Integration an. (tle)