From 5e95d487982b9362b544139b98d1da55fa6ef78c Mon Sep 17 00:00:00 2001 From: PS Date: Sat, 7 Feb 2026 10:20:30 +0100 Subject: Add doc --- doc/bin/compile-db.html | 98 +++++++++++++++++++++++++ doc/bin/longrun-make.html | 141 ++++++++++++++++++++++++++++++++++++ doc/bin/oneshot-make.html | 101 ++++++++++++++++++++++++++ doc/bin/prepare-svscan.html | 120 ++++++++++++++++++++++++++++++ doc/bin/system-db.html | 67 +++++++++++++++++ doc/bin/system-ml.html | 96 ++++++++++++++++++++++++ doc/bin/system-rc.html | 63 ++++++++++++++++ doc/bin/system-run.html | 67 +++++++++++++++++ doc/bin/system-shutdown-daemon.html | 123 +++++++++++++++++++++++++++++++ doc/bin/user-db.html | 82 +++++++++++++++++++++ doc/bin/user-init.html | 128 ++++++++++++++++++++++++++++++++ doc/bin/user-ml.html | 104 ++++++++++++++++++++++++++ doc/bin/user-rc.html | 74 +++++++++++++++++++ doc/bin/user-run.html | 78 ++++++++++++++++++++ doc/bin/user-shutdown.html | 68 +++++++++++++++++ doc/bin/user-tmpfs.html | 104 ++++++++++++++++++++++++++ 16 files changed, 1514 insertions(+) create mode 100644 doc/bin/compile-db.html create mode 100644 doc/bin/longrun-make.html create mode 100644 doc/bin/oneshot-make.html create mode 100644 doc/bin/prepare-svscan.html create mode 100644 doc/bin/system-db.html create mode 100644 doc/bin/system-ml.html create mode 100644 doc/bin/system-rc.html create mode 100644 doc/bin/system-run.html create mode 100644 doc/bin/system-shutdown-daemon.html create mode 100644 doc/bin/user-db.html create mode 100644 doc/bin/user-init.html create mode 100644 doc/bin/user-ml.html create mode 100644 doc/bin/user-rc.html create mode 100644 doc/bin/user-run.html create mode 100644 doc/bin/user-shutdown.html create mode 100644 doc/bin/user-tmpfs.html (limited to 'doc/bin') diff --git a/doc/bin/compile-db.html b/doc/bin/compile-db.html new file mode 100644 index 0000000..c0ed957 --- /dev/null +++ b/doc/bin/compile-db.html @@ -0,0 +1,98 @@ + + + + + + + compile-db + + + +
+

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

+
+ +

The compile-db program

+

+ compile-db is a helper script for use by other software + that compiles a general confdir + tries to use the result to update a general + livedir. +

+

Interface

+
     compile-db confdir livedir
+ +

Exit codes

+ +

Options

+ + + diff --git a/doc/bin/longrun-make.html b/doc/bin/longrun-make.html new file mode 100644 index 0000000..0c5d8c4 --- /dev/null +++ b/doc/bin/longrun-make.html @@ -0,0 +1,141 @@ + + + + + + + longrun-make + + + +
+

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

+
+ +

The longrun-make program

+

+ longrun-make contains boilerplate code + required to create the + source directory + of a longrun service + based on strings. +

+

Interface

+
     longrun-make workingdir name type script dependencies
+ +

+ longrun-make is, by means of locking and checking for duplicates, + specifically designed to allow parallel creation of logging + source directories. +

+

Exit codes

+ +

Options

+ + + diff --git a/doc/bin/oneshot-make.html b/doc/bin/oneshot-make.html new file mode 100644 index 0000000..1b285c6 --- /dev/null +++ b/doc/bin/oneshot-make.html @@ -0,0 +1,101 @@ + + + + + + + oneshot-make + + + +
+

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

+
+ +

The oneshot-make program

+

