Changes references to client to browser in manpage and readme

This commit is contained in:
sloumdrone 2019-11-13 20:01:27 -08:00 committed by asdf
parent 0281458763
commit e4324c6863
3 changed files with 12 additions and 12 deletions

View File

@ -1,8 +1,8 @@
# Bombadillo - a non-web client
# Bombadillo - a non-web browser
Bombadillo is a non-web client for the terminal.
Bombadillo is a non-web browser for the terminal.
![a screenshot of the bombadillo client](bombadillo-screenshot.png)
![a screenshot of the bombadillo browser](bombadillo-screenshot.png)
Bombadillo features a full terminal user interface, vim-like keybindings, document pager, configurable settings, and a robust command selection.
@ -115,7 +115,7 @@ Bombadillo development is largely handled by Sloum, with help from asdf, jboverf
There are many ways to contribute to Bombadillo, including a fair few that don't require knowledge of programming:
- Try out the client and let us know if you have a suggestion for improvement, or if you find a bug.
- Try out the browser and let us know if you have a suggestion for improvement, or if you find a bug.
- Read the documentation and let us know if something isn't well explained, or needs correction.
- Maybe you have a cool logo or some art that you think would look nice.

View File

@ -1,6 +1,6 @@
.TH "bombadillo" 1 "27 OCT 2019" "" "General Operation Manual"
.SH NAME
\fBbombadillo \fP- a non-web client
\fBbombadillo \fP- a non-web browser
.SH SYNOPSIS
.nf
.fam C
@ -9,7 +9,7 @@
.fam T
.fi
.SH DESCRIPTION
\fBbombadillo\fP is a non-web client for the terminal. It features a full terminal user interface, vim-like keybindings, document pager, configurable settings, and a robust command selection.
\fBbombadillo\fP is a non-web browser for the terminal. It features a full terminal user interface, vim-like keybindings, document pager, configurable settings, and a robust command selection.
.TP
\fBbombadillo\fP supports the following protocols as first class citizens: gopher, gemini, finger, and local (a users file system). Support for telnet, http and https is also available via integration with third party applications.
.SH OPTIONS
@ -30,7 +30,7 @@ Gopher is the default protocol for \fBbombadillo\fP. Any textual item types will
.TP
.B
gemini
Gemini is supported, but as a new protocol with an incomplete specification, features may change over time. At present Bombadillo supports TLS with a trust on first use certificate pinning system (similar to SSH). Client certificates are also supported as a configurable option. Gemini maps and other text types are rendered in the client and non-text types will be downloaded.
Gemini is supported, but as a new protocol with an incomplete specification, features may change over time. At present Bombadillo supports TLS with a trust on first use certificate pinning system (similar to SSH). Client certificates are also supported as a configurable option. Gemini maps and other text types are rendered in the browser and non-text types will be downloaded.
.TP
.B
finger
@ -46,11 +46,11 @@ Telnet is not supported directly, but addresses will be followed and opened as a
.TP
.B
http, https
Neither of the world wide web protocols are supported directly. However, \fBbombadillo\fP can open web links in a user's default web browser, or display web content directly in the client via the lynx web browser. Opening http/https links is opt-in only, controlled by the \fIopenhttp\fP setting.
Neither of the world wide web protocols are supported directly. However, \fBbombadillo\fP can open web links in a user's default web browser, or display web content directly in the browser via the lynx web browser. Opening http/https links is opt-in only, controlled by the \fIopenhttp\fP setting.
.IP
Opening links in a default web browser only works if a GUI environment is available.
.IP
Opening web content directly in the client requires the lynx web browser, and is enabled using the \fIlynxmode\fP setting. Web content is processed using lynx, and then displayed in the client.
Opening web content directly in the browser requires the lynx web browser, and is enabled using the \fIlynxmode\fP setting. Web content is processed using lynx, and then displayed in \fBbombadillo\fP.
.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.
@ -215,7 +215,7 @@ Sets whether or not to use lynx as a rendering engine for http/https requests, a
.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 these links in a user's default web browser, or render them via lynx, depending on the status of \fIlynxmode\fP and \fIterminalonly\fP settings. Valid values are \fItrue\fP and \fIfalse\fP.
Tells the browser whether or not to try to follow web (http/https) links. If set to \fItrue\fP, \fBbombadillo\fP will try to open these links in a user's default web browser, or render them via lynx, depending on the status of \fIlynxmode\fP and \fIterminalonly\fP settings. Valid values are \fItrue\fP and \fIfalse\fP.
.TP
.B
savelocation
@ -227,7 +227,7 @@ The url to use for the LINE COMMANDs \fI?\fP and \fIsearch\fP. Should be a valid
.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.
Tells the browser 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.
.TP
.B
terminalonly

View File

@ -168,7 +168,7 @@ func handleSignals(c <-chan os.Signal) {
//printHelp produces a nice display message when the --help flag is used
func printHelp() {
art := `Bombadillo - a non-web client
art := `Bombadillo - a non-web browser
Syntax: bombadillo [url]
bombadillo [options...]