s6: the s6-instance-status program
Keywords: s6 command s6-instance-status instance dynamic instantiation instanced services status s6-svstat

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.