The user-ml program
user-ml automatically creates logging service source directories for longrun services of the user configuration directory. To create the logging service source directories, user-ml uses longrun-make internally.
Interface
user-ml
- user-ml takes no arguments.
-
It reads the
USERenvironment variable, if it is empty it exits 100. -
It reads the
USERTREEenvironment variable, if it is empty it exits 100. -
It reads the
HOMEenvironment variable, if it is empty it exits 100. -
It deletes the
${USERTREE}/src/generated-loggersubdirectory of the user configuration subdirectory. -
It scans the
${USERTREE}/srcsubdirectory of the user configuration subdirectory 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
${USERTREE}/src/generated-logger/@longrun@-login parallel for each longrun@longrun@-srvit found in the user configuration subdirectory.
Exit codes
- 100 if a critical environment variable is missing.
- Since user-ml is an execline script, it exits with an approximation of employed program that failed.
- user-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 user-ml.
