From ee111aabf49128fe88968f658b0f4b683a3caa00 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Sat, 29 Aug 2015 20:25:40 +0000 Subject: - some work on s6-rc-update - add s6-rc-bundle and relevant doc --- doc/s6-rc-bundle.html | 132 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 doc/s6-rc-bundle.html (limited to 'doc/s6-rc-bundle.html') diff --git a/doc/s6-rc-bundle.html b/doc/s6-rc-bundle.html new file mode 100644 index 0000000..c77f890 --- /dev/null +++ b/doc/s6-rc-bundle.html @@ -0,0 +1,132 @@ + + + + + + s6-rc: the s6-rc-bundle program + + + + + + +

+ +

The s6-rc-bundle program

+ +

+ s6-rc-bundle is a tool to add or delete bundles from a compiled +service database without having to recompile it from source. +

+ +

+ It is an offline tool, i.e. you can run it on any +compiled service database without actually having a live set +of services managed by s6-rc. However, if you do have a live +set, you can still run s6-rc-bundle on the current database (and +it is the default); it won't interfere with your normal service +operation. +

+ +

Interface

+ +

+     s6-rc-bundle help
+     s6-rc-bundle [ -f ] [ -l live ] [ -c compiled ] add bundlename contents...
+     s6-rc-bundle [ -f ] [ -l live ] [ -c compiled ] delete bundlenames...
+     s6-rc-bundle [ -f ] [ -l live ] [ -c compiled ] multiple args...
+

+ +

s6-rc-bundle expects to find a compiled service database +in compiled; by default it uses the service database +used by the live state in live.
Depending on the arguments, it adds a bundle definition to this database, or +deletes a bundle definition from it, or performs multiple additions/deletions.

+ +

Options

+ +

-c compiled : operate on a +compiled service database in compiled instead of +the current live one.
-l live : assume the live +state is in live. This option is ignored if the +-c option has been given. Default is +/run/s6-rc. The default can be changed at package +compilation time, by giving the --livedir=live +option to ./configure.
-f : force. s6-rc-bundle will not complain +when given a nonexisting name to delete (it will do nothing), or +when given an existing name to add (it will replace the definition). +By default, s6-rc-bundle will exit when asked to delete a +nonexistent name or to add an existing name.

+ +

Exit codes

+ +

0: success
1: identifier already exists in service database
3: identifier not found in service database
4: invalid or corrupted service database
5: wrong identifier type for the given command
100: wrong usage
111: system call failed

+ +

Subcommands

+ +

s6-rc-bundle help

+ +

+ Prints a help message on stdout. +

+ +

s6-rc-bundle add bundlename contents...

+ +

+ Adds a bundle named bundlename to the database, representing +the services listed in contents. The arguments in contents... +are resolved before the database is modified by the +s6-rc-bundle invocation. +

+ +

s6-rc-bundle delete bundlenames...

+ +

+ Deletes bundles listed in bundlenames.... +

+ +

s6-rc-bundle multiple args...

+ +

+ Performs multiple bundle deletions and additions. This subcommand is best +used in an execline +script, because it uses +blocks. +

+ +

+args... is composed of: +

+ +

One block listing bundle names that will be +deleted from the database.
Zero or more addition definitions, each of them composed of: +
- One argument that is the name of the bundle to add
- One block listing the services contained in the +new bundle. The names in the block are resolved before any addition +is made to the database.

+ + + -- cgit v1.2.3