1OCAMLRUN(1) General Commands Manual OCAMLRUN(1)
2
6 ocamlrun - The OCaml bytecode interpreter
7
10 ocamlrun [ options ] filename argument ...
11
14 The ocamlrun(1) command executes bytecode files produced by the linking
15 phase of the ocamlc(1) command.
16 The first non-option argument is taken to be the name of the file con‐
18 taining the executable bytecode. (That file is searched in the exe‐
19 cutable path as well as in the current directory.) The remaining argu‐
20 ments are passed to the OCaml program, in the string array Sys.argv.
21 Element 0 of this array is the name of the bytecode executable file;
22 elements 1 to n are the remaining arguments.
23 In most cases, the bytecode executable files produced by the ocamlc(1)
25 command are self-executable, and manage to launch the ocamlrun(1) com‐
26 mand on themselves automatically.
27
30 The following command-line options are recognized by ocamlrun(1).
31 -b When the program aborts due to an uncaught exception, print a
33 detailed "back trace" of the execution, showing where the excep‐
34 tion was raised and which function calls were outstanding at
35 this point. The back trace is printed only if the bytecode exe‐
36 cutable contains debugging information, i.e. was compiled and
37 linked with the -g option to ocamlc(1) set. This option is
38 equivalent to setting the b flag in the OCAMLRUNPARAM environ‐
39 ment variable (see below).
40 -I dir Search the directory dir for dynamically-loaded libraries, in
42 addition to the standard search path.
43 -p Print the names of the primitives known to this version of
45 ocamlrun(1) and exit.
46 -v Direct the memory manager to print verbose messages on standard
48 error. This is equivalent to setting v=63 in the OCAMLRUNPARAM
49 environment variable (see below).
50 -version
52 Print version string and exit.
53 -vnum Print short version number and exit.
55
58 The following environment variable are also consulted:
59 CAML_LD_LIBRARY_PATH
61 Additional directories to search for dynamically-loaded
62 libraries.
63 OCAMLLIB
65 The directory containing the OCaml standard library. (If OCAML‐
66 LIB is not set, CAMLLIB will be used instead.) Used to locate
67 the ld.conf configuration file for dynamic loading. If not set,
68 default to the library directory specified when compiling OCaml.
69 OCAMLRUNPARAM
71 Set the runtime system options and garbage collection parame‐
72 ters. (If OCAMLRUNPARAM is not set, CAMLRUNPARAM will be used
73 instead.) This variable must be a sequence of parameter speci‐
74 fications separated by commas. A parameter specification is a
75 letter, optionally followed by an = sign, a decimal number (or a
76 hexadecimal number prefixed by 0x), and an optional multiplier.
77 If the letter is followed by anything else, the corresponding
78 option is set to 1. Unknown letters are ignored. The options
79 are documented below; the last six correspond to the fields of
80 the control record documented in The OCaml user's manual, chap‐
81 ter "Standard Library", section "Gc".
82 b Trigger the printing of a stack backtrace when an uncaught
84 exception aborts the program. This option takes no argument.
85 p Turn on debugging support for ocamlyacc-generated parsers. When
87 this option is on, the pushdown automaton that executes the
88 parsers prints a trace of its actions. This option takes no
89 argument.
90 R Turn on randomization of all hash tables by default (see the
92 Hashtbl module of the standard library). This option takes no
93 argument.
94 h The initial size of the major heap (in words).
96 a (allocation_policy)
98 The policy used for allocating in the OCaml heap. Possible val‐
99 ues are 0 for the next-fit policy, and 1 for the first-fit pol‐
100 icy. Next-fit is usually faster, but first-fit is better for
101 avoiding fragmentation and the associated heap compactions.
102 s (minor_heap_size)
104 The size of the minor heap (in words).
105 i (major_heap_increment)
107 The default size increment for the major heap (in words).
108 o (space_overhead)
110 The major GC speed setting.
111 O (max_overhead)
113 The heap compaction trigger setting.
114 l (stack_limit)
116 The limit (in words) of the stack size.
117 v (verbose)
119 What GC messages to print to stderr. This is a sum of values
120 selected from the following:
121 0x001 Start of major GC cycle.
123 0x002 Minor collection and major GC slice.
125 0x004 Growing and shrinking of the heap.
127 0x008 Resizing of stacks and memory manager tables.
129 0x010 Heap compaction.
131 0x020 Change of GC parameters.
133 0x040 Computation of major GC slice size.
135 0x080 Calling of finalisation functions.
137 0x100 Startup messages (loading the bytecode executable file,
139 resolving shared libraries).
140 0x200 Computation of compaction-triggering condition.
142 0x400 Output GC statistics at program exit, in the same format
144 as Gc.print_stat.
145 The multiplier is k, M, or G, for multiplication by 2^10, 2^20,
147 and 2^30 respectively.
148 If the option letter is not recognized, the whole parameter is
150 ignored; if the equal sign or the number is missing, the value
151 is taken as 1; if the multiplier is not recognized, it is
152 ignored.
153 For example, on a 32-bit machine under bash, the command export
155 OCAMLRUNPARAM='s=256k,v=1' tells a subsequent ocamlrun to set
156 its initial minor heap size to 1 megabyte and to print a message
157 at the start of each major GC cycle.
158 CAMLRUNPARAM
160 If OCAMLRUNPARAM is not found in the environment, then CAMLRUN‐
161 PARAM will be used instead. If CAMLRUNPARAM is also not found,
162 then the default values will be used.
163 PATH List of directories searched to find the bytecode executable
165 file.
166
169 ocamlc(1).
170 The OCaml user's manual, chapter "Runtime system".
171 OCAMLRUN(1)