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