about summary refs log tree commit diff stats
path: root/README.md
blob: 34f3cebf44282e15173f9a2b54c7f65787cdad82 (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
70
71
72
73
74
75
76
# bollux - a bash Gemini client

[![Shellcheck Status](https://drone.tildegit.org/api/badges/acdw/bollux/status.svg)](https://drone.tildegit.org/acdw/bollux)

inspired by

* [birch](https://github.com/dylanaraps/birch)
* [castor](https://git.sr.ht/~julienxx/castor)
* [gemini](https://gemini.circumlunar.space/)

# CAPABILITIES

* make requests
* receive files
* use `dd` to show a nice little download status
* use `less` to display text/* files
* link navigation
* man page
* configuration
* browse gopher
* history (basic)

# STILL TO DO

* history (advanced)
* test configuring capabilities
* bookmarks
* mailcap
* generate certificates
* implement TOFU
* handle http, etc links

# DEPENDENCIES

* bash >= 4.0
* iconv
* openssl
* less (with lesskey)
* dd

# INSTALL

## Packages

- [Slackware](https://slackbuilds.org/repository/14.2/network/bollux/)

## From source

```
$ git clone https://tildegit.org/acdw/bollux
$ cd bollux
# make install
```

**NOTE** if you installed an older version, make sure to rm /usr/bin/bollux.  
The new install path is /usr/local/bin.

## Alternative

```
$ curl -fLo bollux https://tildegit.org/acdw/bollux/raw/branch/main/bollux
$ chmod +x bollux
$ ./bollux
```

It's a bash script, so just plop it in your $PATH somewhere.

# LICENSE

MIT

# CONTRIBUTING

Create an [issue](https://tildegit.org/acdw/bollux/issues/new) or
[pull request](https://tildegit.org/acdw/bollux/compare/main...main) and I'll
get back to you posthaste!