aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html7
-rw-r--r--doc/ls.cgi.html64
-rw-r--r--doc/upgrade.html14
3 files changed, 80 insertions, 5 deletions
diff --git a/doc/index.html b/doc/index.html
index 2aef76b..0557d6f 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -111,11 +111,11 @@ make it shorter. Just like the code.
<li> A POSIX-compliant system with a standard C development environment </li>
<li> GNU make, version 3.81 or later </li>
<li> <a href="//skarnet.org/software/skalibs/">skalibs</a> version
-2.14.1.0 or later. It's a build-time requirement. It's also a run-time
+2.14.1.1 or later. It's a build-time requirement. It's also a run-time
requirement if you link against the shared version of the skalibs
library. </li>
<li> Recommended at run-time: <a href="//skarnet.org/software/s6-networking/">s6-networking</a> version
-2.7.0.1 or later. It's not a strict requirement, but tipidee relies on a super-server such as
+2.7.0.2 or later. It's not a strict requirement, but tipidee relies on a super-server such as
<a href="//skarnet.org/software/s6-networking/s6-tcpserver.html">s6-tcpserver</a>
to listen to the network and provide connection
information via environment variables. It also defers to tools such as
@@ -143,7 +143,7 @@ Don't take my word for it; try it out for yourself. </li>
<ul>
<li> The current released version of tipidee is
-<a href="tipidee-0.0.3.0.tar.gz">0.0.3.0</a>. </li>
+<a href="tipidee-0.0.4.0.tar.gz">0.0.4.0</a>. </li>
<li> You can checkout a copy of the
<a href="//git.skarnet.org/cgi-bin/cgit.cgi/tipidee/">tipidee
git repository</a>:
@@ -181,6 +181,7 @@ the previous versions of tipidee and the current one. </li>
<ul>
<li><a href="tipidee-config-preprocess.html">The <tt>tipidee-config-preprocess</tt> internal program</a></li>
+<li><a href="ls.cgi.html">The <tt>ls.cgi</tt> internal program</a></li>
</ul>
<h3> Configuration format </h3>
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 @@
+<html>
+ <head>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>tipidee: the ls.cgi program</title>
+ <meta name="Description" content="tipidee: the ls.cgi internal program" />
+ <meta name="Keywords" content="tipidee ls.cgi index index.cgi listing directory cgi http" />
+ <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">tipidee</a><br />
+<a href="//skarnet.org/software/">Software</a><br />
+<a href="//skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>ls.cgi</tt> internal program </h1>
+
+<p>
+ <tt>ls.cgi</tt> is a binary that is suitable for using as a CGI script,
+e.g. called <tt>index.cgi</tt>,
+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.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+ ls.cgi
+</pre>
+
+<ul>
+ <li> 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 <tt>libexecdir</tt>,
+not in <tt>bindir</tt>). </li>
+ <li> It is meant to be placed in the repository of CGI scripts and symlinked as
+<tt>index.cgi</tt> in the places where the URL of a directory should list the
+contents of said directory. </li>
+ <li> For instance, if <tt>example.com:443/index.cgi</tt> 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 <tt>https://example.com</tt> will list the files
+available in the <tt>example.com:443/</tt> directory. </li>
+</ul>
+
+<h2> Exit codes </h2>
+
+<dl>
+ <dt> 0 </dt> <dd> success </dd>
+ <dt> 100 </dt> <dd> wrong usage </dd>
+ <dt> 111 </dt> <dd> system call failed </dd>
+</dl>
+
+<h2> Notes </h2>
+
+<ul>
+ <li> 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. </li>
+</ul>
+
+</body>
+</html>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index f2a6880..b7a7d29 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,7 +18,17 @@
<h1> What has changed in tipidee </h1>
-<h2> in.0.0.3.0 </h2>
+<h2> in 0.0.4.0 </h2>
+
+<ul>
+ <li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
+dependency bumped to 2.14.1.1 </li>
+ <li> <a href="//skarnet.org/software/s6-networking/">s6-networking</a>
+recommendation bumped to 2.7.0.2 </li>
+ <li> New <a href="ls.cgi.html">ls.cgi</a> binary </li>
+</ul>
+
+<h2> in 0.0.3.0 </h2>
<ul>
<li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
@@ -28,7 +38,7 @@ recommendation bumped to 2.7.0.1 </li>
<li> New <tt>global XXX_no_translate</tt> configuration directive. </li>
</ul>
-<h2> in.0.0.2.0 </h2>
+<h2> in 0.0.2.0 </h2>
<ul>
<li> <a href="//skarnet.org/software/skalibs/">skalibs</a>