From 96fbd74d6d70b562f45e327eeb0f625b54899bcc Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Sat, 4 Jul 2015 01:40:10 +0000 Subject: Start of doc --- doc/s6-rc-db.html | 134 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 134 insertions(+) create mode 100644 doc/s6-rc-db.html (limited to 'doc/s6-rc-db.html') diff --git a/doc/s6-rc-db.html b/doc/s6-rc-db.html new file mode 100644 index 0000000..9a1cf3b --- /dev/null +++ b/doc/s6-rc-db.html @@ -0,0 +1,134 @@ + + + + + + s6-rc: the s6-rc-db program + + + + + + +

+s6-rc
+Software
+skarnet.org +

+ +

The s6-rc-db program

+ +

+ s6-rc-db is a tool to analyze a compiled service database +and extract information from it, and print it in a user-friendly +format. +

+ +

+ 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-db on the current database (and +it is the default); it won't interfere with your normal service +operation. +

+ +

Interface

+ +

+     s6-rc-db help
+     s6-rc-db [ -l live ] [ -c compiled ] check
+     s6-rc-db [ -l live ] [ -c compiled ] list all|services|oneshots|longruns|bundles
+     s6-rc-db [ -l live ] [ -c compiled ] type servicename
+     s6-rc-db [ -l live ] [ -c compiled ] [ -u | -d ] timeout atomicname
+     s6-rc-db [ -l live ] [ -c compiled ] contents bundlename
+     s6-rc-db [ -l live ] [ -c compiled ] [ -u | -d ] dependencies servicename
+     s6-rc-db [ -l live ] [ -c compiled ] servicedir longrunname
+     s6-rc-db [ -l live ] [ -c compiled ] [ -u | -d ] script oneshotname
+     s6-rc-db [ -l live ] [ -c compiled ] flags atomicname
+     s6-rc-db [ -l live ] [ -c compiled ] atomics servicename...
+     s6-rc-db [ -l live ] [ -c compiled ] [ -u | -d ] all-dependencies servicename...
+

+ +

s6-rc-db expects to find a compiled service database +in compiled; by default it uses the service database +used by the live state in live. +It reads and parses the compiled database it finds. If the +database is invalid, it exits 4.
Depending on the arguments given, it prints the requested +information to stdout, then exits 0.

+ +

Options

+ +

-c compiled : examine a +compiled service database in compiled instead of +the current live one.
-l live : assume the live +state is in live. Default is +/run/s6-rc. This option is ignored if the +-c option has been given.
-u : for commands that use different data +depending on whether it's about bringing the service up or down, +select the "up" data. This option is ignored when it is irrelevant.
-d : for commands that use different data +depending on whether it's about bringing the service up or down, +select the "down" data. This option is ignored when it is irrelevant.

+ +

Subcommands

+ +

s6-rc-db help

+ +

+ Prints a help message on stdout. +

+ +

s6-rc-db check

+ +

+ Checks the database consistency. Exits 4 with an error message if +it finds a problem, such as a mismatch in the direct and reverse +dependency tables, or a dependency cycle. +

+ + +

Usage examples

+ +

 s6-rc myservicebundle

+ Brings up all the services represented by myservicebundle, +dependencies first. +

+ +

 s6-rc -Sad

+ Brings down all the services in an orderly manner. This is typically +run at shutdown time. +

+ +

 s6-rc -Au myservicebundle

+ Prints the names of all atomic services represented by +myservicebundle, as well as everything they depend on. +

+ +

 s6-rc -Ad myservicebundle

+ Prints the names of all atomic services represented by +myservicebundle, as well as everything that depends on them. +

+ +

 s6-rc -pun0 myservicebundle

+ Prints what s6-rc would do to bring the state to just +myservicebundle and its dependencies. +

+ + +

Internals

+ + + -- cgit v1.2.3