diff options
| author | PS <p@0x53.net> | 2026-02-07 10:20:30 +0100 |
|---|---|---|
| committer | PS <p@0x53.net> | 2026-02-07 10:20:30 +0100 |
| commit | 5e95d487982b9362b544139b98d1da55fa6ef78c (patch) | |
| tree | 1abf6d91f9e6d0b6d0ac7b7d759663f2531eb51b /doc/bin/user-ml.html | |
| parent | f7df2f7bb6abbea365cccb1345dcf1a1b7a80797 (diff) | |
| download | goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.tar.gz goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.tar.bz2 goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.zip | |
Add doc
Diffstat (limited to 'doc/bin/user-ml.html')
| -rw-r--r-- | doc/bin/user-ml.html | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/doc/bin/user-ml.html b/doc/bin/user-ml.html new file mode 100644 index 0000000..d6d7e2e --- /dev/null +++ b/doc/bin/user-ml.html @@ -0,0 +1,104 @@ +<!DOCTYPE html> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Language" content="en" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>user-ml</title> + <meta name="Description" content="Script to autogenerate loggers for the user supervision tree." /> + <meta name="Description" content="A policy for s6 and s6-rc" /> + <meta name="Keywords" content="goetia longrun-make s6-rc logger log user supervision tree" /> + </head> + <header> + <p> + <a href="//0x53.net/software/goetia/goetia-base">goetia-base</a> + <br /> + <a href="//0x53.net/software/goetia">goetia</a> + <br /> + <a href="//0x53.net/software">Software</a> + <br /> + <a href="//0x53.net">0x53.net</a> + </p> + </header> + <body> + <h1>The user-ml program</h1> + <p> + user-ml automatically creates logging service + <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">source directories</a> + for longrun services of the + <a href="//0x53.net/software/goetia/confdir.html#user">user configuration directory</a>. + To create the logging service source directories, + user-ml uses + <a href="./longrun-make.html">longrun-make</a> internally. + </p> + <h2>Interface</h2> + <pre> user-ml</pre> + <ul> + <li> + user-ml takes no arguments. + </li> + <li> + It reads the <code>USER</code> environment variable, + if it is empty it exits 100. + </li> + <li> + It reads the <code>USERTREE</code> environment variable, + if it is empty it exits 100. + </li> + <li> + It reads the <code>HOME</code> environment variable, + if it is empty it exits 100. + </li> + <li> + It deletes the <code>${USERTREE}/src/generated-logger</code> subdirectory + of the <a href="//0x53.net/software/goetia/confdir.html#user">user configuration subdirectory</a>. + </li> + <li> + It scans the <code>${USERTREE}/src</code> subdirectory + of the <a href="//0x53.net/software/goetia/confdir.html#user">user configuration subdirectory</a> + for longrun services. + </li> + <li> + It checks for each longrun it detects, + whether its source directory contains a file <code>no-ml</code>. + If this file exits, this longrun is skipped in the subsequent logger generation. + </li> + <li> + It generates a logging service source directory + <code>${USERTREE}/src/generated-logger/<var>@longrun@</var>-log</code> + in parallel for each longrun <code><var>@longrun@</var>-srv</code> it found + in the <a href="//0x53.net/software/goetia/confdir.html#user">user configuration subdirectory</a>. + </li> + </ul> + <h2>Exit codes</h2> + <ul> + <li> + 100 if a critical environment variable is missing. + </li> + <li> + Since user-ml is an + <a href="https://skarnet.org/software/execline/">execline</a> + script, it exits with an approximation + of employed program that failed. + </li> + <li> + user-ml mostly uses + <a href="https://skarnet.org/software/execline/">execline</a> + and + <a href="https://skarnet.org/software/s6/">s6</a> + software, the exit behaviour of which can be looked up on + their respective pages. + </li> + <li> + See also: + <a href="https://skarnet.org/software/execline/exitcodes.html">execline exit code handling</a>. + </li> + </ul> + <h2>Options</h2> + <ul> + <li> + There are no options to user-ml. + </li> + </ul> + </body> +</html> |