From 4a2abe7bf4c05db91093e4a2d29d27430316bc05 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Wed, 6 Mar 2024 12:29:36 +0000 Subject: Add ls.cgi, prepare for 0.0.4.0 Signed-off-by: Laurent Bercot --- doc/ls.cgi.html | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 doc/ls.cgi.html (limited to 'doc/ls.cgi.html') diff --git a/doc/ls.cgi.html b/doc/ls.cgi.html new file mode 100644 index 0000000..c864dfb --- /dev/null +++ b/doc/ls.cgi.html @@ -0,0 +1,64 @@ + + + + + + tipidee: the ls.cgi program + + + + + + +

+tipidee
+Software
+skarnet.org +

+ +

The `ls.cgi` internal program

+ +

+ ls.cgi is a binary that is suitable for using as a CGI script, +e.g. called index.cgi, +in a Web document hierarchy served by tipidee, when the goal of the index +file is only to list the contents of the directory it resides in. +

+ +

Interface

+ +

+     ls.cgi
+

+ +

It is not meant to be invoked by users. It will fail if invoked outside of a +CGI script context. As such, it is unexported (it will appear in libexecdir, +not in bindir).
It is meant to be placed in the repository of CGI scripts and symlinked as +index.cgi in the places where the URL of a directory should list the +contents of said directory.
For instance, if example.com:443/index.cgi is a copy of, or a +symlink to, ls.cgi, and the tipidee configuration says that this binary is meant +to be a CGI script, then access to https://example.com will list the files +available in the example.com:443/ directory.

+ +

Exit codes

+ +

0: success
100: wrong usage
111: system call failed

+ +

Notes

+ +

ls.cgi is very minimalistic. It provides no CSS or anything else than +the bare list of files. It is provided as an example of how CGI scripts can +work with tipidee.

+ + + -- cgit v1.2.3

The ls.cgi internal program

Interface

Exit codes

Notes

The `ls.cgi` internal program