Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

wikiman: add page #14922

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

wikiman: add page #14922

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4270fa5
wikiman: add page
jpnadas Nov 20, 2024
f9a3840
wikiman: updated the description
jpnadas Nov 21, 2024
c9f8b44
wikiman: add one more usage example
jpnadas Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions pages/common/wikiman.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# wikiman

> Offline search engine for documentation.
> Supports manual pages, Arch Wiki, Gentoo Wiki, FreeBSD documentation, and tldr-pages.
> More information: <https://github.com/filiparag/wikiman>.
- Search for a specific topic on all install sources:

`wikiman {{search_term}}`

- Search for a topic on a specific [s]ource:

Check failure on line 11 in pages/common/wikiman.md

View workflow job for this annotation

GitHub Actions / build 

ource ==> source, ounce

`wikiman -s {{source}} {{search_term}}`

- Search for a topic on two specific [s]ources:

Check failure on line 15 in pages/common/wikiman.md

View workflow job for this annotation

GitHub Actions / build 

ources ==> sources, ounces

`wikiman -s {{source1}},{{source2}} {{search_term}}`
Comment on lines +15 to +17
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can it be more than two?

Suggested change
- Search for a topic on two specific [s]ources:
`wikiman -s {{source1}},{{source2}} {{search_term}}`
- Search for a topic on two or more specific [s]ources:
`wikiman -s {{source1,source2,...}} {{search_term}}`


- List existing [S]ources:

Check failure on line 19 in pages/common/wikiman.md

View workflow job for this annotation

GitHub Actions / build 

ources ==> sources, ounces

`wikiman -S`
jpnadas marked this conversation as resolved.
Show resolved Hide resolved

- Display [h]elp:

`wikiman -h`