KAPLA-VOLUME-UNLINK(1)

📦 version 0.4.0, in nixpkgs unstable

okay so this is kapla-volume-unlink, and before we go ANY further: this one is the delete button. girlypop does not do undo. read the synopsis, take a breath, and let's go ✨

🌸 NAME 🌸

kapla-volume-unlink — unlink a volume. that's it. that's the whole job. lowkey iconic, highkey permanent 💀

🦋 SYNOPSIS 🦋

kapla volume unlink [--control=CONTROL_SOCKET] [OPTION]… UUID
🚨 bestie listen to me. this will permanently delete the volume and all the blocks contained within the volume. like, gone gone. no recycle bin, no comeback tour, no "wait I changed my mind". fr fr, double-check that UUID before you hit enter 😭

💖 ARGUMENTS 💖

  • UUID (required) — the UUID of the volume you want to retire 👋 give it a little farewell wave, because that volume is leaving.

✨ OPTIONS ✨

  • -c CONTROL_SOCKET, --control=CONTROL_SOCKET — the Kapla control socket. when it's absent, it falls back to $XDG_STATE_HOME/kapla/kapla.sock, then $HOME/.local/state/kapla/kapla.sock, then /var/lib/kapla/kapla.sock. it's giving "we'll find it, don't worry" 🫶

💅 COMMON OPTIONS 💅

  • --color=WHEN (absent=auto) — colorize that output, bestie 🌈 WHEN has to be one of auto, always or never. pick your fighter.
  • --help[=FMT] (default=auto) — show this help in format FMT 👑 FMT must be one of auto, pager, groff or plain. with auto, the format is pager or plain whenever the TERM env var is dumb or undefined. (yes, TERM can be dumb. relatable.)
  • -q, --quiet — be quiet 🤫 takes over -v and --verbosity. it ate, honestly.
  • -v, --verbose — increase verbosity. repeatable! but more than twice does not bring more 😔 the vibe check caps out at two.
  • --verbosity=LEVEL (absent=warning or KAPLA_LOG_LEVEL env) — be more or less verbose. LEVEL must be one of quiet, error, warning, info or debug. takes over -v.
  • --version — show version information 🎀 the classic.

🔥 EXIT STATUS 🔥

kapla volume unlink exits with:

  • 0 — on success ✨ slay.
  • 123 — on indiscriminate errors reported on standard error 💀 not me getting a 123.
  • 124 — on command line parsing errors 🙈 you typed something cursed.
  • 125 — on unexpected internal errors (bugs) 🐛 aka "this is not my fault, it's a whole bug situation".

🌺 ENVIRONMENT 🌺

these environment variables affect the execution of kapla volume unlink:

  • KAPLA_LOG_LEVEL — set the log level ⭐

🧚 SEE ALSO 🧚

kapla(1) — go read the main character's page, iykyk 💜

and that's the whole page, bestie! stay hydrated, back up your blocks, and remember: unlink means unlink 💀✨

written with love from the Kapla Manual, version Kapla 0.4.0 — mwah, see u in the group chat 🫶🎀

📦 where this page comes from