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-halt.html | 55 --------------------- doc/s6-linux-init-halt.html | 102 +++++++++++++++++++++++++++++++++++++++ doc/s6-linux-init-poweroff.html | 102 +++++++++++++++++++++++++++++++++++++++ doc/s6-linux-init-reboot.html | 102 +++++++++++++++++++++++++++++++++++++++ doc/s6-linux-init-shutdown.html | 78 ++++++++++++++++++++++++++++++ doc/s6-linux-init-shutdownd.html | 81 +++++++++++++++++++++++++++++++ doc/s6-poweroff.html | 55 --------------------- doc/s6-reboot.html | 55 --------------------- doc/upgrade.html | 3 ++ 9 files changed, 468 insertions(+), 165 deletions(-) delete mode 100644 doc/s6-halt.html create mode 100644 doc/s6-linux-init-halt.html create mode 100644 doc/s6-linux-init-poweroff.html create mode 100644 doc/s6-linux-init-reboot.html create mode 100644 doc/s6-linux-init-shutdown.html create mode 100644 doc/s6-linux-init-shutdownd.html delete mode 100644 doc/s6-poweroff.html delete mode 100644 doc/s6-reboot.html (limited to 'doc') diff --git a/doc/s6-halt.html b/doc/s6-halt.html deleted file mode 100644 index 6f2a30e..0000000 --- a/doc/s6-halt.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - s6-linux-init: the s6-halt program - - - - - - -

- -

The `s6-halt` program

- -

-s6-halt sends a signal to process 1 in order to halt the machine; -or, with the -f option, it performs an immediate hard shutdown. -

- -

Interface

- -

-     s6-halt [ -h | -p | -r ] [ -f ]
-

- -

s6-halt sends a signal to process 1.
It then exits 0.

- -

Options

- -

-h : halt. The command will order a halt (i.e. the system will -be shut down, but the power will remain up), which means -sending a SIGUSR2 to process 1. This is the default.
-p : poweroff. The command will order a power off, which means -sending a SIGUSR1 to process 1.
-r : reboot. The command will order a reboot, which means -sending a SIGINT to process 1.
-f : force. The command will not send any signal to process 1; -it will just sync the filesystems then tell the kernel to halt, poweroff or reboot. -s6-reboot -f or s6-poweroff -f should be the last program -executed in the lifetime of a machine, at the end of the shutdown script called -by process 1 when it receives a signal telling it to shut down.

- - - 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 + + + + + + +

+s6-linux-init
+Software
+skarnet.org +

+ +

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.

+ + + diff --git a/doc/s6-linux-init-poweroff.html b/doc/s6-linux-init-poweroff.html new file mode 100644 index 0000000..2126b23 --- /dev/null +++ b/doc/s6-linux-init-poweroff.html @@ -0,0 +1,102 @@ + + + + + + s6-linux-init: the s6-linux-init-poweroff program + + + + + + +

+s6-linux-init
+Software
+skarnet.org +

+ +

The `s6-linux-init-poweroff` program

+ +

+s6-linux-init-poweroff 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-poweroff [ -h | -p | -r ] [ -d | -w ] [ -W ] [ -f ] [ -R tmpfsdir ]
+

+ +

If the -f option is present, s6-linux-init-poweroff 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.

+ + + diff --git a/doc/s6-linux-init-reboot.html b/doc/s6-linux-init-reboot.html new file mode 100644 index 0000000..422eeed --- /dev/null +++ b/doc/s6-linux-init-reboot.html @@ -0,0 +1,102 @@ + + + + + + s6-linux-init: the s6-linux-init-reboot program + + + + + + +

+s6-linux-init
+Software
+skarnet.org +

+ +

The `s6-linux-init-reboot` program

+ +

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

+ +

Interface

+ +

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

+ +

If the -f option is present, s6-linux-init-reboot reboots the system immediately.
Else, it triggers the machine's shutdown procedure, which will end in a reboot. +
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.

