Change variables and update manpages

This commit is contained in:
Case Duckworth 2020-06-02 22:24:49 -05:00
parent 5363521950
commit ed07227f9a
3 changed files with 67 additions and 22 deletions

12
bollux
View File

@ -105,17 +105,17 @@ bollux_config() {
fi
## behavior
: "${BOLLUX_DATADIR:=${XDG_DATA_DIR:-$HOME/.local/share}/bollux}"
: "${BOLLUX_DOWNDIR:=.}" # where to save downloads
: "${BOLLUX_LOGLEVEL:=3}" # log level
: "${BOLLUX_MAXREDIR:=5}" # max redirects
: "${BOLLUX_PORT:=1965}" # port number
: "${BOLLUX_PROTO:=gemini}" # default protocol
: "${BOLLUX_LESSKEY:=/tmp/bollux-lesskey}" # where to store binds
: "${BOLLUX_PAGESRC:=/tmp/bollux-src}" # where to save the source
: "${BOLLUX_URL:=}" # start url
: "${BOLLUX_BYEMSG:=See You Space Cowboy...}" # bye message
BOLLUX_HISTFILE="$BOLLUX_DATADIR/history" # where to save the history
## files
: "${BOLLUX_DATADIR:=${XDG_DATA_DIR:-$HOME/.local/share}/bollux}"
: "${BOLLUX_DOWNDIR:=.}" # where to save downloads
: "${BOLLUX_LESSKEY:=$BOLLUX_DATADIR/lesskey}" # where to store binds
: "${BOLLUX_PAGESRC:=$BOLLUX_DATADIR/pagesrc}" # where to save the source
BOLLUX_HISTFILE="$BOLLUX_DATADIR/history" # where to save the history
## typesetting
: "${T_MARGIN:=4}" # left and right margin
: "${T_WIDTH:=0}" # width of the viewport -- 0 = get term width

View File

@ -52,6 +52,12 @@ goto a new URL
.B r
refresh the current page
.TP
.B [
goto the previous page in history
.TP
.B ]
goto the next page in history
.TP
.B q
quit bollux
.PP

View File

@ -16,7 +16,9 @@ Here are actually useful variables that are good things to set in your
.IR bollux.conf ,
in order of usefulness.
.TP
.BR BOLLUX_URL " valid values are URLs; default is ''."
.BR BOLLUX_URL
valid values are URLs; default is ''.
.br
If
.B BOLLUX_URL
is set,
@ -25,7 +27,9 @@ loads that resource;
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 '.'."
.BR BOLLUX_DOWNDIR
valid values are directories; default is '.'.
.br
The directory to attempt to save downloads in.
.BR bollux (1)
will attempt to download anything whose mimetype isn't
@ -37,13 +41,24 @@ or if there's another file with the same name,
.BR bollux (1)
will report the name of the temporary file it saved.
.TP
.BR BOLLUX_MAXREDIR " valid values are integers; default is '5'."
.BR BOLLUX_DATADIR
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'.
.br
The maximum number of redirects before
.BR bollux (1)
decides to quit.
The default is 5 as per some RFC spec.
.TP
.BR BOLLUX_LOGLEVEL " valid values are '', DEBUG or QUIET; default is ''."
.BR BOLLUX_LOGLEVEL
valid values are '', DEBUG or QUIET; default is ''.
.br
How verbose
.BR bollux (1)
should be.
@ -64,11 +79,15 @@ While it's probably possible to redefine the function in
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."
.BR T_MARGIN
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."
.BR T_WIDTH
valid values are integers; default is 0.
.br
The total width of the window, including
.BR T_MARGIN .
If set to 0, attempts to use the width of the terminal,
@ -84,16 +103,24 @@ and
meaning valid values are anything between those that are valid terminal
color escapes.
.TP
.BR C_SIGIL " default: 35 (fg: magenta)"
.BR C_SIGIL
default: 35 (fg: magenta)
.br
The color of the line type as defined by text/gemini.
.TP
.BR C_LINK_NUMBER " default: 1 (bold)"
.BR C_LINK_NUMBER
default: 1 (bold)
.br
The color of the link number added by typeset_gemini.
.TP
.BR C_LINK_TITLE " default: 4 (underline)"
.BR C_LINK_TITLE
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)"
.BR C_LINK_URL
default: 36 (fg: cyan)
.br
The color of the link's URL.
If the link doesn't have a title, this isn't used.
.TP
@ -106,10 +133,14 @@ for level 2 is
for level 3 is
.IR 3 .
.TP
.BR C_LIST " default: 0 (no formatting)"
.BR C_LIST
default: 0 (no formatting)
.br
The color of list items.
.TP
.BR C_PRE " default: 0 (no formatting)"
.BR C_PRE
default: 0 (no formatting)
.br
The color of preformatted lines, as delimited by '```'.
.SS Variables that could be configured, but probably shouldn't be
These variables control deeper aspects of
@ -120,20 +151,28 @@ It's possible they could be tweaked to make
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'."
.BR BOLLUX_PORT
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'."
.BR BOLLUX_PROTO
valid values are protocol names (strings); default is 'gemini'.
.br
The protocol to use.
.TP
.BR BOLLUX_LESSKEY " valid values are files; default is '/tmp/bollux-lesskey'."
.BR BOLLUX_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 '/tmp/bollux-src'."
.BR BOLLUX_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
.BR bollux (1),