2 files changed, 84 insertions, 5 deletions

@@ -1,3 +1,4 @@
+\" -*- nroff -*-
 .TH bollux 1 0.4.0
 .SH NAME
 bollux \- gemini protocol browser written in
@@ -1,3 +1,4 @@
+\" -*- nroff -*-
 .TH bollux.conf 5 0.4.0
 .SH NAME
 .B bollux.conf
@@ -8,8 +9,8 @@
 uses a number of environment variables that can be sourced from an external file,
 usually placed in
 .IR $XDG_CONFIG_HOME/bollux/bollux.conf .
-The location can be changed at runtime by invoking
-.BR "bollux \-c CONFIG" .
+\"The location can be changed at runtime by invoking
+\".BR "bollux \-c CONFIG" .
 .SH VARIABLES
 .SS Variables you might actually want to set
 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,
 will report the name of the temporary file it saved.
 .TP
 .BR BOLLUX_DATADIR
-valid values are directories; default is '$XDG_DATA_DIR/bollux'.
+valid values are directories; default is '$XDG_DATA_HOME/bollux'.
 .br
 The directory
 .BR bollux (1)
@@ -68,7 +69,16 @@ prints debug-level messages.
 suppresses even error-level messages.
 I'm going to be honest,
 the difference between the levels is somewhat arbitrary.
-So.
+In addition, if the environment variable
+.BR DEBUG
+is set to
+.IR true ,
+.BR bollux (1)
+will enable the
+.BR bash (1)
+functionality behind
+.IR set\ \-x ,
+debugging every call.
 .SS Typesetting
 .BR bollux (1)
 typesets text/gemini content using the
@@ -135,7 +145,12 @@ default: 36 (fg: cyan)
 The color of the link's URL.
 If the link doesn't have a title, this isn't used.
 .TP
-.BI C_HEADER "x where x is 1, 2, or 3"
+.BI C_HEADER "x"
+where x is
+.IR 1 ,
+.IR 2 ", or"
+.IR 3
+.br
 The color of text/gemini headers.
 The default for level 1 is
 .IR 1;4 ,
@@ -153,6 +168,69 @@ The color of list items.
 default: 0 (no formatting)
 .br
 The color of preformatted lines, as delimited by '```'.
+.SS Keybindings
+.BR bollux (1)
+(ab)uses the exit-code scripting capabilities of
+.BR less (1)
+to do things.  The default keys are listed in the man page for
+.BR bollux (1),
+but you can also configure them by tweaking these variables:
+.TP
+.BR KEY_OPEN
+default:
+.IR o
+.br
+the key used to open a link from the current page.
+.TP
+.BR KEY_GOTO
+default:
+.IR g
+.br
+the key used to go to a new link (like a URL bar).
+.TP
+.BR KEY_GOTO_FROM
+default:
+.IR G
+.br
+similar to
+.BR KEY_GOTO ,
+but with the current URL pre-populated.
+.TP
+.BR KEY_BACK
+default:
+.IR [
+.br
+the key used to go back in the history list.
+.TP
+.BR KEY_FORWARD
+default:
+.IR ]
+.br
+the key used to go forward in the history list.
+.TP
+.BR KEY_REFRESH
+default:
+.IR r
+.br
+the key used to re-fetch the current page.
+.TP
+.BR KEY_CYCLE_PRE
+default:
+.IR p
+.br
+the key used to cycle the preformatted text display (see
+.BR T_PRE_DISPLAY ,
+above).
+.TP
+If you want more fine-tuned control over the keybindings,
+you can edit
+.BR BOLLUX_CUSTOM_LESSKEY ,
+which is
+.IR $XDG_CONFIG_HOME/bollux/bollux.lesskey
+by default (of course, it can also be changed).
+See
+.BR lesskey (1)
+for details on that file's format.
 .SS Variables that could be configured, but probably shouldn't be
 These variables control deeper aspects of
 .BR bollux (1)'s