+ + + diff --git a/doc/s6-linux-init-shutdown.html b/doc/s6-linux-init-shutdown.html new file mode 100644 index 0000000..72bbfcf --- /dev/null +++ b/doc/s6-linux-init-shutdown.html @@ -0,0 +1,78 @@ + + + + + + s6-linux-init: the s6-linux-init-shutdown program + + + + + + +

+s6-linux-init
+Software
+skarnet.org +

+ +

The `s6-linux-init-shutdown` program

+ +

+s6-linux-init-shutdown triggers the system shutdown procedure. +

+ +

Interface

+ +

+     s6-linux-init-shutdown [ -h | -p | -r | -k ] [ -a ] [ -t sec ] [ -f | -F ] [ -R tmpfsdir ] time [ message ]
+     s6-linux-init-shutdown -c [ -R tmpfsdir ] [ message ]
+

+ +

If the -c option is present, a pending shutdown is cancelled.
Else, it triggers the shutdown procedure. +
It exits 0. The shutdown procedure happens asynchronously.

+ +

+ The s6-linux-init-shutdown program conforms to the LSB-3.0.0 +shutdown +interface. +

+ +

Exit codes

+ +

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

+ +

Supplementary options

+ +

+ These options are supported by s6-linux-init-shutdown but are not +part of the LSB-3.0.0 shutdown specification. +

+ +

-R tmpfsdir : assume that the root-only +boot-time tmpfs has been mounted on tmpfsdir. Default is /run. +The shutdown script created by a +s6-linux-init-maker invocation +automatically execs into s6-linux-init-shutdown with the correct +-R option.

+ +

Notes

+ +

The s6-linux-init-shutdown +binary is not meant to be called directly by administrators. +Instead, its purpose is to be used in a shutdown script created by +s6-linux-init-maker.

+ + + diff --git a/doc/s6-linux-init-shutdownd.html b/doc/s6-linux-init-shutdownd.html new file mode 100644 index 0000000..b6ea412 --- /dev/null +++ b/doc/s6-linux-init-shutdownd.html @@ -0,0 +1,81 @@ + + + + + + s6-linux-init: the s6-linux-init-shutdownd internal program + + + + + + +

+s6-linux-init
+Software
+skarnet.org +

+ +

The `s6-linux-init-shutdownd` internal program

+ +

+s6-linux-init-shutdownd is the daemon that manages the shutdown +procedure for a s6-linux-init installation. It is not meant to be called +directly by the user. +

+ +

Interface

+ +

+     s6-linux-init-shutdownd [ -b bindir ] [ -c basedir ] [ -g gracetime ] fifo
+

+ +

s6-linux-init-shutdownd opens the fifo named pipe +and listens to it. This is where programs such as +s6-linux-init-shutdown send their +commands when they are told to trigger the shutdown procedure.
When it receives a command to shut down, s6-linux-init-shutdownd +first spawns the stage3 script defined by the last +s6-linux-init-maker invocation.
When this script exits, s6-linux-init-shutdownd kills all +processes, first with a SIGTERM, then (after the grace time specified by +the shutdown command) with a SIGKILL.
It then runs the automatically-generated stage 4 script, +which unmounts the file systems and halts, powers off or reboots the +machine.

+ +

Exit codes

+ +

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

+ +

Options

+ +

-b bindir : look for the +execlineb +script interpreter in the bindir directory. Default is /bin.
-c basedir : look for the +stage3 and stage4 scripts in the basedir +directory. Default is /etc/s6-linux-init.
-g gracetime : if the shutdown command +does not specify a grace time between the SIGTERM and the SIGKILL, use +gracetime milliseconds. Default is 3000.

+ +

Notes

+ +

The s6-linux-init-shutdownd +binary is not meant to be called directly by administrators. It is run +by a s6 service that is automatically +generated by +s6-linux-init-maker.

