S6-INSTANCE-CONTROL(8)

πŸ“¦ version 2.15.1.0, in nixpkgs unstable

πŸ‘‘ S6-INSTANCE-CONTROL(8) πŸ‘‘

okay so bestie, you're reading the System Manager's Manual page for s6-instance-control, and the entire assignment is: send commands to a running instance of an s6-instanced-service(7). It's giving "tiny CLI, big main character energy" πŸ’…

πŸ’– NAME πŸ’–

s6-instance-control β€” send commands to a running instance of an s6-instanced-service(7). That's literally the whole name, periodt.

✨ SYNOPSIS ✨

s6-instance-control [-wu | -wU | -wd | -wD | -wr | -wR]] [-T timeout]
                    [-abqhkti12pcyroduDUxO] servicedir name

πŸ¦‹ DESCRIPTION πŸ¦‹

s6-instance-control expects a running, supervised s6-instanced-service(7) in servicedir, plus an existing instance of that service named name. No ghost instances, no "it's around here somewhere" energy β€” it needs the real thing. πŸ™ˆ

It sends the given series of commands to the supervisor monitoring the name instance.

It exits 0. Slay.

🌸 OPTIONS 🌸

The options, and the commands they represent, are exactly the same as the ones understood by s6-svc(8). This page is not out here reinventing the flag dictionary, bestie.

In fact, s6-instance-control is nothing more than a call to s6-svc(8) 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. Iconic convenience behavior, honestly 🫢

Here are the synopsis flags, every single one:

  • -wu β€” same meaning and command as in s6-svc(8), no cap.
  • -wU β€” same meaning and command as in s6-svc(8), no cap.
  • -wd β€” same meaning and command as in s6-svc(8), no cap.
  • -wD β€” same meaning and command as in s6-svc(8), no cap.
  • -wr β€” same meaning and command as in s6-svc(8), no cap.
  • -wR β€” same meaning and command as in s6-svc(8), no cap.
  • -T timeout β€” same meaning and command as in s6-svc(8), no cap.
  • -abqhkti12pcyroduDUxO β€” the bundled flag string from the synopsis; same meanings and commands as in s6-svc(8), fr fr.
πŸ’€ reminder: because all of these are exactly the s6-svc(8) options, don't expect this page to give you a whole second set of definitions. Go check s6-svc(8) for the actual flag lore, iykyk.

⭐ EXIT STATUS ⭐

  • 0 β€” success. We love a clean exit πŸ’–
  • 99 β€” with one of the -w options, timed out while waiting for the command to complete. Not the ending we wanted 😭
  • 100 β€” wrong usage. Oop.
  • 111 β€” system call failed. Rude.

🌈 SEE ALSO 🌈

Go read these next, bestie:

πŸŽ€ AUTHORS πŸŽ€

  • Laurent Bercot
  • Alexis <flexibeast@gmail.com> (man page port) β€” thank you for the port, bestie 🫢

πŸ“ That's the whole page! Source/version: Debian; date: May 19, 2024; manual: S6-INSTANCE-CONTROL(8) β€” mwah, bestie πŸ’‹
πŸ“¦ where this page comes from