astro

fork of https://github.com/blmayer/astro
git clone git://git.clttr.info/astro.git
Log (Feed) | Files | Refs (Tags) | README | LICENSE

README.md (2961B)


      1 # astro
      2 
      3 ![print](https://github.com/blmayer/astro/blob/main/astro.png?raw=true)
      4 > A Gemini web browser using shell script
      5 
      6 
      7 ## Installing
      8 
      9 There is an AUR package for archlinux users:
     10 
     11 [![astro](https://img.shields.io/aur/version/astro?label=astro&logo=arch-linux)](https://aur.archlinux.org/packages/astro)
     12 [![astro-git](https://img.shields.io/aur/version/astro-git?label=astro-git&logo=arch-linux)](https://aur.archlinux.org/packages/astro-git)
     13 
     14 You can also move the file *astro* to a folder in your PATH variable, 
     15 or run `make install`, by default it will be installed into *~/.local/bin*.
     16 Use *PREFIX* to override the install location, e.g.
     17 
     18 
     19 
     20 
     21 ## Using
     22 
     23 Start browsing by running astro with an optional URL:
     24 
     25 `astro gemini://rawtext.club:1965/~sloum/spacewalk.gmi`
     26 
     27 you can omit the protocol and port:
     28 
     29 `astro rawtext.club/~sloum/spacewalk.gmi`
     30 
     31 no arguments takes you to *gemini.circumlunar.space*:
     32 
     33 `astro`
     34 
     35 ### Client certificates
     36 
     37 astro can work with client certificates if capsules requires them for authentication.
     38 
     39 astro 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.
     40 
     41 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 certicates are stored in `~/.config/astro/certs/`.
     42 
     43 To remove a certificate simply delete the `<domain>.crt` and `<domain>.key` files in the directory mentioned above.
     44 
     45 ### Key bindings
     46 
     47 - `b` to go back one page
     48 - `o` to open a new URL, you'll be prompted to type it
     49 - `r` to reload the page
     50 - `H` to go to the home page
     51 - `g` to follow a link in the current page, a link will be displayed, and
     52 - `s` to save the page to a file
     53 - `m` to add the current page to bookmarks
     54 - `M` to go to a bookmark
     55 - `q` to quit
     56 
     57 More coming.
     58 
     59 ### Configuration
     60 
     61 You can setup a config file at `~/.config/astro/astro.conf` to configure *astro* the way you like.
     62 
     63 The file uses a simple `key=value` style, see the complete example for the default values below.
     64 
     65 **hints:**
     66 * `astro` will be appended to `cachehome`, the directory must be writable for your user.
     67 * The `style-` keys must be ANSI style codes.
     68 
     69 ```
     70 cachehome=~/.cache/
     71 margin=8
     72 homepage=gemini.circumlunar.space
     73 style-header1=35;4;1
     74 style-header2=35;1
     75 style-header3=35;4
     76 style-quote=2;3
     77 style-link-bullet=33
     78 style-link-text=36;3
     79 style-list-bullet=35;1
     80 style-list-text=0
     81 ```
     82 
     83 ## Meta
     84 
     85 This software is a work in progress and may not work as it is intended to.
     86 
     87 
     88 ### Contributing
     89 
     90 Please read the [contributing file](CONTRIBUTING.md).
     91 
     92 
     93 ### Further works
     94 
     95 - Better history
     96 - Opening files
     97 - Support input
     98 
     99 
    100 ### Inspired by
    101 
    102 - [gmi](https://sr.ht/~chambln/gmi/)
    103 - [bollux](https://sr.ht/~acdw/bollux/)
    104 
    105 
    106 ### Packaging
    107 
    108 I'm not the maintainer of the AUR packages for this project,
    109 thanks [guzzisti](https://aur.archlinux.org/account/guzzisti) for the contribution.