1 # AV-98 2 3 This is a fork of the original [AV-98](https://tildegit.org/solderpunk/AV-98) 4 by Solderpunk. He's not very active in maintaining it anymore. 5 6 AV-98 is an experimental client for the 7 [Gemini protocol](https://gemini.circumlunar.space). It is derived from the 8 [gopher client VF-1](https://github.com/solderpunk/VF-1) by the same author. 9 AV-98 is "experimental" in the sense that it may occasionally extend or deviate 10 from the official Gemini specification for the purposes of, well, 11 experimentation. Despite this, it is expected to be stable enough for regular 12 daily use at the same time. 13 14 ## Dependencies 15 16 AV-98 has no "strict dependencies", i.e. it will run and work without anything 17 else beyond the Python standard library. However, it will "opportunistically 18 import" a few other libraries if they are available to offer an improved 19 experience. 20 21 * The [ansiwrap library](https://pypi.org/project/ansiwrap/) may result in 22 neater display of text which makes use of ANSI escape codes to control colour. 23 * The [cryptography library](https://pypi.org/project/cryptography/) will 24 provide a better and slightly more secure experience when using the default 25 TOFU certificate validation mode and is highly recommended. 26 27 ## Features 28 29 * TOFU or CA server certificate validation 30 * Extensive client certificate support if an `openssl` binary is available 31 * Ability to specify external handler programs for different MIME types 32 * Gopher proxy support (e.g. for use with 33 [Agena](https://tildegit.org/solderpunk/agena)) 34 * Advanced navigation tools like `tour` and `mark` (as per VF-1) 35 * Bookmarks 36 * IPv6 support 37 * Supports any character encoding recognised by Python 38 39 ## Lightning introduction 40 41 You use the `go` command to visit a URL, e.g. `go gemini.circumlunar.space`. 42 43 Links in Gemini documents are assigned numerical indices. Just type an index to 44 follow that link. 45 46 If a Gemini document is too long to fit on your screen, use the `less` command 47 to pipe it to the `less` pager. 48 49 Use the `help` command to learn about additional commands. 50 51 ## RC files 52 53 You can use an RC file to automatically run any sequence of valid AV-98 54 commands upon start up. This can be used to make settings controlled with the 55 `set` or `handler` commanders persistent. You can also put a `go` command in 56 your RC file to visit a "homepage" automatically on startup, or to pre-prepare 57 a `tour` of your favourite Gemini sites. 58 59 The RC file should be called `av98rc`. AV-98 will look for it first in 60 `~/.av98/` and second in `~/.config/av98/`. Note that either directory might 61 already exist even if you haven't created it manually, as AV-98 will, if 62 necessary, create the directory itself the first time you save a bookmark (the 63 bookmark file is saved in the same location). AV-98 will create 64 `~/.config/av98` only if `~/.config/` already exists on your system, otherwise 65 it will create `~/.av98/`.