From d31250fc850b196d2b46b94c82f0538f4b79248c Mon Sep 17 00:00:00 2001 From: PS Date: Sat, 7 Feb 2026 10:38:55 +0100 Subject: Add doc --- doc/bin/system-init.html | 74 +++++++++ doc/bin/system-shutdown.html | 54 +++++++ doc/index.html | 192 ++++++++++++++++++++++++ doc/service/system/.s6-svscan.html | 38 +++++ doc/service/system/s6-linux-init-runleveld.html | 39 +++++ doc/service/system/s6-linux-init-shutdownd.html | 33 ++++ 6 files changed, 430 insertions(+) create mode 100644 doc/bin/system-init.html create mode 100644 doc/bin/system-shutdown.html create mode 100644 doc/index.html create mode 100644 doc/service/system/.s6-svscan.html create mode 100644 doc/service/system/s6-linux-init-runleveld.html create mode 100644 doc/service/system/s6-linux-init-shutdownd.html diff --git a/doc/bin/system-init.html b/doc/bin/system-init.html new file mode 100644 index 0000000..e0f1812 --- /dev/null +++ b/doc/bin/system-init.html @@ -0,0 +1,74 @@ + + + + + + + system-init + + + +

+ goetia-s6-linux-init +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The system-init program

+ system-init is a wrapper around + s6-linux-init. +

Interface

     system-init

+ system-init takes no arguments. +
It executes s6-linux-init with proper arguments to: +
- + Use the umask 0022. +
- + Use the config at /etc/s6-linux-init/goetia +
- + Use the PATH environment variable set to + /command:/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin:/usr/libexec:/usr/local/libexec. +
+

Exit codes

+ system-init does nothing more than starting + s6-linux-init + with arguments + and behaves exactly like it. +
+ 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..ae0904e --- /dev/null +++ b/doc/bin/system-shutdown.html @@ -0,0 +1,54 @@ + + + + + + + system-shutdown + + + +

+ goetia-s6-linux-init +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The system-shutdown program

+ system-shutdown is a wrapper around + s6-linux-init-shutdown. +

Interface

     system-shutdown ... see s6-linux-init-shutdown ...

+ see s6-linux-init-shutdown +

Options

+ see s6-linux-init-shutdown +

Exit codes

+ system-shutdown is a wrapper around + see s6-linux-init-shutdown + and behaves exactly like it. +
+ See also: + execline exit code handling. +

+ + diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..81e4e34 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,192 @@ + + + + + + + goetia-s6-linux-init + + + +

+ goetia +
+ Software +
+ 0x53.net +

+ +

goetia-s6-linux-init

What is it?

+ goetia-s6-linux-init contains a configuration for + s6-linux-init. + It also contains wrappers around some of s6-linux-inits commands + to make them fit the rest of goetia. + Finally, it contains service directories for some + s6-linux-init specific daemons. +

+ The configuration is used by copying + the s6-linux-init directory in the + installation directory + to /etc/s6-linux-init/goetia, + renaming the directory in the process. +

+ It is critical, + that some arguments given to ./configure + during the installation of + s6-linux-init + match those used in the goetia packages. + These are: +

+ --tmpfsdir=... which must be the same + in both the goetia packages and the s6-linux-init package. + The default is in both cases the same and can be left unchanged. + However, a change of this option in e.g. + goetia-base + mandates the exact same change of this option in s6-linux-init + and vice versa. +
+ --scandir=... of s6-linux-init + which must match + --sysrundir=... in goetia. + This is by default not given. + If the default of goetia packages is kept, + --scandir=system/service has to be used + for s6-linux-init. + In general setting --sysrundir=@sysrundir@ on + goetia packages means having to set + --scandir=@sysrundir@/service + on s6-linux-init. +

+ Additionally two things in respect to the + run-image subdirectory of the + system configuration directory + change for system supervision trees only. +

+ The run-image subdirectory lies now at + /etc/s6-linux-init/goetia/run-image + instead of + @sysconfdir@/system/run-image. +
+ When using s6-linux-init, the run-image is now + copied to @tmpfsdir@ instead of + @tmpfsdir@/@sysrundir@/system. + This has to be accomodated for by adding an additional system + subdirectory between the run-image and the service + directory. + To make it more clear: this results in: + /etc/s6-linux-init/goetia/run-image/system/service/ + instead of + /etc/goetia/system/run-image/service/ + with goetia-linux-init. + Bear in mind that this has to be further corrected for every non standard + --sysrundir=... setting in the goetia packages. +

+ If all defaults are kept on the other geotia packages, + this means the following in practice: +

+ During the installation of s6-linux-init, run at least ./configure --scandir=system/service. +
+ Symlink or copy + service directories + to /etc/s6-linux-init/goetia/run-image/system/service/. +

Installation

Requirements

+ A set of POSIX tools as described in the general + requirements +
+ A POSIX-compliant implementation of make, or GNU make +
+ s6-linux-init +

Licensing

+ goetia-s6-linux-init is free software. It is available under the + ISC license. +

Download

+ Alternatively, you can checkout a copy of the + goetia-s6-linux-init git repository: +
```
git clone git://git.0x53.net/goetia-s6-linux-init
```
+

Compilation

+ See the enclosed INSTALL file for installation details. +

Reference

Commands

+ All of the following are + execline + scripts. +

+ system-init +
+ system-shutdown +

Service directories

+ Service directories specific to the Linux Kernel + and to this init system. +

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

+ goetia-s6-linux-init +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The system .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 system using system-shutdown + upon receiving certain signals. +

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

+ + diff --git a/doc/service/system/s6-linux-init-runleveld.html b/doc/service/system/s6-linux-init-runleveld.html new file mode 100644 index 0000000..bf3c287 --- /dev/null +++ b/doc/service/system/s6-linux-init-runleveld.html @@ -0,0 +1,39 @@ + + + + + + + s6-linux-init-runleveld + + + +

+ goetia-s6-linux-init +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The s6-linux-init-runleveld service

+ s6-linux-init-runleveld starts the daemon corresponding to + s6-linux-init-telinit. + It is very similar to + goetia-runner + (which corresponds to system-run). + s6-linux-init-runleveld can be used to start and stop bundles + (bundles replace a functionality historically called runlevels) + and have the corresponding + s6-rc + command executed from the supervision tree. + This makes the transition resilient to e.g. interface crashes + or the command itself stopping the interface it was executed from. +

+ + diff --git a/doc/service/system/s6-linux-init-shutdownd.html b/doc/service/system/s6-linux-init-shutdownd.html new file mode 100644 index 0000000..e198bb7 --- /dev/null +++ b/doc/service/system/s6-linux-init-shutdownd.html @@ -0,0 +1,33 @@ + + + + + + + s6-linux-init-shutdownd + + + +

+ goetia-s6-linux-init +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The s6-linux-init-shutdownd service

+ s6-linux-init-shutdownd is the service that starts + s6-linux-init-shutdownd. + This daemon, upon activation by + s6-linux-init-shutdown + (in goetia wrapped by system-shutdown), + runs the shutdown procedure. +

+ + -- cgit v1.2.3