2019-12-28 20:37:24 +00:00
|
|
|
<!--
|
2019-12-29 03:25:09 +00:00
|
|
|
/ / /
|
|
|
|
|
___ (___ ___ (___ ___ (___
|
2019-12-28 20:37:24 +00:00
|
|
|
| )| )|___)| | | )
|
2019-12-29 03:25:09 +00:00
|
|
|
|__/ | / |__ |__ |__ | /
|
|
|
|
|
|
|
2020-01-06 09:14:29 +00:00
|
|
|
--> <p align="center"> <img src="./img/logo.png"> <br>
|
2020-01-05 00:49:13 +00:00
|
|
|
<a href="https://github.com/dvkt/phetch/releases">
|
|
|
|
|
<img src="https://img.shields.io/github/v/release/dvkt/phetch?include_prereleases">
|
|
|
|
|
</a>
|
|
|
|
|
</p>
|
2019-12-18 00:48:30 +00:00
|
|
|
|
2019-12-31 18:03:42 +00:00
|
|
|
`phetch` is a terminal client designed to help you quickly navigate
|
2019-12-29 08:16:27 +00:00
|
|
|
the gophersphere.
|
2019-11-22 07:45:02 +00:00
|
|
|
|
2019-12-24 04:27:18 +00:00
|
|
|
## features
|
2019-11-22 07:45:02 +00:00
|
|
|
|
2020-01-06 22:30:18 +00:00
|
|
|
- <1MB executable for linux and mac
|
2019-12-20 04:29:10 +00:00
|
|
|
- technicolor design (based on [GILD](https://github.com/dvkt/gild))
|
2019-12-31 17:58:34 +00:00
|
|
|
- no-nonsense keyboard navigation
|
2019-12-24 04:31:47 +00:00
|
|
|
- supports gopher searches, text and menu pages, and downloads
|
|
|
|
|
- save your favorite gopherholes with bookmarks
|
2019-12-27 02:46:08 +00:00
|
|
|
- opt-in history
|
2020-01-06 09:39:15 +00:00
|
|
|
- secure gopher support (TLS)
|
2019-11-22 07:45:02 +00:00
|
|
|
|
2019-12-17 07:57:18 +00:00
|
|
|
## usage
|
|
|
|
|
|
2019-12-24 17:20:43 +00:00
|
|
|
phetch launch and show start page
|
2019-12-29 08:16:27 +00:00
|
|
|
phetch <gopher-url> open gopher url
|
2020-01-07 17:17:04 +00:00
|
|
|
phetch -t, --tls <gopher-url> try to open all pages w/ tls
|
2019-12-24 17:20:43 +00:00
|
|
|
phetch -r, --raw <gopher-url> print raw gopher response
|
2020-01-07 17:37:38 +00:00
|
|
|
phetch -p, --print <gopher-url> print rendered gopher response
|
2020-01-04 19:40:30 +00:00
|
|
|
phetch -l, --local connect to 127.0.0.1:7070
|
2019-12-24 17:20:43 +00:00
|
|
|
phetch -h, --help show this screen
|
|
|
|
|
phetch -v, --version show phetch version
|
2019-12-17 07:57:18 +00:00
|
|
|
|
2019-12-29 08:16:27 +00:00
|
|
|
once you've launched phetch, use `ctrl-h` to view the on-line help.
|
2019-12-23 23:29:02 +00:00
|
|
|
|
2019-12-18 00:48:30 +00:00
|
|
|
## installation
|
|
|
|
|
|
2019-12-31 18:03:42 +00:00
|
|
|
binaries for linux, mac, and raspberry pi are available
|
2019-12-29 08:16:27 +00:00
|
|
|
at https://github.com/dvkt/phetch/releases:
|
2019-12-24 04:56:54 +00:00
|
|
|
|
2020-01-06 10:21:28 +00:00
|
|
|
- [phetch-v0.1.11-linux-x86_64.tgz][0]
|
|
|
|
|
- [phetch-v0.1.11-linux-armv7.tgz (RPi)][1]
|
2020-01-06 10:18:03 +00:00
|
|
|
- [phetch-v0.1.11-macos.zip][2]
|
2019-12-19 04:52:21 +00:00
|
|
|
|
2019-12-29 08:16:27 +00:00
|
|
|
just unzip/untar the `phetch` program into your $PATH and get going!
|
2019-12-18 00:48:30 +00:00
|
|
|
|
2020-01-04 22:36:00 +00:00
|
|
|
## updates
|
|
|
|
|
|
2020-01-06 09:39:15 +00:00
|
|
|
to check for new versions of `phetch`, use the on-line help system in
|
2020-01-06 10:21:28 +00:00
|
|
|
the app (`ctrl-h`) or visit:
|
2020-01-04 22:36:00 +00:00
|
|
|
|
|
|
|
|
gopher://phkt.io/1/phetch/latest
|
|
|
|
|
|
2019-11-24 20:29:01 +00:00
|
|
|
## development
|
2019-11-22 07:45:02 +00:00
|
|
|
|
2019-12-17 20:23:07 +00:00
|
|
|
cargo run -- <gopher-url>
|
|
|
|
|
|
2020-01-04 22:36:00 +00:00
|
|
|
*pro-tip:* run a local gopher server on `127.0.0.1:7070` and start
|
|
|
|
|
phetch with `-l` or `--local` to quickly connect to it.
|
|
|
|
|
|
2020-01-06 09:41:53 +00:00
|
|
|
to build with TLS support on **linux**, you need `openssl` and
|
|
|
|
|
`pkg-config`:
|
|
|
|
|
|
|
|
|
|
sudo apt install -y pkg-config libssl-dev
|
|
|
|
|
|
2020-01-06 18:26:58 +00:00
|
|
|
to build without TLS support, build with the `no-tls` feature:
|
|
|
|
|
|
2020-01-06 18:28:14 +00:00
|
|
|
cargo build --features disable-tls
|
|
|
|
|
|
|
|
|
|
you can check whether TLS is enabled by visiting the About page:
|
|
|
|
|
|
|
|
|
|
cargo run --features disable-tls -- gopher://phetch/about
|
2020-01-06 18:26:58 +00:00
|
|
|
|
2019-12-24 04:20:53 +00:00
|
|
|
## screenies
|
2019-12-20 04:34:03 +00:00
|
|
|
|
2019-12-24 01:25:53 +00:00
|
|
|
|
|
|
|
|
|
2019-12-24 01:24:36 +00:00
|
|
|
|
2019-12-20 04:34:03 +00:00
|
|
|
|
2019-12-24 01:24:36 +00:00
|
|
|
|
|
|
|
|
|
2019-12-19 05:56:37 +00:00
|
|
|
## todo
|
2019-12-16 19:56:25 +00:00
|
|
|
|
2019-12-27 02:46:08 +00:00
|
|
|
- [ ] fork+exec telnet: gopher://bitreich.org/1/lawn/bbs
|
2019-12-31 17:58:34 +00:00
|
|
|
- [ ] ~/.config/phetch/phetch.conf
|
2019-12-18 21:40:09 +00:00
|
|
|
|
2019-12-20 04:34:03 +00:00
|
|
|
## bugs
|
2019-12-18 21:40:09 +00:00
|
|
|
|
2020-01-07 00:01:49 +00:00
|
|
|
- [ ] "stream did not contain valid UTF-8" sdf.org/maps/
|
|
|
|
|
- [ ] ctrl-z (suspend) doesn't work
|
|
|
|
|
- [ ] unknown keypress: \n needs escaping
|
|
|
|
|
- [ ] unknown keypress: [ during status messages
|
2020-01-02 23:58:58 +00:00
|
|
|
- [ ] gopher://1436.ninja/1/twit.cgi ("iWritten and performed by
|
|
|
|
|
Nathaniel" weirdness) (kitty only)
|
|
|
|
|
- [ ] gopherpedia 'recent entries' weirdness (also kitty only)
|
2020-01-07 06:57:09 +00:00
|
|
|
- [ ] selectors that don't start with /
|
|
|
|
|
- [ ] gopher://alexschroeder.ch/2020-01-02_This_Gopher_Hole/menu
|
|
|
|
|
- [ ] gopher://gopher.conman.org/0About:Server
|
2019-12-20 18:22:35 +00:00
|
|
|
|
2019-12-31 17:58:34 +00:00
|
|
|
## v1.0
|
2019-12-20 18:22:35 +00:00
|
|
|
|
2019-12-31 17:58:34 +00:00
|
|
|
- [ ] Changelog generation (for gopher and github)
|
2019-12-31 18:03:42 +00:00
|
|
|
- [ ] GIF screencast
|
2019-12-31 17:58:34 +00:00
|
|
|
- [ ] man page (small one)
|
|
|
|
|
|
2019-12-31 18:03:42 +00:00
|
|
|
## future features
|
2019-12-31 17:58:34 +00:00
|
|
|
|
|
|
|
|
- [ ] track binary size per release
|
2020-01-03 08:32:42 +00:00
|
|
|
- [ ] text views are menus when URLs are present (one per line max)
|
|
|
|
|
- [ ] Find Text in Text views
|
2019-12-31 17:58:34 +00:00
|
|
|
- [ ] fuzzy find incremental search
|
|
|
|
|
- [ ] persistent history
|
|
|
|
|
- [ ] bookmarks: toggle instead of just prepending to the file
|
|
|
|
|
- [ ] bookmarks: save the title of the current page
|
2019-12-29 08:16:27 +00:00
|
|
|
|
2020-01-06 10:21:28 +00:00
|
|
|
[0]: https://github.com/dvkt/phetch/releases/download/v0.1.11/phetch-v0.1.11-linux-x86_64.tgz
|
|
|
|
|
[1]: https://github.com/dvkt/phetch/releases/download/v0.1.11/phetch-v0.1.11-linux-armv7.tgz
|
2020-01-06 10:18:03 +00:00
|
|
|
[2]: https://github.com/dvkt/phetch/releases/download/v0.1.11/phetch-v0.1.11-macos.zip
|
