Adds more help documentation
This commit is contained in:
parent
8baf53d32b
commit
55a31fa8df
|
@ -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`
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -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`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue