stubb/README.md

67 lines
2.3 KiB
Markdown
Raw Normal View History

# Stubb
Stubb is a text based gopher client that only displays and supports gophertypes: 0 (text) and 1 (gopher map). The program is named for the character [Stubb from Moby Dick](https://en.wikipedia.org/wiki/List_of_Moby-Dick_characters#Crewmates), known for his imaginative patter and good humor.
In an effort to streamline the browsing experience for text only, gophermap rendering will not include lines with gophertypes that are not 0, 1, or i (text/display elements). Stubb supports bookmarks, file save, and session only history (cleared on quit).
Support for search is currently under consideration. I have not generally found Gopher search to be particularly useful. The lack of tagging and organization makes most search results from Veronica2 seem like playing the lottery. We'll see.
### Setup
Make sure your system has Lua 5.1 on it. I believe this application should work with 5.2 (so long as you get the appropriate dependencies), however, I believe the socket library is buggy for 5.3, so best to stay on an earlier version.
If you do not have luarocks package manager, get it and run: `luarocks install luasocket`
That should take care of dependencies. You just need to make sure that __stubb__ (found in this repo) is executable and you are good to go.
### Commands
Stub responds to single key commands without requiring the user to press enter. Some commands will request further information, such as a link or bookmark id: (5) or (f2) respectively.
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__Navigation__
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__B__ack
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__F__orward
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__G__o to url
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__R__eload current address
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__V__isit link/bookmark
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__Bookmarks__
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__A__dd bookmark
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__D__elete bookmark
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__L__ist bookmarks
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__U__pdate bookmark title
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__System__
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__H__elp
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__Q__uit
2019-01-06 00:09:31 +00:00
2019-01-06 00:08:16 +00:00
__S__ave file to disk
### Recommendations
If Stubb's slim and light style is not fitting your needs, or you just want to check out some other gopher client projects, I highly recomend the following:
- [Burrow](https://tildegit.org/sloum/burrow): My gui based browser with a wider featureset (primarily for *nix system)
- [VF-1](https://github.com/solderpunk/VF-1): A great/stable gopher client written by Solderpunk, who maintains one of the best gopher communities out there, [The People's Circumlunar Zaibatsu, in Circumluanr Space](gopher://zaibatsu.circumlunar.space:70/).