-.TH bollux 1 0.4.0\r
-.SH NAME\r
-bollux \- gemini protocol browser written in\r
-.BR bash (1)\r
-.SH SYNOPSIS\r
-.B bollux\r
-.RI [ \-h ]\r
-.TP\r
-.B bollux\r
-.RI [ \-q ]\r
-.RI [ \-v ]\r
-.\".RI [ \-c\r
-.\".BR CONFIG ]\r
-.RB [ URL ]\r
-.SH DESCRIPTION\r
-.BR bollux (1)\r
-is a browser for the new Gemini protocol, which aims to be\r
-"heavier than gopher, but lighter than the web."\r
-It can follow links, collect user input, download files, and display text/* mimetype pages in geminispace.\r
-.SH OPTIONS\r
-.TP\r
-.B \-h\r
-Display an inline help screen and exit\r
-.TP\r
-.B \-q\r
-Be quiet: don't show any messages, even fatal ones\r
-.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 URL\r
-The gemini URL to navigate to\r
-.SH USAGE\r
-If\r
-.BR bollux (1)\r
-is invoked with a URL, it will download or display that URL.\r
-Otherwise, the user will be prompted for a URL to download or display.\r
-If the URL points to a text/* document, it is paged with\r
-.BR less (1)\r
-with custom keybinds:\r
-.TP\r
-.B o\r
-open a link on the current page\r
-.TP\r
-.B g\r
-goto a new URL\r
-.TP\r
-.B G\r
-goto a new URL - with current URL pre-filled\r
-.TP\r
-.B r\r
-refresh the current page\r
-.TP\r
-.B [\r
-goto the previous page in history\r
-.TP\r
-.B ]\r
-goto the next page in history\r
-.TP\r
-.B q\r
-quit bollux\r
-.TP\r
-.B \=\r
-show a short help message\r
-.PP\r
-If a new URL is selected,\r
-.BR bollux (1)\r
-will repeat the download-and-display loop with the new URL.\r
-.PP\r
-If the mimetype is other than text/*,\r
-.BR bollux (1)\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
-The development repo is located at https://sr.ht/~acdw/bollux.\r
-Please direct all bug reports, patches, or general complaints there.\r
+.TH bollux 1 0.4.0
+.SH NAME
+bollux \- gemini protocol browser written in
+.BR bash (1)
+.SH SYNOPSIS
+.B bollux
+.RI [ \-h ]
+.TP
+.B bollux
+.RI [ \-q ]
+.RI [ \-v ]
+.\".RI [ \-c
+.\".BR CONFIG ]
+.RB [ URL ]
+.SH DESCRIPTION
+.BR bollux (1)
+is a browser for the new Gemini protocol, which aims to be
+"heavier than gopher, but lighter than the web."
+It can follow links, collect user input, download files, and display text/* mimetype pages in geminispace.
+.SH OPTIONS
+.TP
+.B \-h
+Display an inline help screen and exit
+.TP
+.B \-q
+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 URL
+The gemini URL to navigate to
+.SH USAGE
+If
+.BR bollux (1)
+is invoked with a URL, it will download or display that URL.
+Otherwise, the user will be prompted for a URL to download or display.
+If the URL points to a text/* document, it is paged with
+.BR less (1)
+with custom keybinds:
+.TP
+.B o
+open a link on the current page
+.TP
+.B g
+goto a new URL
+.TP
+.B G
+goto a new URL - with current URL pre-filled
+.TP
+.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
+.TP
+.B \=
+show a short help message
+.PP
+If a new URL is selected,
+.BR bollux (1)
+will repeat the download-and-display loop with the new URL.
+.PP
+If the mimetype is other than text/*,
+.BR bollux (1)
+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
+The development repo is located at https://sr.ht/~acdw/bollux.
+Please direct all bug reports, patches, or general complaints there.
-.TH bollux.conf 5 0.4.0\r
-.SH NAME\r
-.B bollux.conf\r
-\- configuration file for\r
-.BR bollux (1)\r
-.SH DESCRIPTION\r
-.BR bollux (1)\r
-uses a number of environment variables that can be sourced from an external file,\r
-usually placed in\r
-.IR $XDG_CONFIG_HOME/bollux/bollux.conf .\r
-The location can be changed at runtime by invoking\r
-.BR "bollux \-c CONFIG" .\r
-.SH VARIABLES\r
-.SS Variables you might actually want to set\r
-Here are actually useful variables that are good things to set in your\r
-.IR bollux.conf ,\r
-in order of usefulness.\r
-.TP\r
-.BR BOLLUX_URL\r
-valid values are URLs; default is ''.\r
-.br\r
-If\r
-.B BOLLUX_URL\r
-is set,\r
-.BR bollux (1)\r
-loads that resource;\r
-otherwise it asks the user for where to go.\r
-Setting this variable works like setting a home page.\r
-.TP\r
-.BR BOLLUX_DOWNDIR\r
-valid values are directories; default is '.'.\r
-.br\r
-The directory to attempt to save downloads in.\r
-.BR bollux (1)\r
-will attempt to download anything whose mimetype isn't\r
-.IR text/* ,\r
-and it tries to place it in\r
-.BR BOLLUX_DOWNDIR .\r
-If it can't open the directory, save the file,\r
-or if there's another file with the same name,\r
-.BR bollux (1)\r
-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
-.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
-.br\r
-The maximum number of redirects before\r
-.BR bollux (1)\r
-decides to quit.\r
-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
-.br\r
-How verbose\r
-.BR bollux (1)\r
-should be.\r
-.I DEBUG\r
-prints debug-level messages.\r
-.I QUIET\r
-suppresses even error-level messages.\r
-I'm going to be honest,\r
-the difference between the levels is somewhat arbitrary.\r
-So.\r
-.SS Typesetting\r
-.BR bollux (1)\r
-typesets text/gemini content using the\r
-.I typeset_gemini\r
-function.\r
-While it's probably possible to redefine the function in\r
-.BR bollux.conf (5),\r
-the default function is pretty nice (at least in my opinion).\r
-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
-.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
-.br\r
-The total width of the window, including\r
-.BR T_MARGIN .\r
-If set to 0, attempts to use the width of the terminal,\r
-falling back to 80.\r
-.SS Colors\r
-The different line-types in text/gemini documents are rendered with\r
-.I m-class\r
-terminal escapes (e.g., '\\e[31m').\r
-The following variables should hold the values between\r
-.I \\e[\r
-and\r
-.IR m ,\r
-meaning valid values are anything between those that are valid terminal\r
-color escapes.\r
-.TP\r
-.BR C_SIGIL\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
-.br\r
-The color of the link number added by typeset_gemini.\r
-.TP\r
-.BR C_LINK_TITLE\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
-.br\r
-The color of the link's URL.\r
-If the link doesn't have a title, this isn't used.\r
-.TP\r
-.BI C_HEADER "x where x is 1, 2, or 3"\r
-The color of text/gemini headers.\r
-The default for level 1 is\r
-.IR 1;4 ,\r
-for level 2 is\r
-.IR 1 ,\r
-for level 3 is\r
-.IR 3 .\r
-.TP\r
-.BR C_LIST\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
-.br\r
-The color of preformatted lines, as delimited by '```'.\r
-.SS Variables that could be configured, but probably shouldn't be\r
-These variables control deeper aspects of\r
-.BR bollux (1)'s\r
-workings.\r
-It's possible they could be tweaked to make\r
-.BR bollux (1)\r
-work differently, like browsing gopher instead of gemini,\r
-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
-.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
-.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
-.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
-.br\r
-Where to store the page source of the site being visited.\r
-It's not used right now by\r
-.BR bollux (1),\r
-but you could ...\r
-.BR cat (1)\r
-it?\r
-.SH FILES\r
-.I $XDG_CONFIG_HOME/bollux/bollux.conf\r
-.SH SEE ALSO\r
-.BR bollux (1)\r
+.TH bollux.conf 5 0.4.0
+.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 ''.
+.br
+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 '.'.
+.br
+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_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
+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 Typesetting
+.BR bollux (1)
+typesets text/gemini content using the
+.I typeset_gemini
+function.
+While it's probably possible to redefine the function in
+.BR bollux.conf (5),
+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
+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
+The total width of the window, including
+.BR T_MARGIN .
+If set to 0, attempts to use the width of the terminal,
+falling back to 80.
+.SS Colors
+The different line-types in text/gemini documents are rendered with
+.I m-class
+terminal escapes (e.g., '\\e[31m').
+The following variables should hold the values between
+.I \\e[
+and
+.IR m ,
+meaning valid values are anything between those that are valid terminal
+color escapes.
+.TP
+.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
+The color of the link number added by typeset_gemini.
+.TP
+.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
+The color of the link's URL.
+If the link doesn't have a title, this isn't used.
+.TP
+.BI C_HEADER "x where x is 1, 2, or 3"
+The color of text/gemini headers.
+The default for level 1 is
+.IR 1;4 ,
+for level 2 is
+.IR 1 ,
+for level 3 is
+.IR 3 .
+.TP
+.BR C_LIST
+default: 0 (no formatting)
+.br
+The color of list items.
+.TP
+.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
+.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'.
+.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
+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'.
+.br
+Where to store the generated
+.BR lesskey (1)
+file.
+.TP
+.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),
+but you could ...
+.BR cat (1)
+it?
+.SH FILES
+.I $XDG_CONFIG_HOME/bollux/bollux.conf
+.SH SEE ALSO
+.BR bollux (1)
https://reisub.nsupdate.info/git / bollux.git / .git / commitdiff