- -a
-
Build a library (.cma file) with the object files (.cmo files)
given on the command line, instead of linking them into an executable
file. The name of the library can be set with the -o option. The
default name is library.cma.
If -custom, -cclib or -ccopt options are passed on the command
line, these options are stored in the resulting .cma library. Then,
linking with this library automatically adds back the -custom,
-cclib and -ccopt options as if they had been provided on the
command line, unless the -noautolink option is given.
- -c
-
Compile only. Suppress the linking phase of the
compilation. Source code files are turned into compiled files, but no
executable file is produced. This option is useful to
compile modules separately.
- -cc ccomp
-
Use ccomp as the C linker called by ocamlc -custom
and as the C compiler for compiling .c source files.
- -cclib -llibname
-
Pass the -llibname option to the C linker when linking in
``custom runtime'' mode (see the -custom option). This causes the
given C library to be linked with the program.
- -ccopt option
-
Pass the given option to the C compiler and linker, when linking in
``custom runtime'' mode (see the -custom option). For instance,
-ccopt -Ldir causes the C linker to search for C libraries in
directory dir.
- -custom
-
Link in ``custom runtime'' mode. In the default linking mode, the
linker produces bytecode that is intended to be executed with the
shared runtime system, ocamlrun. In the custom runtime mode, the
linker produces an output file that contains both the runtime system
and the bytecode for the program. The resulting file is larger, but it
can be executed directly, even if the ocamlrun command is not
installed. Moreover, the ``custom runtime'' mode enables static
linking of Caml code with user-defined C functions, as described in
chapter 18.
Unix:
Never use the strip command on executables produced by ocamlc -custom.
This would remove the bytecode part of the executable.
-
-dllib -llibname
-
Arrange for the C shared library dlllibname.so
(dlllibname.dll under Windows) to be loaded dynamically
by the run-time system ocamlrun at program start-up time.
-
-dllpath dir
-
Adds the directory dir to the run-time search path for shared
C libraries. At link-time, shared libraries are searched in the
standard search path (the one corresponding to the -I option).
The -dllpath option simply stores dir in the produced
executable file, where ocamlrun can find it and exploit it as
described in section 10.3.
- -g
-
Add debugging information while compiling and linking. This option is
required in order to be able to debug the program with ocamldebug
(see chapter 16).
- -i
-
Cause the compiler to print all defined names (with their inferred
types or their definitions) when compiling an implementation (.ml
file). This can be useful to check the types inferred by the
compiler. Also, since the output follows the syntax of interfaces, it
can help in writing an explicit interface (.mli file) for a file:
just redirect the standard output of the compiler to a .mli file,
and edit that file to remove all declarations of unexported names.
- -I directory
-
Add the given directory to the list of directories searched for
compiled interface files (.cmi), compiled object code files
(.cmo), libraries (.cma),
and C libraries specified with
-cclib -lxxx.
By default, the current directory is
searched first, then the standard library directory. Directories added
with -I are searched after the current directory, in the order in
which they were given on the command line, but before the standard
library directory.
If the given directory starts with +, it is taken relative to the
standard library directory. For instance, -I +labltk adds the
subdirectory labltk of the standard library to the search path.
- -impl filename
-
Compile the file filename as an implementation file, even if its
extension is not .ml.
- -intf filename
-
Compile the file filename as an interface file, even if its
extension is not .mli.
- -linkall
-
Force all modules contained in libraries to be linked in. If this
flag is not given, unreferenced modules are not linked in. When
building a library (-a flag), setting the -linkall flag forces all
subsequent links of programs involving that library to link all the
modules contained in the library.
- -make-runtime
-
Build a custom runtime system (in the file specified by option -o)
incorporating the C object files and libraries given on the command
line. This custom runtime system can be used later to execute
bytecode executables produced with the
ocamlc -use-runtime runtime-name option.
See section 18.1.6 for more information.
- -noassert
-
Turn assertion checking off: assertions are not compiled.
This flag has no effect when linking already compiled files.
- -noautolink
-
When linking .cma libraries, ignore -custom, -cclib and -ccopt
options potentially contained in the libraries (if these options were
given when building the libraries). This can be useful if a library
contains incorrect specifications of C libraries or C options; in this
case, during linking, set -noautolink and pass the correct C
libraries and options on the command line.
-
-nolabels
-
Ignore non-optional labels in types. Labels cannot be used in
applications, and parameter order becomes strict.
- -o exec-file
-
Specify the name of the output file produced by the linker. The
default output name is a.out, in keeping with the Unix tradition. If
the -a option is given, specify the name of the library produced.
If the -output-obj option is given, specify the name of the output
file produced.
- -output-obj
-
Cause the linker to produce a C object file instead of a bytecode
executable file. This is useful to wrap Caml code as a C library,
callable from any C program. See chapter 18,
section 18.7.5. The name of the output object file is
camlprog.o by default; it can be set with the -o option.
-
-pack
-
Build a bytecode object file (.cmo file) and its associated compiled
interface (.cmi) that combines the object
files given on the command line, making them appear as sub-modules of
the output .cmo file. The name of the output .cmo file must be
given with the -o option. For instance,
ocamlc -pack -o p.cmo a.cmo b.cmo c.cmo
generates compiled files p.cmo and p.cmi describing a compilation
unit having three sub-modules A, B and C, corresponding to the
contents of the object files a.cmo, b.cmo and c.cmo. These
contents can be referenced as P.A, P.B and P.C in the remainder
of the program.
- -pp command
-
Cause the compiler to call the given command as a preprocessor
for each source file. The output of command is redirected to
an intermediate file, which is compiled. If there are no compilation
errors, the intermediate file is deleted afterwards. The name of this
file is built from the basename of the source file with the extension
.ppi for an interface (.mli) file and .ppo for an implementation
(.ml) file.
-
-principal
-
Check information path during type-checking, to make sure that all
types are derived in a principal way. When using labelled arguments
and/or polymorphic methods, this flag is required to ensure future
versions of the compiler will be able to infer types correctly, even
if internal algorithms change.
All programs accepted in -principal mode are also accepted in
default mode with equivalent types, but different binary signatures,
and this may slow down type checking; yet this is a good idea to
use it once before publishing source code.
- -rectypes
-
Allow arbitrary recursive types during type-checking. By default,
only recursive types where the recursion goes through an object type
are supported.
- -thread
-
Compile or link multithreaded programs, in combination with the
threads library described in chapter 24. What this
option actually does is select a special, thread-safe version of the
standard library.
- -unsafe
-
Turn bound checking off on array and string accesses (the v.(i) and
s.[i] constructs). Programs compiled with -unsafe are therefore
slightly faster, but unsafe: anything can happen if the program
accesses an array or string outside of its bounds.
- -use-runtime runtime-name
-
Generate a bytecode executable file that can be executed on the custom
runtime system runtime-name, built earlier with
ocamlc -make-runtime runtime-name.
See section 18.1.6 for more information.
- -v
-
Print the version number of the compiler
and the location of the
standard library directory, then exit.
-
-verbose
-
Print all external commands before they are executed, in particular
invocations of the C compiler and linker in -custom mode. Useful to
debug C library problems.
-
-version
-
Print the version number of the compiler in short form (e.g. 3.06),
then exit.
- -w warning-list
-
Enable or disable warnings according to the argument
warning-list. The argument is a string of one or several
characters, with the following meaning for each character:
-
A/a
- enable/disable all warnings.
-
C/c
-
enable/disable warnings for suspicious comments.
-
D/d
-
enable/disable warnings for deprecated features.
- F/f
- enable/disable warnings for partially applied functions
(i.e. f x; expr where the application f x has a function type).
-
L/l
-
enable/disable warnings for labels omitted in application.
- M/m
- enable/disable warnings for overriden methods.
- P/p
- enable/disable warnings for partial matches (missing cases
in pattern matchings).
- S/s
- enable/disable warnings for statements that do not have
type unit (e.g. expr1; expr2 when expr1 does not
have type unit).
- U/u
- enable/disable warnings for unused (redundant) match cases.
- V/v
- enable/disable warnings for hidden instance variables.
- X/x
- enable/disable all other warnings.
The default setting is -w Al (all warnings but labels enabled).
- -warn-error warning-list
-
Turn the warnings indicated in the argument warning-list into
errors. The compiler will stop on an error as soon as one of these
warnings is emitted, instead of going on. The warning-list
is a string of one or several characters, with the same meaning as for
the -w option: an uppercase character turns the corresponding
warning into an error, a lowercase character leaves it as a warning.
The default setting is -warn-error a (all warnings are not treated
as errors).
- -where
-
Print the location of the standard library, then exit.