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 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 doc/tipidee-config-preprocess.html (limited to 'doc/tipidee-config-preprocess.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