CMDLINER-INS...-TOOL-SUPPORT(1)

💅 CMDLINER-INS...-TOOL-SUPPORT(1)

okay so bestie, welcome to the manual page for cmdliner-install-tool-support — that's the Cmdliner Manual, section 1, and it's genuinely the "do both things at once" icon we all needed 🎀

---

✨ NAME ✨

cmdliner-install-tool-support — Install both tool completion and manpages. that's it, that's the whole vibe. two jobs, one command, main character energy fr 💅

---

🌸 SYNOPSIS 🌸

cmdliner install tool-support [OPTION]… TOOLEXEC[:NAME]… PREFIX

---

🦋 DESCRIPTION 🦋

so cmdliner install tool-support is literally just install tool-completion and install tool-manpages holding hands 🫶 it installs all the tool support files into a given PREFIX — and it assumes that PREFIX follows the Filesystem Hierarchy Standard. slay.

but listen, if that's not your situation (like, say, in opam as of writing 🙈), use the options --sharedir and/or --mandir to point it where you actually want stuff to go.

and pls, do yourself a favor: use option --dry-run to see which paths would be written before anything actually gets written. it's giving responsible queen behavior 👑

example time, no cap:

cmdliner install tool-support ./mytool /usr/local
cmdliner install tool-support --update-opam-install=mypkg.install \
         _build/mytool _build/prefix

---

👑 ARGUMENTS 👑

• PREFIX (required) — this is the install prefix, bestie. for example /usr/local. iconic.
• TOOLEXEC[:NAME] (required) — TOOLEXEC is the tool executable. it gets searched in the PATH unless you give an explicit file path. NAME is the tool name, and if you don't specify it, it's derived from TOOLEXEC by taking the basename and stripping any .exe extension. also: repeatable 🔁 — you can stack these, go off.

---

✨ OPTIONS ✨

• --dry-run — do not install, just output the paths that would be written. peek, don't touch 💜
• --mandir=MANDIR (absent=SHAREDIR/man) — MANDIR is the root man directory to install to.
• -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 collect them all like Pokémon 🌈
• --sharedir=SHAREDIR (absent=PREFIX/share) — SHAREDIR is the share directory to install to.
• --standalone-completion — generate standalone completion scripts. these scripts do not depend on the generic cmdliner completion scripts. heads up tho: for some shells this may result in slower completion 💀 (worth it? you decide, bestie)
• --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. and yes, this also happens if --dry-run is specified 👀 so like, not fully dry, iykyk.

---

🎀 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. iconic, brief, we love her ⭐

---

🔥 EXIT STATUS 🔥

cmdliner install tool-support exits with:

1. 0 — on success. we love a happy ending 💖
2. 123 — on indiscriminate errors reported on standard error.
3. 124 — on command line parsing errors. (typo era 😭)
4. 125 — on unexpected internal errors (bugs). if you see this one, it's not you, it's them 🐛

---

🌟 SEE ALSO 🌟

• cmdliner(1) — go read the main one, bestie, it's the parent fr fr

---

okay that's the whole page!! this was Cmdliner v2.1.1, and honestly? she ate. go install some tool support, stay hydrated, and remember: dry-run first, queen 🌸💅✨