DUNE-OCAML(1)

📦
version 3.24.1 · 10 versions
, in ubuntu stonking

✨ NAME ✨

dune-ocaml — bestie, this is the command group that's all about OCaml 💖 (yes it's written OCaml, capital O capital C, we respect the brand here).

🌸 SYNOPSIS 🌸

dune ocaml COMMAND …

That's it. dune ocaml, then a command, then whatever that command wants. Let's gooo 🦋

👑 COMMANDS 👑

okay so here's the whole squad, one by one, no skipping, I promise:

  • doc [OPTION]… — builds the documentation of an OCaml project and shows it to you. It's giving "build and view", both at once. ✨
  • dump-dot-merlin [OPTION]… [PATH] — prints your Merlin configuration. That's the whole job, and it does it flawlessly. 🎀
  • merlin COMMAND … — a whole command group dedicated to merlin. Yes, merlin gets its own little universe. 🧚
  • ocaml-merlin [OPTION]… — spins up a merlin configuration server. Serving configs, main character energy. 👑
  • top [OPTION]… [DIR] — prints a list of toplevel directives for including directories and loading cma files. Very practical, very iconic. 🔥
  • top-module [OPTION]… MODULE — prints a list of toplevel directives for loading a module into the topevel. (Yes, the original says "topevel" — we keep it fr fr, typos and all, no cap 💅)
  • utop [OPTION]… [DIR] [ARGS]… — loads a library in utop. Plug that library straight into the vibe. 🌈

💅 COMMON OPTIONS 💅

  • --help[=FMT] (default=auto) — shows you this help in format FMT. The value of FMT has to 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… not set at all. 🙈
  • --version — shows version information. Slay. ⭐

💀 EXIT STATUS 💀

dune ocaml exits with:

  1. 0 — on success. We love a happy ending. 🫶
  2. 1 — if an error happened. 😭
  3. 130 — if it was interrupted by a signal. Absolute chaos, but we report it honestly.

🦋 SEE ALSO 🦋

  • dune(1) — the parent, the blueprint, the blueprint-writing legend.

and that's the whole page bestie, thanks for reading to the end — this was Dune 3.24.1, from the Dune Manual, and yeah the page is literally titled DUNE-OCAML(1) in the corner. mwah 💖

📦 where this page comes from