Update documentation

diff --git a/bollux b/bollux
index 1aaa70f..9b8d5fa 100755 (executable)
--- a/bollux
+++ b/bollux
@@ -336,10 +336,9 @@ gemini_request() {
        server="${server%%/*}"
 
        ssl_cmd=(openssl s_client -crlf -quiet -connect "$server:$port")
-       # disable old TLS/SSL versions (thanks makeworld!)
+       # disable old TLS/SSL versions
        ssl_cmd+=(-no_ssl3 -no_tls1 -no_tls1_1)
 
-       # always try to connect with TLS v1.3 first
        run "${ssl_cmd[@]}" <<<"$url" 2>/dev/null
 }
 
@@ -849,9 +848,8 @@ bollux_init() {
 }
 
 bollux_cleanup() {
-       # XXX
+       # Stubbed in case of need in future
        :
-       #kill $(jobs -p)
 }
 
 history_append() { # history_append url TITLE

diff --git a/bollux.1 b/bollux.1
index 4b6948d..122934d 100644 (file)
--- a/bollux.1
+++ b/bollux.1
@@ -1,6 +1,7 @@
-.TH bollux 1 0.3.0\r
+.TH bollux 1 0.4.0\r
 .SH NAME\r
-bollux \- gemini protocol browser written in bash(1)\r
+bollux \- gemini protocol browser written in \r
+.BR bash (1)\r
 .SH SYNOPSIS\r
 .B bollux\r
 .RI [ \-h ]\r
@@ -26,11 +27,11 @@ Be quiet: don't show any messages, even fatal ones
 .TP\r
 .B \-v\r
 Be verbose: show all messages, even debug ones\r
-.TP\r
-.B \-c CONFIG\r
-Use CONFIG file to configure\r
-.BR bollux (1)\r
-instead of the default: $XDG_CONFIG_HOME/bollux/bollux.conf.\r
+.\".TP\r
+.\".B \-c CONFIG\r
+.\"Use CONFIG file to configure\r
+.\".BR bollux (1)\r
+.\"instead of the default: $XDG_CONFIG_HOME/bollux/bollux.conf.\r
 .TP\r
 .B URL\r
 The gemini URL to navigate to\r
@@ -67,10 +68,21 @@ quit bollux
 If a new URL is selected,\r
 .BR bollux (1)\r
 will repeat the download-and-display loop with the new URL.\r
-.SH ISSUES\r
-There is currently no history storage or recall.\r
+.PP\r
+If the mimetype is other than text/*,\r
 .BR bollux (1)\r
-can get confused on some URLs \-\- munging them correctly is an area of active research.\r
+will attempt to download the file to\r
+.B $BOLLUX_DOWNDIR\r
+(which defaults to '.').\r
+.PP\r
+.BR bollux (1)\r
+also supports the gopher protocol,\r
+which is browsed the same way as the gemini protocol\r
+(except the URL starts with 'gopher://').\r
+Gopher support is as of now rudimentary.\r
+.SH ISSUES\r
+Certificate handling needs to be much improved: TOFU needs to be implemented\r
+and bollux should be able to generate client certificates.\r
 .SH SEE ALSO\r
 .BR bollux.conf (5)\r
 .SH BUGS\r

diff --git a/bollux.conf.5 b/bollux.conf.5
index 9cee1b5..9f431db 100644 (file)
--- a/bollux.conf.5
+++ b/bollux.conf.5
@@ -1,4 +1,4 @@
-.TH bollux.conf 5 0.3.0\r
+.TH bollux.conf 5 0.4.0\r
 .SH NAME\r
 .B bollux.conf\r
 \- configuration file for\r
@@ -17,7 +17,7 @@ Here are actually useful variables that are good things to set in your
 in order of usefulness.\r
 .TP\r
 .BR BOLLUX_URL\r
-valid values are URLs; default is ''. \r
+valid values are URLs; default is ''.\r
 .br\r
 If\r
 .B BOLLUX_URL\r
@@ -28,7 +28,7 @@ otherwise it asks the user for where to go.
 Setting this variable works like setting a home page.\r
 .TP\r
 .BR BOLLUX_DOWNDIR\r
-valid values are directories; default is '.'. \r
+valid values are directories; default is '.'.\r
 .br\r
 The directory to attempt to save downloads in.\r
 .BR bollux (1)\r
@@ -42,14 +42,14 @@ or if there's another file with the same name,
 will report the name of the temporary file it saved.\r
 .TP\r
 .BR BOLLUX_DATADIR\r
-valid values are directories; default is '$XDG_DATA_DIR/bollux'. \r
+valid values are directories; default is '$XDG_DATA_DIR/bollux'.\r
 .br\r
 The directory\r
 .BR bollux (1)\r
 will put its data files, such as history, cert fingerprints, etc.\r
 .TP\r
 .BR BOLLUX_MAXREDIR\r
-valid values are integers; default is '5'. \r
+valid values are integers; default is '5'.\r
 .br\r
 The maximum number of redirects before\r
 .BR bollux (1)\r
@@ -57,7 +57,7 @@ decides to quit.
 The default is 5 as per some RFC spec.\r
 .TP\r
 .BR BOLLUX_LOGLEVEL\r
-valid values are '', DEBUG or QUIET; default is ''. \r
+valid values are '', DEBUG or QUIET; default is ''.\r
 .br\r
 How verbose\r
 .BR bollux (1)\r
@@ -80,13 +80,13 @@ the default function is pretty nice (at least in my opinion).
 The following variables control how text/gemini content is rendered:\r
 .TP\r
 .BR T_MARGIN\r
-valid values are integers; default is 4. \r
+valid values are integers; default is 4.\r
 .br\r
 The left margin for text.\r
 Should be at least 3, since line-markers will be displayed in the left margin.\r
 .TP\r
 .BR T_WIDTH\r
-valid values are integers; default is 0. \r
+valid values are integers; default is 0.\r
 .br\r
 The total width of the window, including\r
 .BR T_MARGIN .\r
@@ -104,22 +104,22 @@ meaning valid values are anything between those that are valid terminal
 color escapes.\r
 .TP\r
 .BR C_SIGIL\r
-default: 35 (fg: magenta) \r
+default: 35 (fg: magenta)\r
 .br\r
 The color of the line type as defined by text/gemini.\r
 .TP\r
 .BR C_LINK_NUMBER\r
-default: 1 (bold) \r
+default: 1 (bold)\r
 .br\r
 The color of the link number added by typeset_gemini.\r
 .TP\r
 .BR C_LINK_TITLE\r
-default: 4 (underline) \r
+default: 4 (underline)\r
 .br\r
 The color of the link's title, or if titleless, the URL.\r
 .TP\r
 .BR C_LINK_URL\r
-default: 36 (fg: cyan) \r
+default: 36 (fg: cyan)\r
 .br\r
 The color of the link's URL.\r
 If the link doesn't have a title, this isn't used.\r
@@ -134,12 +134,12 @@ for level 3 is
 .IR 3 .\r
 .TP\r
 .BR C_LIST\r
-default: 0 (no formatting) \r
+default: 0 (no formatting)\r
 .br\r
 The color of list items.\r
 .TP\r
 .BR C_PRE\r
-default: 0 (no formatting) \r
+default: 0 (no formatting)\r
 .br\r
 The color of preformatted lines, as delimited by '```'.\r
 .SS Variables that could be configured, but probably shouldn't be\r
@@ -152,26 +152,32 @@ work differently, like browsing gopher instead of gemini,
 but that capability has not been tested.\r
 .TP\r
 .BR BOLLUX_PORT\r
-valid values are port numbers (1-65535); default is '1965'. \r
+valid values are port numbers (1-65535); default is '1965'.\r
 .br\r
 The port\r
 .BR bollux (1)\r
 tries to connect to on the server.\r
 .TP\r
 .BR BOLLUX_PROTO\r
-valid values are protocol names (strings); default is 'gemini'. \r
+valid values are protocol names (strings); default is 'gemini'.\r
 .br\r
 The protocol to use.\r
 .TP\r
+.BR BOLLUX_TIMEOUT\r
+valid values are as specified in 'help read'; default is '30'.\r
+.br\r
+The request timeout duration.\r
+Specified in seconds.\r
+.TP\r
 .BR BOLLUX_LESSKEY\r
-valid values are files; default is '$BOLLUX_DATADIR/lesskey'. \r
+valid values are files; default is '$BOLLUX_DATADIR/lesskey'.\r
 .br\r
 Where to store the generated\r
 .BR lesskey (1)\r
 file.\r
 .TP\r
 .BR BOLLUX_PAGESRC\r
-valid values are files; default is '$BOLLUX_DATADIR/pagesrc'. \r
+valid values are files; default is '$BOLLUX_DATADIR/pagesrc'.\r
 .br\r
 Where to store the page source of the site being visited.\r
 It's not used right now by\r