CAML2HTML(1)

💖 NAME 💖

okay so bestie, welcome to the caml2html page — this is section 1 of the User Manuals, and it's literally all about pretty printing OCaml in html and latex ✨

---

🌸 SYNOPSIS 🌸

caml2html [Options...] files...

---

🦋 DESCRIPTION 🦋

So what does caml2html do? It pretty prints your OCaml source code as html or LaTeX files, and it's giving ✨aesthetic✨ the whole time. The pretty printing uses colors 🌈 and it adds tool-tips with type annotations if the matching .annot file is sitting right there. iykyk.

If you don't hand it any file arguments at all, it reads from standard input instead. And by default? It writes to standard output. no cap. 💅

---

✨ OPTIONS ✨

okay here's the whole menu, don't skip any, every single one matters 🫶

• -annotfilter {innermost|outermost} — pick your fighter: should the innermost or the outermost type annotations get used? (default is innermost)
• -noannot — don't insert the type annotations that get read from .annot files. HTML output only, just so you know.
• -ln — drop a line number at the beginning of every single line 🔢
• -hc — comments get treated as raw HTML or LaTeX code. heads up tho: no newlines inside of tags ⚠️
• -t — add a title to the HTML page 👑
• -body — output only the document's body, so you can shove it inside an existing document (peep -make-css and -make-latex-defs too 👀)
• -nf — do not add footnotes to the HTML page
• -inhead — use the default styling and place it in the <head> section of the document (this is the default when it applies)
• -charset <charset> — specify which charset to use (default: iso-8859-1)
• -css — use a separate CSS style file, style.css
• -cssurl <URL> — use URL as the CSS
• -inline — use inline styling (HTML only, and it's the default fallback if -inhead isn't applicable)
• -ie7 — drop support for type annotations on Internet Explorer 6 and older 💀
• -notab — do not replace tabs by spaces
• -tab <integer> — replace a tab by n spaces (default = 8)
• -d <directory> — generate files in directory dir, rather than in the current directory
• -o <filename> — output file
• -make-css <filename> — create a CSS file with the default color definitions and then exit
• -ext <NAME:CMD> — use the given external command CMD to handle comments that start with (*NAME. NAME must be a lowercase identifier. See EXAMPLES below 👇
• -latex — output LaTeX code instead of HTML.
• -make-latex-defs <filename> — create a file containing the default LaTeX color definitions and matching highlighting commands, and exit. \usepackage{alltt,color} is not included.
• -v — print version number to stdout and exit
• -help | --help — Display options and exit.

---

🍓 EXAMPLES 🍓

Process many files into a single file:

caml2html -o result.html *.mli *.ml

Process many files, and create one HTML page for each file:

caml2html *.ml

You can use HTML in the comments of the source file, for instance, to insert hyperlinks:

(* This is file1.ml.
   <a href="#file2.ml">This is a link to file2.ml</a>. *)

Note, that one HTML tag cannot span over several lines, and that the ordinary characters <, > and & must be written as <, > and &. 🫠

Custom comment handlers — to implement an include directive for comments, use

caml2html -ext "include: xargs cat" example.ml

Then

(*include i.html *)
let f x = 2 * x + 1

produces

... contens of i.html ...
let f x = 2 * x + 1

as result. slay 💅

---

💜 SEE ALSO 💜

• The caml2html web page — http://mjambon.com/caml2html.html
• Some more examples are on — /usr/share/doc/caml2html/caml2html.html

---

👑 AUTHOR 👑

This manual page was written by Sylvain Le Gall <gildor@debian.org> and Hendrik Tews <hendrik@askra.de>, specifically for the Debian project (and may be used by others). legends fr fr 🫶

---

and that's the whole page bestie, mwah 💋 — this was the caml2html manual, dated May 2013, from the CAML2HTML era of things. go forth and pretty-print ur OCaml, main character energy only 🌟💖