Compare commits

...

8 Commits

20 changed files with 2091 additions and 20 deletions

View File

@ -53,6 +53,12 @@ install-bin: build
install -d ${DESTDIR}${BINDIR}
install -m 0755 ./${BINARY} ${DESTDIR}${BINDIR}
.PHONY: install-help
install-help:
install -d ${DESTDIR}${DATAROOTDIR}/bombadillo/help
install -m 0644 ./help/* ${DESTDIR}${DATAROOTDIR}/bombadillo/help
.PHONY: clean
clean:
${GOCMD} clean
@ -65,6 +71,7 @@ uninstall: clean
rm -f ${DESTDIR}${BINDIR}/${BINARY}
rm -f ${DESTDIR}${DATAROOTDIR}/applications/bombadillo.desktop
rm -f ${DESTDIR}${DATAROOTDIR}/pixmaps/bombadillo-icon.png
rm -rf ${DESTDIR}${DATAROOTDIR}/bombadillo
-update-desktop-database 2> /dev/null
.PHONY: release
@ -74,6 +81,5 @@ release:
GOOS=linux GOARCH=386 ${GOCMD} build ${LDFLAGS} -o ${BINARY}_linux_32
GOOS=darwin GOARCH=amd64 ${GOCMD} build ${LDFLAGS} -o ${BINARY}_darwin_64
.PHONY: test
test: clean build

175
client.go
View File

@ -22,6 +22,7 @@ import (
"tildegit.org/sloum/bombadillo/termios"
)
//------------------------------------------------\\
// + + + T Y P E S + + + \\
//--------------------------------------------------\\
@ -317,9 +318,28 @@ func (c *client) routeCommandInput(com *cmdparse.Command) error {
}
func (c *client) simpleCommand(action string) {
action = strings.ToUpper(action)
switch action {
case "A", "ADD":
c.SetMessage(syntaxErrorMessage("ADD"), true)
c.DrawMessage()
case "S", "SET":
c.SetMessage(syntaxErrorMessage("SET"), true)
c.DrawMessage()
case "D", "DELETE":
c.SetMessage(syntaxErrorMessage("DELETE"), true)
c.DrawMessage()
case "W", "WRITE":
c.SetMessage(syntaxErrorMessage("WRITE"), true)
c.DrawMessage()
case "P", "PURGE":
c.SetMessage(syntaxErrorMessage("PURGE"), true)
c.DrawMessage()
case "C", "CHECK":
c.SetMessage(syntaxErrorMessage("CHECK"), true)
c.DrawMessage()
case "Q", "QUIT":
cui.Exit(0, "")
case "H", "HOME":
@ -351,16 +371,41 @@ func (c *client) simpleCommand(action string) {
}
}
func (c *client) doCommand(action string, values []string) {
if length := len(values); length != 1 {
c.SetMessage(fmt.Sprintf("Expected 1 argument, received %d", len(values)), true)
c.DrawMessage()
return
}
func (c *client) doCommand(action string, values []string) {
switch action {
case "CHECK", "C":
case "A", "ADD":
c.SetMessage(syntaxErrorMessage("ADD"), true)
c.DrawMessage()
case "B", "BOOKMARKS":
c.SetMessage(syntaxErrorMessage("BOOKMARKS"), true)
c.DrawMessage()
case "C", "CHECK":
c.displayConfigValue(values[0])
c.DrawMessage()
case "D", "DELETE":
c.SetMessage(syntaxErrorMessage("DELETE"), true)
c.DrawMessage()
case "?", "HELP":
path, err := helpAddress(values[0])
if err != nil {
c.SetMessage(err.Error(), true)
c.DrawMessage()
} else {
c.Visit(path)
}
case "H", "HOME":
c.SetMessage(syntaxErrorMessage("HOME"), true)
c.DrawMessage()
case "Q", "QUIT":
c.SetMessage(syntaxErrorMessage("QUIT"), true)
c.DrawMessage()
case "R", "RELOAD":
c.SetMessage(syntaxErrorMessage("QUIT"), true)
c.DrawMessage()
case "S", "SET":
c.SetMessage(syntaxErrorMessage("SET"), true)
c.DrawMessage()
case "PURGE", "P":
err := c.Certs.Purge(values[0])
if err != nil {
@ -411,18 +456,43 @@ func (c *client) doCommand(action string, values []string) {
}
func (c *client) doCommandAs(action string, values []string) {
if len(values) < 2 {
c.SetMessage(fmt.Sprintf("Expected 2+ arguments, received %d", len(values)), true)
c.DrawMessage()
return
}
if values[0] == "." {
values[0] = c.PageState.History[c.PageState.Position].Location.Full
}
switch action {
case "B", "BOOKMARKS":
c.SetMessage(syntaxErrorMessage("BOOKMARKS"), true)
c.DrawMessage()
case "C", "CHECK":
c.displayConfigValue(values[0])
c.DrawMessage()
case "D", "DELETE":
c.SetMessage(syntaxErrorMessage("DELETE"), true)
c.DrawMessage()
case "?", "HELP":
c.SetMessage(syntaxErrorMessage("HELP"), true)
c.DrawMessage()
case "H", "HOME":
c.SetMessage(syntaxErrorMessage("HOME"), true)
c.DrawMessage()
case "P", "PURGE":
c.SetMessage(syntaxErrorMessage("PURGE"), true)
c.DrawMessage()
case "Q", "QUIT":
c.SetMessage(syntaxErrorMessage("QUIT"), true)
c.DrawMessage()
case "R", "RELOAD":
c.SetMessage(syntaxErrorMessage("QUIT"), true)
c.DrawMessage()
case "W", "WRITE":
c.SetMessage(syntaxErrorMessage("WRITE"), true)
c.DrawMessage()
case "ADD", "A":
if len(values) < 2 {
c.SetMessage(syntaxErrorMessage("ADD"), true)
c.DrawMessage()
return
}
if values[0] == "." {
values[0] = c.PageState.History[c.PageState.Position].Location.Full
}
msg, err := c.BookMarks.Add(values)
if err != nil {
c.SetMessage(err.Error(), true)
@ -441,8 +511,18 @@ func (c *client) doCommandAs(action string, values []string) {
c.Draw()
}
case "SEARCH":
if len(values) < 2 {
c.SetMessage(syntaxErrorMessage("SEARCH"), true)
c.DrawMessage()
return
}
c.search(strings.Join(values, " "), "", "")
case "SET", "S":
if len(values) < 2 {
c.SetMessage(syntaxErrorMessage("SET"), true)
c.DrawMessage()
return
}
if _, ok := c.Options[values[0]]; ok {
val := strings.Join(values[1:], " ")
if !validateOpt(values[0], val) {
@ -496,6 +576,36 @@ func (c *client) doLinkCommandAs(action, target string, values []string) {
}
switch action {
case "B", "BOOKMARKS":
c.SetMessage(syntaxErrorMessage("BOOKMARKS"), true)
c.DrawMessage()
case "C", "CHECK":
c.displayConfigValue(values[0])
c.DrawMessage()
case "D", "DELETE":
c.SetMessage(syntaxErrorMessage("DELETE"), true)
c.DrawMessage()
case "?", "HELP":
c.SetMessage(syntaxErrorMessage("HELP"), true)
c.DrawMessage()
case "H", "HOME":
c.SetMessage(syntaxErrorMessage("HOME"), true)
c.DrawMessage()
case "P", "PURGE":
c.SetMessage(syntaxErrorMessage("PURGE"), true)
c.DrawMessage()
case "Q", "QUIT":
c.SetMessage(syntaxErrorMessage("QUIT"), true)
c.DrawMessage()
case "R", "RELOAD":
c.SetMessage(syntaxErrorMessage("QUIT"), true)
c.DrawMessage()
case "SEARCH":
c.SetMessage(syntaxErrorMessage("SEARCH"), true)
c.DrawMessage()
case "S", "SET":
c.SetMessage(syntaxErrorMessage("SET"), true)
c.DrawMessage()
case "ADD", "A":
bm := make([]string, 0, 5)
bm = append(bm, links[num])
@ -593,6 +703,30 @@ func (c *client) doLinkCommand(action, target string) {
}
switch action {
case "A", "ADD":
c.SetMessage(syntaxErrorMessage("ADD"), true)
c.DrawMessage()
case "?", "HELP":
c.SetMessage(syntaxErrorMessage("HELP"), true)
c.DrawMessage()
case "H", "HOME":
c.SetMessage(syntaxErrorMessage("HOME"), true)
c.DrawMessage()
case "P", "PURGE":
c.SetMessage(syntaxErrorMessage("PURGE"), true)
c.DrawMessage()
case "Q", "QUIT":
c.SetMessage(syntaxErrorMessage("QUIT"), true)
c.DrawMessage()
case "R", "RELOAD":
c.SetMessage(syntaxErrorMessage("QUIT"), true)
c.DrawMessage()
case "SEARCH":
c.SetMessage(syntaxErrorMessage("SEARCH"), true)
c.DrawMessage()
case "S", "SET":
c.SetMessage(syntaxErrorMessage("SET"), true)
c.DrawMessage()
case "DELETE", "D":
msg, err := c.BookMarks.Delete(num)
if err != nil {
@ -1195,3 +1329,10 @@ func findAvailableFileName(fpath, fname string) (string, error) {
return savePath, nil
}
func syntaxErrorMessage(action string) string {
if val, ok := ERRS[action]; ok {
return fmt.Sprintf("Incorrect syntax. Try: %s", val)
}
return fmt.Sprintf("Unknown command %q", action)
}

View File

@ -94,10 +94,10 @@ func (p *Parser) parseAction() (*Command, error) {
case Value:
cm.Target = t.val
cm.Type = DOLINK
case Word:
case Word, Action:
cm.Value = append(cm.Value, t.val)
cm.Type = DO
case Action, Whitespace:
case Whitespace:
return nil, fmt.Errorf("Found %q (%d), expected value", t.val, t.kind)
}
t = p.scan()

73
help.go Normal file
View File

@ -0,0 +1,73 @@
package main
import (
"fmt"
"os"
"path/filepath"
"strings"
)
var ERRS = map[string]string{
"ADD": "`add [target] [name...]`",
"DELETE": "`delete [bookmark-id]`",
"BOOKMARKS": "`bookmarks [[bookmark-id]]`",
"CHECK": "`check [link_id]` or `check [setting]`",
"HOME": "`home`",
"PURGE": "`purge [host]`",
"QUIT": "`quit`",
"RELOAD": "`reload`",
"SEARCH": "`search [[keyword(s)...]]`",
"SET": "`set [setting] [value]`",
"WRITE": "`write [target]`",
"HELP": "`help [[topic]]`",
}
var helpRoot string = "/usr/local/share/bombadillo/help"
func helpAddress(section string) (string, error) {
var addr string
switch strings.ToLower(section) {
case "add", "a", "delete", "d", "bookmarks", "bookmark", "b":
addr = "bookmarks.help"
case "quit", "quitting", "q", "flags", "runtime", "options", "exiting", "exit", "general", "startup", "version", "title":
addr = "general.help"
case "help", "info", "?", "information":
addr = "help.help"
case "write", "save", "saving", "w", "file", "writing", "download", "downloading", "downloads":
addr = "saving.help"
case "license":
addr = "license.help"
case "local", "file":
addr = "local.help"
case "finger":
addr = "finger.help"
case "gemini", "text/gemini", "tls", "tofu":
addr = "gemini.help"
case "gopher":
addr = "gopher.help"
case "keys", "key", "hotkeys", "hotkey", "keymap", "controls":
addr = "keys.help"
case "telnet":
addr = "telnet.help"
case "navigating", "navigation", "scroll", "scrolling", "history","links", "link":
addr = "navigation.help"
case "command", "commands", "functions":
addr = "commands.help"
case "protocol", "protocols":
addr = "protocols.help"
case "resources", "links":
addr = "resources.go"
default:
return "", fmt.Errorf("No help section for %q exists", section)
}
fp := filepath.Join(helpRoot, addr)
_, err := os.Stat(fp)
if err != nil {
return "", fmt.Errorf("No help section for %q exists", section)
}
return fp, nil
}

111
help/bookmarks.help Normal file
View File

@ -0,0 +1,111 @@
Bookmark Management
---------------------------
It is easy to add, view, navigate to, and delete bookmarks in Bombadillo. Let's tackle them in that order:
-- Adding Bookmarks --
Adding a bookmark is done with the add command and has the following syntax:
`add [target] [name...]`
Like many commands in Bombadillo, you can use an abbreviated form and just type `a [target] [name...]`
The available target valies are a url, a link ID that appears on the current page, or the character `.`, which represents the current page itself.
Examples:
- `add gopher://bombadillo.colorfield.space Bombadillo`
- `a 5 My Favorite Phlog`
- `add . Dave's Gopherhole`
If you are missing an element, or the link ID does not exist, Bombadillo will let you know the issue and/or show you the correct syntax.
-- Viewing Bookmarks --
Viewing your bookmarks is quite easy. You can use a command or a "hot" key. To toggle the bookmarks bar into and out of view you can press the key "B" (the key combination "shift" + "b"). The command version, including the abbreviated form, is as follows:
- `bookmarks`
- `b`
In general, the hot key is likely more comfortable for most users.
Once the bookmarks bar is visible you can scroll up and down in it with the regular "j" and "k" keys to view your bookmarks if you have more than the height of your temrinal allows on screen at one time. You may notice that you can no longer scroll the page with these keys. This is because the bookmark bar has focus when it is first opened. You can switch focus between the main content and the bookmarks bar by pressing the "tab" key, which will allow you to scroll in whichever area is needed at a given time.
Closing the bookmarks bar is done the same way as opening it.
-- Navigating To Bookmarks --
Navigating to a bookmark is done in much the same way as navigating to a regular link, except there is an additional command paramater. The syntax, including the abbreviated version, is as follows:
- `bookmarks [bookmark-id]`
- `b [bookmark-id]`
The bookmark-id is shown in the bookmarks bar next to the bookmark name.
Examples:
- `bookmarks 3`
- `b 21`
If the bookmark-id you provide does not exist, Bombadillo will let you know. Otherwise, the URL that the selected bookmark represents will be loaded.
-- Deleting Bookmarks --
To delete a bookmark you will need to know its ID. This can be found in the bookmarks bar (see above: 'Viewing Bookmarks') next to the bookmark's name.
The syntax for deleting a bookmark, including the abbreviated form, is as follows:
- `delete [bookmark-id]`
- `d [bookmark-id]`
Examples:
- `delete 3`
- `d 21`
If the bookmark-id you provide does not exist, Bombadillo will let you know. Otherwise, the bookmark will be deleted.
________________________________
This concludes the help section brought up by the following keywords:
bookmark, bookmarks, a, b, d, add, delete
Other sections of the help document:
`help help`
`help general`
`help navigation`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

243
help/commands.help Normal file
View File

@ -0,0 +1,243 @@
Bombadillo Commands
---------------------------
This help page functions as an appendix to let you know the various commands available to you. Each command will have the syntax, description, and at least one example provided.
To use any of the commands below you will first need to enter command mode. This is done by pressing the `:` (while not already in command mode). You may then type your command. Once you have typed your command, press enter to execute it. To cancel command execution and return to normal mode press enter with no text provided for the command. Instead of `:` you may, at your option, type ` ` (the space key) instead. In either case a ':' will appear in the bottom left to let you know you are in command mode and can type a command.
The information in this help guide is largely copied from the Bombadillo man page. you can view this document by entering the following at your terminal's shell prompt (assuming your system administrator, potentially you, installed the man apge):
- `man bombadillo`
-- add --
Syntax:
add [url] [name...]
add [link id] [name...]
add . [name...]
Adds the url (either directly with a url, represented by a link id, or the current url as represented by '.') as a bookmarks labeled by name. `a` can be used instead of the full `add`.
Examples:
`add gopher://bombadillo.colorfield.space Bombadillo Homepage`
`a 5 Bombadillo Homepage`
`a . Bombadillo`
-- bookmarks --
Syntax:
bookmarks
bookmarks [bookmark id]
When the command is given without an id, the bookmark bar will be toggled open/closed, this can also be accomplished with the "hot" key `B`. When the command is given with a bookmark id Bombadillo will navigate to the URL that is represented by the given bookmark id. In either case, the shorthand `b` can be used rather than the full `bookmarks`.
Examples:
`bookmarks 12`
`bookmarks`
`b 7`
-- check --
Syntax:
check [link id]
check [setting name]
The check command allows you to see the value of something. You can give it a link id on the current page and it will show you the url that it links to, or you can give it a setting name and it will show you the current value of that setting. The shorthand `c` may be used rather than the full `check`.
Examples:
`check 4`
`c webmode`
-- delete --
Syntax:
delete [bookmark id]
The delete command is used to remove the bookmark matching the bookmark id that is given to the command. The shorthand `d` may be used rather than the full `delete`.
Examples:
`delete 6`
`d 18`
-- help --
Syntax:
help
help [keyword]
If the help command is run without a further argument the user will be navigated to the Bombadillo gopher hole's 'Quick Start' page. To view local help files on a particular topic you may pass a relevant keyword to the command. The shorthand `?` may be used rather than the full `help`.
Examples:
`help`
`?`
`help commands`
`h general`
-- home --
Syntax:
home
Navigates to the url/document set by the 'homeurl' setting. The shorthand 'h' may be used rather than the full 'home'.
Examples:
`home`
`h`
-- purge --
Syntax:
purge *
purge [host name]
Purge is a command used specifically in relation to the gemini protocol. If you want to clear the TLS certificates on file for all gemini hosts you can pass a '*', otherwise pass the host whose certificate you want to clear. In general using purge is considered insecure and not recommended, but is provided as an option for users that want more control of their security choices. Once a certificate has been purged Bombadillo will automatically request a new certificate the next time that particular host is visited. The shorthand `p` may be used rather than the full `purge`.
Examples:
`purge *`
`p gemini.circumlunar.space`
-- quit --
Syntax:
quit
Quit does what it sounds like: it quits Bombadillo. This is the same as preseing the `q` key. The shorthand `q` may be used instead of the full `quit`.
Examples:
`quit`
`q`
-- reload --
Syntax:
reload
The reload command will reload the current page. This entails making a new request and replacing the current history location with the result of that request. The "hot" key `R` can be used to achieve the same result. The shorthand `r` may be used rather than the full `reload`.
Examples:
`reload`
-- search --
Syntax:
search
search [keywords...]
The search command queries you for search terms and submits a search to the search engine set by the 'searchengine' setting. If keywords are supplied then you will not be queried for keywords and the supplied keywords will instead be used for your search.
Examples:
`search`
`search bombadillo gopher client`
-- set --
Syntax:
set [setting name] [value]
The set command sets the value for a given configuration setting. The shorthand `s` can be used instead of the full `set`. To see the value of a setting, use the 'check' command.
Examples:
`set webmode lynx`
`s timeout 5`
-- write --
Syntax:
write [url]
write [link id]
write .
The write command will write a document to a local file at the location set by the configuration setting 'savelocation'. The write command accepts a url, a link id, or the character '.' (representing the current document). The shorthand `w` may be used rather than the full `write`.
Examples:
`write 2`
`w gopher://bombadillo.colorfield.space`
`w .`
________________________________
This concludes the help section brought up by the following keywords:
command, commands, functions
Other sections of the help document:
`help help`
`help general`
`help bookmarks`
`help navigation`
`help saving`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

59
help/finger.help Normal file
View File

@ -0,0 +1,59 @@
Finger Protocol
---------------------------
The finger protocol originated in the 1970s. It had a long period of usage and then had some serious security flaws found that lead to trouble. Since then the security issues have largely been patched up. Finger can be used to retrieve user and/or system information from a host.
Gnerally speaking, if a host supports the finger protocol you can often get a list of logged in users, uptime stats, or other information by just querying the host. Querying a user at the host will, if the user provides it, yield the contents of their ".plan" and/or ".project" files.
Some users and sysadmins get quite creative with what shows up on finger. Some are known to blog, have games, offer weird system stats (cpu temperature), etc.
-- URL Format --
The URL format in Bombadillo is as follows:
`finger://[user@][host][:port]`
The user section is optional, but if present must end in `@` (after the user's name). The host is required. The port is also optional, as a default finger port will be used if it is not included (this is fine for most use cases).
-- More Information About Finger --
- https://en.wikipedia.org/wiki/Finger_protocol
________________________________
This concludes the help section brought up by the following keywords:
finger
Other sections of the help document:
`help help`
`help general`
`help bookmarks`
`help navigation`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gopher`
`help gemini`
`help http`
`help telnet`
`help local`
`help resources`
`help license`

92
help/gemini.help Normal file
View File

@ -0,0 +1,92 @@
Gemini Protocol
---------------------------
Gemini is a recent internet protocol. As Bombadillo 2.0 was being developed its design was really just getting started and Bombadillo was an early adopter and Bombadillo developers were involved in the discussions around the creation of the protocol.
Bombadillo's implementation of the gemini protocol is centered around document retrieval, rather than applications. As such, client certificates were tested out but are deprecated in the client. Due to the terminal nature of Bombadillo and a desire to be simple and reliable headings, lists, and blockquotes are rendered literally in text/gemini documents.
-- Bombadillo Gemini Support --
Bombadillo supports:
- TLS for every connection to a gemini server
- A TOFU security model when interacting with servers
- Query fields (used for searching/interaction)
- Redirects
- Error messaging support (server errors, client errors, etc)
- Links for text/gemini documents
- Pre-formatted blocks for text/gemini documents (including alt text support)
- Support for relative links in text/gemini documents
Bombadillo does not support:
- Client certificates
- Special rendering for lists, headings, and blockquotes in text/gemini documents
- Special rendering here refers to font changes or similar
-- TLS / TOFU --
Bombadillo connects to all gemini servers via TLS. During the TLS connection handshake the server provides a certificate. If this is the first time you have visited this particular host then Bombadillo will save the certificate hash and its expiration automatically and connect you to the site. The next time you visit a document at that same host the certificate offered by the server will be compared to the one on file. If the one on file has expired then the new one will be accepted automatically. If the certificates differ and the one on file has not expired then you will receive an error message from Bombadillo letting you know that "no matching cert was found". Bombadillo will not connect to the site. This is for your protection and is intentional. It makes you make a choice: trust this new certificate or not. Most users will likely decide to trust the new certificate. To have Bombadillo trust the new certificate you must purge the old one.
To purge a certificate for the host example.com run the following Bombadillo command:
`purge example.com`
Now when you visit the site again it will accept the new certificate and file it away as the one to compare against.
For more info on the purge command, see `help commands`
Other reasons you may receive an error related to certificates:
- The server offers a certificate that is expired
- The server offers a certificate that is not yet valid
- The server offers a certificate with a hostname different than the one you are requesting
If any of the above occur you will be notified. A purge will not solve this problem. Bombadillo, for your safety, will not connect to a site that does not offer a valid TLS certificate. This is by design and will most certainly annoy you when it happens. For that we appologize.
-- More information about gemini --
- https://gemini.circumlunar.space/
- gemini://gemini.circumlunar.space/
________________________________
This concludes the help section brought up by the following keywords:
gemini, text/gemini, tls, tofu
Other sections of the help document:
`help help`
`help general`
`help bookmarks`
`help navigation`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

87
help/general.help Normal file
View File

@ -0,0 +1,87 @@
General Opperation
---------------------------
This help guide will walk you through starting Bombadillo, including the various flags/options avialable at startup. It will also cover quitting Bombadillo and a few other simple commands that are not covered elsewhere.
-- Starting Bombadillo --
If Bombadillo has been installed somewhere on your system path the starting Bombadillo can be done by opening a terminal and typing `bombadillo` at the prompt. Bombadillo should open up in the existing terminal window.
If Bombadillo is not on your system path you can either add it to the path and follow the above instructions, or you can navigate to the directory containing the Bombadillo executable and run it. For example, if I was the user "dave" and had the executable in my home folder I might run the following in my terminal's shell:
- `~/bombadillo`
- `cd && ./bombadillo`.
Users on Linux that support desktop files can also launch Bombadillo by clicking on the desktop icon (it may be found in a menu or launcher, depending on the system).
Bombadillo supports a few command line flags to modify its behavior at run time.
To see the command usage, you can run the following in your terminal's shell:
`bombadillo -h`
This will print out the available command line options, as well as the command syntax, and exit.
To see the version of Bombadillo you are using, you can run the following in your terminal's shell:
`bombadillo -v`
This will print out the version and build information, and exit.
The last command line flag will, for terminal's that support this, change the name of the tab or window that Bombadillo is running in to "Bombadillo". Not all terminals support this behavior, and some that do support it do not support removing it automatically. Most users will not need or want to use this flag, but some users that have a lot of terminal windows open might like to have the name as a reference, so this flag is made available. It can be run as follows:
`bombadillo -t`
The last item in this section is not a flag/option, but an argument. Bombadillo accepts a URL when it is invoked. This will cause Bombadillo to navigate directly to the given URL, rather than load your home page. This behavior can be combined with the `-t` flag, but not with the others.
Examples (run from your terminal's shell):
- `bombadillo bombadillo.colorfield.space`
- `bombadillo -t gopher://bombadillo.colorfield.space`
-- Exiting Bombadillo --
Exiting Bombadillo can be done four different ways. The simplest is to just press the "q" key. This will exit immediately. Alternatively you may use a command (and an abbreviated form of that command) to exit:
`quit`
`q`
Lastly, you can break out of the program by pressing "control" + "c" (while holding the "control" key, press the "c" key). This option should only be used if the program has frozen or you need to exit but the other three ways are not working.
________________________________
This concludes the help section brought up by the following keywords:
quit, quitting, q, flags, runtime, options, exit, exiting, general, startup, version, title
Other sections of the help document:
`help help`
`help navigation`
`help bookmarks`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

59
help/gopher.help Normal file
View File

@ -0,0 +1,59 @@
Gopher Protocol
---------------------------
From wikipedia:
"The Gopher protocol is a communications protocol designed for distributing, searching, and retrieving documents in Internet Protocol networks. The design of the Gopher protocol and user interface is menu-driven."
Gopher is, for most builds of Bombadillo, the default protocol that is used if no url scheme is provided and was the original protocol Bombadillo was built to support.
-- Bombadillo Gopher Support --
- Support for all item types, including telnet
- Search/query support
-- Gopher URL Structure --
A gopher URL has a slightly unique structure:
gopher://[host][:port]/[gopher-item-type][resource-path]
Note that the gophertype is not required for a server to return content, but is required for a client (like Bombadillo) to interpret it properly. The port is optional; Bombadillo will use port 70 if no other port is supplies.
________________________________
This concludes the help section brought up by the following keywords:
gopher
Other sections of the help document:
`help help`
`help general`
`help bookmarks`
`help navigation`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

84
help/help.help Normal file
View File

@ -0,0 +1,84 @@
Using This Guide
---------------------------
The Bombadilo help system is a collection of small "how to" documents about varying aspects of Bombadillo. Some include instructions on what keys to press to achieve certain actions or the syntax for various commands. Others are guides to the kinds of content you will find on the various protocols Bombadillo supports, as well as how Bombadillo interacts with them. Others still are small collections of guides on how certain features work (for example: quitting Bombadillo or writing content to a file).
-- Documentation Syntax --
While reading articles in this help guide you will come across words enclosed in back-ticks, like so: `add 13`. Anytime you see text between back-ticks it represents an actual command that you can run in Bombadillo or your terminal shell. A command will always be noted as a shell command if it is one. Otherwise, you can assume it is a command to be run inside of Bombadillo (see: `help commands`).
Key presses will be notated with double quotes. For example: "a", "B", "w". Keys that do not correspond to characters will be given by name, such as "tab", "space", or "control". Do note that "b" and "B" are different keys, with the later implying the combination of "shift" + "b" (or, if your "caps lock" is on, just "b").
Each page will end with a listing of the keywords that will bring up that page, when combined with the help command. A listing of other pages that can be viewed with the help command will also be included on each page.
-- The Help Command --
The help command can be run in two ways, with an argument and without:
`help [keyword]`
`help`
Running only the help command will load this page. When the help command is run with a keyword Bombadillo will attempt to find a page that can be identified by that keyword. All commands will have a page associated with them, as well as some other groupings of like items (commands, keys), and some pages talk about concepts (bookmarks, help, general). Most of the time just think of a single word that describes what you are looking, Bombadillo strives to make getting help intuitive.
-- Contents --
This is a listing of the available help sections (the keyword given below is the main keyword they are identified with, but many others also exist and are given at the bottom of each article).
1. help - This page
2. general - A guide to running and quitting Bombadillo
3. navigation - How to navigating within a single page, and between pages
4. saving - How to save documents
5. commands - A listing of the available commands and their syntax
6. keys - A listing of the available "hot" keys
7. search - How to use the default search engine
8. settings - How to configure Bombadillo to your liking
9. protocols - A top level guide to each protocol Bombadillo supports
10. gopher - Information about the gopher protocol
11. gemini - Information about the gemini protocol
12. http - Information about the HTTP & HTTPS protocols
13. finger - Information about the finger protocol
13. telnet - Information about the telnet protocol
14. local - Information about how Bombadillo handles local file browsing
15. resources - Places to get additional help or information
16. license - View the software license that Bombadillo is released under
________________________________
This concludes the help section brought up by the following keywords:
help, ?, info, information
Other sections of the help document:
`help general`
`help bookmarks`
`help navigation`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

98
help/keys.help Normal file
View File

@ -0,0 +1,98 @@
Bombadillo Key Bindings
---------------------------
This help page functions as an appendix to let you know the various key bindings avialable to you and their functions. This information is also avialable in your terminal's shell by running `man bombadillo`.
-- Navigating Within A Document --
`j` -> SCROLL DOWN one line in the current document
`k` -> SCROLL UP one line in the current document
`d` -> PAGE DOWN in the current document (3/4 page scroll)
`u` -> PAGE UP in the current document (3/4 page scroll)
`g` -> SCROLL TO TOP of the current document
`G` -> SCROLL TO TOP of the current document
-- Navigating Between Documents --
`h` or `b` -> BACK to previously viewed document
`l` or `f` -> FORWARD to next document
`R` -> RELOAD the current document
`0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, or `9`
-> VISIT a LINK in the current document corresponding to the pressed number (`0`, in this case, represents the link labeled "10")
-- Bookmarks --
`B` -> TOGGLE the BOOKMARKS bar in and out of VIEW
`TAB` -> TOGGLE the FOCUS between the document and the bookmarks bar
-- Search --
`/` -> INITIATE SEARCH in the current document (press `/` then type your query and press `enter` to search)
`n` -> Scroll to NEXT SEARCH result
`N` -> Scroll to PREVIOUS SEARCH
-- Other --
`:` or `space` -> INITIATE COMMAND MODE. See: `help commands` for more information on commands
`q` -> QUIT Bombadillo
________________________________
This concludes the help section brought up by the following keywords:
keys, key, hotkeys, hotkey, keymap, controls
Other sections of the help document:
`help help`
`help general`
`help bookmarks`
`help navigation`
`help saving`
`help commands`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

670
help/license.help Normal file
View File

@ -0,0 +1,670 @@
License
---------------------------
Bombadillo is released under the GNU GPL License and is open source software. At the time of this writing the source code is made available at:
https://tildegit.org/sloum/bombadillo
Bombadillo is primarily developed by sloum < sloum AT rawtext.club >, with much appreciated code and guidance by asdf, jboverf, cmccabe, makeworld, and dancek. As well as lots of folks who have made requests and turned in bug reports via the tildegit page.
-- GNU GPL 3 --
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
________________________________
This concludes the help section brought up by the following keywords:
license
Other sections of the help document:
`help help`
`help general`
`help navigation`
`help bookmarks`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`

51
help/local.help Normal file
View File

@ -0,0 +1,51 @@
Local protocol
---------------------------
The local protocol works very similarly to the 'file` protocol implemented in many modern web browsers. It allows you to view and navigate your files and filesystem.
-- Syntax / Usage --
When using the local protocol you should prefix the path you want with 'local://', so to view '/usr/local/bin' you would enter the following address into Bombadillo:
`local:///user/local/bin`
You may notice there is a third slash after 'local:', this represents the root directory and must be included in full paths.
Bombadillo's local protocol will also expand tildes for your home directory ('local://~').
Other than those things, navigation works like any other protocol, enter the link ID to navigate around folders or view files. When navigating to a folder the output will appear similar to running 'ls -la' in your shell. It will show hidden files and will output file permissions along with the file names. It does not, however, show file sizes.
________________________________
This concludes the help section brought up by the following keywords:
local, file
Other sections of the help document:
`help help`
`help general`
`help navigation`
`help bookmarks`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help resources`
`help license`

66
help/navigation.help Normal file
View File

@ -0,0 +1,66 @@
Navigation
---------------------------
Navigation in Bombadillo has two components: navigating within a single document and navigating between multiple documents. This guide will cover both.
-- Navigating Within a Document --
Scrolling up and down is accomplished with `k` and `j` respectively. These are so-called "hot" keys. You do not need to enter command mode to use them. `u` and `d` will page up and down. `g` will take you to the top of a document and `G` will take you to the bottom.
Those are the basics to moving around a single document. For more information on the available key bindings, use:
`help keys`
-- Navigating Between Multiple Documents --
You can navigate to an address for which you have a URL by entering command mode (type `:`) and then typing or pasting in the address and pressing the enter key to submit your command.
For protocols that have a concept of links (most of them), pages that have links will show link numbers on the left hand side of Bombadillo next to the text that describes that link. To follow a link enter command mode by typing `:`, followed by the link number and press the enter key to submit your command.
Bombadillo keeps a temporary 'history' of your navigation while you are browsing. This history is always cleared every time you exit Bombadillo and will hold at most 20 places in your browsing history for a session. To move backward and forward through your history press `b` and `f` respectively. The same can also be done with `h` and `l`. Moving backward and forward does not trigger a reload/refresh of the page data. If you are visiting a page that updates often you may want to press `R` to refresh the page when moving backward and forward through your history.
To navigate to a bookmarked page you will need the bookmark number. Once you have it you will want to enter command mode by typing `:` and entering `b ` and then the number, followed by the enter key. For example:
`:b 5`
For more information on using bookmarks please see:
`help bookmarks`
________________________________
This concludes the help section brought up by the following keywords:
navigation, scroll, scrolling, history, navigating, links, link
Other sections of the help document:
`help help`
`help general`
`help bookmarks`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

67
help/protocols.help Normal file
View File

@ -0,0 +1,67 @@
Protocols
---------------------------
Bombadillo supports the following protocols:
- gopher
- gemini
- finger
- local
With the help of outside software the following additional protocols are supported:
- telnet
- http
- https
Any terminal based telnet application can be used and can be set in your settings.
http(s) is supported by leveraging the rendering abilities of the following terminal based web browsers:
- lynx
- w3m
- elinks
Having any of the three available on your path and setting 'webmode' to the appropriate browser will allow you to view http(s) content inside of Bombadillo. To set your webmode, follow this example:
`set webmode lynx`
None (will not follow http(s) links at all) and gui are also viable settings. gui will attempt to open http(s) links in your default graphical web browser.
For more information on any given protocol please see their individual protocol help page(s) (see below).
________________________________
This concludes the help section brought up by the following keywords:
protocol, protocols
Other sections of the help document:
`help help`
`help general`
`help navigation`
`help bookmarks`
`help saving`
`help commands`
`help keys`
`help savin`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

54
help/resources.help Normal file
View File

@ -0,0 +1,54 @@
Resources
---------------------------
Additional help resources are available and can be found at the following locations:
gopher://bombadillo.colorfield.space
https://bombadillo.colorfield.space
Or in your shell:
`man bombadillo`
You can view the source code for Bombadillo as well:
https://tildegit.org/sloum/bombadillo
The README document in the source code repository linked above has detailed build and install instructions as well.
________________________________
This concludes the help section brought up by the following keywords:
resources, links
Other sections of the help document:
`help help`
`help general`
`help navigation`
`help bookmarks`
`help saving`
`help commands`
`help keys`
`help saving`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help license`

61
help/saving.help Normal file
View File

@ -0,0 +1,61 @@
Saving To File
---------------------------
Bombadillo is able to save your documents for you. In some cases it will try to do so automatically. Bombadillo will attempt to save any document it does not think it can display. For example, an executable file, a zip file, an image (if you have the setting "showimages" set to "false"), etc. In these cases Bombadillo will download the requested file to the path held in the setting "savelocation". This usually defaults to your home directory. For more information on the two settings mentioned above see:
`help settings`
There is not a 'save as' option, so all files will be saved as whatever their name is from the server. In the event that a file is loaded from a directory (an index.gmi file, or a gophermap, perhaps), the file will be saved as 'index'. In the event that there is already a file with the same name at your "savelocation" Bombadillo will add a number to the end of the filename (starting at 1 and going up as needed until it finds a name that does not yet exist). This way no files on your system get deleted accidentally.
-- The Write Command --
To write content to a file you will use the `write` command. The syntax is as follows:
- `write [url]`
- `write [link_id]`
- `write .`
In the first instance you pass the exact url to the file you would like to download. Bombadillo will download it directly without displaying its contents to you. The same goes for the second example, except instead of a URL you pass it the ID of a link found on the page you are currently viewing.
The third option works a little bit differently. You pass the character '.', which symbolizes your current location. Bombadillo will not redownload the content and will instead write the contents of its buffer to file. There should be no difference between the two ways of going about it, but it is good to know the difference anyway.
Examples:
- `write gopher://bombadillo.colorfield.space/I/images/screenshot1.png`
- `write 3`
- `write .`
________________________________
This concludes the help section brought up by the following keywords:
write, w, save, saving, file, writing, download, downloading, downloads
Other sections of the help document:
`help help`
`help general`
`help navigation`
`help bookmarks`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

0
help/settings.help Normal file
View File

49
help/telnet.help Normal file
View File

@ -0,0 +1,49 @@
Telnet Protocol
---------------------------
Telnet is a protocol for connecting to a remote server. Unlike ssh, this is not a secure connection. Bombadillo does not have a built-in telnet system but will reach out to the "telnet" application and use it to open telnet connections from inside of Bombadillo. For this feature to work a suitable program must be avialable on the system. For most users this will be "telnet", though Bombadillo does support using other applications via a user configurable setting (see `help settings`).
This proxying of responsibility to a remote program works pretty well, but in some cases has been known to provide buggy output.
-- Telnet URL Structure --
Generally speaking, the following structure will be the most common (though Bombadillo will support any structure that the underlying telnet application supports, so long as the scheme "telnet://" is included at the beginning):
telnet://[host][:port]
________________________________
This concludes the help section brought up by the following keywords:
telnet
Other sections of the help document:
`help help`
`help general`
`help bookmarks`
`help navigation`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help local`
`help resources`
`help license`