90 lines
2.6 KiB
Groff
90 lines
2.6 KiB
Groff
.TH bollux.conf 5 2020-05-26
|
|
.SH NAME
|
|
.B bollux.conf
|
|
\- configuration file for
|
|
.BR bollux (1)
|
|
.SH DESCRIPTION
|
|
.BR bollux (1)
|
|
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" .
|
|
.SH VARIABLES
|
|
.SS Variables you might actually want to set
|
|
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 ''."
|
|
If
|
|
.B BOLLUX_URL
|
|
is set,
|
|
.BR bollux (1)
|
|
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 '.'."
|
|
The directory to attempt to save downloads in.
|
|
.BR bollux (1)
|
|
will attempt to download anything whose mimetype isn't
|
|
.IR text/* ,
|
|
and it tries to place it in
|
|
.BR BOLLUX_DOWNDIR .
|
|
If it can't open the directory, save the file,
|
|
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'."
|
|
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 ''."
|
|
How verbose
|
|
.BR bollux (1)
|
|
should be.
|
|
.I DEBUG
|
|
prints debug-level messages.
|
|
.I QUIET
|
|
suppresses even error-level messages.
|
|
I'm going to be honest,
|
|
the difference between the levels is somewhat arbitrary.
|
|
So.
|
|
.SS Variables that could be configured, but probably shouldn't be
|
|
These variables control deeper aspects of
|
|
.BR bollux (1)'s
|
|
workings.
|
|
It's possible they could be tweaked to make
|
|
.BR bollux (1)
|
|
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'."
|
|
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'."
|
|
The protocol to use.
|
|
.TP
|
|
.BR BOLLUX_LESSKEY " valid values are files; default is '/tmp/bollux-lesskey'."
|
|
Where to store the generated
|
|
.BR lesskey (1)
|
|
file.
|
|
.TP
|
|
.BR BOLLUX_PAGESRC " valid values are files; default is '/tmp/bollux-src'."
|
|
Where to store the page source of the site being visited.
|
|
It's not used right now by
|
|
.BR bollux (1),
|
|
but you could ...
|
|
.BR cat (1)
|
|
it?
|
|
.SH FILES
|
|
.I $XDG_CONFIG_HOME/bollux/bollux.conf
|
|
.SH SEE ALSO
|
|
.BR bollux (1)
|