202 lines
8.2 KiB
Groff
202 lines
8.2 KiB
Groff
." Text automatically generated by txt2man
|
|
.TH "bombadillo" 1 "21 SEP 2019" "" "General Opperation Manual"
|
|
.SH NAME
|
|
\fBbombadillo \fP- a non-web client
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.fam C
|
|
\fBbombadillo\fP [\fB-v\fP] [\fB-h\fP] [\fIurl\fP]
|
|
.fam T
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\fBbombadillo\fP is a terminal based client for a number of internet protocols, including gopher and gemini. \fBbombadillo\fP will also connect links to a user's default web browser or telnet client. Commands input is loosely based on Vi and Less and is comprised of two modes: key and line input mode.
|
|
.SH OPTIONS
|
|
.TP
|
|
.B
|
|
\fB-v\fP
|
|
Display the version number of \fBbombadillo\fP.
|
|
.TP
|
|
.B
|
|
\fB-h\fP
|
|
Usage help. Displays all command line options with a short description.
|
|
.SH COMMANDS
|
|
.SS KEY COMMANDS
|
|
These commands work as a single keypress anytime \fBbombadillo\fP is not taking in a line based command. This is the default command mode of \fBbombadillo\fP.
|
|
.TP
|
|
.B
|
|
b
|
|
Navigate back one place in your document history.
|
|
.TP
|
|
.B
|
|
B
|
|
Toggle the bookmarks panel open/closed.
|
|
.TP
|
|
.B
|
|
d
|
|
Scroll down an amount corresponding to 75% of your terminal window height in the current document.
|
|
.TP
|
|
.B
|
|
f
|
|
Navigate forward one place in your document history.
|
|
.TP
|
|
.B
|
|
g
|
|
Scroll to the top of the current document.
|
|
.TP
|
|
.B
|
|
G
|
|
Scroll to the bottom of the current document.
|
|
.TP
|
|
.B
|
|
j
|
|
Scroll down a single line in the current document.
|
|
.TP
|
|
.B
|
|
k
|
|
Scroll up a single line.
|
|
.TP
|
|
.B
|
|
q
|
|
Quit \fBbombadillo\fP.
|
|
.TP
|
|
.B
|
|
u
|
|
Scroll up an amount corresponding to 75% of your terminal window height in the current document.
|
|
.TP
|
|
.B
|
|
<tab>
|
|
Toggle the scroll focus between the bookmarks panel and the document panel. Only has an effect if the bookmarks panel is open.
|
|
.TP
|
|
.B
|
|
<spc>
|
|
Enter line command mode. Once a line command is input, the mode will automatically revert to key command mode.
|
|
.TP
|
|
.B
|
|
:
|
|
Alias for <space>. Enter line command mode.
|
|
.SS LINE COMMANDS
|
|
These commands are typed in by the user to perform an action of some sort. As listed in KEY COMMANDS, this mode is initiated by pressing : or <space>. The command names themselves are not case sensitive, though the arguments supplied to them may be.
|
|
.SS NAVIGATION
|
|
.TP
|
|
.B
|
|
[url]
|
|
Navigates to the requested url.
|
|
.TP
|
|
.B
|
|
[link id]
|
|
Follows a link on the current document with the given number.
|
|
.TP
|
|
.B
|
|
bookmarks [bookmark id]
|
|
Navigates to the url represented by the bookmark matching bookmark id. \fIb\fP can be entered, rather than the full \fIbookmarks\fP.
|
|
.TP
|
|
.B
|
|
home
|
|
Navigates to the document set by the \fIhomeurl\fP setting. \fIh\fP can be entered, rather than the full \fIhome\fP.
|
|
.TP
|
|
.B
|
|
search [keywords\.\.\.]
|
|
Submits a search to the search engine set by the \fIsearchengine\fP setting, with the query being the provided keyword(s).
|
|
.TP
|
|
.B
|
|
search
|
|
Queries the user for search terms and submits a search to the search engine set by the \fIsearchengine\fP setting.
|
|
.TP
|
|
.B
|
|
write [url]
|
|
Writes data from a given url to a file. The file is named by the last component of the url path. If the last component is blank or \fI/\fP a default name will be used. The file saves to the folder set by the \fIsavelocation\fP setting. \fIw\fP can be entered rather than the full \fIwrite\fP.
|
|
.TP
|
|
.B
|
|
write [url] [filename\.\.\.]
|
|
Writes data from a given url to a file. The file is named by the filename argument should should not include a leading \fI/\fP. The file saves to the folder set by the \fIsavelocation\fP setting. \fIw\fP can be entered rather than the full \fIwrite\fP.
|
|
.TP
|
|
.B
|
|
write [link id]]
|
|
Writes data from a given link id in the current document to a file. The file is named by the last component of the url path. If the last component is blank or \fI/\fP a default name will be used. The file saves to the folder set by the \fIsavelocation\fP setting. \fIw\fP can be entered rather than the full \fIwrite\fP.
|
|
.TP
|
|
.B
|
|
write [link id] [filename\.\.\.]
|
|
Writes data from a given link id in the current document to a file. The file is named by the filename argument should should not include a leading \fI/\fP. The file saves to the folder set by the \fIsavelocation\fP setting. \fIw\fP can be entered rather than the full \fIwrite\fP.
|
|
.TP
|
|
.B
|
|
write .
|
|
Writes the current document to a file. The file is named by the last component of the url path. If the last component is blank or \fI/\fP a default name will be used. The file saves to the folder set by the \fIsavelocation\fP setting. \fIw\fP can be entered rather than the full \fIwrite\fP.
|
|
.TP
|
|
.B
|
|
write . [filename\.\.\.]
|
|
Writes the current document to a file. The file is named by the filename argument should should not include a leading \fI/\fP. The file saves to the folder set by the \fIsavelocation\fP setting. \fIw\fP can be entered rather than the full \fIwrite\fP.
|
|
.TP
|
|
.B
|
|
help
|
|
Navigates to the gopher based help page for \fBbombadillo\fP. \fI?\fP can be used instead of the full \fIhelp\fP.
|
|
.SS BOOKMARKS
|
|
.TP
|
|
.B
|
|
bookmarks
|
|
Toggles the bookmarks panel open/closed. Alias for KEY COMMAND \fIB\fP. \fIb\fP can be used instead of the full \fIbookmarks\fP.
|
|
.TP
|
|
.B
|
|
add [url] [name\.\.\.]
|
|
Adds the url as a bookmarks labeled by name. \fIa\fP can be used instead of the full \fIadd\fP.
|
|
.TP
|
|
.B
|
|
add [link id] [name\.\.\.]
|
|
Adds the url represented by the link id within the current document as a bookmark labeled by name. \fIa\fP can be used instead of the full \fIadd\fP.
|
|
.TP
|
|
.B
|
|
add [.] [name\.\.\.]
|
|
Adds the current document's url as a bookmark labeled by name. \fIa\fP can be used instead of the full \fIadd\fP.
|
|
.TP
|
|
.B
|
|
delete [bookmark id]]
|
|
Deletes the bookmark matching the bookmark id. \fId\fP can be used instead of the full \fIdelete\fP.
|
|
.SS MISC
|
|
.TP
|
|
.B
|
|
check [link id]
|
|
Displays the url corresponding to a given link id for the current document. \fIc\fP can be used instead of the full \fIcheck\fP.
|
|
.TP
|
|
.B
|
|
check [setting name]
|
|
Displays the current value for a given configuration setting. \fIc\fP can be used instead of the full \fIcheck\fP.
|
|
.TP
|
|
.B
|
|
set [setting name]
|
|
Sets the value for a given configuration setting. \fIs\fP can be used instead of the full \fIset\fP.
|
|
.TP
|
|
.B
|
|
quit
|
|
Quits \fBbombadillo\fP. Alias for KEY COMMAND \fIq\fP. \fIq\fP can be used instead of the full \fIquit\fP.
|
|
.SH FILES
|
|
\fBbombadillo\fP keeps a hidden configuration file in a user's home directory. The file is a simplified ini file titled '.bombadillo.ini'. It is generated when a user first loads \fBbombadillo\fP and is updated with bookmarks and settings as a user adds them. The file can be directly edited, but it is best to use the SET command to update settings whenever possible. To return to the state of a fresh install, simply remove the file and a new one will be generated with the \fBbombadillo\fP defaults.
|
|
.SH SETTINGS
|
|
The following is a list of the settings that \fBbombadillo\fP recognizes, as well as a description of their valid values.
|
|
.TP
|
|
.B
|
|
homeurl
|
|
The url that \fBbombadillo\fP navigates to when the program loads or when the \fIhome\fP or \fIh\fP LINE COMMAND is issued. This should be a valid url. If a scheme/protocol is not included, gopher will be assumed.
|
|
.TP
|
|
.B
|
|
savelocation
|
|
The path to the folder that \fBbombadillo\fP should write files to. This should be a valid filepath for the system and should end in a \fI/\fP. Defaults to a user's home directory.
|
|
.TP
|
|
.B
|
|
searchengine
|
|
The url to use for the LINE COMMANDs \fI?\fP and \fIsearch\fP. Should be a valid search path that terms may be appended to. Defaults to \fIgopher://gopher.floodgap.com:70/7/v2/vs\fP.
|
|
.TP
|
|
.B
|
|
openhttp
|
|
Tells the client whether or not to try to follow web (http/https) links. If set to \fItrue\fP, \fBbombadillo\fP will try to open a user's default web browser to the link in question. Any value other than \fItrue\fP is considered false. Defaults to \fIfalse\fP.
|
|
.TP
|
|
.B
|
|
telnetcommand
|
|
Tells the client what command to use to start a telnet session. Should be a valid command, including any flags. The address being navigated to will be added to the end of the command. Defaults to \fItelnet\fP.
|
|
.TP
|
|
.B
|
|
theme
|
|
Can toggle between visual modes. Valid values are \fInormal\fP and \fIinverse\fP. When set to ivnerse, the terminal color mode is inversed. Defaults to \fInormal\fP.
|
|
.TP
|
|
.B
|
|
terminalonly
|
|
Sets whether or not to try to open non-text files served via gemini in gui programs or not. If set to \fItrue\fP, bombdaillo will only attempt to use terminal programs to open files. If set to anything else, \fBbombadillo\fP may choose graphical and terminal programs. Defaults to \fItrue\fP.
|