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.542
1 files changed, 24 insertions, 18 deletions
diff --git a/bollux.conf.5 b/bollux.conf.5 index 9cee1b5..9f431db 100644 --- a/bollux.conf.5 +++ b/bollux.conf.5
@@ -1,4 +1,4 @@
1.TH bollux.conf 5 0.3.0 1.TH bollux.conf 5 0.4.0
2.SH NAME 2.SH NAME
3.B bollux.conf 3.B bollux.conf
4\- configuration file for 4\- configuration file for
@@ -17,7 +17,7 @@ Here are actually useful variables that are good things to set in your
17in order of usefulness. 17in order of usefulness.
18.TP 18.TP
19.BR BOLLUX_URL 19.BR BOLLUX_URL
20valid values are URLs; default is ''. 20valid values are URLs; default is ''.
21.br 21.br
22If 22If
23.B BOLLUX_URL 23.B BOLLUX_URL
@@ -28,7 +28,7 @@ otherwise it asks the user for where to go.
28Setting this variable works like setting a home page. 28Setting this variable works like setting a home page.
29.TP 29.TP
30.BR BOLLUX_DOWNDIR 30.BR BOLLUX_DOWNDIR
31valid values are directories; default is '.'. 31valid values are directories; default is '.'.
32.br 32.br
33The directory to attempt to save downloads in. 33The directory to attempt to save downloads in.
34.BR bollux (1) 34.BR bollux (1)
@@ -42,14 +42,14 @@ or if there's another file with the same name,
42will report the name of the temporary file it saved. 42will report the name of the temporary file it saved.
43.TP 43.TP
44.BR BOLLUX_DATADIR 44.BR BOLLUX_DATADIR
45valid values are directories; default is '$XDG_DATA_DIR/bollux'. 45valid values are directories; default is '$XDG_DATA_DIR/bollux'.
46.br 46.br
47The directory 47The directory
48.BR bollux (1) 48.BR bollux (1)
49will put its data files, such as history, cert fingerprints, etc. 49will put its data files, such as history, cert fingerprints, etc.
50.TP 50.TP
51.BR BOLLUX_MAXREDIR 51.BR BOLLUX_MAXREDIR
52valid values are integers; default is '5'. 52valid values are integers; default is '5'.
53.br 53.br
54The maximum number of redirects before 54The maximum number of redirects before
55.BR bollux (1) 55.BR bollux (1)
@@ -57,7 +57,7 @@ decides to quit.
57The default is 5 as per some RFC spec. 57The default is 5 as per some RFC spec.
58.TP 58.TP
59.BR BOLLUX_LOGLEVEL 59.BR BOLLUX_LOGLEVEL
60valid values are '', DEBUG or QUIET; default is ''. 60valid values are '', DEBUG or QUIET; default is ''.
61.br 61.br
62How verbose 62How verbose
63.BR bollux (1) 63.BR bollux (1)
@@ -80,13 +80,13 @@ the default function is pretty nice (at least in my opinion).
80The following variables control how text/gemini content is rendered: 80The following variables control how text/gemini content is rendered:
81.TP 81.TP
82.BR T_MARGIN 82.BR T_MARGIN
83valid values are integers; default is 4. 83valid values are integers; default is 4.
84.br 84.br
85The left margin for text. 85The left margin for text.
86Should 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.
87.TP 87.TP
88.BR T_WIDTH 88.BR T_WIDTH
89valid values are integers; default is 0. 89valid values are integers; default is 0.
90.br 90.br
91The total width of the window, including 91The total width of the window, including
92.BR T_MARGIN . 92.BR T_MARGIN .
@@ -104,22 +104,22 @@ meaning valid values are anything between those that are valid terminal
104color escapes. 104color escapes.
105.TP 105.TP
106.BR C_SIGIL 106.BR C_SIGIL
107default: 35 (fg: magenta) 107default: 35 (fg: magenta)
108.br 108.br
109The color of the line type as defined by text/gemini. 109The color of the line type as defined by text/gemini.
110.TP 110.TP
111.BR C_LINK_NUMBER 111.BR C_LINK_NUMBER
112default: 1 (bold) 112default: 1 (bold)
113.br 113.br
114The color of the link number added by typeset_gemini. 114The color of the link number added by typeset_gemini.
115.TP 115.TP
116.BR C_LINK_TITLE 116.BR C_LINK_TITLE
117default: 4 (underline) 117default: 4 (underline)
118.br 118.br
119The color of the link's title, or if titleless, the URL. 119The color of the link's title, or if titleless, the URL.
120.TP 120.TP
121.BR C_LINK_URL 121.BR C_LINK_URL
122default: 36 (fg: cyan) 122default: 36 (fg: cyan)
123.br 123.br
124The color of the link's URL. 124The color of the link's URL.
125If the link doesn't have a title, this isn't used. 125If the link doesn't have a title, this isn't used.
@@ -134,12 +134,12 @@ for level 3 is
134.IR 3 . 134.IR 3 .
135.TP 135.TP
136.BR C_LIST 136.BR C_LIST
137default: 0 (no formatting) 137default: 0 (no formatting)
138.br 138.br
139The color of list items. 139The color of list items.
140.TP 140.TP
141.BR C_PRE 141.BR C_PRE
142default: 0 (no formatting) 142default: 0 (no formatting)
143.br 143.br
144The color of preformatted lines, as delimited by '```'. 144The color of preformatted lines, as delimited by '```'.
145.SS Variables that could be configured, but probably shouldn't be 145.SS Variables that could be configured, but probably shouldn't be
@@ -152,26 +152,32 @@ work differently, like browsing gopher instead of gemini,
152but that capability has not been tested. 152but that capability has not been tested.
153.TP 153.TP
154.BR BOLLUX_PORT 154.BR BOLLUX_PORT
155valid values are port numbers (1-65535); default is '1965'. 155valid values are port numbers (1-65535); default is '1965'.
156.br 156.br
157The port 157The port
158.BR bollux (1) 158.BR bollux (1)
159tries to connect to on the server. 159tries to connect to on the server.
160.TP 160.TP
161.BR BOLLUX_PROTO 161.BR BOLLUX_PROTO
162valid values are protocol names (strings); default is 'gemini'. 162valid values are protocol names (strings); default is 'gemini'.
163.br 163.br
164The protocol to use. 164The protocol to use.
165.TP 165.TP
166.BR BOLLUX_TIMEOUT
167valid values are as specified in 'help read'; default is '30'.
168.br
169The request timeout duration.
170Specified in seconds.
171.TP
166.BR BOLLUX_LESSKEY 172.BR BOLLUX_LESSKEY
167valid values are files; default is '$BOLLUX_DATADIR/lesskey'. 173valid values are files; default is '$BOLLUX_DATADIR/lesskey'.
168.br 174.br
169Where to store the generated 175Where to store the generated
170.BR lesskey (1) 176.BR lesskey (1)
171file. 177file.
172.TP 178.TP
173.BR BOLLUX_PAGESRC 179.BR BOLLUX_PAGESRC
174valid values are files; default is '$BOLLUX_DATADIR/pagesrc'. 180valid values are files; default is '$BOLLUX_DATADIR/pagesrc'.
175.br 181.br
176Where to store the page source of the site being visited. 182Where to store the page source of the site being visited.
177It's not used right now by 183It's not used right now by