-
Notifications
You must be signed in to change notification settings - Fork 15
/
Copy pathwikiman.1.man
196 lines (156 loc) · 2.88 KB
/
wikiman.1.man
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
.\" Manual for wmrc.
.TH "wikiman" 1 "15 September 2023" "wikiman 2.13.2" "wikiman manual"
.SH NAME
.B wikiman
\- Offline search engine for manual pages, Arch Wiki, Gentoo Wiki and other documentation.
.SH SYNOPSIS
.B wikiman
[-q] [-a] [-p] [-k] [-c]
.br
[-l <comma separated languages>] [-s <comma separated sources>]
.br
[-f <fuzzy finder>] [-H <html viewer>] [-R] <keyword>...
.br
.B wikiman
-S
.br
.B wikiman
-W <shell>
.br
.B wikiman
-v
.br
.B wikiman
-h
If no keywords are provided, show all pages.
.SH DESCRIPTION
.P
Wikiman is an offline search engine for manual pages, Arch Wiki, Gentoo Wiki and other documentation.
Wikiman provides an easy interface for browsing documentation without the need to be exact and connected to the internet.
This is achieved by utilizing full text search for wikis, partial name and description matching for man pages,
and fuzzy filtering for search results.
.SH OPTIONS
.HP
.B -l
<comma separated languages>
.br
search language(s)
.br
default: en
.HP
.B -s
<comma separated sources>
.br
sources to use
.br
default: (all available)
.HP
.B -f
<fuzzy finder>
.br
fuzzy finder to use
.br
default: fzf
.HP
.B -q
.br
enable quick search mode
.HP
.B -a
.br
enable AND operator mode
.HP
.B -p
.br
disable quick result preview
.HP
.B -k
.br
keep open after viewing a result
.HP
.B -c
.br
show source column
.HP
.B -H
<html viewer>
.br
viewer for HTML pages
.br
default: w3m
.HP
.B -R
.br
print raw output
.HP
.B -S
.br
list available sources and exit
.HP
.B -W
<shell>
.br
print widget code for specified shell and exit
.HP
.B -v
.br
print version and exit
.HP
.B -h
.br
display help and exit
.SH CONFIGURATION:
Default user configuration file location:
.I
~/.config/wikiman/wikiman.conf
(if XDG_CONFIG_HOME is not set).
System-wide configuration location:
.I
/etc/wikiman.conf
.SS Sources
sources =
.SS Fuzzy finder
fuzzy_finder = fzf
.SS Quick search mode
quick_search = false
.SS AND operator mode
and_operator = false
.SS Raw output
raw_output = false
.SS Language(s)
man_lang = en
wiki_lang = en
.PP
.B
List all man languages besides English (en):
.br
find '/usr/share/man' -maxdepth 1 -type d -not -name 'man*' -printf '%P '
.PP
.B
List all Arch Wiki languages:
.br
find '/usr/share/doc/arch-wiki/html' -maxdepth 1 -type d -printf '%P '
.PP
.B
List all FreeBSD Documentation languages:
.br
find '/usr/share/doc/freebsd-docs' -maxdepth 1 -type d -printf '%P '
.SS TUI preview
tui_preview = true
.SS TUI keep open
tui_keep_open = false
.SS TUI show source column
tui_source_column = false
.SS TUI viewer for HTML pages
tui_html = w3m
.SH ADDITIONAL SOURCES:
Default user sources directory:
.I
~/.config/wikiman/sources
(if XDG_CONFIG_HOME is not set).
System-wide sources directory:
.I
/usr/share/wikiman/sources
.SS Installing a source:
To install an additional source called <name>, download it using Wikiman's Makefile:
sudo make install source-<name>