bollux.conf(5)

NAME
bollux.conf - configuration file for bollux(1)

DESCRIPTION
bollux(1) uses a number of environment variables that can be sourced from an external file, usually placed in $XDG_CONFIG_HOME/bollux/bollux.conf. The location can be changed at runtime by invoking bollux -c CONFIG.

VARIABLES

  Variables you might actually want to set
Here are actually useful variables that are good things to set in your bollux.conf, in order of usefulness.

BOLLUX_URL valid values are URLs; default is ''.
    If BOLLUX_URL is set, bollux(1) loads that resource; otherwise it asks the user for where to go. Setting this variable works like setting a home page.

BOLLUX_DOWNDIR valid values are directories; default is '.'.
    The directory to attempt to save downloads in. bollux(1) will attempt to download anything whose mimetype isn't text/*, and it tries to place it in BOLLUX_DOWNDIR. If it can't open the directory, save the file, or if there's another file with the same name, bollux(1) will report the name of the temporary file it saved.

BOLLUX_MAXREDIR valid values are integers; default is '5'.
    The maximum number of redirects before bollux(1) decides to quit. The default is 5 as per some RFC spec.

BOLLUX_LOGLEVEL valid values are '', DEBUG or QUIET; default is ''.
    How verbose bollux(1) should be. DEBUG prints debug-level messages. QUIET suppresses even error-level messages. I'm going to be honest, the difference between the levels is somewhat arbitrary. So.

  Typesetting
bollux(1) typesets text/gemini content using the typeset_gemini function. While it's probably possible to redefine the function in bollux.conf(5), the default function is pretty nice (at least in my opinion). The following variables control how text/gemini content is rendered:

T_MARGIN valid values are integers; default is 4.
    The left margin for text. Should be at least 3, since line-markers will be displayed in the left margin.

T_WIDTH valid values are integers; default is 0.
    The total width of the window, including T_MARGIN. If set to 0, attempts to use the width of the terminal, falling back to 80.

  Colors
The different line-types in text/gemini documents are rendered with m-class terminal escapes (e.g., '\e[31m'). The following variables should hold the values between \e[ and m, meaning valid values are anything between those that are valid terminal color escapes.

C_SIGIL default: 35 (fg: magenta)
    The color of the line type as defined by text/gemini.

C_LINK_NUMBER default: 1 (bold)
    The color of the link number added by typeset_gemini.

C_LINK_TITLE default: 4 (underline)
    The color of the link's title, or if titleless, the URL.

C_LINK_URL default: 36 (fg: cyan)
    The color of the link's URL. If the link doesn't have a title, this isn't used.

C_HEADERx where x is 1, 2, or 3
    The color of text/gemini headers. The default for level 1 is 1;4, for level 2 is 1, for level 3 is 3.

C_LIST default: 0 (no formatting)
    The color of list items.

C_PRE default: 0 (no formatting)
    The color of preformatted lines, as delimited by '```'.

  Variables that could be configured, but probably shouldn't be
These variables control deeper aspects of bollux(1)'s workings. It's possible they could be tweaked to make bollux(1) work differently, like browsing gopher instead of gemini, but that capability has not been tested.

BOLLUX_PORT valid values are port numbers (1-65535); default is '1965'.
    The port bollux(1) tries to connect to on the server.

BOLLUX_PROTO valid values are protocol names (strings); default is 'gemini'.
    The protocol to use.

BOLLUX_LESSKEY valid values are files; default is '/tmp/bollux-lesskey'.
    Where to store the generated lesskey(1) file.

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 bollux(1), but you could ... cat(1) it?

FILES
$XDG_CONFIG_HOME/bollux/bollux.conf

SEE ALSO
bollux(1)