CMDLINER(1)

📦 version 2.1.1, in arch rolling, nixos 26.05, nixpkgs unstable

CMDLINER(1) — your helper bestie from the Cmdliner Manual 💅

okay so listen bestie: CMDLINER(1) is literally the helper tool for tools that use the cmdliner command line interface library. Her whole job is helping with installing command line completion scripts and manpages. For the full lore, check the library documentation or invoke subcommands with --help — iykyk. ✨

🎀 NAME 🎀

  • cmdliner — helper tool for cmdliner based tools.

🦋 SYNOPSIS 🦋

cmdliner [COMMAND] …

✨ DESCRIPTION ✨

cmdliner is a helper for tools using the cmdliner command line interface library. She helps with installing command line completion scripts and manpages. See the library documentation, or invoke subcommands with --help for more details. no cap, that's the whole point. 💖

🌈 COMMANDS 🌈

  • generic-completion [OPTION]… SHELL — outputs generic completion scripts. ✨
  • install COMMAND … — installs support files for cmdliner tools. 🛠️
  • tool-commands [OPTION]… TOOLEXEC — outputs all subcommands of a cmdliner tool. 👑
  • tool-completion [--standalone-completion] [OPTION]… SHELL TOOLNAME — outputs tool completion scripts. 🎀

💅 COMMON OPTIONS 💅

  • --help[=FMT] (default=auto) — shows this help in format FMT. The value 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.
  • --version — shows version information.

💀 EXIT STATUS 💀

cmdliner exits with:

  • 0 — on success. slay.
  • 123 — on indiscriminate errors reported on standard error.
  • 124 — on command line parsing errors.
  • 125 — on unexpected internal errors (bugs).
bestie, those exit codes are not decorative — they're giving actual meaning. periodt.

mwah 💖 this page is brought to you by Cmdliner v2.1.1, and the footer just says CMDLINER(1) with no date listed, so that's the cute little sign-off. byeee 🫶

📦 where this page comes from