bollux/README.md

77 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2020-05-22 22:19:00 +00:00
# bollux - a bash Gemini client
2020-05-22 13:38:40 +00:00
2021-02-25 23:20:10 +00:00
[![Shellcheck Status](https://drone.tildegit.org/api/badges/acdw/bollux/status.svg)](https://drone.tildegit.org/acdw/bollux)
2020-05-22 13:38:40 +00:00
inspired by
2020-06-01 20:08:53 +00:00
* [birch](https://github.com/dylanaraps/birch)
* [castor](https://git.sr.ht/~julienxx/castor)
* [gemini](https://gemini.circumlunar.space/)
2020-05-22 22:19:00 +00:00
# CAPABILITIES
* make requests
* receive files
* use `dd` to show a nice little download status
2020-05-24 05:28:01 +00:00
* use `less` to display text/* files
2020-05-26 02:48:36 +00:00
* link navigation
2020-05-30 21:46:04 +00:00
* man page
* configuration
2020-06-07 19:06:46 +00:00
* browse gopher
* history (basic)
2020-05-22 22:19:00 +00:00
# STILL TO DO
2020-06-07 19:06:46 +00:00
* history (advanced)
2020-05-30 21:46:04 +00:00
* test configuring capabilities
* bookmarks
2020-06-07 19:06:46 +00:00
* mailcap
* generate certificates
* implement TOFU
* handle http, etc links
2020-05-26 02:48:36 +00:00
2020-06-03 13:17:34 +00:00
# DEPENDENCIES
* bash >= 4.0
* iconv
* openssl
* less (with lesskey)
2020-06-03 13:17:34 +00:00
* dd
2020-06-01 20:13:31 +00:00
# INSTALL
2020-06-07 19:05:10 +00:00
## Packages
- [Slackware](https://slackbuilds.org/repository/14.2/network/bollux/)
2020-06-01 20:13:31 +00:00
## From source
```
2021-04-27 22:58:36 +00:00
$ git clone https://tildegit.org/acdw/bollux
2020-06-01 20:13:31 +00:00
$ 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.
2020-06-01 20:13:31 +00:00
## Alternative
```
$ curl -fLo bollux https://tildegit.org/acdw/bollux/raw/branch/main/bollux
2020-06-01 20:13:31 +00:00
$ chmod +x bollux
$ ./bollux
```
It's a bash script, so just plop it in your $PATH somewhere.
2020-05-26 02:48:36 +00:00
# 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!