S6-INSTANCE-STATUS(8)

💅 S6-INSTANCE-STATUS(8) — like, the whole manual, but make it make sense

okay so bestie, quick vibe check: this is a page from the System Manager's Manual, and it's all about s6-instance-status — the little tool that tells you what's up with one specific running instance of an s6-instanced-service(7). It'll give you either a short human-readable summary or output you can parse programmatically, your call. ✨

---

🌸 NAME 🌸

s6-instance-status — give the status of a running instance of an s6-instanced-service(7), as a short human-readable summary or programmatically parsable output

🎀 SYNOPSIS 🎀

s6-instance-status
                   [-uwNrpest | -o up,wantedup,normallyup,ready,paused,pid,exitcode,signal,signum,updownsince,readysince,updownfor,readyfor]
                   [-n] servicedir name

like yes, that second line is long, no I will not be apologising for it 💅

🦋 DESCRIPTION 🦋

So here's the tea 🍓: s6-instance-status expects a running, supervised s6-instanced-service(7) sitting in servicedir, and it also expects that an instance of this service named name already exists. Both of those things? Non-negotiable. It's giving "bring your own prerequisites."

Once it's got all that, it prints information to stdout about the monitored instance of servicedir named name. That's it. That's the whole job. 👑

And then — and this is the best part — it exits 0. Slay. ✅

🔥 OPTIONS 🔥

Okay so the options are exactly the same as the ones understood by s6-svstat(8). Not "similar", not "inspired by" — literally the same ones. Iconic behaviour, honestly.

In fact (and this is the plot twist 🫢), s6-instance-status is nothing more than a call to s6-svstat(8) on the service directory representing the name instance. It's syntactic sugar, bestie. Pure, unadulterated sugar. It exists so you, the user, do not have to depend on:

• the internal representation of instances, or
• the location of instances' service directories.

You're welcome. 🫶

⭐ EXIT STATUS ⭐

• 0 — Success. We love to see it. 💖
• 100 — Wrong usage. You did something goofy with the arguments, no judgement. 🙈
• 111 — System call failed. Not your fault, the system's just being like that. 😭

🌈 SEE ALSO 🌈

• s6-instanced-service(7)
• s6-instance-control(8)
• s6-instance-create(8)
• s6-instance-delete(8)
• s6-instance-list(8)
• s6-instance-maker(8)

the whole squad, fr fr 💜

👑 AUTHORS 👑

• Laurent Bercot
• Alexis <flexibeast@gmail.com> (man page port)

---

okay that's the whole thing, no cap 🧚 this edition came from Debian, dated January 11, 2023 — and it's S6-INSTANCE-STATUS(8) all the way down at the bottom too. mwah 💋✨