OPAM-ADMIN-HELP(1)

📦
version 2.6.1 · 8 versions
, in arch rolling, fedora 44

💖 OPAM-ADMIN-HELP(1) — the opam admin Manual, bestie edition ✨

okay so real talk: this is the manual page for opam admin-help, living under the Opam admin manual umbrella. buckle up, it's short and it's slay 💅

🌸 NAME 🌸

opam admin-help — shows you the help for opam admin and all its little subcommands. it's giving "instruction manual for the instruction manual", and honestly? iconic 🎀

✨ SYNOPSIS ✨

opam admin help [--man-format=FMT] [OPTION]… [TOPIC]

🦋 DESCRIPTION 🦋

It prints help about opam admin commands. that's it, that's the job 🫶

And here's the cheat code, no cap: run opam admin help topics to get the full list of help topics. go get 'em 💖

🌈 ARGUMENTS 🌈

  • TOPIC — the topic you wanna get help on. that's the whole vibe. pick your fighter 💅

👑 OPTIONS 👑

  • --man-format=FMT (absent = pager) — show the output in format FMT. the value of FMT must be one of auto, pager, groff or plain. and with auto, the format becomes pager or plain whenever the TERM env var is dumb or just straight-up undefined. yes, plain is the fallback for when your terminal is not serving looks 💀

🧚 COMMON OPTIONS 🧚

  • --help[=FMT] (default = auto) — show this help in format FMT. 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. same rules, different icon ⭐
  • --version — show version information. just the facts, bestie 🔥

💜 EXIT STATUS 💜

opam admin help exits with:

  1. 0 — on success. we ate, no crumbs 🍓
  2. 123 — on indiscriminate errors reported on standard error. mess, but documented mess 😭
  3. 124 — on command line parsing errors. the command line said "not today" 🙈
  4. 125 — on unexpected internal errors (bugs). it's giving bug energy, literally 🐛

🌸 SEE ALSO 🌸

lowkey reminder: every flag, every exit code, every TERM=dumb caveat up there is load-bearing. don't skip the boring bits, that's where the lore lives 💖

that's the whole page, bestie — go forth and --help responsibly ✨

much love from Opam admin version 2.6.1 🫶

📦 where this page comes from