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