s6

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

s6-instance-status.html (2147B)

      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-status program</title>
      7     <meta name="Description" content="s6: the s6-instance-status program" />
      8     <meta name="Keywords" content="s6 command s6-instance-status instance dynamic instantiation instanced services status s6-svstat" />
      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-status program </h1>
     20 
     21 <p>
     22 s6-instance-status gives the status of a running instance of an
     23 <a href="instances.html">instanced service</a>, as a short human-readable
     24 summary or programmatically parsable output.
     25 </p>
     26 
     27 <h2> Interface </h2>
     28 
     29 <pre>
     30      s6-instance-status [ -uwNrpest | -o up,wantedup,normallyup,ready,paused,pid,exitcode,signal,signum,updownsince,readysince,updownfor,readyfor ] [ -n ] <em>servicedir</em> <em>name</em>
     31 </pre>
     32 
     33 <ul>
     34  <li> s6-instance-status expects a running, supervised
     35 <a href="instances.html">instanced service</a> in <em>servicedir</em>,
     36 as well as an existing instance of this service named <em>name</em>. </li>
     37  <li> It prints information to stdout about the monitored instance of <em>servicedir</em> named <em>name</em>. </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> 100: wrong usage </li>
     46  <li> 111: system call failed </li>
     47 </ul>
     48 
     49 <h2> Options </h2>
     50 
     51 <p>
     52  The options are exactly the same as the ones understood by <a href="s6-svstat.html">s6-svstat</a>.
     53 </p>
     54 
     55 <p>
     56  In fact, s6-instance-status is
     57 nothing more than a call to <a href="s6-svstat.html">s6-svstat</a> on the service
     58 directory representing the <em>name</em> instance. It is syntactic sugar so
     59 the user does not have to depend on the internal representation of instances
     60 and the location of instances' service directories.
     61 </p>
     62 
     63 </body>
     64 </html>