From ce6f67df5c30a8dc3464396880b83db631042aca Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Mon, 12 Jan 2026 03:35:44 +0000 Subject: Add doc for s6 process and s6 live --- doc/s6_process.html | 273 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 273 insertions(+) create mode 100644 doc/s6_process.html (limited to 'doc/s6_process.html') diff --git a/doc/s6_process.html b/doc/s6_process.html new file mode 100644 index 0000000..a00793a --- /dev/null +++ b/doc/s6_process.html @@ -0,0 +1,273 @@ + + + + + + s6-frontend: the s6 process command + + + + + + +

+The s6 command
+s6-frontend
+Software
+skarnet.org +

+ +

The s6 process command

+ +

+ s6 process regroups actions that target services that are managed +by an instance of s6-svscan +running on the configured scandir. +

+ +
+

Interface

+
+ +
+     s6 process subcommand [ subcommand_options... ] [ args... ]
+
+ +
+

Subcommands

+
+ +
+

help

+
+ +

+ s6 process help prints a short help message summarizing the options +and usage of the s6 process command. It is not as detailed as this page. +

+ +
+

kill

+
+ +

Interface

+ +
+     s6 process kill [ -W | -w ] [ -s sig ] [ -t timeout ] servicenames...
+
+ + + +

Options

+ +
+
-W, --no-wait
+
Exit immediately, do not wait until the daemon has died and the service +has cleaned up. This is the default.
+ +
-w, --wait
+
Only exit when the daemon has died and the finish script of the service, +if any, has run.
+ +
-s sig, --signal=sig
+
Send signal sig. The default is SIGTERM.
+ +
-t timeout, --timeout=timeout
+
Only wait for at most timeout milliseconds; if the daemon still +hasn't died after that time, exit. The default is 0, meaning infinite: the +command can wait forever. This option is only effective when paired with the +--wait option.
+
+ + +
+

status

+
+ +

Interface

+ +
+     s6 process status [ -L | -l ] servicenames...
+
+ + + +

Options

+ +
+
-L, --without-logs
+
Only print the status for /run/service/foobar even if +/run/service/foobar/log exists. This is the default.
+ +
-l, --with-logs
+
If a /run/service/foobar/log service directory exists, +also print its status along with the one for /run/service/foobar. +Note that this option has no effect on loggers managed by +s6-rc, e.g. services defined in the store and managed by +s6 live, because these loggers are +treated at separate, independent services. The -l option is +only useful with old-style logged s6 services that are not managed by +s6-rc.
+
+ +
+

start

+
+ +

Interface

+ +
+     s6 process start [ -P | -p ] [ -W | -w ] [ -t timeout ] servicenames...
+
+ + + +

Options

+ +
+
-P, --no-permanent
+
Only change the current state of the service, not its default state. +If there is a down file +in /run/service/foobar, then s6 process start foobar will +bring the service up, but will not restart it if foobard dies. This +is the default.
+ +
-p, --permanent
+
Also change the default state of the service. +If there is a down file +in /run/service/foobar, then s6 process start foobar will +delete it, and the service will be automatically restart it +if foobard dies.
+ +
-W, --no-wait
+
Exit immediately, do not wait until the service is up. +This is the default.
+ +
-w, --wait
+
Only exit when the service is up and (if applicable) ready.
+ +
-t timeout, --timeout=timeout
+
Only wait for at most timeout milliseconds; if the daemon still +isn't up and ready after that time, exit. The default is 0, meaning infinite: the +command can wait forever. This option is only effective when paired with the +--wait option.
+
+ +
+

stop

+
+ +

Interface

+ +
+     s6 process stop [ -P | -p ] [ -W | -w ] [ -t timeout ] servicenames...
+
+ + + +

Options

+ +
+
-P, --no-permanent
+
Only change the current state of the service, not its default state. +If there is no down file +in /run/service/foobar, then s6 process stop foobar will +stop the service, but it will still be started whenever its supervisor is started. +This is the default.
+ +
-p, --permanent
+
Also change the default state of the service. +If there is no down file +in /run/service/foobar, then s6 process stop foobar will +create one, and the service will not be automatically started whenever its +supervisor is started.
+ +
-W, --no-wait
+
Exit immediately, do not wait until the service is down. +This is the default.
+ +
-w, --wait
+
Only exit when the service is down and any cleanups are done.
+ +
-t timeout, --timeout=timeout
+
Only wait for at most timeout milliseconds; if the finish script +still isn't done after that time, exit. The default is 0, meaning infinite: the +command can wait forever. This option is only effective when paired with the +--wait option.
+
+ +
+

restart

+
+ +

Interface

+ +
+     s6 process restart [ -W | -w ] [ -t timeout ] servicenames...
+
+ + + +

Options

+ +
+
-W, --no-wait
+
Exit immediately, do not wait until the service has restarted +This is the default.
+ +
-w, --wait
+
Only exit when the new instance of the service is up and (if applicable) ready.
+ +
-t timeout, --timeout=timeout
+
Only wait for at most timeout milliseconds; if the service still +hasn't restarted after that time, exit. The default is 0, meaning infinite: the +command can wait forever. This option is only effective when paired with the +--wait option.
+
+ + + -- cgit v1.3.1