MENHIR(1)

💖 MENHIR 💖

okay so bestie, we're doing the manual page for menhir, straight out of the General Commands Manual. It's section 1. It's a whole mood. Let's get into it. 💅

---

✨ NAME ✨

menhir — an LR(1) parser generator for OCaml

---

🌸 SYNOPSIS 🌸

menhir [options] files

That's it. That's the whole vibe. Options, then your files. 🦋

---

🎀 DESCRIPTION 🎀

So what is it? menhir is an LR(1) parser generator for the OCaml programming language. Which is to say: Menhir takes LR(1) grammar specifications and compiles them all the way down to OCaml code. ✨

And ngl, it's mostly compatible with ocamlyacc(1), so if you're coming from there, you're not starting from zero. periodt.

---

👑 OPTIONS 👑

There are a lot of these. Not me listing every single one. But I am. Because that's the assignment. 💅

• -h, --help — Show a summary of the options. Your little cheat sheet. 🫶
• -b, --base basename — Sets a base name for the output file(s). Name the baby. ✨
• --canonical — Build a canonical Knuth LR(1) automaton. Very demure, very canonical.
• --cmly — Write the grammar and the automaton out to basename.cmly.
• --comment — Slide comments into the generated code. 💬
• --compare-errors file1 --compare-errors file2 — Compare two .messages files against each other. 👀
• --compile-errors file — Compile a .messages file into OCaml code.
• --coq — Generate a formally verified parser, in Coq. formally verified?? we love a queen who can prove things. 👑
• --coq-lib-path path — How to qualify references to MenhirLib.
• --coq-lib-no-path — Don't qualify references to MenhirLib.
• --coq-no-actions — Ignore semantic actions in the Coq output.
• --coq-no-complete — Don't generate a proof of completeness.
• --depend — Invoke ocamldep and display the dependencies.
• --dump — Describe the automaton in the file basename.automaton.
• --dump-resolved — Describe the automaton after conflict resolution, in the file basename.automaton.resolved.
• --echo-errors file — Echo out the sentences stored in the .messages file file.
• --echo-errors-concrete file — Same thing, but echo the sentences stored in the .messages file file in concrete syntax.
• --exn-carries-state — Declares Error of int. The exception Error then carries the number of the state where a syntax error was detected. 🚨
• --explain — Explain the conflicts in basename.conflicts. Drama explained. 💀
• --external-tokens module — Import the token type definition from module.
• --fixed-exception — Declares Error = Parsing.Parse_error.
• --infer — Invoke ocamlc to do type inference.
• --infer-protocol-supported — Stop with exit code 0. That's it. That's the whole option. 😭
• --infer-write-query file — Write a mock .ml file.
• --infer-read-reply file — Read an inferred .mli file.
• --inspection — Generate the inspection API.
• --interpret — Interpret the sentences you feed in on stdin.
• --interpret-show-cst — Show a concrete syntax tree once it accepts. 🌳
• --interpret-error — Interpret a single error sentence provided on stdin.
• --lalr — Build an LALR(1) automaton.
• -la, --log-automaton level — Log info about the automaton.
• -lc, --log-code level — Log info about the generated code.
• -lg, --log-grammar level — Log info about the grammar.
• --list-errors — Produce a list of erroneous inputs. (A little hate-list, if you will. 🙈)
• --merge-errors file1 --merge-errors file2 — Merge two .messages files.
• --no-dollars — Disallow the $i notation. no dollars allowed, we broke 💀
• --no-inline — Ignore the %inline keyword.
• --no-stdlib — Don't load the standard library.
• --ocamlc command — Specifies how ocamlc should be invoked.
• --ocamldep command — Specifies how ocamldep should be invoked.
• --only-preprocess — Print a simplified grammar and exit.
• --only-preprocess-for-ocamlyacc — Print the grammar in ocamlyacc format and exit.
• --only-preprocess-u — Print the grammar with unit actions and exit.
• --only-preprocess-uu — Print the grammar with unit actions and tokens, then exit.
• --only-tokens — Generate the token type definition only, no code.
• --random-seed seed — Set the seed used by the random sentence generator to seed. 🎲
• --random-self-init — Automatically set the seed used by the random sentence generator.
• --random-sentence-length length — Ask the random sentence generator for a sentence of length at most length.
• --random-sentence symbol — Produce a random sentence generated by the nonterminal symbol.
• --random-sentence-concrete symbol — Produce a random sentence generated by the nonterminal symbol, and print that sentence in concrete syntax.
• --raw-depend — Invoke ocamldep and echo its raw output.
• --require-aliases — Check that every terminal symbol has a token alias. no orphan tokens in this house 🫶
• --strategy strategy — Choose how to deal with the error token.
• --strict — Warnings about the grammar are errors. so if you were hoping to just vibe past them? no ma'am.
• --suggest-comp-flags — Suggest compilation flags for ocaml{c,opt}.
• --suggest-link-flags-byte — Suggest link flags for ocamlc.
• --suggest-link-flags-opt — Suggest link flags for ocamlopt.
• --suggest-menhirLib — Suggest where MenhirLib was installed in source form.
• -t, --table — Use the table-based back-end.
• --timings — Display internal timings. ⏱️
• --timings-to file — Dump internal timings into file.
• --trace — Include tracing instructions in the generated code.
• --unused-precedence-levels — Do not warn about unused precedence levels.
• --unused-token token — Do not warn that token is unused.
• --unused-tokens — Do not warn about any unused token, like, at all.
• --update-errors file — Update the auto-comments inside a .messages file.
• --version — Show the version number and exit.
• -v — Synonymous with --dump --explain.

---

🌈 SEE ALSO 🌈

ocaml(1).

---

💜 AUTHOR 💜

menhir was written by François Pottier and Yann Régis-Gianas. kings. 👑

This manual page was originally written by Samuel Mimram <smimram@debian.org> for the Debian project (but it may be used by others, so share the love 🫶).

---

and that's the whole page bestie — from the General Commands Manual, dated <b>July 03, 2018</b>. go write a grammar, you absolute icon. 🌸✨💖