s6

Mirror/fork of https://skarnet.org/software/s6/
git clone https://ccx.te2000.cz/git/s6
Log | Files | Refs | README | LICENSE

s6-instance-control.html (2154B)

      1 <html>
      2   <head>
      3     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
      4     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
      5     <meta http-equiv="Content-Language" content="en" />
      6     <title>s6: the s6-instance-control program</title>
      7     <meta name="Description" content="s6: the s6-instance-control program" />
      8     <meta name="Keywords" content="s6 command s6-instance-control instance dynamic instantiation instanced services control s6-svc" />
      9     <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
     10   </head>
     11 <body>
     12 
     13 <p>
     14 <a href="index.html">s6</a><br />
     15 <a href="//skarnet.org/software/">Software</a><br />
     16 <a href="//skarnet.org/">skarnet.org</a>
     17 </p>
     18 
     19 <h1> The s6-instance-control program </h1>
     20 
     21 <p>
     22 s6-instance-control sends commands to a running instance of an
     23 <a href="instances.html">instanced service</a>.
     24 </p>
     25 
     26 <h2> Interface </h2>
     27 
     28 <pre>
     29      s6-instance-control [ -wu | -wU | -wd | -wD | -wr | -wR ] [ -T <em>timeout</em> ] [ -abqhkti12pcyroduDUxO ] <em>servicedir</em> <em>name</em>
     30 </pre>
     31 
     32 <ul>
     33  <li> s6-instance-control expects a running, supervised
     34 <a href="instances.html">instanced service</a> in <em>servicedir</em>,
     35 as well as an existing instance of this service named <em>name</em>. </li>
     36  <li> It sends the given series of commands to the supervisor monitoring
     37 the <em>name</em> instance. </li>
     38  <li> It exits 0. </li>
     39 </ul>
     40 
     41 <h2> Exit codes </h2>
     42 
     43 <ul>
     44  <li> 0: success </li>
     45  <li> 99: with one of the <tt>-w</tt> options, timed out while waiting for the command to complete </li>
     46  <li> 100: wrong usage </li>
     47  <li> 111: system call failed </li>
     48 </ul>
     49 
     50 <h2> Options </h2>
     51 
     52 <p>
     53  The options, and the commands they represent, are exactly the same as the ones
     54 understood by <a href="s6-svc.html">s6-svc</a>.
     55 </p>
     56 
     57 <p>
     58  In fact, s6-instance-control is
     59 nothing more than a call to <a href="s6-svc.html">s6-svc</a> on the service
     60 directory representing the <em>name</em> instance. It is syntactic sugar so
     61 the user does not have to depend on the internal representation of instances
     62 and the location of instances' service directories.
     63 </p>
     64 
     65 </body>
     66 </html>