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/system/goetia-runner.html | 44 ++++++++++++++++++ doc/service/system/s6-svscan-log-console.html | 50 ++++++++++++++++++++ doc/service/system/s6-svscan-log.html | 37 +++++++++++++++ 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 ++++++++++++++++ 7 files changed, 321 insertions(+) create mode 100644 doc/service/system/goetia-runner.html create mode 100644 doc/service/system/s6-svscan-log-console.html create mode 100644 doc/service/system/s6-svscan-log.html 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') diff --git a/doc/service/system/goetia-runner.html b/doc/service/system/goetia-runner.html new file mode 100644 index 0000000..16abb52 --- /dev/null +++ b/doc/service/system/goetia-runner.html @@ -0,0 +1,44 @@ + + + + + + + system goetia-runner + + + +
+

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

+
+ +

The system goetia-runner service

+

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

+

+ An example would be the + system-rc + command invoking state transitions that might bring down + the user interface + (thus aborting mid-transition, + since the controlling terminal dies). +

+ + diff --git a/doc/service/system/s6-svscan-log-console.html b/doc/service/system/s6-svscan-log-console.html new file mode 100644 index 0000000..eff7b14 --- /dev/null +++ b/doc/service/system/s6-svscan-log-console.html @@ -0,0 +1,50 @@ + + + + + + + system s6-svscan-log-console + + + +
+

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

+
+ +

The system s6-svscan-log-console 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). + It writes them to the system/logs/uncaught-logs subdirectory + of the runtime directory. +

+

+ Additionally, all logs are duplicated to + /dev/console. +

+
+

Requirements

+ +
+ + diff --git a/doc/service/system/s6-svscan-log.html b/doc/service/system/s6-svscan-log.html new file mode 100644 index 0000000..9d034dc --- /dev/null +++ b/doc/service/system/s6-svscan-log.html @@ -0,0 +1,37 @@ + + + + + + + system s6-svscan-log + + + +
+

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

+
+ +

The system 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). + It writes them to the system/logs/uncaught-logs subdirectory + of the runtime directory. +

+ + 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: +

+ +

+ 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: +

+ + 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