README.md (3066B)
1 # astro 2 3  4 > A Gemini web browser using shell script 5 6 7 ## Installing 8 9 There is an AUR package for archlinux users: 10 11 [](https://aur.archlinux.org/packages/astro) 12 [](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 certificates 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 - `u` go one path segment up 49 - `o` to open a new URL, you'll be prompted to type it 50 - `r` to reload the page 51 - `H` to go to the home page 52 - `g` to follow a link in the current page, a link will be displayed, and 53 - `s` to save the page to a file 54 - `m` to add the current page to bookmarks 55 - `M` to go to a bookmark 56 - `K` to delete the bookmark of the current page 57 - `q` to quit 58 59 More coming. 60 61 ### Configuration 62 63 You can setup a config file at `~/.config/astro/astro.conf` to configure *astro* the way you like. 64 65 The file uses a simple `key=value` style, see the complete example for the default values below. 66 67 **hints:** 68 * `astro` will be appended to `cachehome`, the directory must be writable for your user. 69 * The `style-` keys must be ANSI style codes. 70 71 ``` 72 margin=8 73 homepage="gemini.circumlunar.space/" 74 sty_header1='\033[35;7;1m' 75 sty_header2='\033[35;4;1m' 76 sty_header3='\033[35;4m' 77 sty_quote='\033[2;3m ' 78 sty_linkb='\033[35m' 79 sty_linkt=' => \033[36;3m ' 80 sty_listb='\033[35;1m •' 81 sty_listt='\033[0m' 82 ``` 83 84 ## Meta 85 86 This software is a work in progress and may not work as it is intended to. 87 88 89 ### Contributing 90 91 Please read the [contributing file](CONTRIBUTING.md). 92 93 94 ### Further works 95 96 - Better history 97 - Opening files 98 - Support input 99 100 101 ### Inspired by 102 103 - [gmi](https://sr.ht/~chambln/gmi/) 104 - [bollux](https://sr.ht/~acdw/bollux/) 105 106 107 ### Packaging 108 109 I'm not the maintainer of the AUR packages for this project, 110 thanks [guzzisti](https://aur.archlinux.org/account/guzzisti) for the contribution.