aboutsummaryrefslogtreecommitdiffstats
path: root/doc/bin/user-shutdown.html
diff options
context:
space:
mode:
authorPS <p@0x53.net>2026-02-07 10:20:30 +0100
committerPS <p@0x53.net>2026-02-07 10:20:30 +0100
commit5e95d487982b9362b544139b98d1da55fa6ef78c (patch)
tree1abf6d91f9e6d0b6d0ac7b7d759663f2531eb51b /doc/bin/user-shutdown.html
parentf7df2f7bb6abbea365cccb1345dcf1a1b7a80797 (diff)
downloadgoetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.tar.gz
goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.tar.bz2
goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.zip
Add doc
Diffstat (limited to 'doc/bin/user-shutdown.html')
-rw-r--r--doc/bin/user-shutdown.html68
1 files changed, 68 insertions, 0 deletions
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 @@
+<!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>user-shutdown</title>
+ <meta name="Description" content="Script to tear down a user supervision tree." />
+ <meta name="Keywords" content="goetia s6 s6-rc shutdown user supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-base">goetia-base</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 user-shutdown program</h1>
+ <p>
+ The user-shutdown program is used to tear down
+ <a href="//0x53.net/software/goetia/supervisiontree.html#user">user supervision trees</a>.
+ </p>
+ <h2>Interface</h2>
+ <pre> user-shutdown</pre>
+ <ul>
+ <li>
+ user-shutdown takes no arguments.
+ </li>
+ <li>
+ It starts the user
+ <a href="//0x53.net/software/goetia/goetia-base/service/user/goetia-shutdown.html">goetia-shutdown</a>
+ service.
+ </li>
+ </ul>
+ <h2>Exit codes</h2>
+ <ul>
+ <li>
+ Since user-shutdown is an
+ <a href="https://skarnet.org/software/execline/">execline</a>
+ script, it exits with an approximation
+ of employed program that failed.
+ </li>
+ <li>
+ user-shutdown mostly uses
+ <a href="https://skarnet.org/software/execline/">execline</a>
+ and
+ <a href="https://skarnet.org/software/s6/">s6</a>
+ software, the exit behaviour of which can be looked up on
+ their respective pages.
+ </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 user-shutdown.
+ </li>
+ </ul>
+ </body>
+</html>