Archives
/
arch-wiki-man
mirror of https://github.com/greg-js/arch-wiki-man
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
14 Commits
1 Branch
13 Tags
1.5 MiB
Roff 52.6%
JavaScript 47.4%
 
 
master
v1.3.0
v1.2.3
v1.2.2
v1.2.1
v1.2.0
v1.1.2
v1.1.1
v1.1.0
v1.0.5
v1.0.4
v1.0.3
v1.0.2
v1.0.1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '59ac2e81e3'
${ noResults }
Go to file
Gregory Scheerlinck 59ac2e81e3 updated readme 9 years ago
bin added -w browser option 9 years ago
lib added apropos-style content search 9 years ago
test better temporary file handling 9 years ago
.eslintrc first commit 9 years ago
.gitignore first commit 9 years ago
LICENSE.md first commit 9 years ago
README.md updated readme 9 years ago
package.json added apropos-style content search 9 years ago

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

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.

Usage & Examples

Use the awman command (it stands for arch wiki man)

awman beginners guide

--> Just one match for beginners guide so the article will open with man

awman guide

--> Multiple matches for guide so a selection menu will be displayed

awman -d i3

--> -d or --desc-search option searches in the descriptions for a match as well as in the titles

awman -k wayland

--> -k or --apropos option searches in the contents for a match.

awman -w tmux

--> -w or --web option opens the resulting match in a web browser rather than with man

License

Licensed under GPLv3