wikiman

Tentang

Wikiman adalah mesin pencari offline untuk halaman manual, wiki lengkung, wiki gentoo dan dokumentasi lainnya.

Wikiman menyediakan antarmuka yang mudah untuk menjelajah dokumentasi tanpa perlu tepat dan terhubung ke Internet. Ini dicapai dengan memanfaatkan pencarian teks lengkap untuk wiki, nama parsial dan pencocokan deskripsi untuk halaman manusia, dan penyaringan fuzzy untuk hasil pencarian.

Secara default, Wikiman hanya mencari halaman manual sistem. Ikuti instruksi ini untuk mengaktifkan sumber opsional.

Demonstrasi

Instalasi

Arch Linux

Instal dari Repositori Ekstra Arch Linux:

pacman -S wikiman

# Optional: Enable Arch Wiki
pacman -S arch-wiki-docs

Jika Anda menjalankan Manjaro atau distribusi berbasis Arch lainnya, unduh paket .pkg.tar.zst terbaru dari tab rilis, dan ikuti instruksi ini untuk menambahkan wiki lengkung sebagai sumber.

sudo pacman -U wikiman * .pkg.tar.zst

Ubuntu / Debian

Unduh paket .deb terbaru dari tab rilis.

sudo apt update
sudo apt install ./wikiman * .deb

Fedora / OpenSuse

Unduh Paket .RPM Terbaru Dari Rilis.

 # Fedora
sudo dnf install wikiman * .rpm

# openSUSE (skip signature verification)
sudo zypper in wikiman * .rpm

Freebsd

Instal TextProc/Wikiman dari koleksi port:

portsnap auto
cd /usr/ports/textproc/wikiman
make install

Atau unduh paket .txz terbaru dari tab rilis.

pkg install wikiman * .txz

Instalasi manual untuk Linux dan BSD

Ketergantungan: 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 menggunakan GNU find dan awk , jadi pengguna BSD harus menginstal findutils dan gawk .

Sumber Dokumentasi Tambahan

Sumber opsional yang tersedia saat ini adalah:

• Arch Wiki ( arch )
• Gentoo Wiki ( gentoo )
• Dokumentasi FreeBSD ( fbsd )
• Halaman TLDR ( tldr )

Karena ukurannya yang besar, wiki tidak datang dengan Wikiman. Jika Anda ingin menggunakannya, Anda dapat mengunduh snapshot terbaru mereka menggunakan perintah berikut.

 # 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

Setelah instalasi, mereka harus diaktifkan secara otomatis jika variabel konfigurasi sources kosong.

Untuk memverifikasi sumber aktif, jalankan:

wikiman -S

Mengkompilasi snapshot (skrip build database)

Di build/ Directory ada skrip untuk kompilasi snapshot manual. Script ini dapat memiliki dependensi eksternal dan tidak disarankan untuk dijalankan oleh pengguna akhir, tetapi oleh pemelihara Wikiman. Jarak tempuh Anda mungkin bervariasi.

Penggunaan

Penggunaan: wikiman [OPTION]... [KEYWORD]...

Jika tidak ada kata kunci yang disediakan, tunjukkan semua halaman.

Opsi:

• -l Bahasa pencarian

  Default: en

• -s Sumber untuk digunakan

  Default: (semua tersedia)

• -f fuzzy finder untuk digunakan

  Default: FZF

• -q Aktifkan Mode Pencarian Cepat

• -a mode aktif dan operator

• -p Nonaktifkan Pratinjau Hasil Cepat

• -k Tetap buka setelah melihat hasilnya

• -c Kolom Sumber Tampilkan

• -H penampil untuk halaman html

  Default: W3m

• -R mencetak output mentah

• -S Daftar Sumber dan Keluar Tersedia

• -W kode widget cetak untuk shell dan keluar tertentu

• -v versi cetak dan keluar

• -h menampilkan bantuan dan keluar ini

Widget shell keybind

Wikiman dapat diluncurkan menggunakan pengikat kunci shell (default: Ctrl+F ). Buffer baris perintah saat ini akan digunakan sebagai permintaan pencarian.

Tambahkan baris yang sesuai dari bawah ke file konfigurasi .bashrc -seperti Anda untuk membuat kunci mengikat permanen.

 # bash
source /usr/share/wikiman/widgets/widget.bash

# fish
source /usr/share/wikiman/widgets/widget.fish

# zsh
source /usr/share/wikiman/widgets/widget.zsh

Konfigurasi

File konfigurasi pengguna terletak di ~/.config/wikiman/wikiman.conf , dan konfigurasi sistem fallback adalah /etc/wikiman.conf .

Jika Anda telah mengatur variabel lingkungan xdg_config_home , konfigurasi pengguna akan dicari dari sana.

Contoh file konfigurasi:

 # 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

Untuk daftar bahasa yang tersedia, jalankan perintah ini:

 # 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 ' 

Sumber Kustom

Wikiman dirancang agar dapat diperluas: setiap sumber memiliki modul dalam sources/ direktori.

Modul sumber adalah skrip shell yang sesuai dengan POSIX. Wikiman menyebut fungsi search mereka yang membaca $query dan variabel konfigurasi, dan mencetak hasil ke stdout . Variabel dengan baris diformat sebagai NAMEtLANGtSOURCEtPATH .

• Judul NAME Halaman
• Kode bahasa dua huruf LANG (dapat mencakup lokal)
• Nama Sumber SOURCE
• PATH jalur ke file html

Saat mencantumkan sumber yang tersedia, Wikiman akan menghubungi Fungsi info Modul yang mencetak nama, negara, jumlah halaman dan jalur sumber.

Kontribusi

Jika Anda membuat modul sumber yang berguna bagi masyarakat umum, silakan bagikan menggunakan permintaan tarik. Permintaan tarik Anda harus berisi:

• sources/your-source.sh
• Makefile resep your-source
• snapshot yang dapat diinstal dari database sumber your-source-TIMESTAMP.tar.xz
• Bangun skrip untuk basis data snapshot build/your-source.sh
• Deskripsi singkat di tubuh permintaan tarik

Perbaikan lain juga diterima!