Doc templates

Signed-off-by: Laurent Bercot <ska@appnovation.com>
author: Laurent Bercot <ska-skaware@skarnet.org> 2023-08-29 19:29:06 +0000
committer: Laurent Bercot <ska@appnovation.com> 2023-08-29 19:29:06 +0000
commit: 1c2e0af877923cf8f0ed3e046662837f3fb6da35 (patch)
tree: 71f8ecbb6e4e90b56a2b93b3f2a7e999c2d8c0c5
parent: df694a5987e58a1ec77ab809d83fcaf124da9d29 (diff)
download: tipidee-1c2e0af877923cf8f0ed3e046662837f3fb6da35.tar.xz
4 files changed, 178 insertions, 1 deletions
diff --git a/doc/tipidee-config-preprocess.html b/doc/tipidee-config-preprocess.html
new file mode 100644
index 0000000..86fb22e
--- /dev/null
+++ b/doc/tipidee-config-preprocess.html
@@ -0,0 +1,65 @@
+<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 tipidee-config-preprocess internal program</title>
+    <meta name="Description" content="tipidee: the tipidee-config-preprocess internal program" />
+    <meta name="Keywords" content="tipidee tipidee web server configuration text compilation preprocessing internal libexec preprocessor include" />
+    <!-- <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>tipidee-config-preprocess</tt> internal program </h1>
+
+<p>
+ <tt>tipidee-config-preprocess</tt> is a tool that reads a line-based
+configuration file like <a href="tipidee.conf.html">tipidee.conf</a>
+containing <tt>!include</tt>, <tt>!includedir</tt> and <tt>!included:</tt>
+directives, and preprocesses it, replacing the lines where these directive
+appear with the full contents of included files where appropriate.
+</p>
+
+<p>
+ <tt>tipidee-config-preprocess</tt> is not supposed to be invoked
+directly by the user. It is automatically invoked by the
+<a href="tipidee-config.html">tipidee-config</a> program.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+     tipidee-config-preprocess <em>file</em>
+</pre>
+
+<ul>
+ <li> tipidee-config-preprocess reads <em>file</em> and
+writes its contents to stdout. </li>
+ <li> If <em>file</em> contains a line starting with <tt>!included:</tt>,
+this line is not printed. </li>
+ <li> If <em>file</em> contains a line starting with <tt>!include</tt> or
+<tt>!includedir</tt>, this line is replaced with the contents of
+appropriately included files. </li>
+ <li> tipidee-config-preprocess then exits 0. </li>
+</ul>
+
+<p>
+ TODO: write this page.
+</p>
+
+<h2> Exit codes </h2>
+
+<h2> Options </h2>
+
+<h2> Detailed operation </h2>
+
+<h2> Notes </h2>
+
+</body>
+</html>
diff --git a/doc/tipidee-config.html b/doc/tipidee-config.html
new file mode 100644
index 0000000..d6a6f56
--- /dev/null
+++ b/doc/tipidee-config.html
@@ -0,0 +1,52 @@
+<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 tipidee-config program</title>
+    <meta name="Description" content="tipidee: the tipidee-config program" />
+    <meta name="Keywords" content="tipidee tipidee web server configuration text cdb file compilation cdbmake" />
+    <!-- <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>tipidee-config</tt> program </h1>
+
+<p>
+ <tt>tipidee-config</tt> is a tool that compiles a text configuration file
+into a binary cdb file that is used by the <a href="tipideed.html">tipideed</a>
+web server.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+     tipidee-config [ -i <em>ifile</em> ] [ -o <em>ofile</em> ]
+</pre>
+
+<ul>
+ <li> tipidee-config reads the <a href="tipidee.conf.html">/etc/tipidee.conf</a>
+configuration file, parses it, and outputs a cdb file to <tt>/etc/tipidee.conf.cdb</tt>. </li>
+ <li> It then exits 0. </li>
+</ul>
+
+<p>
+ TODO: write this page.
+</p>
+
+<h2> Exit codes </h2>
+
+<h2> Options </h2>
+
+<h2> Detailed operation </h2>
+
+<h2> Notes </h2>
+
+</body>
+</html>
diff --git a/doc/tipideed.html b/doc/tipideed.html
new file mode 100644
index 0000000..97102c5
--- /dev/null
+++ b/doc/tipideed.html
@@ -0,0 +1,60 @@
+<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 tipideed program</title>
+    <meta name="Description" content="tipidee: the tipideed program" />
+    <meta name="Keywords" content="tipidee tipideed web server serving http skarnet.org skarnet software httpd" />
+    <!-- <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>tipideed</tt> program </h1>
+
+<p>
+ <tt>tipideed</tt> is the binary that actually does what you want from
+a web server package: it serves files over HTTP.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+     tipideed [ -v <em>verbosity</em> ] [ -f <em>cdbfile</em> ] [ -d <em>basedir</em> ] [ -R ] [ -U ]
+</pre>
+
+<ul>
+ <li> tipideed reads a stream of HTTP (1.0 or 1.1) requests on its stdin, and tries
+to fulfill them, sending answers to stdout, and logs to stderr. </li>
+ <li> tipideed only speaks plaintext HTTP. It supports HTTPS, but the TLS layer
+must be handled upstream by a program such as
+<a href="//skarnet.org/software/s6-networking/s6-tlsd.html">s6-tlsd</a>. </li>
+ <li> tipideed stays alive until the client closes the connection or (in
+HTTP 1.1) sends a request with a <tt>Connection: close</tt> header, or an error
+occurs that makes it nonsensical to keep the connection open. </li>
+ <li> By default, the documents it serves must be in subdirectories of its
+current working directory, one subdirectory for every domain it hosts. </li>
+</ul>
+
+<p>
+ TODO: write this page.
+</p>
+
+<h2> Exit codes </h2>
+
+<h2> Environment variables </h2>
+
+<h2> Options </h2>
+
+<h2> Detailed operation </h2>
+
+<h2> Notes </h2>
+
+</body>
+</html>
diff --git a/src/tipideed/tipideed.c b/src/tipideed/tipideed.c
index f71be9f..0cc512c 100644
--- a/src/tipideed/tipideed.c
+++ b/src/tipideed/tipideed.c
@@ -26,7 +26,7 @@
 #include <tipidee/tipidee.h>
 #include "tipideed-internal.h"
 
-#define USAGE "tipideed [ -v verbosity ] [ -f conffile ] [ -R chroot ] [ -U ]"
+#define USAGE "tipideed [ -v verbosity ] [ -f cdbfile ] [ -d basedir ] [ -R ] [ -U ]"
 #define dieusage() strerr_dieusage(100, USAGE)
 #define dienomem() strerr_diefu1sys(111, "stralloc_catb")
author	Laurent Bercot <ska-skaware@skarnet.org>	2023-08-29 19:29:06 +0000
committer	Laurent Bercot <ska@appnovation.com>	2023-08-29 19:29:06 +0000
commit	1c2e0af877923cf8f0ed3e046662837f3fb6da35 (patch)
tree	71f8ecbb6e4e90b56a2b93b3f2a7e999c2d8c0c5
parent	df694a5987e58a1ec77ab809d83fcaf124da9d29 (diff)
download	tipidee-1c2e0af877923cf8f0ed3e046662837f3fb6da35.tar.xz