ereandel.en.1

.TH EREANDEL "1" "November 2023" "ereandel 0.26.0" "User Commands"
.SH NAME
ereandel \- A Gemini web browser using shell script
.SH SYNOPSIS
.B ereandel
[\fI\,URL\/\fR]\fI\,|\/\fR[\fI\,OPTION\/\fR]
.SH DESCRIPTION
ereandel v0.26.0: Browse the gemini web on any POSIX compatible terminal.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help
.TP
\fB\-v\fR, \fB\-\-version\fR
show version info
.SH COMMANDS
These are the default keybindings to use while running ereandel:
.TP
\fBq
quit
.TP
\fBg
go to a link
.TP
\fBr
reload current page
.TP
\fBb
go back one page
.TP
\fBu
jump one path segment up
.TP
\fBo
open an address
.TP
\fBs
save current page
.TP
\fBH
go to homepage
.TP
\fBm
add bookmark
.TP
\fBM
go to a bookmark
.TP
\fBK
remove bookmark for current url
.SH ENVIRONMENT
Ereandel uses 2 environment variables to help debugging and tracing its execution.
.TP
\fIdebug
To start ereandel in debug mode
.TP
\fItrace
To start ereandel with tracing activated
.SH NOTES
.SS Client certificates
.PP
\fBereandel\fR can work with client certificates if capsules requires them for authentication.
\fBereandel\fR allows a single client certificate per (sub)domain identified by it's name. If a client cert for a specific domain is available ereandel will send it to the server with every request.
When a resource requires a client cert and ereandel can't find one it will show you a command to create a client cert for the capsule.
The certificates are stored in \fI$XDG_CONFIG_DIR/ereandel/certs/\fR.
.PP
To remove a certificate simply delete the \fI<domain>.crt\fR and \fI<domain>.key\fR files in the directory mentioned above.
.SH CONFIGURATION
You can setup a config file at \fI$XDG_CONFIG_DIR/ereandel/ereandel.conf\fR to configure \fBereandel\fR the way you like.
The file uses a simple \fBkey=value\fR style, see the complete example for the default values below.
.PP
.EX
margin=8
homepage="gemini.circumlunar.space/"
sty_header1='\e033[35;7;1m'
sty_header2='\e033[35;4;1m'
sty_header3='\e033[35;4m'
sty_quote='\e033[2;3m  '
sty_linkb='\e033[35m'
sty_linkt=' => \e033[36;3m '
sty_listb='\e033[35;1m  •'
sty_listt='\e033[0m'
openkey='o'
openlocalkey='O'
gokey='g'
refreshkey='r'
backkey='b'
quitkey='q'
markkey='b'
gomarkkey='M'
delmarkkey='K'
goupkey='u'
homekey='H'
.EE
.SH EXAMPLES
.TP
ereandel
Start browsing the default webpage
.TP
ereandel url
Start browsing url
.TP
ereandel \-\-help
Show help
.SH AUTHOR
Written by Brian Lee Mayer.
.SH "REPORTING BUGS"
Report bugs to: bleemayer@gmail.com
.br
Home page: <https://www.github.com/blmayer/ereandel/>
.br
General help: <https://www.github.com/blmayer/ereandel/wiki>
.SH COPYRIGHT
Copyright \(co 2021\-2023 Brian Mayer.
License MIT: MIT License <https://opensource.org/licenses/MIT>
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
.SH "SEE ALSO"
The full documentation for
.B ereandel
is maintained as a Texinfo manual.  If the
.B info
and
.B ereandel
programs are properly installed at your site, the command
.IP
.B info ereandel
.PP
should give you access to the complete manual.