DUNE-HELP(1)

📦
version 3.24.1 · 14 versions
, in ubuntu stonking

💖 DUNE-HELP(1) — the Dune Manual, but make it a group chat 💖

okay bestie so you found dune-help, the extra-help little sibling of dune itself. She's giving "I have a whole other manual for you" energy and honestly? iconic. 🦋

✨ NAME ✨

dune-help — Additional Dune help. Yes that's literally it. She's the help for the help. Very meta. Very main character. 💅

🌸 SYNOPSIS 🌸

dune help [--build-info] [--man-format=FMT] [OPTION]… [TOPIC]

🎀 DESCRIPTION 🎀

okay so dune help TOPIC gives you additional help on the topic you asked for. Like, extra. Beyond. Bonus content. 🫶

the topics you can ask about are:

  • config — which points you at dune-config

that's the whole list, bestie. no cap. 💀

💅 OPTIONS 💅

  • --build-info — shows you the build information. the ✨receipts✨ of the build.
  • --man-format=FMT (absent = pager) — shows the output in format FMT. and FMT has to be one of auto, pager, groff or plain, no improvising fr fr. with auto, the format is pager or plain whenever the TERM env var is dumb or undefined. so if your terminal is being dumb (literally), you get the plain one. 🙈

⭐ COMMON OPTIONS ⭐

  • --help[=FMT] (default = auto) — shows this help in format FMT. and yeah, 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, same vibes. 🔁
  • --version — shows version information. the "who am i" moment. 👑

🔥 EXIT STATUS 🔥

dune help exits with:

  • 0 — on success. we ate. 🔥
  • 1 — if an error happened. it's giving oops. 😭
  • 130 — if it was interrupted by a signal. rude interruption honestly. 💀

🌈 ENVIRONMENT 🌈

these environment variables affect the execution of help, so listen up:

  • CLICOLOR — if it's different than 0, ANSI colors are supported and should be used when the program isn't piped. if it's equal to 0, don't output ANSI color escape codes. zero means no sparkle. 🙅
  • CLICOLOR_FORCE — if it's different than 0, ANSI colors should be enabled no matter what. no matter WHAT. forced. periodt. 💅
  • DUNE_CACHE_ROOT — if set, determines the location of all the different caches used by dune. all of them. the whole cache situation. 🗂️

💀 BUGS 💀

check bug reports at https://github.com/ocaml/dune/issues — go tell them, not me, bestie 🫶

🦋 SEE ALSO 🦋

and that's the whole page, no crumbs left. this was Dune 3.24.1, from the Dune Manual, and it's the page DUNE-HELP(1) — mwah, slay, go run dune help and be free. 💖✨🎀

📦 where this page comes from