From 23fba266a9454ee6ca095b7f6eccf523f6526607 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Sat, 2 Mar 2019 09:41:24 +0000 Subject: Save pending changes in 1.0.0.0 branch --- doc/s6-linux-init-halt.html | 102 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 102 insertions(+) create mode 100644 doc/s6-linux-init-halt.html (limited to 'doc/s6-linux-init-halt.html') diff --git a/doc/s6-linux-init-halt.html b/doc/s6-linux-init-halt.html new file mode 100644 index 0000000..0f68995 --- /dev/null +++ b/doc/s6-linux-init-halt.html @@ -0,0 +1,102 @@ + + + + + + s6-linux-init: the s6-linux-init-halt program + + + + + + +

+ +

The `s6-linux-init-halt` program

+ +

+s6-linux-init-halt triggers the shutdown procedure in order to +halt the system; or, with the -f option, it performs an immediate +hard shutdown. +

+ +

Interface

+ +

+     s6-linux-init-halt [ -h | -p | -r ] [ -d | -w ] [ -W ] [ -f ] [ -R tmpfsdir ]
+

+ +

If the -f option is present, s6-linux-init-halt halts the system immediately.
Else, it triggers the machine's shutdown procedure. +
It exits 0. The shutdown procedure happens asynchronously.

+ +

+ This interface follows the traditional sysvinit interface for the +halt, poweroff and reboot programs as close as possible. +

+ +

Exit codes

+ +

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

+ +

Options

+ +

-h : halt. No matter the name of the command, it will order +a halt (i.e. the system will be shut down, but the power will remain up). +This is the default for s6-linux-init-halt.
-p : poweroff. No matter the name of the command, it will order +a power off. This is the default for s6-linux-init-poweroff.
-r : reboot. No matter the name of the command, it will order +a reboot. This is the default for s6-linux-init-reboot.
-d : Do not write a wtmp shutdown entry.
-w : Only write a wtmp shutdown entry; do not actually shut down +the system.
-W : Do not send a wall message to users before shutting +down the system. Some other implementations of the halt, poweroff +and reboot commands use the --no-wall long option to achieve this.
-f : force. The command will not trigger a clean shutdown +procedure; it will just sync the filesystems then tell the kernel to immediately +halt, poweroff or reboot. This should be the last step in the lifetime of the +machine.
-R tmpfsdir : assume that the root-only +boot-time tmpfs has been mounted on tmpfsdir. Default is /run. +It is important to get this right, because the contact point with the +s6-linux-init-shutdownd daemon, +which manages the shutdown procedure, is located under this directory. The +halt, poweroff and reboot scripts created by a +s6-linux-init-maker invocation +automatically use the correct -R option.

+ +

Notes

+ +

The +s6-linux-init-halt, +s6-linux-init-poweroff, +s6-linux-init-reboot and +s6-linux-init-shutdown +binaries are not meant to be called directly by administrators. +Instead, their purpose is to be used in halt, poweroff, +reboot and shutdown scripts created by +s6-linux-init-maker; those scripts +will call them with the correct -R tmpfsdir option. +The scripts should typically be linked to /sbin after +s6-linux-init-maker execution, to +provide drop-in replacements for the sysvinit programs with the +same names.

+ + + -- cgit v1.2.3

The s6-linux-init-halt program

Interface

Exit codes

Options

Notes

The `s6-linux-init-halt` program