This module defines higher-level functions than the
Unix module and should, wherever possible, be used rather than the
Unix module to ensure portability.
- author Xavier Leroy (Base module)
- author David Teller
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.
true if the given name refers to a directory,
false if it refers to another kind of file.
- raises Sys_error
if no file exists with the given name.
- since 3.10.0
Rename a file. The first argument is the old name and the second is the new name. If there is already another file under the new name,
rename may replace it, or raise an exception, depending on your operating system.
Return the value associated to a variable in the process environment.
- raises Not_found
if the variable is unbound.
Return the value associated to a variable in the process environment or
None if the variable is unbound.
- since 4.05
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 Pervasives.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).
Size of one word on the machine currently executing the OCaml program, in bits: 32 or 64.
Whether the machine currently executing the OCaml program is big-endian.
- since 4.00.0
Maximum length of a normal array. The maximum length of a float array is
max_array_length/2 on 32-bit machines and
max_array_length on 64-bit machines.
type signal_behavior = Sys.signal_behavior =
val signal : int -> signal_behavior -> signal_behavior
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.
- raises Invalid_argument
If the signal number is invalid (or not available on your system).
val set_signal : int -> signal_behavior -> unit
Sys.signal but return value is ignored.
Signal numbers for the standard POSIX signals.
Exception raised on interactive interrupt if
Sys.catch_break is on.
catch_break governs whether interactive interrupt (ctrl-C) terminates the program or raises
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
[+additional-info] parts may be absent.
val files_of : string -> string BatEnum.t
readdir but the results are presented as an enumeration of names.
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
The compiler primitive was added to OCaml 4.03, but we emulate it under 4.02 using the -opaque compilation flag. There is no easy way for Batteries to emulate it correctly under older OCaml versions.
- since 2.5.0 and OCaml 4.02