====== wikiman ======

{{https://raw.githubusercontent.com/filiparag/wikiman/refs/heads/master/demo.gif?400}}

**Offline search engine for manual pages, Arch Wiki, Gentoo Wiki and other documentation**

**wikiman** ist eine Suchmaschine für Handbuchseiten, Wikieinträge und andere Dokumentationen für das Terminal. Der eingegebene Suchbegriff wird ähnliche wie bei [[am>apropos.1|APROPOS(1)]] oder ''man -k'' genutzt, um in dem Handbücher/Wikiseiten Titeln und Inhalt zu suchen. Die gefunde Treffer werden dabei an einem Fuzzy Finder wie z.B. [[tools:cli:fzf:fzf]] (Standard) zur weiteren Filterung weitergeleitet.

wikiman bietet für noch mehr Komfort eine **Shell Widget** für verschiedene [[wpde>Shell_(Betriebssystem)|Shells]] an um den Input Buffer der aktuellen Kommandozeile per Knopfdruck (std. ''STRG+F'') als Suchbergriff zu verwenden.

===== Installation =====

==== Arch Linux ====

  * [[aw>Install|Installiere]] das [[ap>wikiman]] Paket.
  * Für das Arch-Wiki Unterstützung [[aw>Install|Installiere]] das [[ap>arch-wiki-docs]] Paket.

=== Shell Shellintegration (Bash) ===

Füge folgenden Codesnippet in die ''.bashrc'' Datei ein:

<file bash .bashrc>
# wikiman Shell Widget
if type -P wikiman >/dev/null; then
    [[ -f "/usr/share/wikiman/widgets/widget.bash" ]] &&
    source "/usr/share/wikiman/widgets/widget.bash"
fi
</file>

===== Verwendung =====

==== Normale Nutzung ====

Um in allen verfügbaren Quellen nach einen Suchbegriff zu suchen gibt man einfach einen Suchbegriff nach dem Befehl ''wikiman'' ein.

<code bash>
wikiman <Suchbegriff>
</code>

Hat man das Shell Widget installiert, so reicht auch einfach einen Suchbegriff in die Kommandozeile einzugeben um mit ''STRG+F'' danach zu suchen.

==== Suche auf bestimmte Quelle beschränken ====

Möchte man die Suche auf bestimmte Quelle beschränken, so kann dies mit der ''-s'' Option erreicht werden. Es ist dabei eine kommaseparierte Liste von Quellen anzugeben:

=== Suche auf das Arch-Wiki beschränken ===

<code bash>
wikiman -s arch <Suchbegriff>
</code>

=== Suche auf das Arch-Wiki und die Man Pages beschränkt ===

<code bash>
wikiman -s arch,man <Suchbegriff>
</code>

für Mehr Optionen/möglichkeiten siehe [[am>wikiman.1|wikiman(1)]]

===== Siehe auch =====

  * [[https://github.com/filiparag/wikiman|wikiman Github Repository]]
  * [[am>wikiman.1|wikiman(1)]]
  * [[ytv>ooVYAR_0ftU|Improve man pages with syntax highlighting & more]]
  * [[https://www.suletuxe.de/forum/index.php?board=18;action=display;threadid=963|Suletuxe Forum Diskussionsthread]]