about summary refs log tree commit diff stats
path: root/bollux.conf.5
diff options
context:
space:
mode:
Diffstat (limited to 'bollux.conf.5')
-rw-r--r--bollux.conf.571
1 files changed, 55 insertions, 16 deletions
diff --git a/bollux.conf.5 b/bollux.conf.5 index c2d626a..eecaff0 100644 --- a/bollux.conf.5 +++ b/bollux.conf.5
@@ -16,7 +16,9 @@ Here are actually useful variables that are good things to set in your
16.IR bollux.conf , 16.IR bollux.conf ,
17in order of usefulness. 17in order of usefulness.
18.TP 18.TP
19.BR BOLLUX_URL " valid values are URLs; default is ''." 19.BR BOLLUX_URL
20valid values are URLs; default is ''.
21.br
20If 22If
21.B BOLLUX_URL 23.B BOLLUX_URL
22is set, 24is set,
@@ -25,7 +27,9 @@ loads that resource;
25otherwise it asks the user for where to go. 27otherwise it asks the user for where to go.
26Setting this variable works like setting a home page. 28Setting this variable works like setting a home page.
27.TP 29.TP
28.BR BOLLUX_DOWNDIR " valid values are directories; default is '.'." 30.BR BOLLUX_DOWNDIR
31valid values are directories; default is '.'.
32.br
29The directory to attempt to save downloads in. 33The directory to attempt to save downloads in.
30.BR bollux (1) 34.BR bollux (1)
31will attempt to download anything whose mimetype isn't 35will attempt to download anything whose mimetype isn't
@@ -37,13 +41,24 @@ or if there's another file with the same name,
37.BR bollux (1) 41.BR bollux (1)
38will report the name of the temporary file it saved. 42will report the name of the temporary file it saved.
39.TP 43.TP
40.BR BOLLUX_MAXREDIR " valid values are integers; default is '5'." 44.BR BOLLUX_DATADIR
45valid values are directories; default is '$XDG_DATA_DIR/bollux'.
46.br
47The directory
48.BR bollux (1)
49will put its data files, such as history, cert fingerprints, etc.
50.TP
51.BR BOLLUX_MAXREDIR
52valid values are integers; default is '5'.
53.br
41The maximum number of redirects before 54The maximum number of redirects before
42.BR bollux (1) 55.BR bollux (1)
43decides to quit. 56decides to quit.
44The default is 5 as per some RFC spec. 57The default is 5 as per some RFC spec.
45.TP 58.TP
46.BR BOLLUX_LOGLEVEL " valid values are '', DEBUG or QUIET; default is ''." 59.BR BOLLUX_LOGLEVEL
60valid values are '', DEBUG or QUIET; default is ''.
61.br
47How verbose 62How verbose
48.BR bollux (1) 63.BR bollux (1)
49should be. 64should be.
@@ -64,11 +79,15 @@ While it's probably possible to redefine the function in
64the default function is pretty nice (at least in my opinion). 79the default function is pretty nice (at least in my opinion).
65The following variables control how text/gemini content is rendered: 80The following variables control how text/gemini content is rendered:
66.TP 81.TP
67.BR T_MARGIN " valid values are integers; default is 4." 82.BR T_MARGIN
83valid values are integers; default is 4.
84.br
68The left margin for text. 85The left margin for text.
69Should be at least 3, since line-markers will be displayed in the left margin. 86Should be at least 3, since line-markers will be displayed in the left margin.
70.TP 87.TP
71.BR T_WIDTH " valid values are integers; default is 0." 88.BR T_WIDTH
89valid values are integers; default is 0.
90.br
72The total width of the window, including 91The total width of the window, including
73.BR T_MARGIN . 92.BR T_MARGIN .
74If set to 0, attempts to use the width of the terminal, 93If set to 0, attempts to use the width of the terminal,
@@ -84,16 +103,24 @@ and
84meaning valid values are anything between those that are valid terminal 103meaning valid values are anything between those that are valid terminal
85color escapes. 104color escapes.
86.TP 105.TP
87.BR C_SIGIL " default: 35 (fg: magenta)" 106.BR C_SIGIL
107default: 35 (fg: magenta)
108.br
88The color of the line type as defined by text/gemini. 109The color of the line type as defined by text/gemini.
89.TP 110.TP
90.BR C_LINK_NUMBER " default: 1 (bold)" 111.BR C_LINK_NUMBER
112default: 1 (bold)
113.br
91The color of the link number added by typeset_gemini. 114The color of the link number added by typeset_gemini.
92.TP 115.TP
93.BR C_LINK_TITLE " default: 4 (underline)" 116.BR C_LINK_TITLE
117default: 4 (underline)
118.br
94The color of the link's title, or if titleless, the URL. 119The color of the link's title, or if titleless, the URL.
95.TP 120.TP
96.BR C_LINK_URL " default: 36 (fg: cyan)" 121.BR C_LINK_URL
122default: 36 (fg: cyan)
123.br
97The color of the link's URL. 124The color of the link's URL.
98If the link doesn't have a title, this isn't used. 125If the link doesn't have a title, this isn't used.
99.TP 126.TP
@@ -106,10 +133,14 @@ for level 2 is
106for level 3 is 133for level 3 is
107.IR 3 . 134.IR 3 .
108.TP 135.TP
109.BR C_LIST " default: 0 (no formatting)" 136.BR C_LIST
137default: 0 (no formatting)
138.br
110The color of list items. 139The color of list items.
111.TP 140.TP
112.BR C_PRE " default: 0 (no formatting)" 141.BR C_PRE
142default: 0 (no formatting)
143.br
113The color of preformatted lines, as delimited by '```'. 144The color of preformatted lines, as delimited by '```'.
114.SS Variables that could be configured, but probably shouldn't be 145.SS Variables that could be configured, but probably shouldn't be
115These variables control deeper aspects of 146These variables control deeper aspects of
@@ -120,20 +151,28 @@ It's possible they could be tweaked to make
120work differently, like browsing gopher instead of gemini, 151work differently, like browsing gopher instead of gemini,
121but that capability has not been tested. 152but that capability has not been tested.
122.TP 153.TP
123.BR BOLLUX_PORT " valid values are port numbers (1-65535); default is '1965'." 154.BR BOLLUX_PORT
155valid values are port numbers (1-65535); default is '1965'.
156.br
124The port 157The port
125.BR bollux (1) 158.BR bollux (1)
126tries to connect to on the server. 159tries to connect to on the server.
127.TP 160.TP
128.BR BOLLUX_PROTO " valid values are protocol names (strings); default is 'gemini'." 161.BR BOLLUX_PROTO
162valid values are protocol names (strings); default is 'gemini'.
163.br
129The protocol to use. 164The protocol to use.
130.TP 165.TP
131.BR BOLLUX_LESSKEY " valid values are files; default is '/tmp/bollux-lesskey'." 166.BR BOLLUX_LESSKEY
167valid values are files; default is '$BOLLUX_DATADIR/lesskey'.
168.br
132Where to store the generated 169Where to store the generated
133.BR lesskey (1) 170.BR lesskey (1)
134file. 171file.
135.TP 172.TP
136.BR BOLLUX_PAGESRC " valid values are files; default is '/tmp/bollux-src'." 173.BR BOLLUX_PAGESRC
174valid values are files; default is '$BOLLUX_DATADIR/pagesrc'.
175.br
137Where to store the page source of the site being visited. 176Where to store the page source of the site being visited.
138It's not used right now by 177It's not used right now by
139.BR bollux (1), 178.BR bollux (1),