From 41e2c8da3d3253913fb58a61820b9341b16a8550 Mon Sep 17 00:00:00 2001
From: Case Duckworth
Date: Sun, 7 Jun 2020 14:02:57 -0500
Subject: Update documentation

---
 bollux        |  6 ++----
 bollux.1      | 32 ++++++++++++++++++++++----------
 bollux.conf.5 | 42 ++++++++++++++++++++++++------------------
 3 files changed, 48 insertions(+), 32 deletions(-)

diff --git a/bollux b/bollux
index 1aaa70f..9b8d5fa 100755
--- 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
--- a/bollux.1
+++ b/bollux.1
@@ -1,6 +1,7 @@
-.TH bollux 1 0.3.0
+.TH bollux 1 0.4.0
 .SH NAME
-bollux \- gemini protocol browser written in bash(1)
+bollux \- gemini protocol browser written in 
+.BR bash (1)
 .SH SYNOPSIS
 .B bollux
 .RI [ \-h ]
@@ -26,11 +27,11 @@ Be quiet: don't show any messages, even fatal ones
 .TP
 .B \-v
 Be verbose: show all messages, even debug ones
-.TP
-.B \-c CONFIG
-Use CONFIG file to configure
-.BR bollux (1)
-instead of the default: $XDG_CONFIG_HOME/bollux/bollux.conf.
+.\".TP
+.\".B \-c CONFIG
+.\"Use CONFIG file to configure
+.\".BR bollux (1)
+.\"instead of the default: $XDG_CONFIG_HOME/bollux/bollux.conf.
 .TP
 .B URL
 The gemini URL to navigate to
@@ -67,10 +68,21 @@ quit bollux
 If a new URL is selected,
 .BR bollux (1)
 will repeat the download-and-display loop with the new URL.
-.SH ISSUES
-There is currently no history storage or recall.
+.PP
+If the mimetype is other than text/*,
 .BR bollux (1)
-can get confused on some URLs \-\- munging them correctly is an area of active research.
+will attempt to download the file to
+.B $BOLLUX_DOWNDIR
+(which defaults to '.').
+.PP
+.BR bollux (1)
+also supports the gopher protocol,
+which is browsed the same way as the gemini protocol
+(except the URL starts with 'gopher://').
+Gopher support is as of now rudimentary.
+.SH ISSUES
+Certificate handling needs to be much improved: TOFU needs to be implemented
+and bollux should be able to generate client certificates.
 .SH SEE ALSO
 .BR bollux.conf (5)
 .SH BUGS
diff --git a/bollux.conf.5 b/bollux.conf.5
index 9cee1b5..9f431db 100644
--- a/bollux.conf.5
+++ b/bollux.conf.5
@@ -1,4 +1,4 @@
-.TH bollux.conf 5 0.3.0
+.TH bollux.conf 5 0.4.0
 .SH NAME
 .B bollux.conf
 \- configuration file for
@@ -17,7 +17,7 @@ Here are actually useful variables that are good things to set in your
 in order of usefulness.
 .TP
 .BR BOLLUX_URL
-valid values are URLs; default is ''. 
+valid values are URLs; default is ''.
 .br
 If
 .B BOLLUX_URL
@@ -28,7 +28,7 @@ otherwise it asks the user for where to go.
 Setting this variable works like setting a home page.
 .TP
 .BR BOLLUX_DOWNDIR
-valid values are directories; default is '.'. 
+valid values are directories; default is '.'.
 .br
 The directory to attempt to save downloads in.
 .BR bollux (1)
@@ -42,14 +42,14 @@ 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_DIR/bollux'.
 .br
 The directory
 .BR bollux (1)
 will put its data files, such as history, cert fingerprints, etc.
 .TP
 .BR BOLLUX_MAXREDIR
-valid values are integers; default is '5'. 
+valid values are integers; default is '5'.
 .br
 The maximum number of redirects before
 .BR bollux (1)
@@ -57,7 +57,7 @@ decides to quit.
 The default is 5 as per some RFC spec.
 .TP
 .BR BOLLUX_LOGLEVEL
-valid values are '', DEBUG or QUIET; default is ''. 
+valid values are '', DEBUG or QUIET; default is ''.
 .br
 How verbose
 .BR bollux (1)
@@ -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:
 .TP
 .BR T_MARGIN
-valid values are integers; default is 4. 
+valid values are integers; default is 4.
 .br
 The left margin for text.
 Should be at least 3, since line-markers will be displayed in the left margin.
 .TP
 .BR T_WIDTH
-valid values are integers; default is 0. 
+valid values are integers; default is 0.
 .br
 The total width of the window, including
 .BR T_MARGIN .
@@ -104,22 +104,22 @@ meaning valid values are anything between those that are valid terminal
 color escapes.
 .TP
 .BR C_SIGIL
-default: 35 (fg: magenta) 
+default: 35 (fg: magenta)
 .br
 The color of the line type as defined by text/gemini.
 .TP
 .BR C_LINK_NUMBER
-default: 1 (bold) 
+default: 1 (bold)
 .br
 The color of the link number added by typeset_gemini.
 .TP
 .BR C_LINK_TITLE
-default: 4 (underline) 
+default: 4 (underline)
 .br
 The color of the link's title, or if titleless, the URL.
 .TP
 .BR C_LINK_URL
-default: 36 (fg: cyan) 
+default: 36 (fg: cyan)
 .br
 The color of the link's URL.
 If the link doesn't have a title, this isn't used.
@@ -134,12 +134,12 @@ for level 3 is
 .IR 3 .
 .TP
 .BR C_LIST
-default: 0 (no formatting) 
+default: 0 (no formatting)
 .br
 The color of list items.
 .TP
 .BR C_PRE
-default: 0 (no formatting) 
+default: 0 (no formatting)
 .br
 The color of preformatted lines, as delimited by '```'.
 .SS Variables that could be configured, but probably shouldn't be
@@ -152,26 +152,32 @@ work differently, like browsing gopher instead of gemini,
 but that capability has not been tested.
 .TP
 .BR BOLLUX_PORT
-valid values are port numbers (1-65535); default is '1965'. 
+valid values are port numbers (1-65535); default is '1965'.
 .br
 The port
 .BR bollux (1)
 tries to connect to on the server.
 .TP
 .BR BOLLUX_PROTO
-valid values are protocol names (strings); default is 'gemini'. 
+valid values are protocol names (strings); default is 'gemini'.
 .br
 The protocol to use.
 .TP
+.BR BOLLUX_TIMEOUT
+valid values are as specified in 'help read'; default is '30'.
+.br
+The request timeout duration.
+Specified in seconds.
+.TP
 .BR BOLLUX_LESSKEY
-valid values are files; default is '$BOLLUX_DATADIR/lesskey'. 
+valid values are files; default is '$BOLLUX_DATADIR/lesskey'.
 .br
 Where to store the generated
 .BR lesskey (1)
 file.
 .TP
 .BR BOLLUX_PAGESRC
-valid values are files; default is '$BOLLUX_DATADIR/pagesrc'. 
+valid values are files; default is '$BOLLUX_DATADIR/pagesrc'.
 .br
 Where to store the page source of the site being visited.
 It's not used right now by
-- 
cgit 1.4.1-21-gabe81