wikiman
v2.13.2
Wikiman является автономной поисковой системой для ручных страниц, Arch Wiki, Gentoo Wiki и другой документации.
Wikiman предоставляет простой интерфейс для просмотра документации без необходимости быть точным и подключенным к Интернету. Это достигается за счет использования полного текстового поиска вики, частичного имени и описания сопоставления для страниц Man и нечеткой фильтрации для результатов поиска.
По умолчанию Wikiman ищет только ручные страницы системы. Следуйте этим инструкциями, чтобы включить дополнительные источники.
Установите из дополнительного репозитория Arch Linux:
pacman -S wikiman
# Optional: Enable Arch Wiki
pacman -S arch-wiki-docsЕсли вы используете Manjaro или другое распределение на основе арки, загрузите последний пакет .
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 * .rpmУстановите 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. Ваш пробег может варьироваться.
Использование: wikiman [OPTION]... [KEYWORD]...
Если ключевых слов не предоставляется, покажите все страницы.
-l Language (ы)
По умолчанию: en
-s источники для использования
По умолчанию: (все доступно)
-f Fuzzy Finder для использования
По умолчанию: FZF
-q включить режим быстрого поиска
-a и режим оператора
-p Отключить предварительный просмотр быстрых результатов
-k оставайтесь открытыми после просмотра результата
-c Показать столбец источника
-H зритель для HTML -страниц
По умолчанию: 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 ' Викиман предназначен для расширения: у каждого источника есть свой модуль в sources/ каталоге.
Источники являются модулями POSIX Shell Scripts. Wikiman вызывает свою функцию search , которая считывает $query и переменные конфигурации и печатает результаты в Stdout . переменная с рядами, отформатированными как NAMEtLANGtSOURCEtPATH .
NAME заголовок страницыLANG два буквенного языка код (может включать в себя локали)SOURCEPATH к файлу HTML При перечислении доступных источников Wikiman вызовет info Module, которая печатает имя, состояние, количество страниц и путь источника.
Если вы создаете модуль источника, полезный для широкой общественности, поделитесь им, используя запрос на вытяжение. Ваш запрос на притяжение должно содержать:
sources/your-source.shyour-sourceyour-source-TIMESTAMP.tar.xzbuild/your-source.shДругие улучшения также приветствуются!
