summaryrefslogtreecommitdiffstats
path: root/man/ocaml.help
diff options
context:
space:
mode:
Diffstat (limited to 'man/ocaml.help')
-rw-r--r--man/ocaml.help137
1 files changed, 112 insertions, 25 deletions
diff --git a/man/ocaml.help b/man/ocaml.help
index fc20b3459..466896dcc 100644
--- a/man/ocaml.help
+++ b/man/ocaml.help
@@ -1,39 +1,116 @@
-
OCaml # Objective Caml toplevel
-OCaml [-I directory] [-unsafe]
- -I directory # search for interface files in directory
- -unsafe # suppress bound checking for arrays and strings
+Usage: ocaml <options>
+options are:
+ -I <dir> Add <dir> to the list of include directories
+ -unsafe No bound checking on array and string access
+ -drawlambda (undocumented)
+ -dlambda (undocumented)
+ -dinstr (undocumented)
+ -rectypes (undocumented)
-
OCamlc # Objective Caml compiler
-OCamlc [optionsÉ] nameÉ
- -a # build a library file
- -c # compile only, do not link
- -cclib option # pass option to the C linker
- -ccopt option # pass option to the C compiler
- -i # print types
- -I directory # look in directory for .cm[io] files
- -o file # output to file (default a.out)
- -v # print compiler version number
- -unsafe # suppress bound checking for arrays and strings
+Usage: ocamlc <options> <files>
+Options are:
+ -a Build a library
+ -c Compile only (do not link)
+ -cc <comp> Use <comp> as the C compiler and linker
+ -cclib <opt> Pass option <opt> to the C linker
+ -ccopt <opt> Pass option <opt> to the C compiler and linker
+ -g Save debugging information
+ -i Print the types
+ -I <dir> Add <dir> to the list of include directories
+ -impl <file> Compile <file> as a .ml file
+ -intf <file> Compile <file> as a .mli file
+ -intf-suffix <file> Suffix for interface file (default: .mli)
+ -intf_suffix <file> (deprecated) same as -intf-suffix
+ -linkall Link all modules, even unused ones
+ -make-runtime Build a runtime system with given C objects and libraries
+ -make_runtime (deprecated) same as -make-runtime
+ -noassert Do not compile assertion checks
+ -o <file> Set output file name to <file>
+ -output-obj Output a C object file instead of an executable
+ -pp <command> Pipe sources through preprocessor <command>
+ -thread Use thread-safe standard library
+ -unsafe No bounds checking on array and string access
+ -use-runtime <path> Generate bytecode for the given runtime system
+ -use_runtime <path> (deprecated) same as -use-runtime
+ -v Print compiler version number
+ -verbose Print calls to external commands
+ -w <flags> Enable or disable warnings according to <flags>:
+ A/a enable/disable all warnings
+ C/c enable/disable suspicious comment
+ F/f enable/disable partially applied function
+ M/m enable/disable overriden method
+ P/p enable/disable partial match
+ S/s enable/disable non-unit statement
+ U/u enable/disable unused match case
+ V/v enable/disable hidden instance variable
+ X/x enable/disable all other warnings
+ default setting is A (all warnings enabled)
+ -nopervasives (undocumented)
+ -dparsetree (undocumented)
+ -drawlambda (undocumented)
+ -dlambda (undocumented)
+ -dinstr (undocumented)
+ -use-prims <file> (undocumented)
+ -rectypes (undocumented)
+ - <file> Treat <file> as a file name (even if it starts with `-')
-
OCamlc-custom # Objective Caml compiler for custom runtime mode
-OCamlc-custom [optionsÉ] nameÉ
- -a # build a library file
- -c # compile only, do not link
- -cclib option # pass option to the C linker
- -ccopt option # pass option to the C compiler
- -i # print types
- -I directory # look in directory for .cm[io] files
- -o file # output to file (default a.out)
- -v # print compiler version number
- -unsafe # suppress bound checking for arrays and strings
+Usage: ocamlc-custom <options> <files>
+Options are:
+ -a Build a library
+ -c Compile only (do not link)
+ -cc <comp> Use <comp> as the C compiler and linker
+ -cclib <opt> Pass option <opt> to the C linker
+ -ccopt <opt> Pass option <opt> to the C compiler and linker
+ -g Save debugging information
+ -i Print the types
+ -I <dir> Add <dir> to the list of include directories
+ -impl <file> Compile <file> as a .ml file
+ -intf <file> Compile <file> as a .mli file
+ -intf-suffix <file> Suffix for interface file (default: .mli)
+ -intf_suffix <file> (deprecated) same as -intf-suffix
+ -linkall Link all modules, even unused ones
+ -make-runtime Build a runtime system with given C objects and libraries
+ -make_runtime (deprecated) same as -make-runtime
+ -noassert Do not compile assertion checks
+ -o <file> Set output file name to <file>
+ -output-obj Output a C object file instead of an executable
+ -pp <command> Pipe sources through preprocessor <command>
+ -thread Use thread-safe standard library
+ -unsafe No bounds checking on array and string access
+ -use-runtime <path> Generate bytecode for the given runtime system
+ -use_runtime <path> (deprecated) same as -use-runtime
+ -v Print compiler version number
+ -verbose Print calls to external commands
+ -w <flags> Enable or disable warnings according to <flags>:
+ A/a enable/disable all warnings
+ C/c enable/disable suspicious comment
+ F/f enable/disable partially applied function
+ M/m enable/disable overriden method
+ P/p enable/disable partial match
+ S/s enable/disable non-unit statement
+ U/u enable/disable unused match case
+ V/v enable/disable hidden instance variable
+ X/x enable/disable all other warnings
+ default setting is A (all warnings enabled)
+ -nopervasives (undocumented)
+ -dparsetree (undocumented)
+ -drawlambda (undocumented)
+ -dlambda (undocumented)
+ -dinstr (undocumented)
+ -use-prims <file> (undocumented)
+ -rectypes (undocumented)
+ - <file> Treat <file> as a file name (even if it starts with `-')
-
OCamlDep # Objective Caml dependency generator
-OcamlDep [-I directory] nameÉ
- -I # look in directory for .cmi files
+Usage: ocamldep [-I <dir>] <files>
+ -I <dir> Add <dir> to the list of include directories
-
OCamlLex # Objective Caml lexer generator
@@ -44,6 +121,16 @@ OCamlRun # Objective Caml bytecode interpreter
OCamlRun [-v] file [argumentsÉ]
-v # print GC messages
+Environment variable:
+Set -e OCamlRunParam "<option>=<value>,É"
+ h # initial size of the major heap
+ i # minimum size increment for the major heap
+ l # maximum stack size
+ o # major GC speed setting
+ O # heap compaction trigger setting
+ s # size of the minor heap
+ v # verbosity flags for GC messages
+
-
OCamlYacc # Objective Caml parser generator
OCamlYacc [-v] [-b string] file.mly