From 5e95d487982b9362b544139b98d1da55fa6ef78c Mon Sep 17 00:00:00 2001 From: PS Date: Sat, 7 Feb 2026 10:20:30 +0100 Subject: Add doc --- doc/service/user/.s6-svscan.html | 48 +++++++++++++++++++++++++ doc/service/user/goetia-runner.html | 36 +++++++++++++++++++ doc/service/user/goetia-shutdown.html | 67 +++++++++++++++++++++++++++++++++++ doc/service/user/s6-svscan-log.html | 39 ++++++++++++++++++++ 4 files changed, 190 insertions(+) create mode 100644 doc/service/user/.s6-svscan.html create mode 100644 doc/service/user/goetia-runner.html create mode 100644 doc/service/user/goetia-shutdown.html create mode 100644 doc/service/user/s6-svscan-log.html (limited to 'doc/service/user') diff --git a/doc/service/user/.s6-svscan.html b/doc/service/user/.s6-svscan.html new file mode 100644 index 0000000..c861e00 --- /dev/null +++ b/doc/service/user/.s6-svscan.html @@ -0,0 +1,48 @@ + + + + + + + user .s6-svscan + + + +

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

+ +

The user .s6-svscan directory

+ The .s6-svscan directory contains scripts + that are executed if + s6-svscan + receives a signal or exits. + In this case its main use is to properly shutdown the + user supervision tree + using: +

+ user-shutdown + upon receiving SIGTERM. +
+ Deleting the runtime directory + of the user supervision tree in the finish script. +

+ The .s6-svscan directory is easily overlooked, + do not forget to symlink/copy it! +

+ + diff --git a/doc/service/user/goetia-runner.html b/doc/service/user/goetia-runner.html new file mode 100644 index 0000000..1e6591c --- /dev/null +++ b/doc/service/user/goetia-runner.html @@ -0,0 +1,36 @@ + + + + + + + user goetia-runner + + + +

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

+ +

The user goetia-runner service

+ This service allows to hand of execution of a commandline to the + user supervision tree. + It is the "server side" counterpart to + user-run. + To achieve that, + goetia-runner makes user of + s6-ipcserver + and + s6-sudod. +

+ + diff --git a/doc/service/user/goetia-shutdown.html b/doc/service/user/goetia-shutdown.html new file mode 100644 index 0000000..5652923 --- /dev/null +++ b/doc/service/user/goetia-shutdown.html @@ -0,0 +1,67 @@ + + + + + + + user goetia-shutdown + + + +

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

+ +

The user goetia-shutdown service

+ The user goetia-shutdown service is used to tear down + user supervision trees. + Upon being started it: +

+ It reads the USER environment variable, + if it is empty it exits 100. +
+ It reads the USERTREE environment variable, + If it is empty it exits 100. +
+ It checks whether the subdirectory + ${USER}/${USERTREE} + of the + user runtime directory + exists. If not, meaning no user supervision tree is running, it exits 0. +
+ It makes all of its stdout and stderr go to the + s6-svscan-log + of the user supervision tree. +
+ It stops all services managed by + s6-rc. +
+ It sends SIGHUP to s6-svscan-log of the user supervision tree. + This is important, since s6-svscan will keep the fifo open, + waiting for s6-svscan-log to exit, which in turn waits for + EOF before exiting itself. + SIGHUP tells s6-svscan-log to immediatly exit. +
+ It tells + s6-svscan + to stop all remaining services and exit. +

+ + diff --git a/doc/service/user/s6-svscan-log.html b/doc/service/user/s6-svscan-log.html new file mode 100644 index 0000000..f434517 --- /dev/null +++ b/doc/service/user/s6-svscan-log.html @@ -0,0 +1,39 @@ + + + + + + + user s6-svscan-log + + + +

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

+ +

The user s6-svscan-log service

+ This service writes all messages + that arrive at the + s6-svscan + process, as well as the stdout + of s6-svscan itself to a directory of the logdir format + (see s6-log + and + logging directory). + This is + ${XDG_STATE_HOME}/log/uncaught-logs, + if ${XDG_STATE_HOME} is unset it defaults to + ${HOME}/.local/state/log/uncaught-logs +

+ + -- cgit v1.2.3