Merge commit 'ocaml3102'
[ocaml.git] / man / ocaml.help
blob466896dcc784d29e4607aabcfcaa6bb7d231d30f
1 -   
2 OCaml           # Objective Caml toplevel
3 Usage: ocaml <options>
4 options are:
5   -I <dir>  Add <dir> to the list of include directories
6   -unsafe  No bound checking on array and string access
7   -drawlambda  (undocumented)
8   -dlambda  (undocumented)
9   -dinstr  (undocumented)
10   -rectypes  (undocumented)
12 -   
13 OCamlc          # Objective Caml compiler
14 Usage: ocamlc <options> <files>
15 Options are:
16   -a  Build a library
17   -c  Compile only (do not link)
18   -cc <comp>  Use <comp> as the C compiler and linker
19   -cclib <opt>  Pass option <opt> to the C linker
20   -ccopt <opt>  Pass option <opt> to the C compiler and linker
21   -g  Save debugging information
22   -i  Print the types
23   -I <dir>  Add <dir> to the list of include directories
24   -impl <file>  Compile <file> as a .ml file
25   -intf <file>  Compile <file> as a .mli file
26   -intf-suffix <file>  Suffix for interface file (default: .mli)
27   -intf_suffix <file>  (deprecated) same as -intf-suffix
28   -linkall  Link all modules, even unused ones
29   -make-runtime  Build a runtime system with given C objects and libraries
30   -make_runtime  (deprecated) same as -make-runtime
31   -noassert  Do not compile assertion checks
32   -o <file>  Set output file name to <file>
33   -output-obj Output a C object file instead of an executable
34   -pp <command>  Pipe sources through preprocessor <command>
35   -thread  Use thread-safe standard library
36   -unsafe  No bounds checking on array and string access
37   -use-runtime <path>  Generate bytecode for the given runtime system
38   -use_runtime <path>  (deprecated) same as -use-runtime
39   -v  Print compiler version number
40   -verbose  Print calls to external commands
41   -w <flags>  Enable or disable warnings according to <flags>:
42      A/a enable/disable all warnings
43      C/c enable/disable suspicious comment
44      F/f enable/disable partially applied function
45      M/m enable/disable overriden method
46      P/p enable/disable partial match
47      S/s enable/disable non-unit statement
48      U/u enable/disable unused match case
49      V/v enable/disable hidden instance variable
50      X/x enable/disable all other warnings
51      default setting is A (all warnings enabled)
52   -nopervasives  (undocumented)
53   -dparsetree  (undocumented)
54   -drawlambda  (undocumented)
55   -dlambda  (undocumented)
56   -dinstr  (undocumented)
57   -use-prims <file>  (undocumented)
58   -rectypes  (undocumented)
59   - <file>  Treat <file> as a file name (even if it starts with `-')
61 -   
62 OCamlc-custom   # Objective Caml compiler for custom runtime mode
63 Usage: ocamlc-custom <options> <files>
64 Options are:
65   -a  Build a library
66   -c  Compile only (do not link)
67   -cc <comp>  Use <comp> as the C compiler and linker
68   -cclib <opt>  Pass option <opt> to the C linker
69   -ccopt <opt>  Pass option <opt> to the C compiler and linker
70   -g  Save debugging information
71   -i  Print the types
72   -I <dir>  Add <dir> to the list of include directories
73   -impl <file>  Compile <file> as a .ml file
74   -intf <file>  Compile <file> as a .mli file
75   -intf-suffix <file>  Suffix for interface file (default: .mli)
76   -intf_suffix <file>  (deprecated) same as -intf-suffix
77   -linkall  Link all modules, even unused ones
78   -make-runtime  Build a runtime system with given C objects and libraries
79   -make_runtime  (deprecated) same as -make-runtime
80   -noassert  Do not compile assertion checks
81   -o <file>  Set output file name to <file>
82   -output-obj Output a C object file instead of an executable
83   -pp <command>  Pipe sources through preprocessor <command>
84   -thread  Use thread-safe standard library
85   -unsafe  No bounds checking on array and string access
86   -use-runtime <path>  Generate bytecode for the given runtime system
87   -use_runtime <path>  (deprecated) same as -use-runtime
88   -v  Print compiler version number
89   -verbose  Print calls to external commands
90   -w <flags>  Enable or disable warnings according to <flags>:
91      A/a enable/disable all warnings
92      C/c enable/disable suspicious comment
93      F/f enable/disable partially applied function
94      M/m enable/disable overriden method
95      P/p enable/disable partial match
96      S/s enable/disable non-unit statement
97      U/u enable/disable unused match case
98      V/v enable/disable hidden instance variable
99      X/x enable/disable all other warnings
100      default setting is A (all warnings enabled)
101   -nopervasives  (undocumented)
102   -dparsetree  (undocumented)
103   -drawlambda  (undocumented)
104   -dlambda  (undocumented)
105   -dinstr  (undocumented)
106   -use-prims <file>  (undocumented)
107   -rectypes  (undocumented)
108   - <file>  Treat <file> as a file name (even if it starts with `-')
110 -   
111 OCamlDep        # Objective Caml dependency generator
112 Usage: ocamldep [-I <dir>] <files>
113   -I <dir>  Add <dir> to the list of include directories
115 -   
116 OCamlLex        # Objective Caml lexer generator
117 OCamlLex name.mll
119 -   
120 OCamlRun        # Objective Caml bytecode interpreter
121 OCamlRun [-v] file [argumentsÉ]
122     -v                      # print GC messages
124 Environment variable:
125 Set -e OCamlRunParam "<option>=<value>,É"
126     h     # initial size of the major heap
127     i     # minimum size increment for the major heap
128     l     # maximum stack size
129     o     # major GC speed setting
130     O     # heap compaction trigger setting
131     s     # size of the minor heap
132     v     # verbosity flags for GC messages
134 -   
135 OCamlYacc       # Objective Caml parser generator
136 OCamlYacc [-v] [-b string] file.mly
137     -v                      # put verbose report in file.output
138     -b string               # name output files string.ml and string.mli