add an intro and fix a typo in the manpage - libgcgi - REST library for Gopher
HTML git clone git://bitreich.org/libgcgi git://hg6vgqziawt5s4dj.onion/libgcgi
DIR Log
DIR Files
DIR Refs
DIR Tags
DIR README
DIR LICENSE
---
DIR commit b3f118ffbf6488c5e8897be2fa8e225d5149c394
DIR parent 9dd4e7ace8205ca78f096674aa8f2129c790fbc9
HTML Author: Josuah Demangeon <me@josuah.net>
Date: Wed, 3 Aug 2022 20:08:34 +0200
add an intro and fix a typo in the manpage
Diffstat:
M README | 7 ++++++-
M libgcgi.3 | 10 +++++++++-
2 files changed, 15 insertions(+), 2 deletions(-)
---
DIR diff --git a/README b/README
@@ -41,6 +41,11 @@ SYNOPSIS
struct gcgi_var_list gcgi_gopher_query
DESCRIPTION
+ This library is a C wrapper around the geomyidae(8) new CGI interface,
+ which permits REST applications to be written for Gopher. In this mode,
+ geomyidae(8) directs all requests to a single binary in charge of
+ handling all paths, rather than trying to serve a file.
+
Request Handling
The central element of the library is an array of structures, using
appropriate handler depending on the query path.
@@ -51,7 +56,7 @@ DESCRIPTION
};
The glob is a string against which the path (everything in the query
- before the “”?) will be matched against.
+ before the “?”) will be matched against.
The fn function pointer will be called, with an array of matches passed
as argument. There are as many matches populated as there are “*” in
DIR diff --git a/libgcgi.3 b/libgcgi.3
@@ -42,6 +42,14 @@
.
.Sh DESCRIPTION
.
+This library is a C wrapper around the
+.Xr geomyidae 8
+new CGI interface, which permits REST applications to be written for Gopher.
+In this mode,
+.Xr geomyidae 8
+directs all requests to a single binary in charge of handling all paths,
+rather than trying to serve a file.
+.
.
.Ss Request Handling
.
@@ -59,7 +67,7 @@ struct gcgi_handler {
The
.Vt glob
is a string against which the path (everything in the query before the
-.Dq ? )
+.Dq "?" )
will be matched against.
.Pp
The