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 " valid values are URLs; default is ''."\r
  20 If\r
  21 .B BOLLUX_URL\r
  22 is set,\r
  23 .BR bollux (1)\r
  24 loads that resource;\r
  25 otherwise it asks the user for where to go.\r
  26 Setting this variable works like setting a home page.\r
  27 .TP\r
  28 .BR BOLLUX_DOWNDIR " valid values are directories; default is '.'."\r
  29 The directory to attempt to save downloads in.\r
  30 .BR bollux (1)\r
  31 will attempt to download anything whose mimetype isn't\r
  32 .IR text/* ,\r
  33 and it tries to place it in\r
  34 .BR BOLLUX_DOWNDIR .\r
  35 If it can't open the directory, save the file,\r
  36 or if there's another file with the same name,\r
  37 .BR bollux (1)\r
  38 will report the name of the temporary file it saved.\r
  39 .TP\r
  40 .BR BOLLUX_MAXREDIR " valid values are integers; default is '5'."\r
  41 The maximum number of redirects before\r
  42 .BR bollux (1)\r
  43 decides to quit.\r
  44 The default is 5 as per some RFC spec.\r
  45 .TP\r
  46 .BR BOLLUX_LOGLEVEL " valid values are '', DEBUG or QUIET; default is ''."\r
  47 How verbose\r
  48 .BR bollux (1)\r
  49 should be.\r
  50 .I DEBUG\r
  51 prints debug-level messages.\r
  52 .I QUIET\r
  53 suppresses even error-level messages.\r
  54 I'm going to be honest,\r
  55 the difference between the levels is somewhat arbitrary.\r
  56 So.\r
  57 .SS Typesetting\r
  58 .BR bollux (1)\r
  59 typesets text/gemini content using the\r
  60 .I typeset_gemini\r
  61 function.\r
  62 While it's probably possible to redefine the function in\r
  63 .BR bollux.conf (5),\r
  64 the default function is pretty nice (at least in my opinion).\r
  65 The following variables control how text/gemini content is rendered:\r
  66 .TP\r
  67 .BR T_MARGIN " valid values are integers; default is 4."\r
  68 The left margin for text.\r
  69 Should be at least 3, since line-markers will be displayed in the left margin.\r
  70 .TP\r
  71 .BR T_WIDTH " valid values are integers; default is 0."\r
  72 The total width of the window, including\r
  73 .BR T_MARGIN .\r
  74 If set to 0, attempts to use the width of the terminal,\r
  75 falling back to 80.\r
  76 .SS Colors\r
  77 The different line-types in text/gemini documents are rendered with\r
  78 .I m-class\r
  79 terminal escapes (e.g., '\\e[31m').\r
  80 The following variables should hold the values between\r
  81 .I \\e[\r
  82 and\r
  83 .IR m ,\r
  84 meaning valid values are anything between those that are valid terminal\r
  85 color escapes.\r
  86 .TP\r
  87 .BR C_SIGIL " default: 35 (fg: magenta)"\r
  88 The color of the line type as defined by text/gemini.\r
  89 .TP\r
  90 .BR C_LINK_NUMBER " default: 1 (bold)"\r
  91 The color of the link number added by typeset_gemini.\r
  92 .TP\r
  93 .BR C_LINK_TITLE " default: 4 (underline)"\r
  94 The color of the link's title, or if titleless, the URL.\r
  95 .TP\r
  96 .BR C_LINK_URL " default: 36 (fg: cyan)"\r
  97 The color of the link's URL.\r
  98 If the link doesn't have a title, this isn't used.\r
  99 .TP\r
 100 .BI C_HEADER "x where x is 1, 2, or 3"\r
 101 The color of text/gemini headers.\r
 102 The default for level 1 is\r
 103 .IR 1;4 ,\r
 104 for level 2 is\r
 105 .IR 1 ,\r
 106 for level 3 is\r
 107 .IR 3 .\r
 108 .TP\r
 109 .BR C_LIST " default: 0 (no formatting)"\r
 110 The color of list items.\r
 111 .TP\r
 112 .BR C_PRE " default: 0 (no formatting)"\r
 113 The color of preformatted lines, as delimited by '```'.\r
 114 .SS Variables that could be configured, but probably shouldn't be\r
 115 These variables control deeper aspects of\r
 116 .BR bollux (1)'s\r
 117 workings.\r
 118 It's possible they could be tweaked to make\r
 119 .BR bollux (1)\r
 120 work differently, like browsing gopher instead of gemini,\r
 121 but that capability has not been tested.\r
 122 .TP\r
 123 .BR BOLLUX_PORT " valid values are port numbers (1-65535); default is '1965'."\r
 124 The port\r
 125 .BR bollux (1)\r
 126 tries to connect to on the server.\r
 127 .TP\r
 128 .BR BOLLUX_PROTO " valid values are protocol names (strings); default is 'gemini'."\r
 129 The protocol to use.\r
 130 .TP\r
 131 .BR BOLLUX_LESSKEY " valid values are files; default is '/tmp/bollux-lesskey'."\r
 132 Where to store the generated\r
 133 .BR lesskey (1)\r
 134 file.\r
 135 .TP\r
 136 .BR BOLLUX_PAGESRC " valid values are files; default is '/tmp/bollux-src'."\r
 137 Where to store the page source of the site being visited.\r
 138 It's not used right now by\r
 139 .BR bollux (1),\r
 140 but you could ...\r
 141 .BR cat (1)\r
 142 it?\r
 143 .SH FILES\r
 144 .I $XDG_CONFIG_HOME/bollux/bollux.conf\r
 145 .SH SEE ALSO\r
 146 .BR bollux (1)\r