You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
phetch/README.md

127 lines
3.6 KiB
Markdown

4 years ago
<!--
4 years ago
/ / /
___ (___ ___ (___ ___ (___
4 years ago
| )| )|___)| | | )
4 years ago
|__/ | / |__ |__ |__ | /
|
4 years ago
--> <p align="center"> <img src="./img/logo.png"> <br>
4 years ago
<a href="https://git.io/JveQo">
<img src="https://img.shields.io/github/v/release/dvkt/phetch?include_prereleases">
</a>
</p>
4 years ago
4 years ago
`phetch` is a terminal client designed to help you quickly navigate
the gophersphere.
5 years ago
4 years ago
## features
5 years ago
4 years ago
- <1MB executable for Linux and Mac
- Technicolor design (based on [GILD](https://github.com/dvkt/gild))
- No-nonsense keyboard navigation
- Supports Gopher searches, text and menu pages, and downloads
- Save your favorite Gopher sites with bookmarks
- Opt-in history tracking
- Secure Gopher support (TLS)
5 years ago
4 years ago
## usage
4 years ago
phetch [options] Launch phetch in interactive mode
phetch [options] [url] Open Gopher URL in interactive mode
4 years ago
Options:
4 years ago
-t, --tls Try to open all pages w/ TLS
-r, --raw Print raw Gopher response only
-p, --print Print rendered Gopher response only
-l, --local Connect to 127.0.0.1:7070
4 years ago
-h, --help Show this screen
-v, --version Show phetch version
4 years ago
Once you've launched phetch, use `ctrl-h` to view the on-line help.
4 years ago
## installation
4 years ago
Binaries for linux, mac, and raspberry pi are available
at https://github.com/dvkt/phetch/releases:
4 years ago
- [phetch-v0.1.12-linux-x86_64.tgz][0]
- [phetch-v0.1.12-linux-armv7.tgz (RPi)][1]
- [phetch-v0.1.12-macos.zip][2]
4 years ago
4 years ago
Just unzip/untar the `phetch` program into your $PATH and get going!
4 years ago
4 years ago
You can also build and install from source:
git clone https://github.com/dvkt/phetch
cd phetch
env PREFIX=/usr/local make install
## updates
4 years ago
To check for new versions of `phetch`, use the on-line help system in
4 years ago
the app (`ctrl-h`) or visit:
gopher://phkt.io/1/phetch/latest
5 years ago
## development
5 years ago
cargo run -- <gopher-url>
4 years ago
*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.
4 years ago
To build with TLS support on **Linux**, you need `openssl` and
`pkg-config`:
sudo apt install -y pkg-config libssl-dev
4 years ago
To build without TLS support, build with the `no-tls` feature:
cargo build --features disable-tls
4 years ago
You can check whether TLS is enabled by visiting the About page:
cargo run --features disable-tls -- gopher://phetch/about
4 years ago
## screenies
|![DOS Archive](./img/dos.png)|![Floodgap](./img/menu-view.png)|
|:-:|:-:|
| DOS Archive | Floodgap |
4 years ago
4 years ago
## todo
4 years ago
4 years ago
- [ ] ~/.config/phetch/phetch.conf
## bugs
4 years ago
- [ ] unknown keypress: \n needs escaping
- [ ] unknown keypress: [ during status messages
- [ ] gopher://1436.ninja/1/twit.cgi ("iWritten and performed by
Nathaniel" weirdness) (kitty only)
- [ ] gopherpedia 'recent entries' weirdness (also kitty only)
4 years ago
- [ ] selectors that don't start with /
- [ ] gopher://alexschroeder.ch/2020-01-02_This_Gopher_Hole/menu
- [ ] gopher://gopher.conman.org/0About:Server
4 years ago
4 years ago
## v1.0
4 years ago
4 years ago
- [ ] Changelog generation (for gopher and github)
4 years ago
- [ ] GIF screencast
4 years ago
4 years ago
## future features
4 years ago
- [ ] track binary size per release
4 years ago
- [ ] text views are menus when URLs are present (one per line max)
- [ ] Find Text in Text views
4 years ago
- [ ] fuzzy find incremental search
- [ ] persistent history
- [ ] bookmarks: toggle instead of just prepending to the file
- [ ] bookmarks: save the title of the current page
[0]: https://github.com/dvkt/phetch/releases/download/v0.1.12/phetch-v0.1.12-linux-x86_64.tgz
[1]: https://github.com/dvkt/phetch/releases/download/v0.1.12/phetch-v0.1.12-linux-armv7.tgz
[2]: https://github.com/dvkt/phetch/releases/download/v0.1.12/phetch-v0.1.12-macos.zip