wikiman

À propos

Wikiman est un moteur de recherche hors ligne pour les pages manuelles, le wiki arch, le wiki Gentoo et d'autres documents.

Wikiman fournit une interface facile pour la documentation de navigation sans avoir besoin d'être exact et connecté à Internet. Ceci est réalisé en utilisant la recherche de texte intégral pour les wikis, le nom partiel et la description correspondant aux pages de l'homme et le filtrage flou pour les résultats de recherche.

Par défaut, Wikiman recherche uniquement les pages manuelles du système. Suivez ces instructions pour permettre des sources facultatives.

Démonstration

Installation

Arch Linux

Installez à partir du référentiel supplémentaire d'Arch Linux:

pacman -S wikiman

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

Si vous exécutez Manjaro ou une autre distribution basée sur une arche, téléchargez le dernier package .pkg.tar.zst à partir des relâches et suivez ces instructions pour ajouter un wiki arch comme source.

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

Ubuntu / Debian

Téléchargez le dernier package .deb à partir de l'onglet des versions.

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

Fedora / OpenSUSE

Téléchargez le dernier package .rpm à partir de l'onglet des versions.

 # Fedora
sudo dnf install wikiman * .rpm

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

FreeBSD

Installez TextProc / Wikiman à partir de la collection Ports:

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

Ou téléchargez le dernier package .txz à partir de l'onglet des versions.

pkg install wikiman * .txz

Installation manuelle pour Linux et BSD

Dépendances: 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 utilise GNU find et awk , donc les utilisateurs de BSD doivent installer findutils et gawk .

Sources de documentation supplémentaires

Les sources facultatives actuellement disponibles sont:

• Arch Wiki ( arch )
• Gentoo Wiki ( gentoo )
• Documentation FreeBSD ( fbsd )
• Pages TLDR ( tldr )

En raison de leur grande taille, les wikis ne sont pas venus avec du wikiman. Si vous souhaitez les utiliser, vous pouvez télécharger leurs derniers instantanés en utilisant les commandes suivantes.

 # 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

Après l'installation, ils doivent être activés automatiquement si la variable de configuration sources est vide.

Pour vérifier les sources actives, exécutez:

wikiman -S

Compilation d'un instantané (scripts de construction de base de données)

Dans build/ Directory, il existe des scripts pour la compilation de snapshot manuelle. Ces scripts peuvent avoir des dépendances externes et ne sont pas recommandées d'être exécutées par les utilisateurs finaux, mais par Wikiman Responctionneurs. Votre kilométrage peut varier.

Usage

Utilisation: wikiman [OPTION]... [KEYWORD]...

Si aucun mot-clé n'est fourni, affichez toutes les pages.

Options:

• -l Langue de recherche (s)

  Par défaut: en

• -s sources à utiliser

  Par défaut: (tous disponibles)

• -f Fuzzy Finder à utiliser

  Par défaut: FZF

• -q activer le mode de recherche rapide

• -a mode d'activation et d'opérateur

• -p Désactiver l'aperçu des résultats rapides

• -k rester ouvert après avoir vu un résultat

• -c Afficher la colonne Source

• -H de pages HTML

  Par défaut: W3M

• -R Imprimer la sortie brute

• -S Liste des sources et sortie disponibles

• -W Imprimer le code de widget pour le shell et la sortie spécifiés

• -v version et sortie d'impression

• -h afficher cette aide et quitter

Widgets de clés de shell

Wikiman peut être lancé à l'aide d'une liaison de clé de shell (par défaut: Ctrl+F ). Le tampon de ligne de commande actuel sera utilisé comme requête de recherche.

Ajoutez une ligne appropriée à partir de ci-dessous à votre fichier de configuration .bashrc -like pour rendre la clé de clé permanente.

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

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

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

Configuration

Le fichier de configuration utilisateur est situé à ~/.config/wikiman/wikiman.conf , et la configuration du système de secours est /etc/wikiman.conf .

Si vous avez défini la variable d'environnement XDG_CONFIG_HOME , la configuration de l'utilisateur sera à la place à partir de là.

Exemple de fichier de configuration:

 # 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

Pour répertorier les langues disponibles, exécutez ces commandes:

 # 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 personnalisées

Wikiman est conçu pour être extensible: chaque source a son module dans sources/ répertoire.

Les modules source sont des scripts de coquille conformes à POSIX. Wikiman appelle leur fonction search qui lit les variables $query , et imprime les résultats à stdout . Variable avec des lignes formatées comme NAMEtLANGtSOURCEtPATH .

• Nom NAME de la page
• LANG Code linguistique à deux lettres (peut inclure les paramètres régionaux)
• Nom de source SOURCE
• Chemin PATH chemin vers le fichier HTML

Lors de la liste des sources disponibles, Wikiman appellera le funcion info du module qui imprime le nom, l'état, le nombre de pages et le chemin de la source.

Contributions

Si vous créez un module source utile au grand public, veuillez le partager à l'aide d'une demande de traction. Votre demande de traction doit contenir:

• sources/your-source.sh
• Recette de makefile your-source
• Instantané installable de la base de données source your-source-TIMESTAMP.tar.xz
• Build Script pour le Snapshot build/your-source.sh
• Brève description dans le corps de la demande de traction

D'autres améliorations sont également les bienvenues!