From eb36640078ee6469427e85ca0695f8c920909ea0 Mon Sep 17 00:00:00 2001 From: PS Date: Sat, 7 Feb 2026 10:34:21 +0100 Subject: Add doc --- doc/bin/system-init.html | 132 +++++++++++++++++++++++++++++++++++++++++++ doc/bin/system-shutdown.html | 88 +++++++++++++++++++++++++++++ 2 files changed, 220 insertions(+) create mode 100644 doc/bin/system-init.html create mode 100644 doc/bin/system-shutdown.html (limited to 'doc/bin') diff --git a/doc/bin/system-init.html b/doc/bin/system-init.html new file mode 100644 index 0000000..f744d6a --- /dev/null +++ b/doc/bin/system-init.html @@ -0,0 +1,132 @@ + + + + + + + system-init + + + +

+ goetia-freebsd-init +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The system-init program

+ system-init is a minimal, scripted init to bring up a goetia based system. +

Interface

     system-init

+ system-init takes no arguments. +
+ It makes /dev/console its stdout and stderr. +
+ It reads the environment variable BUNDLE, + which can be specified on the Kernel command line. + If it is undefined, it uses default as the value. +
+ It reads the environment variable PATH, + which can be specified on the Kernel command line. + If it is undefined, it uses + /command:/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin:/usr/libexec:/usr/local/libexec + as the value. +
+ It sets the PATH environment variable to the value + chosen above. +
+ It chdirs to /. +
+ It runs s6-setsid + to become the session leader. +
+ It creates the + runtime directory + if it does not already exist. +
+ It mounts the + runtime directory + tmpfs. +
+ It copies the old system logs from the + system/uncaught-logs + subdirectory of the + log directory + to the + system/ + subdirectory of the + runtime directory + if they exist. +
+ It runs + prepare-svscan + with the proper arguments. +
+ Finally, it executes into + s6-svscan + on the scandir represented by the + system/service + subdirectory of the + runtime directory. +

Exit codes

+ system-init usually executes into + s6-svscan + which exits according to its page. +
+ Since system-init is an + execline + script, it exits with an approximation + of employed program that failed. +
+ system-init 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-init. +

Notes

+ system-init is primarily intended to be used + as an init for an acutal boot process, not for containers. +

+ + diff --git a/doc/bin/system-shutdown.html b/doc/bin/system-shutdown.html new file mode 100644 index 0000000..c20d0a1 --- /dev/null +++ b/doc/bin/system-shutdown.html @@ -0,0 +1,88 @@ + + + + + + + system-shutdown + + + +

+ goetia-freebsd-init +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The system-shutdown program

+ system-shutdown is the interface to the + system-shutdown-daemon. +

Interface

     system-shutdown -h | -p | -r

+ system-shutdown writes its argument to the file DIRECTIVE in the envdir at the + shutdown-directive subdirectory of the + system runtime directory. +
+ It continues to initiate the shutdown sequence by starting the service + goetia-shutdown. +

Options

+ -h: at the end of the shutdown sequence, halt the system. +
+ -p: at the end of the shutdown sequence, poweroff the system. +
+ -r: at the end of the shutdown sequence, reboot the system. +

Exit codes

+ system-shutdown exits 100 if wrong options were used. +
+ Since system-shutdown is an + execline + script, it exits with an approximation + of employed program that failed. +
+ system-shutdown 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. +

Notes

+ There is a reason this program exists as part of (multiple) + goetia-init packages and not as part of + goetia-base. + It is that some supported init systems, like + s6-linux-init + (through goetia-s6-linux-init) + provide their own shutdown procedure and interface. +

+ + -- cgit v1.2.3