From 1c2e0af877923cf8f0ed3e046662837f3fb6da35 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Tue, 29 Aug 2023 19:29:06 +0000 Subject: Doc templates Signed-off-by: Laurent Bercot --- doc/tipidee-config-preprocess.html | 65 ++++++++++++++++++++++++++++++++++++++ doc/tipidee-config.html | 52 ++++++++++++++++++++++++++++++ doc/tipideed.html | 60 +++++++++++++++++++++++++++++++++++ src/tipideed/tipideed.c | 2 +- 4 files changed, 178 insertions(+), 1 deletion(-) create mode 100644 doc/tipidee-config-preprocess.html create mode 100644 doc/tipidee-config.html create mode 100644 doc/tipideed.html 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 @@ + + + + + + tipidee: the tipidee-config-preprocess internal program + + + + + + +

+tipidee
+Software
+skarnet.org +

+ +

The `tipidee-config-preprocess` internal program

+ +

+ tipidee-config-preprocess is a tool that reads a line-based +configuration file like tipidee.conf +containing !include, !includedir and !included: +directives, and preprocesses it, replacing the lines where these directive +appear with the full contents of included files where appropriate. +

+ +

+ tipidee-config-preprocess is not supposed to be invoked +directly by the user. It is automatically invoked by the +tipidee-config program. +

+ +

Interface

+ +

+     tipidee-config-preprocess file
+

+ +

tipidee-config-preprocess reads file and +writes its contents to stdout.
If file contains a line starting with !included:, +this line is not printed.
If file contains a line starting with !include or +!includedir, this line is replaced with the contents of +appropriately included files.
tipidee-config-preprocess then exits 0.

+ +

+ TODO: write this page. +

+ +

Exit codes

+ +

Options

+ +

Detailed operation

+ +

Notes

+ + + 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 @@ + + + + + + tipidee: the tipidee-config program + + + + + + +

+tipidee
+Software
+skarnet.org +

+ +

The `tipidee-config` program

+ +

+ tipidee-config is a tool that compiles a text configuration file +into a binary cdb file that is used by the tipideed +web server. +

+ +

Interface

+ +

+     tipidee-config [ -i ifile ] [ -o ofile ]
+

+ +

tipidee-config reads the /etc/tipidee.conf +configuration file, parses it, and outputs a cdb file to /etc/tipidee.conf.cdb.
It then exits 0.

+ +

+ TODO: write this page. +

+ +

Exit codes

+ +

Options

+ +

Detailed operation

+ +

Notes

+ + + 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 @@ + + + + + + tipidee: the tipideed program + + + + + + +

+tipidee
+Software
+skarnet.org +

+ +

The `tipideed` program

+ +

+ tipideed is the binary that actually does what you want from +a web server package: it serves files over HTTP. +

+ +

Interface

+ +

+     tipideed [ -v verbosity ] [ -f cdbfile ] [ -d basedir ] [ -R ] [ -U ]
+

+ +

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.
tipideed only speaks plaintext HTTP. It supports HTTPS, but the TLS layer +must be handled upstream by a program such as +s6-tlsd.
tipideed stays alive until the client closes the connection or (in +HTTP 1.1) sends a request with a Connection: close header, or an error +occurs that makes it nonsensical to keep the connection open.
By default, the documents it serves must be in subdirectories of its +current working directory, one subdirectory for every domain it hosts.

+ +

+ TODO: write this page. +

+ +

Exit codes

+ +

Environment variables

+ +

Options

+ +

Detailed operation

+ +

Notes

+ + + 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 #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") -- cgit v1.2.3

The tipidee-config-preprocess internal program

Interface

Exit codes

Options

Detailed operation

Notes

The tipidee-config program

Interface

Exit codes

Options

Detailed operation

Notes

The tipideed program

Interface

Exit codes

Environment variables

Options

Detailed operation

Notes

The `tipidee-config-preprocess` internal program

The `tipidee-config` program

The `tipideed` program