bollux.conf.5

   1 .TH bollux.conf 5 0.2.2\r
   2 .SH NAME\r
   3 .B bollux.conf\r
   4 \- configuration file for\r
   5 .BR bollux (1)\r
   6 .SH DESCRIPTION\r
   7 .BR bollux (1)\r
   8 uses a number of environment variables that can be sourced from an external file,\r
   9 usually placed in\r
  10 .IR $XDG_CONFIG_HOME/bollux/bollux.conf .\r
  11 The location can be changed at runtime by invoking\r
  12 .BR "bollux \-c CONFIG" .\r
  13 .SH VARIABLES\r
  14 .SS Variables you might actually want to set\r
  15 Here are actually useful variables that are good things to set in your\r
  16 .IR bollux.conf ,\r
  17 in order of usefulness.\r
  18 .TP\r
  19 .BR BOLLUX_URL\r
  20 valid values are URLs; default is ''. \r
  21 .br\r
  22 If\r
  23 .B BOLLUX_URL\r
  24 is set,\r
  25 .BR bollux (1)\r
  26 loads that resource;\r
  27 otherwise it asks the user for where to go.\r
  28 Setting this variable works like setting a home page.\r
  29 .TP\r
  30 .BR BOLLUX_DOWNDIR\r
  31 valid values are directories; default is '.'. \r
  32 .br\r
  33 The directory to attempt to save downloads in.\r
  34 .BR bollux (1)\r
  35 will attempt to download anything whose mimetype isn't\r
  36 .IR text/* ,\r
  37 and it tries to place it in\r
  38 .BR BOLLUX_DOWNDIR .\r
  39 If it can't open the directory, save the file,\r
  40 or if there's another file with the same name,\r
  41 .BR bollux (1)\r
  42 will report the name of the temporary file it saved.\r
  43 .TP\r
  44 .BR BOLLUX_DATADIR\r
  45 valid values are directories; default is '$XDG_DATA_DIR/bollux'. \r
  46 .br\r
  47 The directory\r
  48 .BR bollux (1)\r
  49 will put its data files, such as history, cert fingerprints, etc.\r
  50 .TP\r
  51 .BR BOLLUX_MAXREDIR\r
  52 valid values are integers; default is '5'. \r
  53 .br\r
  54 The maximum number of redirects before\r
  55 .BR bollux (1)\r
  56 decides to quit.\r
  57 The default is 5 as per some RFC spec.\r
  58 .TP\r
  59 .BR BOLLUX_LOGLEVEL\r
  60 valid values are '', DEBUG or QUIET; default is ''. \r
  61 .br\r
  62 How verbose\r
  63 .BR bollux (1)\r
  64 should be.\r
  65 .I DEBUG\r
  66 prints debug-level messages.\r
  67 .I QUIET\r
  68 suppresses even error-level messages.\r
  69 I'm going to be honest,\r
  70 the difference between the levels is somewhat arbitrary.\r
  71 So.\r
  72 .SS Typesetting\r
  73 .BR bollux (1)\r
  74 typesets text/gemini content using the\r
  75 .I typeset_gemini\r
  76 function.\r
  77 While it's probably possible to redefine the function in\r
  78 .BR bollux.conf (5),\r
  79 the default function is pretty nice (at least in my opinion).\r
  80 The following variables control how text/gemini content is rendered:\r
  81 .TP\r
  82 .BR T_MARGIN\r
  83 valid values are integers; default is 4. \r
  84 .br\r
  85 The left margin for text.\r
  86 Should be at least 3, since line-markers will be displayed in the left margin.\r
  87 .TP\r
  88 .BR T_WIDTH\r
  89 valid values are integers; default is 0. \r
  90 .br\r
  91 The total width of the window, including\r
  92 .BR T_MARGIN .\r
  93 If set to 0, attempts to use the width of the terminal,\r
  94 falling back to 80.\r
  95 .SS Colors\r
  96 The different line-types in text/gemini documents are rendered with\r
  97 .I m-class\r
  98 terminal escapes (e.g., '\\e[31m').\r
  99 The following variables should hold the values between\r
 100 .I \\e[\r
 101 and\r
 102 .IR m ,\r
 103 meaning valid values are anything between those that are valid terminal\r
 104 color escapes.\r
 105 .TP\r
 106 .BR C_SIGIL\r
 107 default: 35 (fg: magenta) \r
 108 .br\r
 109 The color of the line type as defined by text/gemini.\r
 110 .TP\r
 111 .BR C_LINK_NUMBER\r
 112 default: 1 (bold) \r
 113 .br\r
 114 The color of the link number added by typeset_gemini.\r
 115 .TP\r
 116 .BR C_LINK_TITLE\r
 117 default: 4 (underline) \r
 118 .br\r
 119 The color of the link's title, or if titleless, the URL.\r
 120 .TP\r
 121 .BR C_LINK_URL\r
 122 default: 36 (fg: cyan) \r
 123 .br\r
 124 The color of the link's URL.\r
 125 If the link doesn't have a title, this isn't used.\r
 126 .TP\r
 127 .BI C_HEADER "x where x is 1, 2, or 3"\r
 128 The color of text/gemini headers.\r
 129 The default for level 1 is\r
 130 .IR 1;4 ,\r
 131 for level 2 is\r
 132 .IR 1 ,\r
 133 for level 3 is\r
 134 .IR 3 .\r
 135 .TP\r
 136 .BR C_LIST\r
 137 default: 0 (no formatting) \r
 138 .br\r
 139 The color of list items.\r
 140 .TP\r
 141 .BR C_PRE\r
 142 default: 0 (no formatting) \r
 143 .br\r
 144 The color of preformatted lines, as delimited by '```'.\r
 145 .SS Variables that could be configured, but probably shouldn't be\r
 146 These variables control deeper aspects of\r
 147 .BR bollux (1)'s\r
 148 workings.\r
 149 It's possible they could be tweaked to make\r
 150 .BR bollux (1)\r
 151 work differently, like browsing gopher instead of gemini,\r
 152 but that capability has not been tested.\r
 153 .TP\r
 154 .BR BOLLUX_PORT\r
 155 valid values are port numbers (1-65535); default is '1965'. \r
 156 .br\r
 157 The port\r
 158 .BR bollux (1)\r
 159 tries to connect to on the server.\r
 160 .TP\r
 161 .BR BOLLUX_PROTO\r
 162 valid values are protocol names (strings); default is 'gemini'. \r
 163 .br\r
 164 The protocol to use.\r
 165 .TP\r
 166 .BR BOLLUX_LESSKEY\r
 167 valid values are files; default is '$BOLLUX_DATADIR/lesskey'. \r
 168 .br\r
 169 Where to store the generated\r
 170 .BR lesskey (1)\r
 171 file.\r
 172 .TP\r
 173 .BR BOLLUX_PAGESRC\r
 174 valid values are files; default is '$BOLLUX_DATADIR/pagesrc'. \r
 175 .br\r
 176 Where to store the page source of the site being visited.\r
 177 It's not used right now by\r
 178 .BR bollux (1),\r
 179 but you could ...\r
 180 .BR cat (1)\r
 181 it?\r
 182 .SH FILES\r
 183 .I $XDG_CONFIG_HOME/bollux/bollux.conf\r
 184 .SH SEE ALSO\r
 185 .BR bollux (1)\r