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 is_directory : string -> bool
48 Returns true if the given name refers to a directory, false if it
50 refers to another kind of file. Raise Sys_error if no file exists with
51 the given name.
52 val remove : string -> unit
57 Remove the given file name from the file system.
59 val rename : string -> string -> unit
64 Rename a file. The first argument is the old name and the second is the
66 new name. If there is already another file under the new name, rename
67 may replace it, or raise an exception, depending on your operating sys‐
68 tem.
69 val getenv : string -> string
74 Return the value associated to a variable in the process environment.
76 Raise Not_found if the variable is unbound.
77 val command : string -> int
82 Execute the given shell command and return its exit code.
84 val time : unit -> float
89 Return the processor time, in seconds, used by the program since the
91 beginning of execution.
92 val chdir : string -> unit
97 Change the current working directory of the process.
99 val getcwd : unit -> string
104 Return the current working directory of the process.
106 val readdir : string -> string array
111 Return the names of all files present in the given directory. Names
113 denoting the current directory and the parent directory ( . and .. in
114 Unix) are not returned. Each string in the result is a file name
115 rather than a complete path. There is no guarantee that the name
116 strings in the resulting array will appear in any specific order; they
117 are not, in particular, guaranteed to appear in alphabetical order.
118 val interactive : bool Pervasives.ref
123 This reference is initially set to false in standalone programs and to
125 true if the code is being executed under the interactive toplevel sys‐
126 tem ocaml .
127 val os_type : string
132 Operating system currently executing the Caml program. One of
134 - Unix (for all Unix versions, including Linux and Mac OS X),
136 - Win32 (for MS-Windows, OCaml compiled with MSVC++ or Mingw),
138 - Cygwin (for MS-Windows, OCaml compiled with Cygwin).
140 val word_size : int
146 Size of one word on the machine currently executing the Caml program,
148 in bits: 32 or 64.
149 val max_string_length : int
154 Maximum length of a string.
156 val max_array_length : int
161 Maximum length of a normal array. The maximum length of a float array
163 is max_array_length/2 on 32-bit machines and max_array_length on 64-bit
164 machines.
165 === Signal handling ===
171 type signal_behavior =
174 | Signal_default
175 | Signal_ignore
176 | Signal_handle of (int -> unit) (* What to do when receiving a sig‐
177 nal:
178 - Signal_default : take the default behavior (usually: abort the pro‐
180 gram)
181 - Signal_ignore : ignore the signal
183 - Signal_handle f : call function f , giving it the signal number as
185 argument.
186 *)
187 val signal : int -> signal_behavior -> signal_behavior
193 Set the behavior of the system on receipt of a given signal. The first
195 argument is the signal number. Return the behavior previously associ‐
196 ated with the signal. If the signal number is invalid (or not available
197 on your system), an Invalid_argument exception is raised.
198 val set_signal : int -> signal_behavior -> unit
203 Same as Sys.signal but return value is ignored.
205 === Signal numbers for the standard POSIX signals. ===
211 val sigabrt : int
214 Abnormal termination
216 val sigalrm : int
221 Timeout
223 val sigfpe : int
228 Arithmetic exception
230 val sighup : int
235 Hangup on controlling terminal
237 val sigill : int
242 Invalid hardware instruction
244 val sigint : int
249 Interactive interrupt (ctrl-C)
251 val sigkill : int
256 Termination (cannot be ignored)
258 val sigpipe : int
263 Broken pipe
265 val sigquit : int
270 Interactive termination
272 val sigsegv : int
277 Invalid memory reference
279 val sigterm : int
284 Termination
286 val sigusr1 : int
291 Application-defined signal 1
293 val sigusr2 : int
298 Application-defined signal 2
300 val sigchld : int
305 Child process terminated
307 val sigcont : int
312 Continue
314 val sigstop : int
319 Stop
321 val sigtstp : int
326 Interactive stop
328 val sigttin : int
333 Terminal read from background process
335 val sigttou : int
340 Terminal write from background process
342 val sigvtalrm : int
347 Timeout in virtual time
349 val sigprof : int
354 Profiling interrupt
356 exception Break
361 Exception raised on interactive interrupt if Sys.catch_break is on.
364 val catch_break : bool -> unit
369 catch_break governs whether interactive interrupt (ctrl-C) terminates
372 the program or raises the Break exception. Call catch_break true to
373 enable raising Break , and catch_break false to let the system termi‐
374 nate the program on user interrupt.
375 val ocaml_version : string
380 ocaml_version is the version of Objective Caml. It is a string of the
383 form major.minor[.patchlevel][+additional-info] , where major , minor ,
384 and patchlevel are integers, and additional-info is an arbitrary
385 string. The [.patchlevel] and [+additional-info] parts may be absent.
386OCamldoc 2010-01-29 Sys(3)