From 5e95d487982b9362b544139b98d1da55fa6ef78c Mon Sep 17 00:00:00 2001 From: PS Date: Sat, 7 Feb 2026 10:20:30 +0100 Subject: Add doc --- doc/bin/system-ml.html | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 doc/bin/system-ml.html (limited to 'doc/bin/system-ml.html') diff --git a/doc/bin/system-ml.html b/doc/bin/system-ml.html new file mode 100644 index 0000000..bc487a9 --- /dev/null +++ b/doc/bin/system-ml.html @@ -0,0 +1,96 @@ + + + + + + + system-ml + + + +

+ goetia-base +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The system-ml program

+ system-ml automatically creates logging service + source directories + for longrun services in the + system configuration directory. + To create the logging service source directories, + system-ml uses + longrun-make internally. +

Interface

     system-ml

+ system-ml takes no arguments. +
+ It deletes the src/generated-logger subdirectory of the + system configuration directory. +
+ It scans the src subdirecotry of the + system configuration directory + for longrun services. +
+ It checks for each longrun it detects, + whether its source directory contains a file no-ml. + If this file exits, this longrun is skipped in the subsequent logger generation. +
+ It generates a logging service source directory at + src/generated-logger/@longrun@-log + in the system configuration directory. + It does so in parallel for each longrun @longrun@-srv it found. +

Exit codes

+ Since system-ml is an + execline + script, it exits with an approximation + of employed program that failed. +
+ system-ml mostly uses + execline + and + s6 + software, the exit behaviour of which can be looked up on + their respective pages. +
+ See also: + execline exit code handling. +

Options

+ There are no options to system-ml. +

Notes

+ The logger services created by this script + will drop privileges to + @loguser@, + which must exist at runtime. + (see log directory). +

+ + -- cgit v1.2.3