From 7b9931e6403db6aeabb0ccc26e126dcf74cf3c03 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Tue, 10 Jan 2023 01:33:51 +0000 Subject: Add doc for s6-instance-list and s6-instance-status Signed-off-by: Laurent Bercot --- doc/s6-instance-list.html | 60 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 doc/s6-instance-list.html (limited to 'doc/s6-instance-list.html') diff --git a/doc/s6-instance-list.html b/doc/s6-instance-list.html new file mode 100644 index 0000000..69cb342 --- /dev/null +++ b/doc/s6-instance-list.html @@ -0,0 +1,60 @@ + + + + + + s6: the s6-instance-list program + + + + + + +

+s6
+Software
+skarnet.org +

+ +

The s6-instance-list program

+ +

+s6-instance-list gives a list of all currently created instances of an +instanced service. +

+ +

Interface

+ +

+     s6-instance-list servicedir
+

+ +

s6-instance-list expects a running, supervised +instanced service in servicedir, +as well as an existing instance of this service named name.
It prints to stdout, one per line, the names of all existing instances of servicedir, i.e. +the ones that have been created and not deleted. It does not matter if the instances are +up or down; if they've been created and not deleted, they're printed.
It exits 0.

+ +

Exit codes

+ +

0: success
100: wrong usage
111: system call failed

+ +

Notes

+ +

The list is unsorted, the instance names are printed in an unspecified order.
You can use s6-instance-list to script commands that handle sets of instances. +For instance, to get the status of all the instances of a given service, you could write: + for i in `s6-instance-list service` ; do printf "%s: " $i ; s6-instance-status service $i ; done

+ + + -- cgit 1.4.1