bollux.1

   1 .TH bollux 1 0.4.0\r
   2 .SH NAME\r
   3 bollux \- gemini protocol browser written in\r
   4 .BR bash (1)\r
   5 .SH SYNOPSIS\r
   6 .B bollux\r
   7 .RI [ \-h ]\r
   8 .TP\r
   9 .B bollux\r
  10 .RI [ \-q ]\r
  11 .RI [ \-v ]\r
  12 .\".RI [ \-c\r
  13 .\".BR CONFIG ]\r
  14 .RB [ URL ]\r
  15 .SH DESCRIPTION\r
  16 .BR bollux (1)\r
  17 is a browser for the new Gemini protocol, which aims to be\r
  18 "heavier than gopher, but lighter than the web."\r
  19 It can follow links, collect user input, download files, and display text/* mimetype pages in geminispace.\r
  20 .SH OPTIONS\r
  21 .TP\r
  22 .B \-h\r
  23 Display an inline help screen and exit\r
  24 .TP\r
  25 .B \-q\r
  26 Be quiet: don't show any messages, even fatal ones\r
  27 .TP\r
  28 .B \-v\r
  29 Be verbose: show all messages, even debug ones\r
  30 .\".TP\r
  31 .\".B \-c CONFIG\r
  32 .\"Use CONFIG file to configure\r
  33 .\".BR bollux (1)\r
  34 .\"instead of the default: $XDG_CONFIG_HOME/bollux/bollux.conf.\r
  35 .TP\r
  36 .B URL\r
  37 The gemini URL to navigate to\r
  38 .SH USAGE\r
  39 If\r
  40 .BR bollux (1)\r
  41 is invoked with a URL, it will download or display that URL.\r
  42 Otherwise, the user will be prompted for a URL to download or display.\r
  43 If the URL points to a text/* document, it is paged with\r
  44 .BR less (1)\r
  45 with custom keybinds:\r
  46 .TP\r
  47 .B o\r
  48 open a link on the current page\r
  49 .TP\r
  50 .B g\r
  51 goto a new URL\r
  52 .TP\r
  53 .B G\r
  54 goto a new URL - with current URL pre-filled\r
  55 .TP\r
  56 .B r\r
  57 refresh the current page\r
  58 .TP\r
  59 .B [\r
  60 goto the previous page in history\r
  61 .TP\r
  62 .B ]\r
  63 goto the next page in history\r
  64 .TP\r
  65 .B q\r
  66 quit bollux\r
  67 .TP\r
  68 .B \=\r
  69 show a short help message\r
  70 .PP\r
  71 If a new URL is selected,\r
  72 .BR bollux (1)\r
  73 will repeat the download-and-display loop with the new URL.\r
  74 .PP\r
  75 If the mimetype is other than text/*,\r
  76 .BR bollux (1)\r
  77 will attempt to download the file to\r
  78 .B $BOLLUX_DOWNDIR\r
  79 (which defaults to '.').\r
  80 .PP\r
  81 .BR bollux (1)\r
  82 also supports the gopher protocol,\r
  83 which is browsed the same way as the gemini protocol\r
  84 (except the URL starts with 'gopher://').\r
  85 Gopher support is as of now rudimentary.\r
  86 .SH ISSUES\r
  87 Certificate handling needs to be much improved: TOFU needs to be implemented\r
  88 and bollux should be able to generate client certificates.\r
  89 .SH SEE ALSO\r
  90 .BR bollux.conf (5)\r
  91 .SH BUGS\r
  92 The development repo is located at https://sr.ht/~acdw/bollux.\r
  93 Please direct all bug reports, patches, or general complaints there.\r