wikiman
v2.13.2
Wikimanは、手動ページ、Arch Wiki、Gentoo Wiki、その他のドキュメントのオフライン検索エンジンです。
Wikimanは、正確にしてインターネットに接続する必要なく、ドキュメントを閲覧するための簡単なインターフェイスを提供します。これは、WIKIの全文検索、Manページの部分的な名前と説明マッチング、および検索結果のファジーフィルタリングを利用することによって達成されます。
デフォルトでは、Wikimanはシステムのマニュアルページのみを検索します。これらの指示に従って、オプションのソースを有効にします。
Arch Linuxの追加リポジトリからインストール：
pacman -S wikiman
# Optional: Enable Arch Wiki
pacman -S arch-wiki-docsManjaroまたは別のアーチベースのディストリビューションを実行している場合は、[リリース]タブから最新の.pkg.tar.zstパッケージをダウンロードし、次の手順に従ってソースとしてArch Wikiを追加します。
sudo pacman -U wikiman * .pkg.tar.zst[リリース]タブから最新の.debパッケージをダウンロードします。
sudo apt update
sudo apt install ./wikiman * .deb[リリース]タブから最新の.RPMパッケージをダウンロードします。
# Fedora
sudo dnf install wikiman * .rpm
# openSUSE (skip signature verification)
sudo zypper in wikiman * .rpmPortsコレクションからTextProc/Wikimanをインストールします。
portsnap auto
cd /usr/ports/textproc/wikiman
make installまたは、[リリース]タブから最新の.TXZパッケージをダウンロードします。
pkg install wikiman * .txz依存関係： man 、 fzf 、 ripgrep 、 awk 、 w3m 、 coreutils 、 parallel
# Clone from GitHub
git clone ' https://github.com/filiparag/wikiman '
cd ./wikiman
# Switch to latest stable release (optional)
git checkout $( git describe --tags | cut -d ' - ' -f1 )
# Available targets: all, core, widgets, completions, config, docs
make all
# Only for BSD users: install to /usr/local instead of /usr
make local
# Install Wikiman
sudo make install WikimanはGNU findとawkを使用するため、BSDユーザーはfindutilsとgawkをインストールする必要があります。
現在利用可能なオプションのソースは次のとおりです。
arch ）gentoo ）fbsd ）tldr ）サイズが大きいため、ウィキはウィキマンに束ねられません。それらを使用したい場合は、次のコマンドを使用して最新のスナップショットをダウンロードできます。
# Download latest Makefile
curl -L ' https://raw.githubusercontent.com/filiparag/wikiman/master/Makefile ' -o ' wikiman-makefile '
# Example for Linux: install Arch Wiki
make -f ./wikiman-makefile source-arch
sudo make -f ./wikiman-makefile source-install
sudo make -f ./wikiman-makefile clean
# Example for BSD: install FreeBSD Documentation
make -f ./wikiman-makefile source-fbsd local
sudo make -f ./wikiman-makefile source-install
sudo make -f ./wikiman-makefile cleanインストール後、 sources構成変数が空である場合、それらは自動的に有効にする必要があります。
アクティブなソースを確認するには、実行してください。
wikiman -S build/ディレクトリには、手動スナップショットコンピレーションのスクリプトがあります。これらのスクリプトには外部依存関係があり、エンドユーザーではなくウィキマンメンテナーが実行することをお勧めします。あなたの走行距離は異なる場合があります。
使用法： wikiman [OPTION]... [KEYWORD]...
キーワードが提供されていない場合は、すべてのページを表示します。
-l検索言語
デフォルト： en
-s使用するソース
デフォルト：（すべて利用可能）
-f使用するファジーファインダー
デフォルト： FZF
-qクイック検索モードを有効にします
-a有効化および演算子モード
-pクイック結果プレビューを無効にします
-k 、結果を表示してから開いたままにします
-cソース列を表示します
-H HTMLページのビューアー
デフォルト： W3m
-R RAW出力を印刷します
-S利用可能なソースと出口をリストします
-W指定されたシェルとエグジット用のウィジェットコードを印刷します
-v印刷バージョンと終了
-hこのヘルプを表示して終了します
ウィキマンは、シェルキーバインディング（デフォルト： Ctrl+F ）を使用して起動できます。現在のコマンドラインバッファーは、検索クエリとして使用されます。
キーバインディングを永続的にするために、 .bashrc -like configurationファイルに下記の適切な行を追加します。
# bash
source /usr/share/wikiman/widgets/widget.bash
# fish
source /usr/share/wikiman/widgets/widget.fish
# zsh
source /usr/share/wikiman/widgets/widget.zshユーザー構成ファイルは~/.config/wikiman/wikiman.confにあり、フォールバックシステム全体の構成は/etc/wikiman.confです。
XDG_CONFIG_HOME環境変数を設定した場合、代わりにユーザー構成がそこから調べられます。
構成ファイルの例：
# Sources (if empty, use all available)
sources = man, arch
# Fuzzy finder
fuzzy_finder = sk
# Quick search mode (only by title)
quick_search = true
# Raw output (for developers)
raw_output = false
# Manpages language(s)
man_lang = en, pt
# Wiki language(s)
wiki_lang = zh-CN
# Show previews in TUI
tui_preview = false
# Keep open after viewing a result
tui_keep_open = true
# Show source column
tui_source_column = true
# Viewer for HTML pages
tui_html = xdg-open利用可能な言語をリストするには、これらのコマンドを実行します。
# Man pages (excluding English)
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 '
# FreeBSD Documentation
find ' /usr/share/doc/freebsd-docs ' -maxdepth 1 -type d -printf ' %P '
# TLDR Pages
find ' /usr/share/doc/tldr-pages ' -maxdepth 1 -type d -printf ' %P ' ウィキマンは拡張可能になるように設計されています。各ソースにはsources/ディレクトリにモジュールがあります。
ソースモジュールは、POSIX準拠のシェルスクリプトです。 Wikimanは$queryとConfigurationの変数を読み取り、結果をSTDOUTに印刷するsearch関数を呼び出します。 NAMEtLANGtSOURCEtPATHとしてフォーマットされた行の変数。
NAMEのタイトルLANG Two Letter言語コード（ロケールを含めることができます）SOURCEソース名PATH利用可能なソースをリストすると、ウィキマンは、名前、状態、ページ数、ソースのパスを印刷するモジュールのinfoファンを呼び出します。
一般の人々に役立つソースモジュールを作成する場合は、プルリクエストを使用して共有してください。プルリクエストには以下が含まれている必要があります。
sources/your-source.shyour-sourceyour-source-TIMESTAMP.tar.xzbuild/your-source.shのビルドスクリプトその他の改善も大歓迎です！