+ oneshot-make contains boilerplate code + required to create the + source directory + of a oneshot service + based on strings. +

+

Interface

+
     oneshot-make workingdir name upscript downscript dependencies
+ +

Exit codes

+ +

Options

+ + + diff --git a/doc/bin/prepare-svscan.html b/doc/bin/prepare-svscan.html new file mode 100644 index 0000000..6b82bd5 --- /dev/null +++ b/doc/bin/prepare-svscan.html @@ -0,0 +1,120 @@ + + + + + + + prepare-svscan + + + +
+

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

+
+ +

The prepare-svscan program

+

+ prepare-svscan does generic preparation of the + supervision tree. + It is also used in system-init and + user-init. +

+

Interface

+
     prepare-svscan workingdir rundir bundle prog...
+ +

+ Once s6-svscan is launched it will start an + s6-supervise + process on rundir/service/s6-svscan-log which starts + s6-log reading + from rundir/service/s6-svscan-log/fifo. + This in turn triggers the forked background process to continue with its second step. +

+

Exit codes

+ +

Options

+ + + diff --git a/doc/bin/system-db.html b/doc/bin/system-db.html new file mode 100644 index 0000000..056f5b7 --- /dev/null +++ b/doc/bin/system-db.html @@ -0,0 +1,67 @@ + + + + + + + system-db + + + +
+

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

+
+ +

The system-db program

+

+ system-db compiles the + source directories + of the + system configuration directory + into the compiled format. + This format can then be used by init and + system-rc + to set up and control a + system supervision tree. +

+

+ system-db is a wrapper around the more general + compile-db + making it target the system supervision tree. +

+

Interface

+
     system-db
+ +

Exit codes

+ +

Options

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

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

+
+ +

The system-ml program

+

+ system-ml automatically creates logging service + source directories + for longrun services in the + system configuration directory. + To create the logging service source directories, + system-ml uses + longrun-make internally. +

+

Interface

+
     system-ml
+ +

Exit codes

+ +

Options

+ +

Notes

+

+ The logger services created by this script + will drop privileges to + @loguser@, + which must exist at runtime. + (see log directory). +

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

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

+
+ +

The system-rc program

+

+ system-rc is a thin convenience wrapper around + s6-rc + doing nothing more then pointing it to the right livedir. +

+

+ Read the page of + s6-rc + to understand what this utility does. +

+

Interface

+
     system-rc ... see s6-rc ...
+ +

Exit codes

+ +

Options

+ + + diff --git a/doc/bin/system-run.html b/doc/bin/system-run.html new file mode 100644 index 0000000..465cee4 --- /dev/null +++ b/doc/bin/system-run.html @@ -0,0 +1,67 @@ + + + + + + + system-run + + + +
+

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

+
+ +

The system-run program

+

+ system-run allows + to hand over the execution of commands to the + system supervision tree. +

+

Interface

+
     system-run prog...
+ +

Exit codes

+ +

Options

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

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

+
+ +

The system-shutdown-daemon program

+

+ system-shutdown-daemon contains the Kernel independent + part of the shutdown sequence. + It is invoked by the Kernel specifict goetia-shutdown service, + e.g. + goetia-shutdown service for Linux + or + goetia-shutdown service for FreeBSD. + system-shutdown-daemon is a long lived program that waits for instruction by the system-shutdown command + The latter is part of the Kernel specific packages, e.g. + goetia-linux + or + goetia-freebsd. +

+

Interface

+
     system-shutdown-daemon
+ +

Exit codes

+ +

Options

+ + + diff --git a/doc/bin/user-db.html b/doc/bin/user-db.html new file mode 100644 index 0000000..26ef310 --- /dev/null +++ b/doc/bin/user-db.html @@ -0,0 +1,82 @@ + + + + + + + user-db + + + +
+

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

+
+ +

The user-db program

+

