Version bump
[bollux.git/.git] / bollux.1
1 .TH bollux 1 0.2\r
2 .SH NAME\r
3 bollux \- gemini protocol browser written in bash(1)\r
4 .SH SYNOPSIS\r
5 .B bollux\r
6 .RI [ \-h ]\r
7 .TP\r
8 .B bollux\r
9 .RI [ \-q ]\r
10 .RI [ \-v ]\r
11 .RI [ \-c\r
12 .BR CONFIG ]\r
13 .RB [ URL ]\r
14 .SH DESCRIPTION\r
15 .BR bollux (1)\r
16 is a browser for the new Gemini protocol, which aims to be\r
17 "heavier than gopher, but lighter than the web."\r
18 It can follow links, collect user input, download files, and display text/* mimetype pages in geminispace.\r
19 .SH OPTIONS\r
20 .TP\r
21 .B \-h\r
22 Display an inline help screen and exit\r
23 .TP\r
24 .B \-q\r
25 Be quiet: don't show any messages, even fatal ones\r
26 .TP\r
27 .B \-v\r
28 Be verbose: show all messages, even debug ones\r
29 .TP\r
30 .B \-c CONFIG\r
31 Use CONFIG file to configure\r
32 .BR bollux (1)\r
33 instead of the default: $XDG_CONFIG_HOME/bollux/bollux.conf.\r
34 .TP\r
35 .B URL\r
36 The gemini URL to navigate to\r
37 .SH USAGE\r
38 If\r
39 .BR bollux (1)\r
40 is invoked with a URL, it will download or display that URL.\r
41 Otherwise, the user will be prompted for a URL to download or display.\r
42 If the URL points to a text/* document, it is paged with\r
43 .BR less (1)\r
44 with custom keybinds:\r
45 .TP\r
46 .B o\r
47 open a link on the current page\r
48 .TP\r
49 .B g\r
50 goto a new URL\r
51 .TP\r
52 .B r\r
53 refresh the current page\r
54 .TP\r
55 .B q\r
56 quit bollux\r
57 .PP\r
58 If a new URL is selected, \r
59 .BR bollux (1)\r
60 will repeat the download-and-display loop with the new URL.\r
61 .SH ISSUES\r
62 There is currently no history storage or recall.\r
63 .BR bollux (1)\r
64 can get confused on some URLs \-\- munging them correctly is an area of active research.\r
65 .SH SEE ALSO\r
66 .BR bollux.conf (5)\r
67 .SH BUGS\r
68 The development repo is located at https://sr.ht/~acdw/bollux.\r
69 Please direct all bug reports, patches, or general complaints there.\r