|
|
|
|
|
|
|
|
|
|
**** bombadillo **** |
|
|
|
|
|
|
|
bombadillo is a gopher client for the terminal. it functions as a pager |
|
|
|
with a "full screen" terminal user interface. keys are mapped similarly |
|
|
|
to vim (as detailed below). source code can be downloaded from the link |
|
|
|
and is written in golang. linux and osx are fully supported for both arm |
|
|
|
and x86_64. |
|
|
|
|
|
|
|
in bombadillo, scroll down with 'j' and up with 'k'. this is being |
|
|
|
listed here to facilitate easier viewing of the rest of this doc |
|
|
|
for first time users. |
|
|
|
|
|
|
|
|
|
|
|
source code is available here: |
|
|
 |
http://tildegit.org/sloum/bombadillo |
text/html |
|
|
|
|
|
|
web based documentation/links available here: |
|
|
|
https://rawtext.club/~sloum/bombadillo.html |
text/html |
|
|
|
|
|
|
|
|
|
|
to open the above link in bombadillo a user must enable the feature. to do so |
|
|
|
a user would ":set openhttp true". this will open the http based web link in |
|
|
|
their default web browser. a user can change back to false at any time if |
|
|
|
prefer to not open non-gopher links. if a default web browser is not set, the |
|
|
|
true value will still result in failure :( unfortunately, if you are in a |
|
|
|
non-graphical environment entiely (such as in a remote shell) you will likely |
|
|
|
not be able to open a web browser as lynx (or the like) are not generally |
|
|
|
set up to work as a system default browser. |
|
|
|
|
|
|
|
bombadillo uses, if it is available, the alternate terminal buffer. this will |
|
|
|
help keep your terminal clean when you exit as well as create a better full |
|
|
|
screen experience in a terminal. a configuration flag to toggle this feature |
|
|
|
is in the works. |
|
|
|
|
|
|
|
|
|
|
|
** quick start ** |
|
|
|
|
|
|
|
upon opening bombadillo for the first time a user will be presented with this |
|
|
|
screen and a top bar with the application title. to visit a page a user can |
|
|
|
enter a colon followed by a gopher url or a link number (shown on the active |
|
|
|
page to the left of link text and to the right of the gopher type). For |
|
|
|
example: |
|
|
|
|
|
|
|
:colorfield.space |
|
|
|
|
|
|
|
upon doing so the user will see the colorfield.space gopher page |
|
|
|
you will see the ':' key come up a lot as it leads into many commands. |
|
|
|
|
|
|
|
you can pass a url to bombadillo when opening it from the terminal. |
|
|
|
doing so will open the client directly to that url. for example: |
|
|
|
|
|
|
|
bombadillo gopher://colorfield.space |
|
|
|
|
|
|
|
|
|
|
|
A note on window resizing: |
|
|
|
|
|
|
|
If you resize your terminal window the screen will wrap text in weird/wild |
|
|
|
ways. Pressing any key when the screen is in this state will redraw the |
|
|
|
screen and realign the text. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
** hot keys ** |
|
|
|
|
|
|
|
some keys function as "hot keys". when pressed, they will initite an |
|
|
|
action immediately. the following keys work as hot keys: |
|
|
|
|
|
|
|
key behavior |
|
|
|
-------- -------------------------------------------------------------- |
|
|
|
q quit bombadillo |
|
|
|
b back (go back a place in browsing history if available) |
|
|
|
f forward (go forward a place in browsing history if available) |
|
|
|
j scroll down (if there is room to do so) |
|
|
|
k scroll up (if there is room to do so) |
|
|
|
G scroll to bottom (end) |
|
|
|
g scroll to top (home) |
|
|
|
d page down |
|
|
|
u page up |
|
|
|
B toggle bookmarks sidebar into or out of view |
|
|
|
: enter command mode |
|
|
|
SPC enter command mode |
|
|
|
TAB cycle window focus |
|
|
|
|
|
|
|
*window focus changes only have an effect if the bookmark window is open. |
|
|
|
Changing focus will allow the focused window to be scrolled while both |
|
|
|
windows are visible on screen. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
** commands ** |
|
|
|
|
|
|
|
once in command mode, the following commands are available: |
|
|
|
(most can function using just their first letter... ex: |
|
|
|
:q will quit |
|
|
|
:w . somefile.txt will save the current file as somefile.txt |
|
|
|
all current commands work this way in addition to their long form) |
|
|
|
|
|
|
|
|
|
|
|
action syntax notes |
|
|
|
----------------- -------------------------------- --------------------- |
|
|
|
quit bombadillo :quit same as 'q' hot key |
|
|
|
visit homepage :home set by homeurl option |
|
|
|
visit help :help short version :? |
|
|
|
search :search will ask for kwds |
|
|
|
visit url :[url] valid gopher url |
|
|
|
visit link :[number] link # on active page |
|
|
|
view bookmarks :bookmarks same as 'B' hot key |
|
|
|
visit bookmark :bookmarks [number] valid bookmark # |
|
|
|
add bookmark :add [url] [bookmark title] valid gopher url |
|
|
|
add bookmark :add [link #] [bookmark title] link # on active page |
|
|
|
add bookmark :add . [bookmark title] adds active page |
|
|
|
delete bookmark :delete [number] valid bookmark # |
|
|
|
set an option :set [option] [value] used for configuration |
|
|
|
check an option :check [option name] used to check config |
|
|
|
write to file :write [url] [file name] valid gopher url |
|
|
|
write to file :write [link #] [file name] link # on active page |
|
|
|
write to file :write . [file name] saves active page |
|
|
|
|
|
|
|
*: navigating to a non-text gophertype will automaticall save |
|
|
|
files save to the path set by the 'saveurl' option (defaults |
|
|
|
to a user's Downloads folder in their home directory). |
|
|
|
**: search is entered on its own and will query the user for keywords |
|
|
|
and will then query the search service set as 'searchengine' |
|
|
|
(defaults to veronica2) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
** configuartion ** |
|
|
|
|
|
|
|
various configuartion options can be set via the 'set' command. |
|
|
|
the following are the currently avialable options, more will be |
|
|
|
coming in the near future (including color theme options) |
|
|
|
|
|
|
|
once a user sets an option or adds a bookmark a config file will be |
|
|
|
created in their home directory. the file will be named '.bombadillo.ini' |
|
|
|
while it can be edited directly, it is recommended to use bombadillo |
|
|
|
to interact with said file. |
|
|
|
|
|
|
|
|
|
|
|
option value type default |
|
|
|
--------------- ------------------------- ------------------------ |
|
|
|
|
|
|
|
homeurl valid gopher url this document |
|
|
|
savelocation an non-relative filepath /[home path]/Downloads/ |
|
|
|
searchengine a type 7 gopher url gopher.floodgap.com:70/7/v2/vs |
|
|
|
openhttp true/false false |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
for more information please contact the following: |
|
|
 |
colorfield space |
|
|
|
sloum@sdf.org |
|
|
|
tildegit |
text/html |
|
|
|
|
|
|
|
|
|
|
|
|