summaryrefslogtreecommitdiffstats
path: root/doc/service
diff options
context:
space:
mode:
authorPS <p@0x53.net>2026-02-07 10:38:55 +0100
committerPS <p@0x53.net>2026-02-07 10:38:55 +0100
commitd31250fc850b196d2b46b94c82f0538f4b79248c (patch)
tree939ad4bf9011accaed58a002f3b936f1b494f519 /doc/service
parent466a79421d335c020bf2208692e9f7f41614f6f1 (diff)
downloadgoetia-s6-linux-init-d31250fc850b196d2b46b94c82f0538f4b79248c.tar.gz
goetia-s6-linux-init-d31250fc850b196d2b46b94c82f0538f4b79248c.tar.bz2
goetia-s6-linux-init-d31250fc850b196d2b46b94c82f0538f4b79248c.zip
Add doc
Diffstat (limited to 'doc/service')
-rw-r--r--doc/service/system/.s6-svscan.html38
-rw-r--r--doc/service/system/s6-linux-init-runleveld.html39
-rw-r--r--doc/service/system/s6-linux-init-shutdownd.html33
3 files changed, 110 insertions, 0 deletions
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 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>system .s6-svscan</title>
+ <meta name="Description" content="Configuration directory for s6-svscan for the system supervision tree" />
+ <meta name="Keywords" content="goetia s6 s6-svscan system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-s6-linux-init">goetia-s6-linux-init</a>
+ <br />
+ <a href="//0x53.net/software/goetia">goetia</a>
+ <br />
+ <a href="//0x53.net/software">Software</a>
+ <br />
+ <a href="//0x53.net">0x53.net</a>
+ </p>
+ </header>
+ <body>
+ <h1>The system .s6-svscan directory</h1>
+ <p>
+ The .s6-svscan directory contains scripts
+ that are executed if
+ <a href="https://skarnet.org/software/s6/s6-svscan.html">s6-svscan</a>
+ receives a signal or exits.
+ In this case its main use is to properly shutdown
+ the system using <code>system-shutdown</code>
+ upon receiving certain signals.
+ </p>
+ <p>
+ The .s6-svscan directory is easily overlooked,
+ do not forget to symlink/copy it!
+ </p>
+ </body>
+</html>
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 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>s6-linux-init-runleveld</title>
+ <meta name="Description" content="System service allowing to run s6-rc invocations of the system supervision tree." />
+ <meta name="Keywords" content="goetia s6 s6-rc s6-linux-init Linux run system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-s6-linux-init">goetia-s6-linux-init</a>
+ <br />
+ <a href="//0x53.net/software/goetia">goetia</a>
+ <br />
+ <a href="//0x53.net/software">Software</a>
+ <br />
+ <a href="//0x53.net">0x53.net</a>
+ </p>
+ </header>
+ <body>
+ <h1>The s6-linux-init-runleveld service</h1>
+ <p>
+ s6-linux-init-runleveld starts the daemon corresponding to
+ <a href="https://skarnet.org/software/s6-linux-init/s6-linux-init-telinit.html">s6-linux-init-telinit</a>.
+ It is very similar to
+ <a href="//0x53.net/software/goetia/goetia-base/service/system/goetia-runner.html">goetia-runner</a>
+ (which corresponds to <a href="//0x53.net/software/goetia/goetia-base/bin/system-run.html">system-run</a>).
+ s6-linux-init-runleveld can be used to start and stop bundles
+ (bundles replace a functionality historically called runlevels)
+ and have the corresponding
+ <a href="https://skarnet.org/software/s6-rc/s6-rc.html">s6-rc</a>
+ command executed <em>from the supervision tree</em>.
+ This makes the transition resilient to e.g. interface crashes
+ or the command itself stopping the interface it was executed from.
+ </p>
+ </body>
+</html>
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 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>s6-linux-init-shutdownd</title>
+ <meta name="Description" content="System service to start the s6-linux-init-shutdownd daemon." />
+ <meta name="Keywords" content="goetia s6 s6-rc s6-linux-init Linux shutdown system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-s6-linux-init">goetia-s6-linux-init</a>
+ <br />
+ <a href="//0x53.net/software/goetia">goetia</a>
+ <br />
+ <a href="//0x53.net/software">Software</a>
+ <br />
+ <a href="//0x53.net">0x53.net</a>
+ </p>
+ </header>
+ <body>
+ <h1>The s6-linux-init-shutdownd service</h1>
+ <p>
+ s6-linux-init-shutdownd is the service that starts
+ <a href="https://skarnet.org/software/s6-linux-init/s6-linux-init-shutdownd.html">s6-linux-init-shutdownd</a>.
+ This daemon, upon activation by
+ <a href="https://skarnet.org/software/s6-linux-init/s6-linux-init-shutdown.html">s6-linux-init-shutdown</a>
+ (in goetia wrapped by <a href="//0x53.net/software/goetia/goetia-s6-linux-init/bin/system-shutdown.html">system-shutdown</a>),
+ runs the shutdown procedure.
+ </p>
+ </body>
+</html>