wikiman

เกี่ยวกับ

Wikiman เป็นเครื่องมือค้นหาแบบออฟไลน์สำหรับหน้าด้วยตนเอง Arch Wiki, Gentoo Wiki และเอกสารอื่น ๆ

Wikiman ให้อินเทอร์เฟซง่าย ๆ สำหรับการเรียกดูเอกสารโดยไม่จำเป็นต้องมีความแน่นอนและเชื่อมต่อกับอินเทอร์เน็ต สิ่งนี้สามารถทำได้โดยการใช้การค้นหาข้อความแบบเต็มสำหรับวิกิชื่อบางส่วนและคำอธิบายการจับคู่สำหรับหน้าผู้ชายและการกรองฟัซซี่สำหรับผลการค้นหา

โดยค่าเริ่มต้น Wikiman จะค้นหาหน้าคู่มือของระบบเท่านั้น ทำตามคำแนะนำเหล่านี้เพื่อเปิดใช้งานแหล่งที่เลือก

สาธิต

การติดตั้ง

ซุ้มประตู

ติดตั้งจากที่เก็บพิเศษของ Arch Linux:

pacman -S wikiman

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

หากคุณใช้งาน Manjaro หรือการกระจายแบบอื่น ๆ ให้ดาวน์โหลดแพ็คเกจ . pkg.tar.zst ล่าสุดจากแท็บรีลีสและทำตามคำแนะนำเหล่านี้เพื่อเพิ่ม Arch Wiki เป็นแหล่งที่มา

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

Ubuntu / Debian

ดาวน์โหลดแพ็คเกจ . deb ล่าสุดจากแท็บรีลีส

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

fedora / opensuse

ดาวน์โหลดแพ็คเกจ . rpm ล่าสุดจากแท็บ Releases

 # Fedora
sudo dnf install wikiman * .rpm

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

FreeBSD

ติดตั้ง TextProc/Wikiman จากคอลเลกชันพอร์ต:

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

หรือดาวน์โหลดแพ็คเกจ . TXZ ล่าสุดจากแท็บรีลีส

pkg install wikiman * .txz

การติดตั้งด้วยตนเองสำหรับ Linux และ BSD

การพึ่งพา: 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 Wiki ( arch )
• Gentoo Wiki ( gentoo )
• เอกสาร FreeBSD ( fbsd )
• หน้า tldr ( 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/ Directory มีสคริปต์สำหรับการรวบรวมสแน็ปช็อตด้วยตนเอง สคริปต์เหล่านี้สามารถมีการพึ่งพาภายนอกและไม่แนะนำให้ดำเนินการโดยผู้ใช้ปลายทาง แต่โดยผู้ดูแลวิกิมัน ไมล์สะสมของคุณอาจแตกต่างกันไป

การใช้งาน

การใช้งาน: wikiman [OPTION]... [KEYWORD]...

หากไม่มีคำหลักให้แสดงหน้าทั้งหมด

ตัวเลือก:

• -l ภาษาค้นหา

  ค่าเริ่มต้น: en

• -s แหล่งที่มาใช้

  ค่าเริ่มต้น: (พร้อมใช้งานทั้งหมด)

• -f Fuzzy Finder ที่จะใช้

  ค่าเริ่มต้น: FZF

• -q เปิดใช้งานโหมดการค้นหาอย่างรวดเร็ว

• -a โหมดเปิดใช้งาน และ ผู้ให้บริการ

• -p ปิดการใช้งานตัวอย่างผลลัพธ์ด่วน

• -k เปิดให้บริการหลังจากดูผลลัพธ์

• -c คอลัมน์แหล่งแสดง

• -H Viewer สำหรับหน้า html

  ค่าเริ่มต้น: W3M

• -R พิมพ์เอาต์พุตดิบ

• -S รายการแหล่งที่มาและทางออกที่มีอยู่

• -W พิมพ์รหัสวิดเจ็ตสำหรับเชลล์และออกที่ระบุ

• -v เวอร์ชันพิมพ์และออก

• -h แสดงความช่วยเหลือและออกนี้

วิดเจ็ต Shell Keybind

Wikiman สามารถเปิดใช้งานได้โดยใช้การเชื่อมโยงคีย์เชลล์ (ค่าเริ่มต้น: Ctrl+F ) บัฟเฟอร์บรรทัดคำสั่งปัจจุบันจะถูกใช้เป็นคำค้นหา

เพิ่มบรรทัดที่เหมาะสมจากด้านล่างไปยังไฟล์กำหนดค่า .bashrc -LIKE ของคุณเพื่อให้คีย์มีผลผูกพันถาวร

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

แหล่งที่กำหนดเอง

Wikiman ได้รับการออกแบบให้สามารถขยายได้: แต่ละแหล่งมีโมดูลใน sources/ ไดเรกทอรี

โมดูลแหล่งที่มาคือสคริปต์เชลล์ที่สอดคล้องกับ POSIX Wikiman เรียกใช้ฟังก์ชั่น search ซึ่งอ่านตัวแปร $query และการกำหนดค่าและพิมพ์ผลลัพธ์ไปยัง stdout ตัวแปรที่มีแถวที่จัดรูปแบบเป็น NAMEtLANGtSOURCEtPATH

• ชื่อ NAME ของหน้า
• LANG สองรหัสภาษาตัวอักษร (สามารถรวม locale)
• ชื่อ SOURCE
• พา PATH พา ธ ไปยังไฟล์ html

เมื่อแสดงรายการแหล่งข้อมูลที่มีอยู่ Wikiman จะโทรหา Funcion info ของโมดูลซึ่งพิมพ์ชื่อรัฐจำนวนหน้าและเส้นทางของแหล่งที่มา

ผลงาน

หากคุณสร้างโมดูลต้นฉบับที่เป็นประโยชน์ต่อสาธารณะทั่วไปโปรดแบ่งปันโดยใช้คำขอดึง คำขอดึงของคุณควรมี:

• sources/your-source.sh
• สูตร makefile your-source
• Snapshot ที่ติดตั้งได้ของฐานข้อมูล your-source-TIMESTAMP.tar.xz
• สร้างสคริปต์สำหรับฐานข้อมูล snapshot build/your-source.sh
• คำอธิบายสั้น ๆ ในร่างกายของคำขอดึง

การปรับปรุงอื่น ๆ ก็ยินดีต้อนรับ!