OPAM-HELP(1)

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

💖 OPAM-HELP(1) 💖

okay bestie, gather round, because this is the page that explains how you ask opam for help. it lives in the Opam Manual, and it is literally the friendliest little command in the whole toolbox. no cap.

✨ NAME ✨

opam-help — display help about opam and opam commands. yes girl, that's the whole job. it's giving "ask and you shall receive". 🫶

🌸 SYNOPSIS 🌸

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

🦋 DESCRIPTION 🦋

Prints help about opam commands. that's it, that's the vibe. ✨

Use opam help topics to get the full list of help topics — like, the entire menu of things you're allowed to ask about. lowkey the most useful thing you'll type all day. 💅

🎀 ARGUMENTS 🎀

  • TOPIC — the topic to get help on. whatever you're curious about, drop it here and opam will yap about it. 👑

💜 OPTIONS 💜

  • --man-format=FMT (absent=pager) — show output 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. so basically it picks the sensible option for your terminal and doesn't embarrass you. iconic behaviour honestly. 🌈

⭐ 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. help for the help command… recursion? no bestie, it's just self-care. 🙈
  • --version — show version information. the "who even are you" option. 🍓

🔥 EXIT STATUS 🔥

opam help exits with:

  1. 0 — on success. we love a clean exit. slay. 💖
  2. 123 — on indiscriminate errors reported on standard error. 🤨
  3. 124 — on command line parsing errors. you typed something cursed, bestie. 😭
  4. 125 — on unexpected internal errors (bugs). not me filing a bug report… 💀

🌟 SEE ALSO 🌟

fr fr, if opam help can't help you, nothing can. go read opam help topics and stan a command. 👑

and that's the whole page, bestie — no notes, periodt.

this masterpiece was delivered to you by Opam 2.6.1, dated by its OPAM-HELP(1) footer, and written with so much love you can feel it through the terminal. mwah. 🎀💅🫶

📦 where this page comes from