wikiman(1)

💅 wikiman(1) — the manual page, but make it make sense

okay bestie, so this is wikiman from the wikiman manual and honestly? it's a whole vibe. it's an offline search engine for manual pages, the Arch Wiki, the Gentoo Wiki and other documentation. no wifi required, no cap. let's get into it 🫶

---

✨ SYNOPSIS ✨

like, here's how you actually run her:

wikiman [-q] [-a] [-p] [-k] [-c]
        [-l <comma separated languages>] [-s <comma separated sources>]
        [-f <fuzzy finder>] [-H <html viewer>] [-R] <keyword>...
wikiman -S
wikiman -W <shell>
wikiman -v
wikiman -h

and if you don't give her any keywords at all? she just shows you everything. iconic behaviour tbh 💅

---

🌸 DESCRIPTION 🌸

Wikiman is an offline search engine for manual pages, Arch Wiki, Gentoo Wiki and other documentation.

she gives you a super easy interface for browsing docs without needing to be exact and without being connected to the internet. how? three little tricks, and they're all lowkey genius:

• full text search for wikis 🔍
• partial name and description matching for man pages 📄
• fuzzy filtering for your search results ✨

the way that she just finds things... main character energy fr fr 👑

---

🎀 OPTIONS 🎀

• -l <comma separated languages> — which language(s) to search. default: en
• -s <comma separated sources> — which sources to use. default: (all available)
• -f <fuzzy finder> — which fuzzy finder to use. default: fzf
• -q — turns on quick search mode ⚡
• -a — turns on AND operator mode
• -p — disables the quick result preview (no lil sneak peek, sad but valid)
• -k — keeps her open after you view a result
• -c — shows the source column
• -H <html viewer> — the viewer for HTML pages. default: w3m
• -R — prints raw output
• -S — lists available sources and exits
• -W <shell> — prints widget code for the specified shell and exits
• -v — prints the version and exits
• -h — displays help and exits

---

💖 CONFIGURATION 💖

default user configuration file location: ~/.config/wikiman/wikiman.conf (if XDG_CONFIG_HOME is not set).

system-wide configuration location: /etc/wikiman.conf

🦋 Sources

sources =

🦋 Fuzzy finder

fuzzy_finder = fzf

🦋 Quick search mode

quick_search = false

🦋 AND operator mode

and_operator = false

🦋 Raw output

raw_output = false

🦋 Language(s)

man_lang = en

wiki_lang = en

List all man languages besides English (en):

find '/usr/share/man' -maxdepth 1 -type d -not -name 'man*' -printf '%P\n'

List all Arch Wiki languages:

find '/usr/share/doc/arch-wiki/html' -maxdepth 1 -type d -printf '%P\n'

List all FreeBSD Documentation languages:

find '/usr/share/doc/freebsd-docs' -maxdepth 1 -type d -printf '%P\n'

🦋 TUI preview

tui_preview = true

🦋 TUI keep open

tui_keep_open = false

🦋 TUI show source column

tui_source_column = false

🦋 TUI viewer for HTML pages

tui_html = w3m

---

🌈 ADDITIONAL SOURCES 🌈

default user sources directory: ~/.config/wikiman/sources (if XDG_CONFIG_HOME is not set).

system-wide sources directory: /usr/share/wikiman/sources

🧚 Installing a source:

so to install an additional source called <name>, just download it using Wikiman's Makefile:

sudo make install source-<name>

periodt. that's the whole thing 💜

---

ngl bestie, that's the full page — every flag, every default, every path, nothing skipped 💀

and that's a wrap! sign-off time: this is wikiman 2.14, dated 12 May 2025, and it's the wikiman(1) page, mwah 💋 🎀✨