a POSIX shell compatible gemini client (mirror of
git clone
Log (Feed) | Files | Refs (Tags) | README | LICENSE

commit 631ce7063b1d748173d467115dc820fd19242728
parent 37c4304a019d5888cae2a58147986a58a7478f59
Author: blmayer <>
Date:   Fri,  1 Sep 2023 17:00:01 -0300

Added man page

Mastro | 13++++++++-----
Aastro.en.1 | 120+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 128 insertions(+), 5 deletions(-)

diff --git a/astro b/astro @@ -5,13 +5,18 @@ version="0.22.4" usage() { echo "astro v$version: Browse the gemini web on the terminal." echo "" - echo "Usage: astro [url]|[option]" + echo "Usage: astro [URL]|[OPTION]" echo "" echo "Options:" echo " -h, --help show this help" echo " -v, --version show version info" echo "" - echo "Commands available inside the browser:" + echo "Configuration:" + echo "You can setup a config file at `~/.config/astro/astro.conf` to configure *astro* the way you like." + echo "" + echo "Commands:" + echo "These are the default keybindings to use while running astro:" + echo "" echo " q quit" echo " g go to a link" echo " r reload current page" @@ -29,9 +34,6 @@ usage() { echo " astro url Start browsing url" echo " astro --help Show help" echo "" - echo "Debugging:" - echo " debug=1 astro Will start astro in debug mode" - echo "" echo "Report bugs to:" echo "Home page: <>" echo "General help: <>" @@ -39,6 +41,7 @@ usage() { version() { echo "astro $version" + echo "" echo "Copyright (C) 2021-2023 Brian Mayer." echo "License MIT: MIT License <>" echo "THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND," diff --git a/astro.en.1 b/astro.en.1 @@ -0,0 +1,120 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. +.TH ASTRO "1" "September 2023" "astro 0.22.4" "User Commands" +.SH NAME +astro \- manual page for astro 0.22.4 +.SH SYNOPSIS +.B astro +[\fI\,URL\/\fR]\fI\,|\/\fR[\fI\,OPTION\/\fR] +.SH DESCRIPTION +astro v0.22.4: Browse the gemini web on the 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 astro: +.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 +Astro uses 2 environment variables to help debugging and tracing its execution. +.TP +\fIdebug +To start astro in debug mode +.TP +\fItrace +To start astro with tracing activated +.SH NOTES +.SS Client certificates +.PP +\fBastro\fR can work with client certificates if capsules requires them for authentication. +\fBastro\fR allows a single client certificate per (sub)domain identified by it's name. If a client cert for a specific domain is available astro will send it to the server with every request. +When a resource requires a client cert and astro 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/astro/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/astro/astro.conf\fR to configure \fBastro\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="" +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' +.EE +.SH EXAMPLES +.TP +astro +Start browsing the default webpage +.TP +astro url +Start browsing url +.TP +astro \-\-help +Show help +.SH AUTHOR +Written by Brian Lee Mayer. +.SH "REPORTING BUGS" +Report bugs to: +Home page: <> +General help: <> +.SH COPYRIGHT +Copyright \(co 2021\-2023 Brian Mayer. +License MIT: MIT License <> +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 astro +is maintained as a Texinfo manual. If the +.B info +and +.B astro +programs are properly installed at your site, the command +.IP +.B info astro +.PP +should give you access to the complete manual.