aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorbptato <nincsnevem662@gmail.com>2024-07-13 19:54:39 +0200
committerbptato <nincsnevem662@gmail.com>2024-10-12 16:30:11 +0200
commit6087f759642cd747d03e43cc57da0a508ccc1d61 (patch)
tree3c3261e0d28fd72003e50623b64f80ce22a803ff /doc
parent47caa59e5d1455484c4e5b08f58177a1b2172f44 (diff)
downloadchawan-6087f759642cd747d03e43cc57da0a508ccc1d61.tar.gz
gmifetch: rewrite in Nim
This finally makes it possible to use socks5 for Gemini. Also slightly refactored the config, to make it easier to pass on the config dir. By the way, the known_hosts file is now stored in the config dir too. The adapter will try to move it to there from the old location.
Diffstat (limited to 'doc')
-rw-r--r--doc/localcgi.md2
-rw-r--r--doc/protocols.md23
2 files changed, 11 insertions, 14 deletions
diff --git a/doc/localcgi.md b/doc/localcgi.md
index bcf91e80..a266f2c4 100644
--- a/doc/localcgi.md
+++ b/doc/localcgi.md
@@ -133,6 +133,8 @@ Chawan sets the following environment variables:
returning an error.
* `HTTP_COOKIE=` if set, the Cookie header.
* `HTTP_REFERER=` if set, the Referer header.
+* `CHA_TMP_DIR=` directory used for storing temporary files.
+* `CHA_CONFIG_DIR=` location of the config file.
For requests originating from a urimethodmap rewrite, Chawan will also set
the parsed URL's parts as environment variables. Use of these is highly
diff --git a/doc/protocols.md b/doc/protocols.md
index 04f09c24..9fa07f06 100644
--- a/doc/protocols.md
+++ b/doc/protocols.md
@@ -71,9 +71,9 @@ covered by the Match field are ignored.
## Gopher
-Gopher is supported through the `adapter/protocol/gopher.nim` adapter.
-Gopher directories are passed as the `text/gopher` type, and
-`adapter/format/gopher.nim` takes care of converting this to HTML.
+Chawan supports the Gopher protocol through the gopher CGI program.
+Gopher directories are passed as the `text/gopher` type, and gopher2html
+takes care of converting this to HTML.
Gopher selector types are converted to MIME types when possible; note however,
that this is very limited, as most of them (like `s` sound, or `I` image)
@@ -83,19 +83,14 @@ case may end up with `application/octet-stream`.
## Gemini
-Chawan's gemini adapter (in `adapter/protocol/gmifetch.c`) is a C program. It
-requires OpenSSL to work.
+Chawan's Gemini adapter has been rewritten as a Nim program. It still requires
+OpenSSL to work.
-It still has some limitations:
+A limitation that remains is that the Gemini adapter does not support sites that
+require private key authentication.
-* It does not support proxies yet.
-* It does not support sites that require private key authentication.
-
-`adapter/format/gmi2html.nim` is its companion program to convert the
-`text/gemini` file format to HTML. Note that the gemtext specification insists
-on line breaks being visually significant, and forbids their collapsing onto
-a single line; gmi2html respects this. However, inline whitespace is still
-collapsed outside of preformatted blocks.
+gmi2html is its companion program to convert the `text/gemini` file format to
+HTML.
## Finger