aboutsummaryrefslogtreecommitdiffstats
path: root/doc/bin
diff options
context:
space:
mode:
Diffstat (limited to 'doc/bin')
-rw-r--r--doc/bin/system-init.html74
-rw-r--r--doc/bin/system-shutdown.html54
2 files changed, 128 insertions, 0 deletions
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 @@
+<!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-init</title>
+ <meta name="Description" content="A wrapper around s6-linux-init to start it with the correct options for goetia." />
+ <meta name="Keywords" content="goetia s6 s6-rc s6-linux-init Linux init" />
+ </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-init program</h1>
+ <p>
+ system-init is a wrapper around
+ <a href="https://skarnet.org/software/s6-linux-init/s6-linux-init.html">s6-linux-init</a>.
+ </p>
+ <h2>Interface</h2>
+ <pre> system-init</pre>
+ <ul>
+ <li>
+ system-init takes no arguments.
+ </li>
+ <li> It executes s6-linux-init with proper arguments to:
+ <ul>
+ <li>
+ Use the umask <code>0022</code>.
+ </li>
+ <li>
+ Use the config at <code>/etc/s6-linux-init/goetia</code>
+ </li>
+ <li>
+ Use the <code>PATH</code> environment variable set to
+ <code>/command:/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin:/usr/libexec:/usr/local/libexec</code>.
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <h2>Exit codes</h2>
+ <ul>
+ <li>
+ system-init does nothing more than starting
+ <a href="https://skarnet.org/software/s6-linux-init/s6-linux-init.html">s6-linux-init</a>
+ with arguments
+ and behaves exactly like it.
+ </li>
+ <li>
+ See also:
+ <a href="https://skarnet.org/software/execline/exitcodes.html">execline exit code handling</a>.
+ </li>
+ </ul>
+ <h2>Options</h2>
+ <ul>
+ <li>
+ There are no options to system-init.
+ </li>
+ </ul>
+ <h2>Notes</h2>
+ <p>
+ system-init is primarily intended to be used
+ as an init for an acutal boot process, not for containers.
+ </p>
+ </body>
+</html>
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 @@
+<!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-shutdown</title>
+ <meta name="Description" content="Convenience wrapper around s6-linux-init-shutdown." />
+ <meta name="Keywords" content="goetia s6 s6-rc s6-linux-init Linux shutdown" />
+ </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-shutdown program</h1>
+ <p>
+ system-shutdown is a wrapper around
+ <a href="https://skarnet.org/software/s6-linux-init/s6-linux-init-shutdown.html">s6-linux-init-shutdown</a>.
+ </p>
+ <h2>Interface</h2>
+ <pre> system-shutdown ... <a href="https://skarnet.org/software/s6-linux-init/s6-linux-init-shutdown.html">see s6-linux-init-shutdown</a> ...</pre>
+ <ul>
+ <li>
+ <a href="https://skarnet.org/software/s6-linux-init/s6-linux-init-shutdown.html">see s6-linux-init-shutdown</a>
+ </li>
+ </ul>
+ <h2>Options</h2>
+ <ul>
+ <li>
+ <a href="https://skarnet.org/software/s6-linux-init/s6-linux-init-shutdown.html">see s6-linux-init-shutdown</a>
+ </li>
+ </ul>
+ <h2>Exit codes</h2>
+ <ul>
+ <li>
+ system-shutdown is a wrapper around
+ <a href="https://skarnet.org/software/s6-linux-init/s6-linux-init-shutdown.html">see s6-linux-init-shutdown</a>
+ and behaves exactly like it.
+ </li>
+ <li>
+ See also:
+ <a href="https://skarnet.org/software/execline/exitcodes.html">execline exit code handling</a>.
+ </li>
+ </ul>
+ </body>
+</html>