+ + + diff --git a/doc/s6-poweroff.html b/doc/s6-poweroff.html deleted file mode 100644 index e215c38..0000000 --- a/doc/s6-poweroff.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - s6-linux-init: the s6-poweroff program - - - - - - -

-s6-linux-init
-Software
-skarnet.org -

- -

The `s6-poweroff` program

- -

-s6-poweroff sends a signal to process 1 in order to power off the machine; -or, with the -f option, it performs an immediate hard shutdown. -

- -

Interface

- -

-     s6-poweroff [ -h | -p | -r ] [ -f ]
-

- -

s6-poweroff sends a signal to process 1.
It then exits 0.

- -

Options

- -

-h : halt. The command will order a halt (i.e. the system will -be shut down, but the power will remain up), which means -sending a SIGUSR2 to process 1.
-p : poweroff. The command will order a power off, which means -sending a SIGUSR1 to process 1. This is the default.
-r : reboot. The command will order a reboot, which means -sending a SIGINT to process 1.
-f : force. The command will not send any signal to process 1; -it will just sync the filesystems then tell the kernel to halt, poweroff or reboot. -s6-reboot -f or s6-poweroff -f should be the last program -executed in the lifetime of a machine, at the end of the shutdown script called -by process 1 when it receives a signal telling it to shut down.

- - - diff --git a/doc/s6-reboot.html b/doc/s6-reboot.html deleted file mode 100644 index 16043c5..0000000 --- a/doc/s6-reboot.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - s6-linux-init: the s6-reboot program - - - - - - -

-s6-linux-init
-Software
-skarnet.org -

- -

The `s6-reboot` program

- -

-s6-reboot sends a signal to process 1 in order to reboot the machine; -or, with the -f option, it performs an immediate reboot. -

- -

Interface

- -

-     s6-reboot [ -h | -p | -r ] [ -f ]
-

- -

s6-reboot sends a signal to process 1.
It then exits 0.

- -

Options

- -

-h : halt. The command will order a halt (i.e. the system will -be shut down, but the power will remain up), which means -sending a SIGUSR2 to process 1.
-p : poweroff. The command will order a power off, which means -sending a SIGUSR1 to process 1.
-r : reboot. The command will order a reboot, which means -sending a SIGINT to process 1. This is the default.
-f : force. The command will not send any signal to process 1; -it will just sync the filesystems then tell the kernel to halt, poweroff or reboot. -s6-reboot -f or s6-poweroff -f should be the last program -executed in the lifetime of a machine, at the end of the shutdown script called -by process 1 when it receives a signal telling it to shut down.

- - - diff --git a/doc/upgrade.html b/doc/upgrade.html index 7a5d279..2b082fb 100644 --- a/doc/upgrade.html +++ b/doc/upgrade.html @@ -33,6 +33,9 @@ anymore (stage 3 was previously the user-written /etc/rc.shutdown script).

The default user-provided "end of stage 2, bring down services" script was named /etc/rc.tini before; now it's named /etc/rc.shutdown.

Everything now builds as PIC by default no matter +the toolchain's settings. Use the --disable-all-pic configure +option to build executables and static libraries as non-PIC.

in 0.3.1.1

-- cgit v1.2.3

The s6-halt program

Interface

Options

The s6-linux-init-halt program

Interface

Exit codes

Options

Notes

The s6-linux-init-poweroff program

Interface

Exit codes

Options

Notes

The s6-linux-init-reboot program

Interface

Exit codes

Options

Notes

The s6-linux-init-shutdown program

Interface

Exit codes

Supplementary options

Notes

The s6-linux-init-shutdownd internal program

Interface

Exit codes

Options

Notes

The s6-poweroff program

Interface

Options

The s6-reboot program

Interface

Options

in 0.3.1.1

The `s6-halt` program

The `s6-linux-init-halt` program

The `s6-linux-init-poweroff` program

The `s6-linux-init-reboot` program

The `s6-linux-init-shutdown` program

The `s6-linux-init-shutdownd` internal program

The `s6-poweroff` program

The `s6-reboot` program