1Sys(3) OCaml library Sys(3)
2
6 Sys - System interface.
7
9 Module Sys
10
12 Module Sys
13 : sig end
14 System interface.
17 val argv : string array
25 The command line arguments given to the process. The first element is
27 the command name used to invoke the program. The following elements
28 are the command-line arguments given to the program.
29 val executable_name : string
34 The name of the file containing the executable currently running.
36 val file_exists : string -> bool
41 Test if a file with the given name exists.
43 val remove : string -> unit
48 Remove the given file name from the file system.
50 val rename : string -> string -> unit
55 Rename a file. The first argument is the old name and the second is the
57 new name. If there is already another file under the new name, rename
58 may replace it, or raise an exception, depending on your operating sys‐
59 tem.
60 val getenv : string -> string
65 Return the value associated to a variable in the process environment.
67 Raise Not_found if the variable is unbound.
68 val command : string -> int
73 Execute the given shell command and return its exit code.
75 val time : unit -> float
80 Return the processor time, in seconds, used by the program since the
82 beginning of execution.
83 val chdir : string -> unit
88 Change the current working directory of the process.
90 val getcwd : unit -> string
95 Return the current working directory of the process.
97 val readdir : string -> string array
102 Return the names of all files present in the given directory. Names
104 denoting the current directory and the parent directory ( . and .. in
105 Unix) are not returned. Each string in the result is a file name
106 rather than a complete path. There is no guarantee that the name
107 strings in the resulting array will appear in any specific order; they
108 are not, in particular, guaranteed to appear in alphabetical order.
109 val interactive : bool Pervasives.ref
114 This reference is initially set to false in standalone programs and to
116 true if the code is being executed under the interactive toplevel sys‐
117 tem ocaml .
118 val os_type : string
123 Operating system currently executing the Caml program. One of
125 - Unix (for all Unix versions, including Linux and Mac OS X),
127 - Win32 (for MS-Windows, OCaml compiled with MSVC++ or Mingw),
129 - Cygwin (for MS-Windows, OCaml compiled with Cygwin).
131 val word_size : int
137 Size of one word on the machine currently executing the Caml program,
139 in bits: 32 or 64.
140 val max_string_length : int
145 Maximum length of a string.
147 val max_array_length : int
152 Maximum length of a normal array. The maximum length of a float array
154 is max_array_length/2 on 32-bit machines and max_array_length on 64-bit
155 machines.
156 === Signal handling ===
162 type signal_behavior =
164 | Signal_default
165 | Signal_ignore
166 | Signal_handle of (int -> unit) (* What to do when receiving a sig‐
167 nal:
168 - Signal_default : take the default behavior (usually: abort the pro‐
170 gram)
171 - Signal_ignore : ignore the signal
173 - Signal_handle f : call function f , giving it the signal number as
175 argument.
176 *)
177 val signal : int -> signal_behavior -> signal_behavior
183 Set the behavior of the system on receipt of a given signal. The first
185 argument is the signal number. Return the behavior previously associ‐
186 ated with the signal. If the signal number is invalid (or not available
187 on your system), an Invalid_argument exception is raised.
188 val set_signal : int -> signal_behavior -> unit
193 Same as Sys.signal but return value is ignored.
195 === Signal numbers for the standard POSIX signals. ===
201 val sigabrt : int
204 Abnormal termination
206 val sigalrm : int
211 Timeout
213 val sigfpe : int
218 Arithmetic exception
220 val sighup : int
225 Hangup on controlling terminal
227 val sigill : int
232 Invalid hardware instruction
234 val sigint : int
239 Interactive interrupt (ctrl-C)
241 val sigkill : int
246 Termination (cannot be ignored)
248 val sigpipe : int
253 Broken pipe
255 val sigquit : int
260 Interactive termination
262 val sigsegv : int
267 Invalid memory reference
269 val sigterm : int
274 Termination
276 val sigusr1 : int
281 Application-defined signal 1
283 val sigusr2 : int
288 Application-defined signal 2
290 val sigchld : int
295 Child process terminated
297 val sigcont : int
302 Continue
304 val sigstop : int
309 Stop
311 val sigtstp : int
316 Interactive stop
318 val sigttin : int
323 Terminal read from background process
325 val sigttou : int
330 Terminal write from background process
332 val sigvtalrm : int
337 Timeout in virtual time
339 val sigprof : int
344 Profiling interrupt
346 exception Break
351 Exception raised on interactive interrupt if Sys.catch_break is on.
354 val catch_break : bool -> unit
359 catch_break governs whether interactive interrupt (ctrl-C) terminates
362 the program or raises the Break exception. Call catch_break true to
363 enable raising Break , and catch_break false to let the system termi‐
364 nate the program on user interrupt.
365 val ocaml_version : string
370 ocaml_version is the version of Objective Caml. It is a string of the
373 form major.minor[.patchlevel][+additional-info] Where major , minor ,
374 and patchlevel are integers, and additional-info is an arbitrary
375 string. The [.patchlevel] and [+additional-info] parts may be absent.
376OCamldoc 2007-05-24 Sys(3)