igeomyidae.8: improve man page formatting and some lint - geomyidae - A small C-based gopherd. Err bitreich.org 70 hgit clone git://bitreich.org/geomyidae/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/geomyidae/ URL:git://bitreich.org/geomyidae/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/geomyidae/ bitreich.org 70 1Log /scm/geomyidae/log.gph bitreich.org 70 1Files /scm/geomyidae/files.gph bitreich.org 70 1Refs /scm/geomyidae/refs.gph bitreich.org 70 1Tags /scm/geomyidae/tag bitreich.org 70 1README /scm/geomyidae/file/README.gph bitreich.org 70 1LICENSE /scm/geomyidae/file/LICENSE.gph bitreich.org 70 i--- Err bitreich.org 70 1commit ef96bd3ac67bd8a63756736a172fe34590d45ea5 /scm/geomyidae/commit/ef96bd3ac67bd8a63756736a172fe34590d45ea5.gph bitreich.org 70 1parent e03b02a1d3a3f7669d4bd88741def54dad981d59 /scm/geomyidae/commit/e03b02a1d3a3f7669d4bd88741def54dad981d59.gph bitreich.org 70 hAuthor: Hiltjo Posthuma URL:mailto:hiltjo@codemadness.org bitreich.org 70 iDate: Fri, 11 Nov 2022 10:45:11 +0100 Err bitreich.org 70 i Err bitreich.org 70 igeomyidae.8: improve man page formatting and some lint Err bitreich.org 70 i Err bitreich.org 70 i* Simplify and improve some nested sections. These are less portable according Err bitreich.org 70 i to the mandoc lint warning. Change .Dl or .D1 lines to a literal block. Err bitreich.org 70 i* Fix a few lines longer than 79 characters. Err bitreich.org 70 i* Fix some mandoc -Tlint warnings. Err bitreich.org 70 i* Remove an extra paragraph which added an extra line, this is an injustice. Err bitreich.org 70 i Err bitreich.org 70 iSigned-off-by: Christoph Lohmann <20h@r-36.net> Err bitreich.org 70 i Err bitreich.org 70 iDiffstat: Err bitreich.org 70 i M geomyidae.8 | 74 +++++++++++++++---------------- Err bitreich.org 70 i Err bitreich.org 70 i1 file changed, 36 insertions(+), 38 deletions(-) Err bitreich.org 70 i--- Err bitreich.org 70 1diff --git a/geomyidae.8 b/geomyidae.8 /scm/geomyidae/file/geomyidae.8.gph bitreich.org 70 i@@ -53,9 +53,8 @@ by default), then run the Err bitreich.org 70 i commands. The resulting executable should be run by root. Err bitreich.org 70 i .Ed Err bitreich.org 70 i . Err bitreich.org 70 i-.Ss Basic Installation and Startup: Err bitreich.org 70 i+.Ss Basic Installation and Startup Err bitreich.org 70 i .Bd -literal Err bitreich.org 70 i- Err bitreich.org 70 i $ wget ftp://bitreich.org/releases/geomyidae/geomyidae-$VERSION.tar.lz Err bitreich.org 70 i $ lzip -d geomyidae-$VERSION.tar.lz Err bitreich.org 70 i $ tar -xvf geomyidae-*.tar Err bitreich.org 70 i@@ -81,9 +80,9 @@ and Err bitreich.org 70 i values if set. See Err bitreich.org 70 i .Ic OPTIONS Err bitreich.org 70 i below for specifics. Launching geomyidae automatically is best done via a UNIX Err bitreich.org 70 i-run-time (rc.d) script; several sample rc.d scripts are included in the geomyidae Err bitreich.org 70 i-source archive. Logging in geomyidae can be done through either logfiles Err bitreich.org 70 i-or syslog. Err bitreich.org 70 i+run-time (rc.d) script; several sample rc.d scripts are included in the Err bitreich.org 70 i+geomyidae source archive. Logging in geomyidae can be done through either Err bitreich.org 70 i+logfiles or syslog. Err bitreich.org 70 i . Err bitreich.org 70 i .Sh OPTIONS Err bitreich.org 70 i geomyidae options and default settings: Err bitreich.org 70 i@@ -332,7 +331,6 @@ Search Veronica II Err bitreich.org 70 i Telnet to SDF Public Access Unix System Err bitreich.org 70 i .El Err bitreich.org 70 i .Sh DYNAMIC CONTENT (gopher CGI) Err bitreich.org 70 i-.Bd -filled Err bitreich.org 70 i There are two options provided for dynamic content creation: standard CGI ( Err bitreich.org 70 i .Ic .cgi Err bitreich.org 70 i ) and dynamic CGI Err bitreich.org 70 i@@ -347,15 +345,17 @@ the same user:group running geomyidae. Consequently, it is best to use Err bitreich.org 70 i the -u and -g server options to avoid running as root. Err bitreich.org 70 i .Pp Err bitreich.org 70 i Both .cgi and .dcgi scripts have the same argument call structure (as seen by geomyidae): Err bitreich.org 70 i-.Pp Err bitreich.org 70 i-.D1 executable.[d]cgi $search $arguments $host $port Err bitreich.org 70 i+.Bd -literal -offset indent Err bitreich.org 70 i+executable.[d]cgi $search $arguments $host $port Err bitreich.org 70 i+.Ed Err bitreich.org 70 i .Pp Err bitreich.org 70 i where Err bitreich.org 70 i-.Pp Err bitreich.org 70 i-.D1 search = query string (type 7) or Qo Qc (type 0) Err bitreich.org 70 i-.D1 arguments = string after Qo ? Qc in the path, the remaining path or Qo Qc Err bitreich.org 70 i-.D1 host = server's hostname ("localhost" by default) Err bitreich.org 70 i-.D1 port = server's port ("70" by default) Err bitreich.org 70 i+.Bd -literal -offset indent Err bitreich.org 70 i+search = query string (type 7) or "" (type 0) Err bitreich.org 70 i+arguments = string after "?" in the path, the remaining path or "" Err bitreich.org 70 i+host = server's hostname ("localhost" by default) Err bitreich.org 70 i+port = server's port ("70" by default) Err bitreich.org 70 i+.Ed Err bitreich.org 70 i .Pp Err bitreich.org 70 i All terms are tab-separated (per gopher protocol) which can cause some Err bitreich.org 70 i surprises depending on how a script is written. See the CGI file (included Err bitreich.org 70 i@@ -366,32 +366,31 @@ description. Err bitreich.org 70 i .Pp Err bitreich.org 70 i QUIRK: The original gopher client tried to be too intelligent. It is using Err bitreich.org 70 i gopher+ when you request some resource. When "search" is just the value "+", Err bitreich.org 70 i-"!", "$" or empty, geomyidae will display a gopher+ redirect instead of invoking the Err bitreich.org 70 i-script. Be careful to design your search script so the user is unlikely to Err bitreich.org 70 i-enter those values. The designers of gopher+ did not think of classic gopher Err bitreich.org 70 i-to survive. It survived gopher+. Err bitreich.org 70 i+"!", "$" or empty, geomyidae will display a gopher+ redirect instead of Err bitreich.org 70 i+invoking the script. Be careful to design your search script so the user is Err bitreich.org 70 i+unlikely to enter those values. The designers of gopher+ did not think of Err bitreich.org 70 i+classic gopher to survive. It survived gopher+. Err bitreich.org 70 i .Pp Err bitreich.org 70 i Additionally to the above arguments several environment variables are set. Err bitreich.org 70 i-.Pp Err bitreich.org 70 i-.Dl GATEWAY_INTERFACE = `CGI/1.1' Err bitreich.org 70 i-.Dl PATH_INFO = script which is executed Err bitreich.org 70 i-.Dl PATH_TRANSLATED = absolute path with script which is executed Err bitreich.org 70 i-.Dl QUERY_STRING = arguments (See above.) Err bitreich.org 70 i-.Dl SELECTOR = arguments (For backwards compatibility.) Err bitreich.org 70 i-.Dl REQUEST = arguments (For backwards compatibility.) Err bitreich.org 70 i-.Dl REMOTE_ADDR = IP of the client Err bitreich.org 70 i-.Dl REMOTE_HOST = REMOTE_ADDR Err bitreich.org 70 i-.Dl REQUEST_METHOD = `GET' Err bitreich.org 70 i-.Dl SCRIPT_NAME = script which is executed Err bitreich.org 70 i-.Dl SERVER_NAME = server's hostname Err bitreich.org 70 i-.Dl SERVER_PORT = server's port Err bitreich.org 70 i-.Dl SERVER_LISTEN_NAME = ip the server received the connection on Err bitreich.org 70 i-.Dl SERVER_PROTOCOL = `gopher/1.0' Err bitreich.org 70 i-.Dl SERVER_SOFTWARE = `geomyidae' Err bitreich.org 70 i-.Dl X_GOPHER_SEARCH = search (See above.) Err bitreich.org 70 i-.Dl SEARCHREQUEST = search (For backwards compatibility.) Err bitreich.org 70 i-.Dl HTTPS and GOPHERS = set, if TLS is used Err bitreich.org 70 i-.Pp Err bitreich.org 70 i+.Bd -literal -offset indent Err bitreich.org 70 i+GATEWAY_INTERFACE = `CGI/1.1' Err bitreich.org 70 i+PATH_INFO = script which is executed Err bitreich.org 70 i+PATH_TRANSLATED = absolute path with script which is executed Err bitreich.org 70 i+QUERY_STRING = arguments (See above.) Err bitreich.org 70 i+SELECTOR = arguments (For backwards compatibility.) Err bitreich.org 70 i+REQUEST = arguments (For backwards compatibility.) Err bitreich.org 70 i+REMOTE_ADDR = IP of the client Err bitreich.org 70 i+REMOTE_HOST = REMOTE_ADDR Err bitreich.org 70 i+REQUEST_METHOD = `GET' Err bitreich.org 70 i+SCRIPT_NAME = script which is executed Err bitreich.org 70 i+SERVER_NAME = server's hostname Err bitreich.org 70 i+SERVER_PORT = server's port Err bitreich.org 70 i+SERVER_LISTEN_NAME = ip the server received the connection on Err bitreich.org 70 i+SERVER_PROTOCOL = `gopher/1.0' Err bitreich.org 70 i+SERVER_SOFTWARE = `geomyidae' Err bitreich.org 70 i+X_GOPHER_SEARCH = search (See above.) Err bitreich.org 70 i+SEARCHREQUEST = search (For backwards compatibility.) Err bitreich.org 70 i+HTTPS and GOPHERS = set, if TLS is used Err bitreich.org 70 i .Ed Err bitreich.org 70 i . Err bitreich.org 70 i .Ss Some CGI Examples Err bitreich.org 70 i@@ -529,7 +528,6 @@ ex. - some common status entries: Err bitreich.org 70 i => web link redirect (Type h) Err bitreich.org 70 i .It Qo dir listing Qc Err bitreich.org 70 i => unindexed directory listing Err bitreich.org 70 i-.Pp Err bitreich.org 70 i .It Ic Err bitreich.org 70 i = full path to item served Err bitreich.org 70 i .Pp Err bitreich.org 70 .