diff options
author | Case Duckworth | 2021-03-01 17:58:32 -0600 |
---|---|---|
committer | Case Duckworth | 2021-03-01 17:58:32 -0600 |
commit | a4f6f72d0c253290918c0e21d237846f9b67978c (patch) | |
tree | 27edbe1b9ec65117d196c2b187874d0822f16a90 | |
parent | Enable customization of keybindings (diff) | |
download | bollux-a4f6f72d0c253290918c0e21d237846f9b67978c.tar.gz bollux-a4f6f72d0c253290918c0e21d237846f9b67978c.zip |
Update man pages
-rw-r--r-- | bollux.1 | 1 | ||||
-rw-r--r-- | bollux.conf.5 | 88 |
2 files changed, 84 insertions, 5 deletions
diff --git a/bollux.1 b/bollux.1 index 35c93f5..a098615 100644 --- a/bollux.1 +++ b/bollux.1 | |||
@@ -1,3 +1,4 @@ | |||
1 | \" -*- nroff -*- | ||
1 | .TH bollux 1 0.4.0 | 2 | .TH bollux 1 0.4.0 |
2 | .SH NAME | 3 | .SH NAME |
3 | bollux \- gemini protocol browser written in | 4 | bollux \- gemini protocol browser written in |
diff --git a/bollux.conf.5 b/bollux.conf.5 index b23aa62..9c66ced 100644 --- a/bollux.conf.5 +++ b/bollux.conf.5 | |||
@@ -1,3 +1,4 @@ | |||
1 | \" -*- nroff -*- | ||
1 | .TH bollux.conf 5 0.4.0 | 2 | .TH bollux.conf 5 0.4.0 |
2 | .SH NAME | 3 | .SH NAME |
3 | .B bollux.conf | 4 | .B bollux.conf |
@@ -8,8 +9,8 @@ | |||
8 | uses a number of environment variables that can be sourced from an external file, | 9 | uses a number of environment variables that can be sourced from an external file, |
9 | usually placed in | 10 | usually placed in |
10 | .IR $XDG_CONFIG_HOME/bollux/bollux.conf . | 11 | .IR $XDG_CONFIG_HOME/bollux/bollux.conf . |
11 | The location can be changed at runtime by invoking | 12 | \"The location can be changed at runtime by invoking |
12 | .BR "bollux \-c CONFIG" . | 13 | \".BR "bollux \-c CONFIG" . |
13 | .SH VARIABLES | 14 | .SH VARIABLES |
14 | .SS Variables you might actually want to set | 15 | .SS Variables you might actually want to set |
15 | Here are actually useful variables that are good things to set in your | 16 | Here are actually useful variables that are good things to set in your |
@@ -42,7 +43,7 @@ or if there's another file with the same name, | |||
42 | will report the name of the temporary file it saved. | 43 | will report the name of the temporary file it saved. |
43 | .TP | 44 | .TP |
44 | .BR BOLLUX_DATADIR | 45 | .BR BOLLUX_DATADIR |
45 | valid values are directories; default is '$XDG_DATA_DIR/bollux'. | 46 | valid values are directories; default is '$XDG_DATA_HOME/bollux'. |
46 | .br | 47 | .br |
47 | The directory | 48 | The directory |
48 | .BR bollux (1) | 49 | .BR bollux (1) |
@@ -68,7 +69,16 @@ prints debug-level messages. | |||
68 | suppresses even error-level messages. | 69 | suppresses even error-level messages. |
69 | I'm going to be honest, | 70 | I'm going to be honest, |
70 | the difference between the levels is somewhat arbitrary. | 71 | the difference between the levels is somewhat arbitrary. |
71 | So. | 72 | In addition, if the environment variable |
73 | .BR DEBUG | ||
74 | is set to | ||
75 | .IR true , | ||
76 | .BR bollux (1) | ||
77 | will enable the | ||
78 | .BR bash (1) | ||
79 | functionality behind | ||
80 | .IR set\ \-x , | ||
81 | debugging every call. | ||
72 | .SS Typesetting | 82 | .SS Typesetting |
73 | .BR bollux (1) | 83 | .BR bollux (1) |
74 | typesets text/gemini content using the | 84 | typesets text/gemini content using the |
@@ -135,7 +145,12 @@ default: 36 (fg: cyan) | |||
135 | The color of the link's URL. | 145 | The color of the link's URL. |
136 | If the link doesn't have a title, this isn't used. | 146 | If the link doesn't have a title, this isn't used. |
137 | .TP | 147 | .TP |
138 | .BI C_HEADER "x where x is 1, 2, or 3" | 148 | .BI C_HEADER "x" |
149 | where x is | ||
150 | .IR 1 , | ||
151 | .IR 2 ", or" | ||
152 | .IR 3 | ||
153 | .br | ||
139 | The color of text/gemini headers. | 154 | The color of text/gemini headers. |
140 | The default for level 1 is | 155 | The default for level 1 is |
141 | .IR 1;4 , | 156 | .IR 1;4 , |
@@ -153,6 +168,69 @@ The color of list items. | |||
153 | default: 0 (no formatting) | 168 | default: 0 (no formatting) |
154 | .br | 169 | .br |
155 | The color of preformatted lines, as delimited by '```'. | 170 | The color of preformatted lines, as delimited by '```'. |
171 | .SS Keybindings | ||
172 | .BR bollux (1) | ||
173 | (ab)uses the exit-code scripting capabilities of | ||
174 | .BR less (1) | ||
175 | to do things. The default keys are listed in the man page for | ||
176 | .BR bollux (1), | ||
177 | but you can also configure them by tweaking these variables: | ||
178 | .TP | ||
179 | .BR KEY_OPEN | ||
180 | default: | ||
181 | .IR o | ||
182 | .br | ||
183 | the key used to open a link from the current page. | ||
184 | .TP | ||
185 | .BR KEY_GOTO | ||
186 | default: | ||
187 | .IR g | ||
188 | .br | ||
189 | the key used to go to a new link (like a URL bar). | ||
190 | .TP | ||
191 | .BR KEY_GOTO_FROM | ||
192 | default: | ||
193 | .IR G | ||
194 | .br | ||
195 | similar to | ||
196 | .BR KEY_GOTO , | ||
197 | but with the current URL pre-populated. | ||
198 | .TP | ||
199 | .BR KEY_BACK | ||
200 | default: | ||
201 | .IR [ | ||
202 | .br | ||
203 | the key used to go back in the history list. | ||
204 | .TP | ||
205 | .BR KEY_FORWARD | ||
206 | default: | ||
207 | .IR ] | ||
208 | .br | ||
209 | the key used to go forward in the history list. | ||
210 | .TP | ||
211 | .BR KEY_REFRESH | ||
212 | default: | ||
213 | .IR r | ||
214 | .br | ||
215 | the key used to re-fetch the current page. | ||
216 | .TP | ||
217 | .BR KEY_CYCLE_PRE | ||
218 | default: | ||
219 | .IR p | ||
220 | .br | ||
221 | the key used to cycle the preformatted text display (see | ||
222 | .BR T_PRE_DISPLAY , | ||
223 | above). | ||
224 | .TP | ||
225 | If you want more fine-tuned control over the keybindings, | ||
226 | you can edit | ||
227 | .BR BOLLUX_CUSTOM_LESSKEY , | ||
228 | which is | ||
229 | .IR $XDG_CONFIG_HOME/bollux/bollux.lesskey | ||
230 | by default (of course, it can also be changed). | ||
231 | See | ||
232 | .BR lesskey (1) | ||
233 | for details on that file's format. | ||
156 | .SS Variables that could be configured, but probably shouldn't be | 234 | .SS Variables that could be configured, but probably shouldn't be |
157 | These variables control deeper aspects of | 235 | These variables control deeper aspects of |
158 | .BR bollux (1)'s | 236 | .BR bollux (1)'s |