Commit | Line | Data |
---|---|---|
d6ce1786 C |
1 | .\" Hey, EMACS: -*- nroff -*- |
2 | .TH MENHIR 1 "April 19, 2006" | |
3 | .\" Please adjust this date whenever revising the manpage. | |
4 | .\" | |
5 | .\" Some roff macros, for reference: | |
6 | .\" .nh disable hyphenation | |
7 | .\" .hy enable hyphenation | |
8 | .\" .ad l left justify | |
9 | .\" .ad b justify to both left and right margins | |
10 | .\" .nf disable filling | |
11 | .\" .fi enable filling | |
12 | .\" .br insert line break | |
13 | .\" .sp <n> insert n+1 empty lines | |
14 | .\" for manpage-specific macros, see man(7) | |
15 | ||
16 | ||
17 | .SH NAME | |
18 | menhir \- parser generator for OCaml | |
19 | ||
20 | ||
21 | .SH SYNOPSIS | |
22 | .B menhir | |
23 | .RI [ options ] " files" | |
24 | .SH DESCRIPTION | |
25 | .B menhir | |
26 | is a LR(1) parser generator for the Objective Caml programming language. That is, Menhir compiles LR(1) grammar specifications down to Objective Caml code. It is mostly compatible with | |
27 | .BR ocamlyacc (1). | |
28 | ||
29 | ||
30 | .SH OPTIONS | |
31 | .TP | |
32 | .B \-h, \-\-help | |
33 | Show summary of options. | |
34 | .TP | |
35 | .BI \-b,\ \-\-base\ basename | |
36 | Specifies a base name for the output file(s). | |
37 | .TP | |
38 | .B \-\-comment | |
39 | Include comments in the generated code. | |
40 | .TP | |
41 | .B \-\-depend | |
42 | Invoke ocamldep and display dependencies. | |
43 | .TP | |
44 | .B \-\-dump | |
45 | Describe the automaton in | |
46 | .IR basename .automaton. | |
47 | .TP | |
48 | .B \-\-error\-recovery | |
49 | Attempt recovery by discarding tokens after errors. | |
50 | .TP | |
51 | .B \-\-explain | |
52 | Explain conflicts in | |
53 | .IR basename .conflicts. | |
54 | .TP | |
55 | .BI \-\-external\-tokens\ module | |
56 | Import token type definition from | |
57 | .IR module . | |
58 | .TP | |
59 | .B \-\-graph | |
60 | Write grammar's dependency graph to | |
61 | .IR basename .dot. | |
62 | .TP | |
63 | .B \-\-infer | |
64 | Invoke ocamlc for ahead of time type inference. | |
65 | .TP | |
66 | .B \-\-interpret | |
67 | Interpret the sentences provided on stdin. | |
68 | .TP | |
69 | .B \-\-interpret\-show\-cst | |
70 | Show a concrete syntax tree upon acceptance. | |
71 | .TP | |
72 | .BI \-la,\ \-\-log\-automaton\ level | |
73 | Log information about the automaton. | |
74 | .TP | |
75 | .BI \-lc,\ \-\-log\-code\ level | |
76 | Log information about the generated code. | |
77 | .TP | |
78 | .BI \-lg,\ \-\-log\-grammar\ level | |
79 | Log information about the grammar. | |
80 | .TP | |
81 | .B \-\-no\-inline | |
82 | Ignore the %inline keyword. | |
83 | .TP | |
84 | .B \-\-no\-stdlib | |
85 | Do not load the standard library. | |
86 | .TP | |
87 | .BI \-\-ocamlc\ command | |
88 | Specifies how ocamlc should be invoked. | |
89 | .TP | |
90 | .BI \-\-ocamldep\ command | |
91 | Specifies how ocamldep should be invoked. | |
92 | .TP | |
93 | .B \-\-only\-preprocess | |
94 | Print a simplified grammar and exit. | |
95 | .TP | |
96 | .B \-\-only\-tokens | |
97 | Generate token type definition only, no code. | |
98 | .TP | |
99 | .B \-\-raw\-depend | |
100 | Invoke ocamldep and echo its raw output. | |
101 | .TP | |
102 | .BI \-\-stdlib\ directory | |
103 | Specify where the standard library lies. | |
104 | .TP | |
105 | .B \-\-suggest\-comp\-flags | |
106 | Suggest compilation flags for ocaml{c,opt}. | |
107 | .TP | |
108 | .B \-\-suggest\-link\-flags-byte | |
109 | Suggest link flags for ocamlc. | |
110 | .TP | |
111 | .B \-\-suggest\-link\-flags-opt | |
112 | Suggest link flags for ocamlopt. | |
113 | .TP | |
114 | .B \-t, \-\-table | |
115 | Use the table-based back-end. | |
116 | .TP | |
117 | .B \-\-timings | |
118 | Display internal timings. | |
119 | .TP | |
120 | .B \-\-trace | |
121 | Include tracing instructions in the generated code. | |
122 | .TP | |
123 | .B \-\-version | |
124 | Show version number and exit. | |
125 | .TP | |
126 | .B \-v | |
127 | Synonymous with | |
128 | .BR \-\-dump\ \-\-explain . | |
129 | ||
130 | ||
131 | .SH SEE ALSO | |
132 | .BR ocaml (1). | |
133 | ||
134 | ||
135 | .SH AUTHOR | |
136 | .B menhir | |
137 |