PR#3915 update man pages
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@9023 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02master
Damien Doligez
parent
3a62f73c4b
commit
7034f03311
105
man/ocaml.m
105
man/ocaml.m
|
|
@ -7,10 +7,7 @@ ocaml \- The Objective Caml interactive toplevel
|
|||
.SH SYNOPSIS
|
||||
.B ocaml
|
||||
[
|
||||
.B \-unsafe
|
||||
]
|
||||
[
|
||||
.BI \-I \ lib-dir
|
||||
.I options
|
||||
]
|
||||
[
|
||||
.I object-files
|
||||
|
|
@ -32,7 +29,7 @@ system prints a # (sharp) prompt before reading each phrase.
|
|||
A toplevel phrase can span several lines. It is terminated by ;; (a
|
||||
double-semicolon). The syntax of toplevel phrases is as follows.
|
||||
|
||||
The toplevel system is started by the command
|
||||
The toplevel system is started by the command
|
||||
.BR ocaml (1).
|
||||
Phrases are read on standard input, results are printed on standard
|
||||
output, errors on standard error. End-of-file on standard input
|
||||
|
|
@ -58,34 +55,111 @@ exits after the execution of the last phrase.
|
|||
|
||||
The following command-line options are recognized by
|
||||
.BR ocaml (1).
|
||||
|
||||
.TP
|
||||
.BI \-I \ directory
|
||||
.BI -I \ directory
|
||||
Add the given directory to the list of directories searched for
|
||||
source and compiled files. By default, the current directory is
|
||||
searched first, then the standard library directory. Directories added
|
||||
with
|
||||
with
|
||||
.B \-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.
|
||||
|
||||
.IP
|
||||
If the given directory starts with
|
||||
.BR + ,
|
||||
it is taken relative to the
|
||||
standard library directory. For instance,
|
||||
.B \-I +labltk
|
||||
adds the subdirectory
|
||||
.B labltk
|
||||
of the standard library to the search path.
|
||||
.IP
|
||||
Directories can also be added to the search path once the toplevel
|
||||
is running with the
|
||||
.B #directory
|
||||
directive.
|
||||
.TP
|
||||
.BI \-init \ file
|
||||
Load the given file instead of the default initialization file.
|
||||
The default file is
|
||||
.B .ocamlinit
|
||||
in the current directory if it exists, otherwise
|
||||
.B .ocamlinit
|
||||
in the user's home directory.
|
||||
.TP
|
||||
.B \-labels
|
||||
Labels are not ignored in types, labels may be used in applications,
|
||||
and labelled parameters can be given in any order. This is the default.
|
||||
.TP
|
||||
.B \-noassert
|
||||
Do not compile assertion checks. Note that the special form
|
||||
.B assert false
|
||||
is always compiled because it is typed specially.
|
||||
.TP
|
||||
.B \-nolabels
|
||||
Ignore non-optional labels in types. Labels cannot be used in
|
||||
applications, and parameter order becomes strict.
|
||||
.TP
|
||||
.B \-noprompt
|
||||
Do not display any prompt when waiting for input.
|
||||
.TP
|
||||
.B \-nostdlib
|
||||
Do not include the standard library directory in the list of
|
||||
directories searched for source and compiled files.
|
||||
.TP
|
||||
.B \-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
|
||||
.B \-principal
|
||||
mode are also accepted in the
|
||||
default mode with equivalent types, but different binary signatures,
|
||||
and this may slow down type checking; yet it is a good idea to
|
||||
use it once before publishing source code.
|
||||
.TP
|
||||
.B \-rectypes
|
||||
Allow arbitrary recursive types during type-checking. By default,
|
||||
only recursive types where the recursion goes through an object type
|
||||
are supported.
|
||||
.TP
|
||||
.B \-unsafe
|
||||
Turn bound checking off on array and string accesses (the v.(i)
|
||||
and s.[i] constructs). Programs compiled with
|
||||
Turn bound checking off on array and string accesses (the
|
||||
.BR v.(i) and s.[i]
|
||||
constructs). Programs compiled with
|
||||
.B \-unsafe
|
||||
are therefore slightly faster, but unsafe: anything can happen if the program
|
||||
accesses an array or string outside of its bounds.
|
||||
.TP
|
||||
.B \-version
|
||||
Print version string and exit.
|
||||
.TP
|
||||
.BI \-w \ warning-list
|
||||
Enable or disable warnings according to the argument
|
||||
.IR warning-list .
|
||||
See
|
||||
.BR ocamlc (1)
|
||||
for the syntax of the argument.
|
||||
.TP
|
||||
.BI \-warn-error \ warning-list
|
||||
Treat as errors the warnings enabled by the argument
|
||||
.IR warning-list .
|
||||
See
|
||||
.BR ocamlc (1)
|
||||
for the syntax of the argument.
|
||||
.TP
|
||||
.BR \-help \ or \ \-\-help
|
||||
Display a usage summary and exit.
|
||||
|
||||
.SH ENVIRONMENT VARIABLES
|
||||
|
||||
.TP
|
||||
.B LC_CTYPE
|
||||
If set to iso_8859_1, accented characters (from the
|
||||
ISO Latin-1 character set) in string and character literals are
|
||||
printed as is; otherwise, they are printed as decimal escape sequences.
|
||||
|
||||
.TP
|
||||
.B TERM
|
||||
When printing error messages, the toplevel system
|
||||
|
|
@ -94,8 +168,7 @@ consults the TERM variable to determines the type of output terminal
|
|||
and look up its capabilities in the terminal database.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR ocamlc (1).
|
||||
.BR ocamlc (1), \ ocamlopt (1), \ ocamlrun (1).
|
||||
.br
|
||||
.I The Objective Caml user's manual,
|
||||
.IR The\ Objective\ Caml\ user's\ manual ,
|
||||
chapter "The toplevel system".
|
||||
|
||||
|
|
|
|||
499
man/ocamlc.m
499
man/ocamlc.m
|
|
@ -7,41 +7,26 @@ ocamlc \- The Objective Caml bytecode compiler
|
|||
.SH SYNOPSIS
|
||||
.B ocamlc
|
||||
[
|
||||
.B \-aciv
|
||||
]
|
||||
[
|
||||
.BI \-cclib \ libname
|
||||
]
|
||||
[
|
||||
.BI \-ccopt \ option
|
||||
]
|
||||
[
|
||||
.B \-custom
|
||||
]
|
||||
[
|
||||
.B \-unsafe
|
||||
]
|
||||
[
|
||||
.BI \-o \ exec-file
|
||||
]
|
||||
[
|
||||
.BI \-I \ lib-dir
|
||||
.I options
|
||||
]
|
||||
.I filename ...
|
||||
|
||||
.B ocamlc.opt
|
||||
.I (same options)
|
||||
[
|
||||
.I options
|
||||
]
|
||||
.I filename ...
|
||||
|
||||
.SH DESCRIPTION
|
||||
|
||||
The Objective Caml bytecode compiler
|
||||
.BR ocamlc (1)
|
||||
compiles Caml source files to bytecode object files and link
|
||||
compiles Caml source files to bytecode object files and links
|
||||
these object files to produce standalone bytecode executable files.
|
||||
These executable files are then run by the bytecode interpreter
|
||||
.BR ocamlrun (1).
|
||||
|
||||
The
|
||||
The
|
||||
.BR ocamlc (1)
|
||||
command has a command-line interface similar to the one of
|
||||
most C compilers. It accepts several types of arguments and processes them
|
||||
|
|
@ -51,25 +36,25 @@ Arguments ending in .mli are taken to be source files for
|
|||
compilation unit interfaces. Interfaces specify the names exported by
|
||||
compilation units: they declare value names with their types, define
|
||||
public data types, declare abstract data types, and so on. From the
|
||||
file
|
||||
file
|
||||
.IR x \&.mli,
|
||||
the
|
||||
the
|
||||
.BR ocamlc (1)
|
||||
compiler produces a compiled interface
|
||||
in the file
|
||||
in the file
|
||||
.IR x \&.cmi.
|
||||
|
||||
Arguments ending in .ml are taken to be source files for compilation
|
||||
unit implementations. Implementations provide definitions for the
|
||||
names exported by the unit, and also contain expressions to be
|
||||
evaluated for their side-effects. From the file
|
||||
evaluated for their side-effects. From the file
|
||||
.IR x \&.ml,
|
||||
the
|
||||
the
|
||||
.BR ocamlc (1)
|
||||
compiler produces compiled object bytecode in the file
|
||||
compiler produces compiled object bytecode in the file
|
||||
.IR x \&.cmo.
|
||||
|
||||
If the interface file
|
||||
|
||||
If the interface file
|
||||
.IR x \&.mli
|
||||
exists, the implementation
|
||||
.IR x \&.ml
|
||||
|
|
@ -77,17 +62,17 @@ is checked against the corresponding compiled interface
|
|||
.IR x \&.cmi,
|
||||
which is assumed to exist. If no interface
|
||||
.IR x \&.mli
|
||||
is provided, the compilation of
|
||||
is provided, the compilation of
|
||||
.IR x \&.ml
|
||||
produces a compiled interface file
|
||||
produces a compiled interface file
|
||||
.IR x \&.cmi
|
||||
in addition to the compiled object code file
|
||||
in addition to the compiled object code file
|
||||
.IR x \&.cmo.
|
||||
The file
|
||||
The file
|
||||
.IR x \&.cmi
|
||||
produced
|
||||
corresponds to an interface that exports everything that is defined in
|
||||
the implementation
|
||||
the implementation
|
||||
.IR x \&.ml.
|
||||
|
||||
Arguments ending in .cmo are taken to be compiled object bytecode. These
|
||||
|
|
@ -97,35 +82,72 @@ library, to produce a standalone executable program. The order in
|
|||
which .cmo and.ml arguments are presented on the command line is
|
||||
relevant: compilation units are initialized in that order at
|
||||
run-time, and it is a link-time error to use a component of a unit
|
||||
before having initialized it. Hence, a given
|
||||
before having initialized it. Hence, a given
|
||||
.IR x \&.cmo
|
||||
file must come before all .cmo files that refer to the unit
|
||||
file must come before all .cmo files that refer to the unit
|
||||
.IR x .
|
||||
|
||||
Arguments ending in .cma are taken to be libraries of object bytecode.
|
||||
A library of object bytecode packs in a single file a set of object
|
||||
bytecode files (.cmo files). Libraries are built with
|
||||
bytecode files (.cmo files). Libraries are built with
|
||||
.B ocamlc \-a
|
||||
(see the description of the
|
||||
(see the description of the
|
||||
.B \-a
|
||||
option below). The object files
|
||||
contained in the library are linked as regular .cmo files (see above), in the order specified when the .cma file was built. The only difference is that if an object file
|
||||
contained in the library are linked as regular .cmo files (see above),
|
||||
in the order specified when the .cma file was built. The only
|
||||
difference is that if an object file
|
||||
contained in a library is not referenced anywhere in the program, then
|
||||
it is not linked in.
|
||||
|
||||
Arguments ending in .c are passed to the C compiler, which generates a .o object file. This object file is linked with the program if the
|
||||
Arguments ending in .c are passed to the C compiler, which generates
|
||||
a .o object file. This object file is linked with the program if the
|
||||
.B \-custom
|
||||
flag is set (see the description of
|
||||
flag is set (see the description of
|
||||
.B \-custom
|
||||
below).
|
||||
|
||||
Arguments ending in .o or .a are assumed to be C object files and
|
||||
libraries. They are passed to the C linker when linking in
|
||||
libraries. They are passed to the C linker when linking in
|
||||
.B \-custom
|
||||
mode (see the description of
|
||||
mode (see the description of
|
||||
.B \-custom
|
||||
below).
|
||||
|
||||
Arguments ending in .so
|
||||
are assumed to be C shared libraries (DLLs). During linking, they are
|
||||
searched for external C functions referenced from the Caml code,
|
||||
and their names are written in the generated bytecode executable.
|
||||
The run-time system
|
||||
.BR ocamlrun (1)
|
||||
then loads them dynamically at program start-up time.
|
||||
|
||||
The output of the linking phase is a file containing compiled bytecode
|
||||
that can be executed by the Objective Caml bytecode interpreter:
|
||||
the command
|
||||
.BR ocamlrun (1).
|
||||
If
|
||||
.B caml.out
|
||||
is the name of the file produced by the linking phase, the command
|
||||
.B ocamlrun caml.out
|
||||
.IR arg1 \ \ arg2 \ ... \ argn
|
||||
executes the compiled code contained in
|
||||
.BR caml.out ,
|
||||
passing it as arguments the character strings
|
||||
.I arg1
|
||||
to
|
||||
.IR argn .
|
||||
(See
|
||||
.BR ocamlrun (1)
|
||||
for more details.)
|
||||
|
||||
On most systems, the file produced by the linking
|
||||
phase can be run directly, as in:
|
||||
.B ./caml.out
|
||||
.IR arg1 \ \ arg2 \ ... \ argn .
|
||||
The produced file has the executable bit set, and it manages to launch
|
||||
the bytecode interpreter by itself.
|
||||
|
||||
.B ocamlc.opt
|
||||
is the same compiler as
|
||||
.BR ocamlc ,
|
||||
|
|
@ -135,114 +157,411 @@ Thus, it behaves exactly like
|
|||
.BR ocamlc ,
|
||||
but compiles faster.
|
||||
.B ocamlc.opt
|
||||
is not available in all installations of Objective Caml.
|
||||
may not be available in all installations of Objective Caml.
|
||||
|
||||
.SH OPTIONS
|
||||
|
||||
The following command-line options are recognized by
|
||||
The following command-line options are recognized by
|
||||
.BR ocamlc (1).
|
||||
|
||||
.TP
|
||||
.B \-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
|
||||
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 must be set with the
|
||||
.B \-o
|
||||
option. The default name is
|
||||
.BR library.cma .
|
||||
|
||||
option.
|
||||
.IP
|
||||
If
|
||||
.BR \-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
|
||||
.BR \-custom , \ \-cclib \ and \ \-ccopt
|
||||
options as if they had been provided on the
|
||||
command line, unless the
|
||||
.B -noautolink
|
||||
option is given.
|
||||
.TP
|
||||
.B \-annot
|
||||
Dump detailed information about the compilation (types, bindings,
|
||||
tail-calls, etc). The information for file
|
||||
.IR src .ml
|
||||
is put into file
|
||||
.IR src .annot.
|
||||
In case of a type error, dump all the information inferred by the
|
||||
type-checker before the error. The
|
||||
.IR src .annot
|
||||
file can be used with the emacs commands given in
|
||||
.B emacs/caml-types.el
|
||||
to display types and other annotations interactively.
|
||||
.TP
|
||||
.B \-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.
|
||||
|
||||
.TP
|
||||
.BI \-cc \ ccomp
|
||||
Use
|
||||
.I ccomp
|
||||
as the C linker when linking in "custom runtime" mode (see the
|
||||
.B \-custom
|
||||
option) and as the C compiler for compiling .c source files.
|
||||
.TP
|
||||
.BI \-cclib\ -l libname
|
||||
Pass the
|
||||
Pass the
|
||||
.BI \-l libname
|
||||
option to the C linker when linking in
|
||||
``custom runtime'' mode (see the
|
||||
option to the C linker when linking in "custom runtime" mode (see the
|
||||
.B \-custom
|
||||
option). This causes the
|
||||
given C library to be linked with the program.
|
||||
|
||||
option). This causes the given C library to be linked with the program.
|
||||
.TP
|
||||
.B \-ccopt
|
||||
Pass the given option to the C compiler and linker, when linking in
|
||||
``custom runtime'' mode (see the
|
||||
"custom runtime" mode (see the
|
||||
.B \-custom
|
||||
option). For instance,
|
||||
.B -ccopt -L
|
||||
.I dir
|
||||
.BI \-ccopt\ \-L dir
|
||||
causes the C linker to search for C libraries in
|
||||
directory
|
||||
directory
|
||||
.IR dir .
|
||||
|
||||
.TP
|
||||
.B \-custom
|
||||
Link in ``custom runtime'' mode. In the default linking mode, the
|
||||
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,
|
||||
shared runtime system,
|
||||
.BR ocamlrun (1).
|
||||
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
|
||||
can be executed directly, even if the
|
||||
.BR ocamlrun (1)
|
||||
command is not
|
||||
installed. Moreover, the ``custom runtime'' mode enables linking Caml
|
||||
code with user-defined C functions.
|
||||
|
||||
installed. Moreover, the "custom runtime" mode enables linking Caml
|
||||
code with user-defined C functions. Never use the
|
||||
.BR strip (1)
|
||||
command on executables produced by
|
||||
.BR ocamlc\ \-custom ,
|
||||
this would remove the bytecode part of the executable.
|
||||
.TP
|
||||
.BI \-dllib\ \-l libname
|
||||
Arrange for the C shared library
|
||||
.BI dll libname .so
|
||||
to be loaded dynamically by the run-time system
|
||||
.BR ocamlrun (1)
|
||||
at program start-up time.
|
||||
.TP
|
||||
.BI \-dllpath \ dir
|
||||
Adds the directory
|
||||
.I 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
|
||||
.B \-I
|
||||
option).
|
||||
The
|
||||
.B \-dllpath
|
||||
option simply stores
|
||||
.I dir
|
||||
in the produced
|
||||
executable file, where
|
||||
.BR ocamlrun (1)
|
||||
can find it and use it.
|
||||
.TP
|
||||
.B \-g
|
||||
Add debugging information while compiling and linking. This option is
|
||||
required in order to be able to debug the program with
|
||||
.BR ocamldebug (1)
|
||||
and to produce stack backtraces when
|
||||
the program terminates on an uncaught exception.
|
||||
.TP
|
||||
.B \-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
|
||||
file). No compiled files (.cmo and .cmi files) are produced.
|
||||
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.
|
||||
|
||||
.TP
|
||||
.BI \-I \ directory
|
||||
Add the given directory to the list of directories searched for
|
||||
compiled interface files (.cmi) and compiled object code files
|
||||
(.cmo). By default, the current directory is searched first, then the
|
||||
compiled interface files (.cmi), compiled object code files
|
||||
(.cmo), libraries (.cma), and C libraries specified with
|
||||
.B \-cclib\ \-l
|
||||
.IR xxx .
|
||||
By default, the current directory is searched first, then the
|
||||
standard library directory. Directories added with
|
||||
.B -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.
|
||||
|
||||
.IP
|
||||
If the given directory starts with
|
||||
.BR + ,
|
||||
it is taken relative to the
|
||||
standard library directory. For instance,
|
||||
.B \-I +labltk
|
||||
adds the subdirectory
|
||||
.B labltk
|
||||
of the standard library to the search path.
|
||||
.TP
|
||||
.BI \-o \ exec-file
|
||||
.BI \-impl \ filename
|
||||
Compile the file
|
||||
.I filename
|
||||
as an implementation file, even if its extension is not .ml.
|
||||
.TP
|
||||
.BI \-intf \ filename
|
||||
Compile the file
|
||||
.I filename
|
||||
as an interface file, even if its extension is not .mli.
|
||||
.TP
|
||||
.BI \-intf\-suffix \ string
|
||||
Recognize file names ending with
|
||||
.I string
|
||||
as interface files (instead of the default .mli).
|
||||
.TP
|
||||
.B \-labels
|
||||
Labels are not ignored in types, labels may be used in applications,
|
||||
and labelled parameters can be given in any order. This is the default.
|
||||
.TP
|
||||
.B \-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 (option
|
||||
.BR \-a ),
|
||||
setting the
|
||||
.B -linkall
|
||||
option forces all subsequent links of programs involving that library
|
||||
to link all the modules contained in the library.
|
||||
.TP
|
||||
.B \-make\-runtime
|
||||
Build a custom runtime system (in the file specified by option
|
||||
.BR \-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 option
|
||||
.B ocamlc\ \-use\-runtime
|
||||
.IR runtime-name .
|
||||
.TP
|
||||
.B \-noassert
|
||||
Do not compile assertion checks. Note that the special form
|
||||
.B assert false
|
||||
is always compiled because it is typed specially.
|
||||
This flag has no effect when linking already-compiled files.
|
||||
.TP
|
||||
.B \-noautolink
|
||||
When linking .cma libraries, ignore
|
||||
.BR \-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
|
||||
.B \-noautolink
|
||||
and pass the correct C libraries and options on the command line.
|
||||
.TP
|
||||
.B \-nolabels
|
||||
Ignore non-optional labels in types. Labels cannot be used in
|
||||
applications, and parameter order becomes strict.
|
||||
.TP
|
||||
.BI \-o \ exec\-file
|
||||
Specify the name of the output file produced by the linker. The
|
||||
default output name is
|
||||
default output name is
|
||||
.BR a.out ,
|
||||
in keeping with the Unix tradition. If the
|
||||
in keeping with the Unix tradition. If the
|
||||
.B \-a
|
||||
option is given, specify the name of the library produced.
|
||||
|
||||
option is given, specify the name of the library
|
||||
produced. If the
|
||||
.B \-pack
|
||||
option is given, specify the name of the
|
||||
packed object file produced. If the
|
||||
.B \-output\-obj
|
||||
option is given,
|
||||
specify the name of the output file produced.
|
||||
.TP
|
||||
.B \-v
|
||||
Print the version number of the compiler.
|
||||
|
||||
.B \-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. The name of the output object file is
|
||||
.B camlprog.o
|
||||
by default; it can be set with the
|
||||
.B \-o
|
||||
option. This
|
||||
option can also be used to produce a C source file (.c extension) or
|
||||
a compiled shared/dynamic library (.so extension).
|
||||
.TP
|
||||
.B \-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
|
||||
.B \-o
|
||||
option. For instance,
|
||||
.B 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.
|
||||
.TP
|
||||
.BI \-pp \ command
|
||||
Cause the compiler to call the given
|
||||
.I command
|
||||
as a preprocessor for each source file. The output of
|
||||
.I 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.
|
||||
.TP
|
||||
.B \-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
|
||||
.B \-principal
|
||||
mode are also accepted in the
|
||||
default mode with equivalent types, but different binary signatures,
|
||||
and this may slow down type checking; yet it is a good idea to
|
||||
use it once before publishing source code.
|
||||
.TP
|
||||
.B \-rectypes
|
||||
Allow arbitrary recursive types during type-checking. By default,
|
||||
only recursive types where the recursion goes through an object type
|
||||
are supported. Note that once you have created an interface using this
|
||||
flag, you must use it again for all dependencies.
|
||||
.TP
|
||||
.B \-thread
|
||||
Compile or link multithreaded programs, in combination with the
|
||||
system "threads" library described in
|
||||
.IR The\ Objective\ Caml\ user's\ manual .
|
||||
.TP
|
||||
.B \-unsafe
|
||||
Turn bound checking off on array and string accesses (the
|
||||
.B v.(i)
|
||||
and
|
||||
.B s.[i]
|
||||
constructs). Programs compiled with
|
||||
Turn bound checking off on array and string accesses (the
|
||||
.BR v.(i) and s.[i]
|
||||
constructs). Programs compiled with
|
||||
.B \-unsafe
|
||||
are therefore
|
||||
slightly faster, but unsafe: anything can happen if the program
|
||||
accesses an array or string outside of its bounds.
|
||||
.TP
|
||||
.BI \-use\-runtime \ runtime\-name
|
||||
Generate a bytecode executable file that can be executed on the custom
|
||||
runtime system
|
||||
.IR runtime\-name ,
|
||||
built earlier with
|
||||
.B ocamlc -make-runtime
|
||||
.IR runtime\-name .
|
||||
.TP
|
||||
.B \-v
|
||||
Print the version number of the compiler and the location of the
|
||||
standard library directory, then exit.
|
||||
.TP
|
||||
.B \-verbose
|
||||
Print all external commands before they are executed, in particular
|
||||
invocations of the C compiler and linker in
|
||||
.B \-custom
|
||||
mode. Useful to debug C library problems.
|
||||
.TP
|
||||
.B \-version
|
||||
Print the version number of the compiler in short form (e.g. 3.06),
|
||||
then exit.
|
||||
.TP
|
||||
.B \-vmthread
|
||||
Compile or link multithreaded programs, in combination with the
|
||||
VM-level threads library described in
|
||||
.IR The\ Objective\ Caml\ user's\ manual .
|
||||
.TP
|
||||
.BI \-w \ warning\-list
|
||||
Enable or disable warnings according to the argument
|
||||
.IR warning\-list .
|
||||
The argument is a set of letters. If a letter is
|
||||
uppercase, it enables the corresponding warnings; lowercase disables
|
||||
the warnings. The correspondence is the following:
|
||||
.TP
|
||||
.B A
|
||||
all warnings
|
||||
.TP
|
||||
.B C
|
||||
start of comments that look like mistakes
|
||||
.TP
|
||||
.B D
|
||||
use of deprecated features
|
||||
.TP
|
||||
.B E
|
||||
fragile pattern matchings (matchings that will remain
|
||||
complete even if additional constructors are added to one of the
|
||||
variant types matched)
|
||||
.TP
|
||||
.B F
|
||||
partially applied functions (expressions whose result has
|
||||
function type and is ignored)
|
||||
.TP
|
||||
.B L
|
||||
omission of labels in applications
|
||||
.TP
|
||||
.B M
|
||||
overriding of methods
|
||||
.TP
|
||||
.B P
|
||||
missing cases in pattern matchings (i.e. partial matchings)
|
||||
.TP
|
||||
.B S
|
||||
expressions in the left-hand side of a sequence that don't
|
||||
have type
|
||||
.B unit
|
||||
(and that are not functions, see
|
||||
.B F
|
||||
above)
|
||||
.TP
|
||||
.B U
|
||||
redundant cases in pattern matching (unused cases)
|
||||
.TP
|
||||
.B V
|
||||
overriding of instance variables
|
||||
.TP
|
||||
.B Y
|
||||
unused variables that are bound with
|
||||
.BR let \ or \ as ,
|
||||
and don't start with underscore
|
||||
.TP
|
||||
.B Z
|
||||
all other cases of unused variables that don't start with underscore
|
||||
.TP
|
||||
.B X
|
||||
warnings that don't fit in the above categories
|
||||
.IP
|
||||
The default setting is
|
||||
.BR Aelz ,
|
||||
enabling all warnings except fragile
|
||||
pattern matchings, omitted labels, and innocuous unused variables.
|
||||
Note that warnings
|
||||
.BR F \ and \ S
|
||||
are not always triggered, depending on the internals of the type checker.
|
||||
.TP
|
||||
.BI \-warn\-error \ warning\-list
|
||||
Turn the warnings indicated in the argument
|
||||
.I warning\-list
|
||||
into errors. The compiler will stop with an error when one of these
|
||||
warnings is emitted. The
|
||||
.I warning\-list
|
||||
has 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
|
||||
.B \-warn\-error a
|
||||
(none of the warnings is treated as an error).
|
||||
.TP
|
||||
.B \-where
|
||||
Print the location of the standard library, then exit.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR ocaml (1),
|
||||
.BR ocamlrun (1).
|
||||
.BR ocamlopt (1), \ ocamlrun (1), \ ocaml (1).
|
||||
.br
|
||||
.I The Objective Caml user's manual,
|
||||
chapter "Batch compilation".
|
||||
|
|
|
|||
Loading…
Reference in New Issue