diff options
| author | Laurent Bercot <ska-skaware@skarnet.org> | 2023-01-09 11:09:14 +0000 |
|---|---|---|
| committer | Laurent Bercot <ska@appnovation.com> | 2023-01-09 11:09:14 +0000 |
| commit | 09750ce3525129a676dec4f579aea3ad2eca1b19 (patch) | |
| tree | acae6b5f47914d7ed85bbb8fe9780ed34a85cfd0 /doc/s6-instance-control.html | |
| parent | 191b46491407632f2431c46eab97dbf5543fa26d (diff) | |
| download | s6-09750ce3525129a676dec4f579aea3ad2eca1b19.tar.xz | |
Add instances implementation (still needs testing)
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc/s6-instance-control.html')
| -rw-r--r-- | doc/s6-instance-control.html | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/s6-instance-control.html b/doc/s6-instance-control.html new file mode 100644 index 0000000..cd76688 --- /dev/null +++ b/doc/s6-instance-control.html @@ -0,0 +1,65 @@ +<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-control program</title> + <meta name="Description" content="s6: the s6-instance-control program" /> + <meta name="Keywords" content="s6 command s6-instance-control instance dynamic instantiation instanced services control s6-svc" /> + <!-- <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-control program </h1> + +<p> +s6-instance-control sends commands to a running instance of an +<a href="instances.html">instanced service</a>. +</p> + +<h2> Interface </h2> + +<pre> + s6-instance-control [ -wu | -wU | -wd | -wD | -wr | -wR ] [ -T <em>timeout</em> ] [ -abqhkti12pcyoduDUxOr ] <em>servicedir</em> <em>name</em> +</pre> + +<ul> + <li> s6-instance-control 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 sends the given series of commands to the supervisor monitoring +the <em>name</em> instance. </li> + <li> It exits 0. </li> +</ul> + +<h2> Exit codes </h2> + +<ul> + <li> 0: success </li> + <li> 99: with one of the <tt>-w</tt> options, timed out while waiting for the command to complete </li> + <li> 100: wrong usage </li> + <li> 111: system call failed </li> +</ul> + +<h2> Options </h2> + +<p> + The options, and the commands they represent, are exactly the same as the ones +understood by <a href="s6-svc.html">s6-svc</a>. +</p> + + In fact, s6-instance-control is +nothing more than a call to <a href="s6-svc.html">s6-svc</a> on the service +directory representing the <em>name</em> 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. +</p> + +</body> +</html> |