astro

a POSIX shell compatible gemini client (mirror of https://github.com/blmayer/astro)
git clone https://git.clttr.info/astro.git
Log (Feed) | Files | Refs (Tags) | README | LICENSE

astro.en.1 (3119B)


      1 .TH ASTRO "1" "November 2023" "astro 0.25.1" "User Commands"
      2 .SH NAME
      3 astro \- A Gemini web browser using shell script
      4 .SH SYNOPSIS
      5 .B astro
      6 [\fI\,URL\/\fR]\fI\,|\/\fR[\fI\,OPTION\/\fR]
      7 .SH DESCRIPTION
      8 astro v0.25.1: Browse the gemini web on any POSIX compatible terminal.
      9 .SH OPTIONS
     10 .TP
     11 \fB\-h\fR, \fB\-\-help\fR
     12 show this help
     13 .TP
     14 \fB\-v\fR, \fB\-\-version\fR
     15 show version info
     16 .SH COMMANDS
     17 These are the default keybindings to use while running astro:
     18 .TP
     19 \fBq
     20 quit
     21 .TP
     22 \fBg
     23 go to a link
     24 .TP
     25 \fBr
     26 reload current page
     27 .TP
     28 \fBb
     29 go back one page
     30 .TP
     31 \fBu
     32 jump one path segment up
     33 .TP
     34 \fBo
     35 open an address
     36 .TP
     37 \fBs
     38 save current page
     39 .TP
     40 \fBH
     41 go to homepage
     42 .TP
     43 \fBm
     44 add bookmark
     45 .TP
     46 \fBM
     47 go to a bookmark
     48 .TP
     49 \fBK
     50 remove bookmark for current url
     51 .SH ENVIRONMENT
     52 Astro uses 2 environment variables to help debugging and tracing its execution.
     53 .TP
     54 \fIdebug
     55 To start astro in debug mode
     56 .TP
     57 \fItrace
     58 To start astro with tracing activated
     59 .SH NOTES
     60 .SS Client certificates
     61 .PP
     62 \fBastro\fR can work with client certificates if capsules requires them for authentication.
     63 \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.
     64 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.
     65 The certificates are stored in \fI$XDG_CONFIG_DIR/astro/certs/\fR.
     66 .PP
     67 To remove a certificate simply delete the \fI<domain>.crt\fR and \fI<domain>.key\fR files in the directory mentioned above.
     68 .SH CONFIGURATION
     69 You can setup a config file at \fI$XDG_CONFIG_DIR/astro/astro.conf\fR to configure \fBastro\fR the way you like.
     70 The file uses a simple \fBkey=value\fR style, see the complete example for the default values below.
     71 .PP
     72 .EX
     73 margin=8
     74 homepage="gemini.circumlunar.space/"
     75 sty_header1='\e033[35;7;1m'
     76 sty_header2='\e033[35;4;1m'
     77 sty_header3='\e033[35;4m'
     78 sty_quote='\e033[2;3m  '
     79 sty_linkb='\e033[35m'
     80 sty_linkt=' => \e033[36;3m '
     81 sty_listb='\e033[35;1m  •'
     82 sty_listt='\e033[0m'
     83 openkey='o'
     84 openlocalkey='O'
     85 gokey='g'
     86 refreshkey='r'
     87 backkey='b'
     88 quitkey='q'
     89 markkey='b'
     90 gomarkkey='M'
     91 delmarkkey='K'
     92 goupkey='u'
     93 homekey='H'
     94 .EE
     95 .SH EXAMPLES
     96 .TP
     97 astro
     98 Start browsing the default webpage
     99 .TP
    100 astro url
    101 Start browsing url
    102 .TP
    103 astro \-\-help
    104 Show help
    105 .SH AUTHOR
    106 Written by Brian Lee Mayer.
    107 .SH "REPORTING BUGS"
    108 Report bugs to: bleemayer@gmail.com
    109 .br
    110 Home page: <https://www.github.com/blmayer/astro/>
    111 .br
    112 General help: <https://www.github.com/blmayer/astro/wiki>
    113 .SH COPYRIGHT
    114 Copyright \(co 2021\-2023 Brian Mayer.
    115 License MIT: MIT License <https://opensource.org/licenses/MIT>
    116 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    117 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    118 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    119 .SH "SEE ALSO"
    120 The full documentation for
    121 .B astro
    122 is maintained as a Texinfo manual.  If the
    123 .B info
    124 and
    125 .B astro
    126 programs are properly installed at your site, the command
    127 .IP
    128 .B info astro
    129 .PP
    130 should give you access to the complete manual.