CMDLINER-INSTALL(1)

💅 cmdliner-install(1) — like, the whole manual, bestie

okay so this is a page from the Cmdliner Manual (yes, the CMDLINER-INSTALL(1) one, you found it, congrats 🎀). Sit down, grab a strawberry drink 🍓, and let's get you acquainted with the little installer that handles all the support files for your cmdliner tools. It's giving "glorified copy-paste" but honestly? Iconic. 👑

---

✨ NAME ✨

cmdliner-install — install support files for cmdliner tools 🫶

---

🌸 SYNOPSIS 🌸

cmdliner install COMMAND …

that's it. that's the whole vibe. cmdliner install and then a COMMAND and then whatever that command wants. periodt. 💅

---

🦋 DESCRIPTION 🦋

so the cmdliner install subcommands are the ones that actually install the cmdliner support files. that's their whole job, no cap. 🌈

want the tea on any of them? the library documentation has you covered — or honestly just poke a subcommand with --help and it'll spill everything. iykyk. 🔥

---

👑 COMMANDS 👑

• generic-completion [--dry-run] [--shell=SHELL] [--update-opam-install=PKG.install] [OPTION]… SHAREDIR — installs the generic completion scripts. the ones that aren't tied to one specific tool, bestie. ✨
• tool-completion [OPTION]… TOOLNAME… SHAREDIR — installs completion scripts for the tools you name. plural TOOLNAME…, so yes, you can absolutely bring your whole friend group. 🫶
• tool-manpages [--dry-run] [--update-opam-install=PKG.install] [OPTION]… TOOLEXEC[:NAME]… MANDIR — installs manpages for your tools and their subcommands. note the TOOLEXEC[:NAME] situation there — you can slap a :NAME on it, iykyk. 📖
• tool-support [OPTION]… TOOLEXEC[:NAME]… PREFIX — the two-for-one special: installs both the tool completion and the manpages in one go. main character energy fr fr. 💖

---

🎀 COMMON OPTIONS 🎀

• --help[=FMT] (default=auto) — shows this very help, in the format FMT. and FMT has got to be one of auto, pager, groff or plain, no exceptions. when it's auto, you get pager or plain whenever the TERM env var is dumb or straight-up undefined. (yes, TERM=dumb is real and it's kind of a mood tbh 💀)
• --version — shows version info. that's it. that's the whole thing. ⭐

---

💀 EXIT STATUS 💀

cmdliner install dips out with:

1. 0 — on success. slay. 🌸
2. 123 — on indiscriminate errors, the ones reported on standard error. not me getting a 123 😭
3. 124 — on command line parsing errors. you typed something weird, bestie. 🙈
4. 125 — on unexpected internal errors. aka bugs. yeah. those. 🐛

---

🧚 SEE ALSO 🧚

• cmdliner(1) — go read the main one, it's literally right there 💜

---

and that's the whole page!! 🎉 happy installing, bestie — go forth and make those completion scripts and manpages gorgeous. 🦋

with love from Cmdliner v2.1.1 💖 (that's the version, mwah, bye!! 👋✨)