CMDLINER-INS...OOL-MANPAGES(1)

💅 cmdliner-install-tool-manpages ✨

okay bestie, so this is a page from the Cmdliner Manual (yes, the Cmdliner Manual, that's the manual name, we said it, moving on 🫶) and it's literally all about getting your manpages installed exactly where they belong.

---

🌸 NAME 🌸

cmdliner-install-tool-manpages — installs the manpages for your tool and all its subcommands. periodt 💖

---

🎀 SYNOPSIS 🎀

cmdliner install tool-manpages [--dry-run]
[--update-opam-install=PKG.install] [OPTION]… TOOLEXEC[:NAME]… MANDIR

like, that's the whole shape of it, no cap ✨

---

🦋 DESCRIPTION 🦋

so cmdliner install tool-manpages installs the manpages of the tool and its commands into the right directories inside a man directory. directories get created if they're needed — it's giving "I'll make room for you" energy 💅

wanna peek before committing? use --dry-run and it'll show you which paths would get written. iconic.

here's the vibe in action:

cmdliner install tool-manpages ./mytool /usr/local/share/man

💀 heads up bestie: the command install tool-support also installs manpages, same as this command does. so don't be surprised if both of them do the thing, iykyk.

---

🌈 ARGUMENTS 🌈

• MANDIR (required) — this is the root man directory you're installing into, like the main character of destinations 👑
• TOOLEXEC[:NAME] (required) — TOOLEXEC is the tool executable. it gets searched in the PATH unless you give an explicit file path. and NAME is the tool name — if you don't specify it, it's derived from TOOLEXEC by taking the basename and stripping any .exe extension. also it's repeatable, so you can stack these, go off 🍓

---

✨ OPTIONS ✨

• --dry-run — do not install, just output the paths that would be written. pure window-shopping, no receipts 🙈
• --update-opam-install=PKG.install — update or create an opam .install file at PKG.install, with install moves from the installed files into the corresponding opam install sections. and yes, this also happens if you passed --dry-run. sneaky but true 💜

---

🧚 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. very considerate of it honestly 🫶
• --version — show version information. the classic, the icon, the moment ⭐

---

⭐ EXIT STATUS ⭐

cmdliner install tool-manpages exits with:

• 0 — on success. slay 🎉
• 123 — on indiscriminate errors reported on standard error. 😭
• 124 — on command line parsing errors. so if you fumbled the flags, that's this one 💀
• 125 — on unexpected internal errors (bugs). like actually a bug, not your fault, tell someone 🔥

---

💜 SEE ALSO 💜

• cmdliner(1) — go read the parent, bestie, it knows things 🌸

---

🦋 okay that's the whole page, every last flag intact, nothing skipped, we ate and left no crumbs 💅

Cmdliner v2.1.1 — that's the source/version, and it's the whole footer, so like… mwah. bye bestie, go install those manpages 💖✨