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