1MENHIR(1) General Commands Manual MENHIR(1)
2
6 menhir - an LR(1) parser generator for OCaml
7
10 menhir [options] files
11
13 menhir is an LR(1) parser generator for the OCaml programming language.
14 That is, Menhir compiles LR(1) grammar specifications down to OCaml
15 code. It is mostly compatible with ocamlyacc(1).
16
19 -h, --help
20 Show summary of options.
21 -b, --base basename
23 Specifies a base name for the output file(s).
24 --canonical
26 Construct a canonical Knuth LR(1) automaton.
27 --cmly Write the grammar and automaton to basename.cmly.
29 --comment
31 Include comments in the generated code.
32 --compare-errors file1 --compare-errors file2
34 Compare two .messages files.
35 --compile-errors file
37 Compile a .messages file to OCaml code.
38 --coq Generate a formally verified parser, in Coq.
40 --coq-lib-path path
42 How to qualify references to MenhirLib.
43 --coq-lib-no-path
45 Do not qualify references to MenhirLib.
46 --coq-no-actions
48 Ignore semantic actions in the Coq output.
49 --coq-no-complete
51 Do not generate a proof of completeness.
52 --depend
54 Invoke ocamldep and display dependencies.
55 --dump Describe the automaton in the file basename.automaton.
57 --dump-resolved
59 Describe the automaton, after conflict resolution, in the file
60 basename.automaton.resolved.
61 --echo-errors file
63 Echo the sentences stored in the .messages file file.
64 --echo-errors-concrete file
66 Echo the sentences stored in the .messages file file in concrete
67 syntax.
68 --exn-carries-state
70 Declares Error of int. The exception Error then carries the num‐
71 ber of the state where a syntax error is detected.
72 --explain
74 Explain conflicts in basename.conflicts.
75 --external-tokens module
77 Import token type definition from module.
78 --fixed-exception
80 Declares Error = Parsing.Parse_error.
81 --infer
83 Invoke ocamlc to do type inference.
84 --infer-protocol-supported
86 Stop with exit code 0.
87 --infer-write-query file
89 Write mock .ml file.
90 --infer-read-reply file
92 Read inferred .mli file.
93 --inspection
95 Generate the inspection API.
96 --interpret
98 Interpret the sentences provided on stdin.
99 --interpret-show-cst
101 Show a concrete syntax tree upon acceptance.
102 --interpret-error
104 Interpret an error sentence provided on stdin.
105 --lalr Construct an LALR(1) automaton.
107 -la, --log-automaton level
109 Log information about the automaton.
110 -lc, --log-code level
112 Log information about the generated code.
113 -lg, --log-grammar level
115 Log information about the grammar.
116 --list-errors
118 Produce a list of erroneous inputs.
119 --merge-errors file1 --merge-errors file2
121 Merge two .messages files.
122 --no-dollars
124 Disallow the use of $i notation.
125 --no-inline
127 Ignore the %inline keyword.
128 --no-stdlib
130 Do not load the standard library.
131 --ocamlc command
133 Specifies how ocamlc should be invoked.
134 --ocamldep command
136 Specifies how ocamldep should be invoked.
137 --only-preprocess
139 Print a simplified grammar and exit.
140 --only-preprocess-for-ocamlyacc
142 Print grammar in ocamlyacc format and exit.
143 --only-preprocess-u
145 Print grammar with unit actions and exit.
146 --only-preprocess-uu
148 Print grammar with unit actions and tokens and exit.
149 --only-tokens
151 Generate token type definition only, no code.
152 --random-seed seed
154 Set the seed used by the random sentence generator to seed.
155 --random-self-init
157 Automatically set the seed used by the random sentence genera‐
158 tor.
159 --random-sentence-length length
161 Ask the random sentence generator for a sentence of length at
162 most length.
163 --random-sentence symbol
165 Produce a random sentence that is generated by the nonterminal
166 symbol symbol.
167 --random-sentence-concrete symbol
169 Produce a random sentence that is generated by the nonterminal
170 symbol symbol, and print this sentence in concrete syntax.
171 --raw-depend
173 Invoke ocamldep and echo its raw output.
174 --require-aliases
176 Check that every terminal symbol has a token alias.
177 --strategy strategy
179 Choose how to deal with the error token.
180 --strict
182 Warnings about the grammar are errors.
183 --suggest-comp-flags
185 Suggest compilation flags for ocaml{c,opt}.
186 --suggest-link-flags-byte
188 Suggest link flags for ocamlc.
189 --suggest-link-flags-opt
191 Suggest link flags for ocamlopt.
192 --suggest-menhirLib
194 Suggest where MenhirLib was installed in source form.
195 -t, --table
197 Use the table-based back-end.
198 --timings
200 Display internal timings.
201 --timings-to file
203 Dump internal timings into file.
204 --trace
206 Include tracing instructions in the generated code.
207 --unused-precedence-levels
209 Do not warn about unused precedence levels.
210 --unused-token token
212 Do not warn that token is unused.
213 --unused-tokens
215 Do not warn about any unused token.
216 --update-errors file
218 Update auto-comments in a .messages file.
219 --version
221 Show version number and exit.
222 -v Synonymous with --dump --explain.
224
228 ocaml(1).
229
233 menhir was written by François Pottier and Yann Régis-Gianas.
234 This manual page was originally written by Samuel Mimram <smimram@de‐
236 bian.org> for the Debian project (but may be used by others).
237 July 03, 2018 MENHIR(1)