CMDLINER-INS...IC-COMPLETION(1)

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

💅 NAME 💅

cmdliner-install-generic-completion — install generic completion scripts, bestie. This one lives in the Cmdliner Manual and is literally here to help you install generic completion scripts. Periodt.

✨ SYNOPSIS ✨

cmdliner install generic-completion [--dry-run] [--shell=SHELL]
[--update-opam-install=PKG.install] [OPTION]… SHAREDIR

🦋 DESCRIPTION 🦋

Okay so cmdliner install generic-completion installs the generic completion script of given shells into a share directory according to specific shell conventions. Directories are created if needed — yes, it handles that for you. Use option --dry-run to see which paths would be written. Examples:

cmdliner install generic-completion /usr/local/share # All supported shells
cmdliner install generic-completion --shell zsh /usr/local/share

To inspect the actual scripts use the command generic-completion. Iconic.

🎀 ARGUMENTS 🎀

  • SHAREDIR (required) — SHAREDIR is the share directory to install to. That’s the destination, bestie.

💖 OPTIONS 💖

  • --dry-run — Do not install; output paths that would be written. It’s the “look, don’t touch” mode.
  • -s SHELL, --shell=SHELL — (absent=All supported shells) SHELL is the shell to support, and it must be one of bash, zsh or pwsh. Repeatable, so you can stack it.
  • --update-opam-install=PKG.install — Update or create an opam .install file PKG.install with install moves from the installed files to the corresponding opam install sections. Also performed if --dry-run is specified. Yes, even in dry-run.

🌈 COMMON OPTIONS 🌈

  • --help[=FMT] — (default=auto) Show 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 — Show version information. Slay.

🔥 EXIT STATUS 🔥

cmdliner install generic-completion exits with:

  • 0 — on success.
  • 123 — on indiscriminate errors reported on standard error.
  • 124 — on command line parsing errors.
  • 125 — on unexpected internal errors (bugs).

⭐ SEE ALSO ⭐

Bye bestie 🫶 — source/version: Cmdliner v2.1.1; date: not shown on the page, so I’m not inventing one. 💖

📦 where this page comes from