summaryrefslogtreecommitdiff
path: root/doc/s6-linux-init-shutdown.html
blob: 72bbfcf5453aa763747ca806f3a8e6a5cabe64cc (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
69
70
71
72
73
74
75
76
77
78
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="Content-Language" content="en" />
    <title>s6-linux-init: the s6-linux-init-shutdown program</title>
    <meta name="Description" content="s6-linux-init: the s6-linux-init-shutdown program" />
    <meta name="Keywords" content="s6 linux init administration root utilities shutdown halt poweroff reboot" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="index.html">s6-linux-init</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> The <tt>s6-linux-init-shutdown</tt> program </h1>

<p>
<tt>s6-linux-init-shutdown</tt> triggers the system shutdown procedure.
</p>

<h2> Interface </h2>

<pre>
     s6-linux-init-shutdown [ -h | -p | -r | -k ] [ -a ] [ -t <em>sec</em> ] [ -f | -F ] [ -R <em>tmpfsdir</em> ] <em>time</em> [ <em>message</em> ]
     s6-linux-init-shutdown -c [ -R <em>tmpfsdir</em> ] [ <em>message</em> ]
</pre>

<ul>
 <li> If the <tt>-c</tt> option is present, a pending shutdown is cancelled. </li>
 <li> Else, it triggers the shutdown procedure.
 <li> It exits 0. The shutdown procedure happens asynchronously. </li>
</ul>

<p>
 The <tt>s6-linux-init-shutdown</tt> program conforms to the LSB-3.0.0
<a href="https://refspecs.linuxfoundation.org/LSB_3.0.0/LSB-PDA/LSB-PDA.junk/shutdown.html">shutdown</a>
interface.
</p>

<h2> Exit codes </h2>

<ul>
 <li> 0: shutdown procedure triggered. </li>
 <li> 100: wrong usage, or user does not have root privileges. </li>
 <li> 111: system call failed. </li>
</ul>

<h2> Supplementary options </h2>

<p>
 These options are supported by <tt>s6-linux-init-shutdown</tt> but are not
part of the LSB-3.0.0 <tt>shutdown</tt> specification.
</p>

<ul>
 <li> <tt>-R&nbsp;<em>tmpfsdir</em></tt>&nbsp;: assume that the root-only
boot-time tmpfs has been mounted on <em>tmpfsdir</em>. Default is <tt>/run</tt>.
The <tt>shutdown</tt> script created by a
<a href="s6-linux-init-maker.html">s6-linux-init-maker</a> invocation
automatically execs into <tt>s6-linux-init-shutdown</tt> with the correct
<tt>-R</tt> option. </li>
</ul>

<h2> Notes </h2>

<ul>
 <li> The <a href="s6-linux-init-shutdown.html">s6-linux-init-shutdown</a>
binary is not meant to be called directly by administrators.
Instead, its purpose is to be used in a <tt>shutdown</tt> script created by
<a href="s6-linux-init-maker.html">s6-linux-init-maker</a>. </li>
</ul>

</body>
</html>