diff options
| author | Laurent Bercot <ska-skaware@skarnet.org> | 2023-01-10 01:33:51 +0000 |
|---|---|---|
| committer | Laurent Bercot <ska@appnovation.com> | 2023-01-10 01:33:51 +0000 |
| commit | 7b9931e6403db6aeabb0ccc26e126dcf74cf3c03 (patch) | |
| tree | 44ff4addcca17eba6bda9a88b7601236646a89fc /doc/s6-instance-list.html | |
| parent | 955d4078d0709372129fb883d3ea4bd6d7ad735e (diff) | |
| download | s6-7b9931e6403db6aeabb0ccc26e126dcf74cf3c03.tar.gz s6-7b9931e6403db6aeabb0ccc26e126dcf74cf3c03.tar.xz s6-7b9931e6403db6aeabb0ccc26e126dcf74cf3c03.zip | |
Add doc for s6-instance-list and s6-instance-status
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc/s6-instance-list.html')
| -rw-r--r-- | doc/s6-instance-list.html | 60 |
1 files changed, 60 insertions, 0 deletions
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 @@ +<html> + <head> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Language" content="en" /> + <title>s6: the s6-instance-list program</title> + <meta name="Description" content="s6: the s6-instance-list program" /> + <meta name="Keywords" content="s6 command s6-instance-list instance dynamic instantiation instanced services list listing" /> + <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> + </head> +<body> + +<p> +<a href="index.html">s6</a><br /> +<a href="//skarnet.org/software/">Software</a><br /> +<a href="//skarnet.org/">skarnet.org</a> +</p> + +<h1> The s6-instance-list program </h1> + +<p> +s6-instance-list gives a list of all currently created instances of an +<a href="instances.html">instanced service</a>. +</p> + +<h2> Interface </h2> + +<pre> + s6-instance-list <em>servicedir</em> +</pre> + +<ul> + <li> s6-instance-list expects a running, supervised +<a href="instances.html">instanced service</a> in <em>servicedir</em>, +as well as an existing instance of this service named <em>name</em>. </li> + <li> It prints to stdout, one per line, the names of all existing instances of <em>servicedir</em>, 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. </li> + <li> It exits 0. </li> +</ul> + +<h2> Exit codes </h2> + +<ul> + <li> 0: success </li> + <li> 100: wrong usage </li> + <li> 111: system call failed </li> +</ul> + +<h2> Notes </h2> + +<ul> + <li> The list is unsorted, the instance names are printed in an unspecified order. </li> + <li> 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: +<code> for i in `s6-instance-list <em>service</em>` ; do printf "%s: " $i ; s6-instance-status <em>service</em> $i ; done </code> </li> +</ul> + +</body> +</html> |