aboutsummaryrefslogtreecommitdiffstats
path: root/doc/bin/user-shutdown.html
blob: 6a52db83ba481d20fc75b343996e814969d4dba5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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>