From 67021ea036215fcdb83ed41f02de512e1bc895dc Mon Sep 17 00:00:00 2001 From: chris west Date: Sat, 23 May 2020 12:45:16 -0700 Subject: [PATCH] mention media in README --- README.md | 22 ++++++++++++++++++---- src/help.rs | 2 +- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2d82823..1a2a8e1 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,8 @@ the gophersphere. ## usage + Usage: + phetch [options] Launch phetch in interactive mode phetch [options] url Open Gopher URL in interactive mode @@ -100,9 +102,9 @@ Regular development uses `cargo`: cargo run -- -_Pro-tip:_ Run a local gopher server (like [phd][phd]) on -`127.0.0.1:7070` and start phetch with `-l` or `--local` to quickly -connect to it. Useful for debugging! +_Pro-tip:_ Run a local gopher server (like [phd]) on `0.0.0.0:7070` +and start phetch with `-l` or `--local` to quickly connect to it. +Useful for debugging! phetch builds with TLS and Tor support by default. To disable these features, or to enable only one of them, use the @@ -118,13 +120,23 @@ To enable just TLS support, or just Tor support, use `--features`: cargo run --no-default-features --features tor -- gopher://phetch/about +## media player support + +phetch includes experimental support for opening video files (`;` item +type) and sound files (`s` item type) in [mpv]. To test it out, +compile phetch using the `--features media` flag and then visit a +compatible Gopher server (maybe one using [gophor]?). Or check out the +"gopher types" help page by pressing `ctrl-h` then `3` in phetch: + + $ cargo run --features media gopher://phetch/1/help/types + ## todo - [ ] ctrl-c in load() not yet implemented ## bugs -- [ ] ctrl-c while telneting kills phetch +- [ ] telnet IO seems broken after raw_input change (1146f42) ## future features @@ -141,3 +153,5 @@ To enable just TLS support, or just Tor support, use `--features`: [2]: https://github.com/xvxx/phetch/releases/download/v1.0.2/phetch-v1.0.2-macos.zip [phd]: https://github.com/xvxx/phd [aur]: https://wiki.archlinux.org/index.php/AUR_helpers +[mpv]: https://github.com/mpv-player/mpv +[gophor]: https://github.com/grufwub/gophor \ No newline at end of file diff --git a/src/help.rs b/src/help.rs index 31217e1..0f20517 100644 --- a/src/help.rs +++ b/src/help.rs @@ -294,7 +294,7 @@ gGIFs /help/types phetch Iimages downloads /help/types phetch ddocuments /help/types phetch i -iand opening these in a media player: +iand these media types: i ssound files URL:https://freepd.com/music/Wakka%20Wakka.mp3 phetch ;video files URL:https://www.youtube.com/watch?v=oHg5SJYRHA0 phetch