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_live.html | 279 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 279 insertions(+) create mode 100644 doc/s6_live.html (limited to 'doc/s6_live.html') diff --git a/doc/s6_live.html b/doc/s6_live.html new file mode 100644 index 0000000..b35ba30 --- /dev/null +++ b/doc/s6_live.html @@ -0,0 +1,279 @@ + + + + + + s6-frontend: the s6 live command + + + + + + +

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

+ +

The s6 live command

+ +

+ s6 live regroups actions that target the live machine state +managed by the s6-rc service manager, +hosted in the configured livedir. +

+ +

+ Where s6 process directly targets instances +of services supervised by s6-supervision, +without knowledge of the service manager, and thus can only address longruns, +s6 live targets services defined in the current live database, oneshots +as well as longruns, and always respects the dependency graph. +

+ +
+

Interface

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

Subcommands

+
+ +
+

help

+
+ +

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

+ +
+

status

+
+ +

Interface

+ +
+     s6 live status [ servicenames... ]
+
+ + + +
+

start

+
+ +

Interface

+ +
+     s6 live start [ -n ] [ -t timeout ] servicenames...
+
+ + + +

Options

+ +
+
-n, --dry-run
+
Only print what would be done; do not actually start services.
+ +
-t timeout, --timeout=timeout
+
If the whole change still hasn't completed after timeout +milliseconds, stop waiting and don't attempt to perform the remaining +transitions. By default, timeout is 0, meaning infinite: the +command can wait forever.
+
+ +
+

stop

+
+ +

Interface

+ +
+     s6 live stop [ -n ] [ -t timeout ] servicenames...
+
+ + + +

Options

+ +
+
-n, --dry-run
+
Only print what would be done; do not actually stop services.
+ +
-t timeout, --timeout=timeout
+
If the whole change still hasn't completed after timeout +milliseconds, stop waiting and don't attempt to perform the remaining +transitions. By default, timeout is 0, meaning infinite: the +command can wait forever.
+
+ +
+

restart

+
+ +

Interface

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

Options

+ +
+
-n, --dry-run
+
Only print what would be done; do not actually stop or start services.
+ +
-t timeout, --timeout=timeout
+
If the whole restart still hasn't completed after timeout +milliseconds, stop waiting and don't attempt to perform the remaining +transitions. By default, timeout is 0, meaning infinite: the +command can wait forever.
+
+ +
+

start_everything

+
+ +

Interface

+ +
+     s6 live start_everything [ -n ] [ -t timeout ] [ -D bundle ]
+
+ + + +

Options

+ +
+
-n, --dry-run
+
Only print what would be done; do not actually start services.
+ +
-t timeout, --timeout=timeout
+
If the whole change still hasn't completed after timeout +milliseconds, stop waiting and don't attempt to perform the remaining +transitions. By default, timeout is 0, meaning infinite: the +command can wait forever.
+ +
+
-D bundle, --default-bundle=bundle
+
Start the bundle of services named bundle instead. +The default is default, possibly overridden by the +--with-default-bundle build-time configure option in +s6-rc or +s6-frontend.
+
+ +
+

stop_everything

+
+ +

Interface

+ +
+     s6 live stop_everything [ -n ] [ -t timeout ]
+
+ + + +

Options

+ +
+
-n, --dry-run
+
Only print what would be done; do not actually stop services.
+ +
-t timeout, --timeout=timeout
+
If the whole change still hasn't completed after timeout +milliseconds, stop waiting and don't attempt to perform the remaining +transitions. By default, timeout is 0, meaning infinite: the +command can wait forever.
+
+ +
+

install

+
+ +

Interface

+ +
+     s6 live install [ -b ] [ -K ] [ -f convfile ]
+
+ + + +

Options

+ +
+
-b, --block
+
Block if something is currently holding the lock on the live service +database. The default is to fail with an error message instead.
+ +
-K, --keep-old
+
Do not automatically delete the old service database after a successful switch. +Instead, print its path to stdout.
+ +
-f convfile, --conversion-file=convfile
+
Use convfile as a conversion file for the underlying +s6-rc-update +invocation, i.e. a file translating service names and states between +the old service database and the one being installed. This option should +never be necessary if the services in the stores are properly managed.
+
+ + + -- cgit v1.3.1