mirror of https://github.com/greg-js/arch-wiki-man synced 2024-11-11 01:10:36 +00:00

Go to file

Gregory Scheerlinck 5a310429f7 updated readme		2016-02-02 14:26:14 +00:00
bin	added -w browser option	2016-02-02 13:32:52 +00:00
docs	added screenshot	2016-02-02 14:16:10 +00:00
lib	added apropos-style content search	2016-02-02 13:08:15 +00:00
test	better temporary file handling	2016-02-02 13:07:28 +00:00
.eslintrc	first commit	2016-01-30 15:11:55 +00:00
.gitignore	first commit	2016-01-30 15:11:55 +00:00
LICENSE.md	first commit	2016-01-30 15:11:55 +00:00
package.json	added apropos-style content search	2016-02-02 13:08:15 +00:00
README.md	updated readme	2016-02-02 14:26:14 +00:00

README.md

A tool to browse and search a constantly updated local copy of the entire (English) Arch Wiki on the command line using man.

Installation

npm install -g arch-wiki-man

Usage & Examples

`awman`

awman beginners guide

Just one match for beginners guide so the article will open with man. By the way, awman stands for arch wiki man.

Multiple matches

awman guide

There are multiple matches for guide so a selection menu will be displayed. Use the arrow keys or vim-style keybindings (j/k) to select the one to read.

Search in descriptions

awman -d i3

The -d or --desc-search option causes searches to scan both the titles and the descriptions for a match.

Apropos

awman -k wayland

The familiar -k or --apropos option causes searches to scan the contents for a match as well. This option makes searches run significantly slower.

Open in a browser

awman -w tmux

The -w or --web option opens the resulting match in a web browser rather than with man. It uses xdg-open to open the relevant url in your default browser.

Updating

npm install -g arch-wiki-man

Updates are pushed automatically every two days to https://github.com/greg-js/arch-wiki-md-repo, a dependency for this project. Whenever the install command is run, the changes will be fetched.

License

Licensed under GPLv3