From 6fc2d7953120668622f0cb3e4f771084eb77ca4c Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Thu, 30 Oct 2025 21:48:44 +0000 Subject: Add missing doc pages --- doc/s6-rc-set-install.html | 106 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 106 insertions(+) create mode 100644 doc/s6-rc-set-install.html (limited to 'doc/s6-rc-set-install.html') diff --git a/doc/s6-rc-set-install.html b/doc/s6-rc-set-install.html new file mode 100644 index 0000000..02b01f8 --- /dev/null +++ b/doc/s6-rc-set-install.html @@ -0,0 +1,106 @@ + + + + + + s6-rc: the s6-rc-set-install program + + + + + + +

+s6-rc
+Software
+skarnet.org +

+ +

The s6-rc-set-install program

+ +

+ s6-rc-set-install installs a committed +set of services, i.e. a compiled database, as +the live database of the currently running system. +

+ +

+ It is basically a wrapper around s6-rc-update. +

+ +

Interface

+ +

+     s6-rc-set-install [ -v verbosity ] [ -r repo ] [ -l livedir ] [ -f convfile ] [ -b ] [ -K ] set bootdbdir
+

+ +

s6-rc-set-install checks that the set of services set +has been committed and that no changes have occurred since.
It takes the corresponding service database and copies it to bootdbdir.
It calls s6-rc-update on that copy of the compiled service +database, which makes it the new live database. Some services may be stopped, and +other started, in the process.

+ +

Options

+ +

-v verbosity, --verbosity=verbosity: Be more or less verbose. The default is 1, which means +that error messages and warnings will be written to stderr. 0 means that only +error messages will be written, and 2 or more adds informational messages.
-r repo, --repository=repo: Use the repository in repo, which must exist. Default is +/var/lib/s6-rc/repository.
-l livedir, --livedir=livedir: Assume the live directory of the machine, as created by +s6-rc-init, is livedir. The default +is /run/s6-rc, but may have been changed at s6-rc +build time with the --livedir configure argument.
-f convfile, --conversion-file=convfile: Specifies a conversion file to give to +s6-rc-update. The default is not having +a conversion file, which should be correct in most cases.
-b, --block: Pass the -b option to s6-rc-update, +which makes it block rather than fail when the live database is currently being +used by another program - typically when an s6-rc change +transition is under way.
-K, --keep-old: If this option is given, the old live database, after it has been +replaced, is kapt around, and s6-rc-set-install prints a line to stdout that +is the path to that old database. It can e.g. be used by automation to keep +the possibility of rollbacks. +By default, s6-rc-set-install will delete the old live database after +successfully updating to the new one.

+ +

Exit codes

+ +

0: Success.
3: set was not found in the repository. +
7: set was not up-to-date. +
100: Incorrect usage.
102: Inconsistent repository.
111: System call failed.
Other codes: s6-rc-set-install can also exit with +exit codes from s6-rc-update.

+ +

Notes

+ +

s6-rc-set-install is a simple wrapper around s6-rc-update +that ties the repo commands and the way they manage service sets with the +basic operation of the s6-rc engine.

+ + + -- cgit v1.3.1