The command line arguments given to the process. The first element is the command name used to invoke the program. The following elements are the command-line arguments given to the program.
The name of the file containing the executable currently running. This name may be absolute or relative to the current directory, depending on the platform and whether the program was compiled to bytecode or a native executable.
true if the given name refers to a directory,
false if it refers to another kind of file.
Rename a file.
rename oldpath newpath renames the file called
oldpath, giving it
newpath as its new name, moving it between directories if needed. If
newpath already exists, its contents will be replaced with those of
oldpath. Depending on the operating system, the metadata (permissions, owner, etc) of
newpath can either be preserved or be replaced by those of
Return the value associated to a variable in the process environment or
None if the variable is unbound.
Execute the given shell command and return its exit code.
The argument of
Sys.command is generally the name of a command followed by zero, one or several arguments, separated by whitespace. The given argument is interpreted by a shell: either the Windows shell
cmd.exe for the Win32 ports of OCaml, or the POSIX shell
sh for other ports. It can contain shell builtin commands such as
echo, and also special characters such as file redirections
<, which will be honored by the shell.
Conversely, whitespace or special shell characters occurring in command names or in their arguments must be quoted or escaped so that the shell does not interpret them. The quoting rules vary between the POSIX shell and the Windows shell. The
Filename.quote_command performs the appropriate quoting given a command name, a list of arguments, and optional file redirections.
Return the processor time, in seconds, used by the program since the beginning of execution.
Return the names of all files present in the given directory. Names denoting the current directory and the parent directory (
".." in Unix) are not returned. Each string in the result is a file name rather than a complete path. There is no guarantee that the name strings in the resulting array will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.
val interactive : bool ref
This reference is initially set to
false in standalone programs and to
true if the code is being executed under the interactive toplevel system
Operating system currently executing the OCaml program. One of
"Unix"(for all Unix versions, including Linux and Mac OS X),
"Win32"(for MS-Windows, OCaml compiled with MSVC++ or Mingw),
"Cygwin"(for MS-Windows, OCaml compiled with Cygwin).
Currently, the official distribution only supports
val backend_type : backend_type
Backend type currently executing the OCaml program.
Size of one word on the machine currently executing the OCaml program, in bits: 32 or 64.
Maximum length of a normal array (i.e. any array whose elements are not of type
float). The maximum length of a
float array is
max_floatarray_length if OCaml was configured with
max_array_length if configured with
Maximum length of a floatarray. This is also the maximum length of a
float array when OCaml is configured with
Return the name of the runtime variant the program is running on. This is normally the argument given to
-runtime-variant at compile time, but for byte-code it can be changed after compilation.
Return the value of the runtime parameters, in the same format as the contents of the
OCAMLRUNPARAM environment variable.
What to do when receiving a signal:
Signal_default: take the default behavior (usually: abort the program)
Signal_ignore: ignore the signal
Signal_handle f: call function
f, giving it the signal number as argument.
Set the behavior of the system on receipt of a given signal. The first argument is the signal number. Return the behavior previously associated with the signal. If the signal number is invalid (or not available on your system), an
Invalid_argument exception is raised.
Exception raised on interactive interrupt if
Sys.catch_break is on.
catch_break governs whether interactive interrupt (ctrl-C) terminates the program or raises the
Break exception. Call
catch_break true to enable raising
catch_break false to let the system terminate the program on user interrupt.
ocaml_version is the version of OCaml. It is a string of the form
patchlevel are integers, and
additional-info is an arbitrary string. The
[.patchlevel] part is absent for versions anterior to 3.08.0. The
[(+|~)additional-info] part may be absent.
Control whether the OCaml runtime system can emit warnings on stderr. Currently, the only supported warning is triggered when a channel created by
open_* functions is finalized without being closed. Runtime warnings are disabled by default.
For the purposes of optimization,
opaque_identity behaves like an unknown (and thus possibly side-effecting) function.
opaque_identity disappears altogether.
A typical use of this function is to prevent pure computations from being optimized away in benchmarking loops. For example:
for _round = 1 to 100_000 do ignore (Sys.opaque_identity (my_pure_computation ())) done
module Immediate64 : sig ... end
This module allows to define a type
t with the
immediate64 attribute. This attribute means that the type is immediate on 64 bit architectures. On other architectures, it might or might not be immediate.