OCAMLDOT(1)

📦 in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 OCAMLDOT(1) 💖

okay bestie, welcome to the General Commands Manual, section 1, where we're talking about ocamldot — yes, the little icon that makes your OCaml dependency spaghetti look like an actual graph ✨

🌸 NAME 🌸

ocamldot — generate dependency graphs of ocaml programs 🦋

✨ SYNOPSIS ✨

ocamldot [options] <dependency-file>

🎀 DESCRIPTION 🎀

okay so first things first: this manual page documents briefly the ocamldot command. brief. like a text from your bestie that just says "call me". 😭

ocamldot generates program dependency graphs for ocaml programs. that's the whole vibe. it takes your dependency info and hands you back a graph, and then a separate program called dot renders that graph into something your eyeballs can actually enjoy. so ocamldot makes the graph, dot makes it pretty. teamwork. slay. 💅

Ocamldot is designed to process the output of ocamldep. that's its whole thing, that's its moment, that's its main character energy. a typical use would be:

ocamldep *.ml | ocamldot > dep.dot

or, if you're the type who likes to save your steps like a little archive goblin 🍓:

ocamldep *.ml > .depend
ocamldot .depend > dep.dot

💅 OPTIONS 💅

  • -fullgraph — draw the full graph. no cap. (the default is to draw only the kernel — more on that lil guy below 👇)
  • -landscape — output in landscape format. (the default is portrait, so if your graph is giving tall-girl energy, this is your fix ✨)
  • -lr — draw the graph from left to right. (the default is top to bottom, so this is the "rotate your whole worldview" option 🌈)
  • -r <r> — use <r> as a root in the graph; nodes reachable from <r> will be shown. so it's like, you pick the main character, and only the people in their orbit get to appear on screen 👑

🧚 a lil note on the kernel 🧚

not me explaining graph theory in a manpage but here we are, bestie, it's giving educational 🫶

The transitive kernel of a dag is the smallest subset of the dag whose transitive closure is the same as the transitive closure of the dag.

okay that's the formal version. here's the vibe check version: for example, the kernel of A->B, A->C, B->C is just the two edges A->B, B->C. because A->C was already implied — it's the redundancy, and the kernel said "we don't need that one, it's derivative, it's a rerun" 💀 so by default ocamldot keeps only the edges that actually matter, and if you want every single one, that's what -fullgraph is for. periodt.

🔥 SEE ALSO 🔥

👑 AUTHOR 👑

Trevor Jim <trevor@research.att.com>

⭐ reminder bestie: ocamldot writes the graph, dot renders it. don't expect one to do the other's job, they're not that kind of relationship 💖

and that's the whole page!! this one lives in section 1 of the General Commands Manual — shoutout to the classic manpage header/footer combo, iconic, no notes, mwah 💋 ✨ 🌸

📦 where this page comes from