282 lines
8.4 KiB
Matlab
282 lines
8.4 KiB
Matlab
.\"**************************************************************************
|
|
.\"* *
|
|
.\"* OCaml *
|
|
.\"* *
|
|
.\"* Xavier Leroy, projet Cristal, INRIA Rocquencourt *
|
|
.\"* *
|
|
.\"* Copyright 1996 Institut National de Recherche en Informatique et *
|
|
.\"* en Automatique. *
|
|
.\"* *
|
|
.\"* All rights reserved. This file is distributed under the terms of *
|
|
.\"* the GNU Lesser General Public License version 2.1, with the *
|
|
.\"* special exception on linking described in the file LICENSE. *
|
|
.\"* *
|
|
.\"**************************************************************************
|
|
.\"
|
|
.TH OCAML 1
|
|
|
|
.SH NAME
|
|
ocaml \- The OCaml interactive toplevel
|
|
|
|
.SH SYNOPSIS
|
|
.B ocaml
|
|
[
|
|
.I options
|
|
]
|
|
[
|
|
.I object-files
|
|
]
|
|
[
|
|
.I script-file
|
|
]
|
|
.SH DESCRIPTION
|
|
|
|
The
|
|
.BR ocaml (1)
|
|
command is the toplevel system for OCaml,
|
|
that permits interactive use of the OCaml system through a
|
|
read-eval-print loop. In this mode, the system repeatedly reads OCaml
|
|
phrases from the input, then typechecks, compiles and evaluates
|
|
them, then prints the inferred type and result value, if any. The
|
|
system prints a # (hash) 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
|
|
.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
|
|
terminates
|
|
.BR ocaml (1).
|
|
|
|
If one or more
|
|
.I object-files
|
|
(ending in .cmo or .cma) are given, they are loaded silently before
|
|
starting the toplevel.
|
|
|
|
If a
|
|
.I script-file
|
|
is given, phrases are read silently from the file, errors printed on
|
|
standard error.
|
|
.BR ocaml (1)
|
|
exits after the execution of the last phrase.
|
|
|
|
.SH OPTIONS
|
|
|
|
The following command-line options are recognized by
|
|
.BR ocaml (1).
|
|
.TP
|
|
.B \-absname
|
|
Show absolute filenames in error messages.
|
|
.TP
|
|
.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
|
|
.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\ +compiler-libs
|
|
adds the subdirectory
|
|
.B compiler-libs
|
|
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.
|
|
See the "Initialization file" section below.
|
|
.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 \-no\-app\-funct
|
|
Deactivates the applicative behaviour of functors. With this option,
|
|
each functor application generates new types in its result and
|
|
applying the same functor twice to the same argument yields two
|
|
incompatible structures.
|
|
.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 \-noinit
|
|
Do not load any initialization file.
|
|
See the "Initialization file" section below.
|
|
.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 \-nopromptcont
|
|
Do not display the secondary prompt when waiting for continuation lines in
|
|
multi-line inputs. This should be used e.g. when running
|
|
.BR ocaml (1)
|
|
in an
|
|
.BR emacs (1)
|
|
window.
|
|
.TP
|
|
.B \-nostdlib
|
|
Do not include the standard library directory in the list of
|
|
directories searched for source and compiled files.
|
|
.TP
|
|
.BI \-open \ module
|
|
Opens the given module before starting the toplevel. If several
|
|
.B \-open
|
|
options are given, they are processed in order, just as if
|
|
the statements open! module1;; ... open! moduleN;; were input.
|
|
.TP
|
|
.BI \-ppx \ command
|
|
After parsing, pipe the abstract syntax tree through the preprocessor
|
|
.IR command .
|
|
The module
|
|
.BR Ast_mapper (3)
|
|
implements the external interface of a preprocessor.
|
|
.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 \-safe\-string
|
|
Enforce the separation between types
|
|
.BR string \ and\ bytes ,
|
|
thereby making strings read-only. This will become the default in
|
|
a future version of OCaml.
|
|
.TP
|
|
.B \-short\-paths
|
|
When a type is visible under several module-paths, use the shortest
|
|
one when printing the type's name in inferred interfaces and error and
|
|
warning messages.
|
|
.TP
|
|
.B \-stdin
|
|
Read the standard input as a script file rather than starting an
|
|
interactive session.
|
|
.TP
|
|
.B \-strict\-sequence
|
|
Force the left-hand part of each sequence to have type unit.
|
|
.TP
|
|
.B \-unsafe
|
|
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 \-unsafe\-string
|
|
Identify the types
|
|
.BR string \ and\ bytes ,
|
|
thereby making strings writable. For reasons of backward compatibility,
|
|
this is the default setting for the moment, but this will change in a future
|
|
version of OCaml.
|
|
.TP
|
|
.B \-version
|
|
Print version string and exit.
|
|
.TP
|
|
.B \-vnum
|
|
Print short version number and exit.
|
|
.TP
|
|
.B \-no\-version
|
|
Do not print the version banner at startup.
|
|
.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
|
|
.I warning\-list
|
|
argument.
|
|
.TP
|
|
.BI \-warn\-error \ warning\-list
|
|
Mark as fatal the warnings described by the argument
|
|
.IR warning\-list .
|
|
Note that a warning is not triggered (and does not trigger an error) if
|
|
it is disabled by the
|
|
.B \-w
|
|
option. See
|
|
.BR ocamlc (1)
|
|
for the syntax of the
|
|
.I warning\-list
|
|
argument.
|
|
.TP
|
|
.B \-warn\-help
|
|
Show the description of all available warning numbers.
|
|
.TP
|
|
.BI \- \ file
|
|
Use
|
|
.I file
|
|
as a script file name, even when it starts with a hyphen (-).
|
|
.TP
|
|
.BR \-help \ or \ \-\-help
|
|
Display a short usage summary and exit.
|
|
|
|
.SH INITIALIZATION FILE
|
|
|
|
When
|
|
.BR ocaml (1)
|
|
is invoked, it will read phrases from an initialization file before
|
|
giving control to the user. The default file is
|
|
.B .ocamlinit
|
|
in the current directory if it exists, otherwise
|
|
.B .ocamlinit
|
|
in the user's home directory. You can specify a different initialization file
|
|
by using the
|
|
.BI \-init \ file
|
|
option, and disable initialization files by using the
|
|
.B \-noinit
|
|
option.
|
|
|
|
Note that you can also use the
|
|
.B #use
|
|
directive to read phrases from a file.
|
|
|
|
.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
|
|
attempts to underline visually the location of the error. It
|
|
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), \ ocamlopt (1), \ ocamlrun (1).
|
|
.br
|
|
.IR The\ OCaml\ user's\ manual ,
|
|
chapter "The toplevel system".
|