+ user-db compiles the + source directories + of the + user configuration directory + into the compiled format. + This format can then be used by init and + user-rc + to set up and control a + user supervision tree. +

+

+ user-db is a wrapper around the more general + compile-db + making it target the user supervision tree. +

+

Interface

+
     user-db
+ +

Exit codes

+ +

Options

+ + + diff --git a/doc/bin/user-init.html b/doc/bin/user-init.html new file mode 100644 index 0000000..c96c3ae --- /dev/null +++ b/doc/bin/user-init.html @@ -0,0 +1,128 @@ + + + + + + + user-init + + + +
+

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

+
+ +

The user-init program

+

+ user-init starts a user supervision tree for + the user defined in the USER + environment variable. +

+

Interface

+
     user-init
+ +

Exit codes

+ +

Options

+ +

Notes

+

+ More information about user supervision trees + themselves can be found on the + user supervision tree + page. +

+ + diff --git a/doc/bin/user-ml.html b/doc/bin/user-ml.html new file mode 100644 index 0000000..d6d7e2e --- /dev/null +++ b/doc/bin/user-ml.html @@ -0,0 +1,104 @@ + + + + + + + user-ml + + + + +
+

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

+
+ +

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

Exit codes

+ +

Options

+ + + diff --git a/doc/bin/user-rc.html b/doc/bin/user-rc.html new file mode 100644 index 0000000..3bad0c5 --- /dev/null +++ b/doc/bin/user-rc.html @@ -0,0 +1,74 @@ + + + + + + + user-rc + + + +
+

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

+
+ +

The user-rc program

+

+ The user-rc program is a thin convenience wrapper around + s6-rc + doing nothing more then pointing it to the right livedir. +

+

+ Read the page of + s6-rc + to understand what this utility does. +

+

Interface

+
     user-rc ... see s6-rc ...
+ +

Exit codes

+ +

Options

+ + + diff --git a/doc/bin/user-run.html b/doc/bin/user-run.html new file mode 100644 index 0000000..924849c --- /dev/null +++ b/doc/bin/user-run.html @@ -0,0 +1,78 @@ + + + + + + + user-run + + + +
+

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

+
+ +

The user-run program

+

+ The user-run program allows + to hand over the execution of commands to the + user supervision tree. +

+

Interface

+
     user-run prog...
+ +

Exit codes

+ +

Options

+ + + diff --git a/doc/bin/user-shutdown.html b/doc/bin/user-shutdown.html new file mode 100644 index 0000000..6a52db8 --- /dev/null +++ b/doc/bin/user-shutdown.html @@ -0,0 +1,68 @@ + + + + + + + user-shutdown + + + +
+

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

+
+ +

The user-shutdown program

+

+ The user-shutdown program is used to tear down + user supervision trees. +

+

Interface

+
     user-shutdown
+ +

Exit codes

+ +

Options

+ + + diff --git a/doc/bin/user-tmpfs.html b/doc/bin/user-tmpfs.html new file mode 100644 index 0000000..3c22c57 --- /dev/null +++ b/doc/bin/user-tmpfs.html @@ -0,0 +1,104 @@ + + + + + + + user-tmpfs + + + +
+

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

+
+ +

The user-tmpfs program

+

+ The user-tmpfs program prepares + a user owned tmpfs for + the user defined in the USER + environment variable. + The user owned tmpfs is created at + @tmpfsdir@/@usrrundir@/${USER}. +

+

Interface

+
     user-tmpfs
+ +

Exit codes

+ +

Options

+ +

Notes

+

+ user-tmpfs is intended to be used in a boot time + system supervision tree + oneshot service to prepare the + user runtime directory + of a user. + For each user who should have a user runtime directory, + there should be a distinct oneshot running user-tmpfs. +

+

+ Alternatively, user-tmpfs could be run by a login manager + after login, but befor initiating the first + user supervision tree. +

+ + -- cgit v1.2.3