KAPLA-VOLUME-RETIRE(1)

πŸ“¦ version 0.4.0, in nixpkgs unstable

πŸ’… KAPLA-VOLUME-RETIRE(1) β€” like, the Kapla Manual, bestie

okay so real talk: this is kapla-volume-retire, one of the kapla manual pages (yes, the Kapla Manual β€” that's the family it runs with), and it does exactly one iconic thing: it retires a volume. that's the whole vibe. let's get into it πŸŽ€


✨ NAME ✨

kapla-volume-retire β€” retire volume. boom. that's the job. slay.


🌸 SYNOPSIS 🌸

kapla volume retire [--control=CONTROL_SOCKET] [OPTION]… UUID

that's the whole shape of it, bestie πŸ’–


πŸ¦‹ ARGUMENTS πŸ¦‹

  • UUID (required, no cap) β€” the UUID of the volume you wanna retire. like, you literally cannot skip this one, it's the whole point πŸ™ˆ

πŸ’… OPTIONS πŸ’…

  • -c CONTROL_SOCKET, --control=CONTROL_SOCKET β€” the Kapla control socket. where does it look if you don't say? in order: $XDG_STATE_HOME/kapla/kapla.sock, then $HOME/.local/state/kapla/kapla.sock, then /var/lib/kapla/kapla.sock. it's giving "absent, so here's the fallback list" energy ✨

🌈 COMMON OPTIONS 🌈

  • --color=WHEN (absent=auto) β€” colorize the output, obviously πŸ’… 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. iykyk 🧚
  • -q, --quiet β€” be quiet. and bestie, it takes over -v and --verbosity. it wins. periodt.
  • -v, --verbose β€” increase verbosity. repeatable, but lowkey more than twice does not bring more. like, it caps out, that's the deal 😭
  • --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. and yeah, it takes over -v. πŸ‘‘
  • --version β€” show version information. the classic.

πŸ“ EXIT STATUS πŸ“

kapla volume retire exits with:

  • 0 β€” on success. we love a happy ending 🫢
  • 123 β€” on indiscriminate errors reported on standard error. πŸ’€
  • 124 β€” on command line parsing errors. (typo era, we've all been there)
  • 125 β€” on unexpected internal errors (bugs). not me tho πŸ™ˆ

πŸ”₯ ENVIRONMENT πŸ”₯

these environment variables affect the execution of kapla volume retire:

  • KAPLA_LOG_LEVEL β€” set the log level. that's it, that's the whole entry, but it's important fr fr ⭐

πŸ‘‘ SEE ALSO πŸ‘‘

kapla(1) β€” go read the big one, bestie, it's the main character πŸ’œ


heads up: this is a manual page, so the facts above are the facts β€” don't go inventing extra flags, i'm serious 😀

and that's the page!! kapla volume retire, explained, no notes πŸ’– this lil writeup is from Kapla 0.4.0, and honestly? iconic. bye bestie, go retire that volume 🌸✨

πŸ“¦ where this page comes from