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-status.html | 64 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 doc/s6-instance-status.html (limited to 'doc/s6-instance-status.html') diff --git a/doc/s6-instance-status.html b/doc/s6-instance-status.html new file mode 100644 index 0000000..4bc6b75 --- /dev/null +++ b/doc/s6-instance-status.html @@ -0,0 +1,64 @@ + + + + + + s6: the s6-instance-status program + + + + + + +

+s6
+Software
+skarnet.org +

+ +

The s6-instance-status program

+ +

+s6-instance-status gives the status of a running instance of an +instanced service, as a short human-readable +summary or programmatically parsable output. +

+ +

Interface

+ +

+     s6-instance-status [ -uwNrpest | -o up,wantedup,normallyup,ready,paused,pid,exitcode,signal,signum,updownsince,readysince,updownfor,readyfor ] [ -n ] servicedir name
+

+ +

s6-instance-status expects a running, supervised +instanced service in servicedir, +as well as an existing instance of this service named name.
It prints information to stdout about the monitored instance of servicedir named name.
It exits 0.

+ +

Exit codes

+ +

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

+ +

Options

+ +

+ The options are exactly the same as the ones understood by s6-svstat. +

+ +

+ In fact, s6-instance-status is +nothing more than a call to s6-svstat on the service +directory representing the name instance. It is syntactic sugar so +the user does not have to depend on the internal representation of instances +and the location of instances' service directories. +

+ + + -- cgit 1.4.1