wikiman

에 대한

Wikiman은 수동 페이지, Arch Wiki, Gentoo Wiki 및 기타 문서의 오프라인 검색 엔진입니다.

Wikiman은 정확하고 인터넷에 연결될 필요없이 문서를 탐색하기위한 쉬운 인터페이스를 제공합니다. 이는 Wikis에 대한 전문 검색, Man Pages의 부분 이름 및 설명 일치 및 검색 결과에 대한 퍼지 필터링을 사용하여 달성됩니다.

기본적으로 Wikiman은 시스템의 수동 페이지 만 검색합니다. 다음 지침에 따라 선택적 소스를 활성화하십시오.

데모

설치

아치 리눅스

Arch Linux의 추가 저장소에서 설치 :

pacman -S wikiman

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

Manjaro 또는 다른 아치 기반 배포를 실행하는 경우 릴리스 탭에서 최신 .pkg.tar.zst 패키지를 다운로드 한 다음 다음 지침을 따라 아치 위키를 소스로 추가하십시오.

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

우분투 / 데비안

릴리스 탭에서 최신 .deb 패키지를 다운로드하십시오.

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

Fedora / OpenSuse

Releases 탭에서 최신 .rpm 패키지를 다운로드하십시오.

 # Fedora
sudo dnf install wikiman * .rpm

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

freebsd

Ports Collection에서 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 )
• Gentoo Wiki ( gentoo )
• freebsd 문서 ( fbsd )
• TLDR 페이지 ( tldr )

큰 크기로 인해 Wikis는 Wikiman과 번들로 제공하지 않습니다. 사용하려면 다음 명령을 사용하여 최신 스냅 샷을 다운로드 할 수 있습니다.

 # 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 관리자가 실행하는 것이 좋습니다. 마일리지는 다를 수 있습니다.

용법

사용법 : wikiman [OPTION]... [KEYWORD]...

키워드가 제공되지 않으면 모든 페이지를 표시하십시오.

옵션 :

• -l 검색어 (들)

  기본값 : en

• -s 소스를 사용할 소스

  기본값 : (모두 사용 가능)

• -f 퍼지 파인더를 사용할 수 있습니다

  기본값 : FZF

• -q 빠른 검색 모드를 활성화합니다

• -a 활성화 및 운영자 모드

• -p 빠른 결과 미리보기를 비활성화합니다

• -k 결과를 본 후에도 열려 있습니다

• -c 쇼 소스 열

• -H 페이지의 뷰어

  기본값 : W3M

• -R 원시 출력을 인쇄합니다

• -S 는 사용 가능한 출처 및 종료 목록입니다

• -W 지정된 쉘 및 종료에 대한 위젯 코드를 인쇄합니다

• -v 인쇄 버전 및 종료

• -h 도움을 표시하고 종료하십시오

쉘 키 바인드 위젯

Wikiman은 쉘 키 바인딩 (기본값 : Ctrl+F )을 사용하여 시작할 수 있습니다. 현재 명령 줄 버퍼는 검색 쿼리로 사용됩니다.

아래에서 .bashrc 유사 구성 파일에 적절한 줄을 추가하여 키 바인딩을 영구적으로 만듭니다.

 # 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은 $query 및 구성 변수를 읽는 search 기능을 호출하고 결과를 stdout 에 인쇄합니다. NAMEtLANGtSOURCEtPATH 로 형식화 된 행이있는 변수.

• 페이지의 NAME 제목
• LANG Two Letter Language Code (로케일 포함)
• SOURCE 소스 이름
• HTML 파일의 PATH 경로

사용 가능한 소스를 나열 할 때 Wikiman은 이름, 상태, 페이지 수 및 소스 경로를 인쇄하는 모듈의 info 기능을 호출합니다.

기여

일반 대중에게 유용한 소스 모듈을 만들면 풀 요청을 사용하여 공유하십시오. 풀 요청에는 다음이 포함되어야합니다.

• 모듈 스크립트 파일 sources/your-source.sh
• your-source 소스를 만들 수 있습니다
• 소스 데이터베이스의 설치 가능한 스냅 샷 your-source-TIMESTAMP.tar.xz
• 데이터베이스 스냅 샷 build/your-source.sh 대한 스크립트를 빌드하십시오
• 풀 요청의 본문에 간단한 설명

다른 개선 사항도 환영합니다!