<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="Start" href="index.html">
<link rel="previous" href="Unix.html">
<link rel="next" href="Weak.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Arg" rel="Chapter" href="Arg.html">
<link title="Arith_status" rel="Chapter" href="Arith_status.html">
<link title="Array" rel="Chapter" href="Array.html">
<link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html">
<link title="Big_int" rel="Chapter" href="Big_int.html">
<link title="Bigarray" rel="Chapter" href="Bigarray.html">
<link title="Buffer" rel="Chapter" href="Buffer.html">
<link title="Callback" rel="Chapter" href="Callback.html">
<link title="CamlinternalOO" rel="Chapter" href="CamlinternalOO.html">
<link title="Char" rel="Chapter" href="Char.html">
<link title="Complex" rel="Chapter" href="Complex.html">
<link title="Condition" rel="Chapter" href="Condition.html">
<link title="Dbm" rel="Chapter" href="Dbm.html">
<link title="Digest" rel="Chapter" href="Digest.html">
<link title="Dynlink" rel="Chapter" href="Dynlink.html">
<link title="Event" rel="Chapter" href="Event.html">
<link title="Filename" rel="Chapter" href="Filename.html">
<link title="Format" rel="Chapter" href="Format.html">
<link title="Gc" rel="Chapter" href="Gc.html">
<link title="Genlex" rel="Chapter" href="Genlex.html">
<link title="Graphics" rel="Chapter" href="Graphics.html">
<link title="GraphicsX11" rel="Chapter" href="GraphicsX11.html">
<link title="Hashtbl" rel="Chapter" href="Hashtbl.html">
<link title="Int32" rel="Chapter" href="Int32.html">
<link title="Int64" rel="Chapter" href="Int64.html">
<link title="Lazy" rel="Chapter" href="Lazy.html">
<link title="Lexing" rel="Chapter" href="Lexing.html">
<link title="List" rel="Chapter" href="List.html">
<link title="ListLabels" rel="Chapter" href="ListLabels.html">
<link title="Map" rel="Chapter" href="Map.html">
<link title="Marshal" rel="Chapter" href="Marshal.html">
<link title="MoreLabels" rel="Chapter" href="MoreLabels.html">
<link title="Mutex" rel="Chapter" href="Mutex.html">
<link title="Nativeint" rel="Chapter" href="Nativeint.html">
<link title="Num" rel="Chapter" href="Num.html">
<link title="Obj" rel="Chapter" href="Obj.html">
<link title="Oo" rel="Chapter" href="Oo.html">
<link title="Parsing" rel="Chapter" href="Parsing.html">
<link title="Pervasives" rel="Chapter" href="Pervasives.html">
<link title="Printexc" rel="Chapter" href="Printexc.html">
<link title="Printf" rel="Chapter" href="Printf.html">
<link title="Queue" rel="Chapter" href="Queue.html">
<link title="Random" rel="Chapter" href="Random.html">
<link title="Scanf" rel="Chapter" href="Scanf.html">
<link title="Set" rel="Chapter" href="Set.html">
<link title="Sort" rel="Chapter" href="Sort.html">
<link title="Stack" rel="Chapter" href="Stack.html">
<link title="StdLabels" rel="Chapter" href="StdLabels.html">
<link title="Str" rel="Chapter" href="Str.html">
<link title="Stream" rel="Chapter" href="Stream.html">
<link title="String" rel="Chapter" href="String.html">
<link title="StringLabels" rel="Chapter" href="StringLabels.html">
<link title="Sys" rel="Chapter" href="Sys.html">
<link title="Thread" rel="Chapter" href="Thread.html">
<link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html">
<link title="Tk" rel="Chapter" href="Tk.html">
<link title="Unix" rel="Chapter" href="Unix.html">
<link title="UnixLabels" rel="Chapter" href="UnixLabels.html">
<link title="Weak" rel="Chapter" href="Weak.html"><link title="Error report" rel="Section" href="#6_Errorreport">
<link title="Access to the process environment" rel="Section" href="#6_Accesstotheprocessenvironment">
<link title="Process handling" rel="Section" href="#6_Processhandling">
<link title="Basic file input/output" rel="Section" href="#6_Basicfileinputoutput">
<link title="Interfacing with the standard input/output library" rel="Section" href="#6_Interfacingwiththestandardinputoutputlibrary">
<link title="Seeking and truncating" rel="Section" href="#6_Seekingandtruncating">
<link title="File statistics" rel="Section" href="#6_Filestatistics">
<link title="Seeking, truncating and statistics on large files" rel="Section" href="#6_Seekingtruncatingandstatisticsonlargefiles">
<link title="Operations on file names" rel="Section" href="#6_Operationsonfilenames">
<link title="File permissions and ownership" rel="Section" href="#6_Filepermissionsandownership">
<link title="Operations on file descriptors" rel="Section" href="#6_Operationsonfiledescriptors">
<link title="Directories" rel="Section" href="#6_Directories">
<link title="Pipes and redirections" rel="Section" href="#6_Pipesandredirections">
<link title="High-level process and redirection management" rel="Section" href="#6_Highlevelprocessandredirectionmanagement">
<link title="Symbolic links" rel="Section" href="#6_Symboliclinks">
<link title="Polling" rel="Section" href="#6_Polling">
<link title="Locking" rel="Section" href="#6_Locking">
<link title="Signals" rel="Section" href="#6_Signals">
<link title="Time functions" rel="Section" href="#6_Timefunctions">
<link title="User id, group id" rel="Section" href="#6_Useridgroupid">
<link title="Internet addresses" rel="Section" href="#6_Internetaddresses">
<link title="Sockets" rel="Section" href="#6_Sockets">
<link title="Socket options" rel="Section" href="#6_Socketoptions">
<link title="High-level network connection functions" rel="Section" href="#6_Highlevelnetworkconnectionfunctions">
<link title="Host and protocol databases" rel="Section" href="#6_Hostandprotocoldatabases">
<link title="Terminal interface" rel="Section" href="#6_Terminalinterface">
<title>UnixLabels</title>
</head>
<body>
<div class="navbar"><a href="Unix.html">Previous</a>
<a href="index.html">Up</a>
<a href="Weak.html">Next</a>
</div>
<center><h1>Module <a href="type_UnixLabels.html">UnixLabels</a></h1></center>
<br>
<pre><span class="keyword">module</span> UnixLabels: <code class="type">sig end</code></pre><div class="info">
Interface to the Unix system.
To use as replacement to default <a href="Unix.html"><code class="code"><span class="constructor">Unix</span></code></a> module,
add <code class="code"><span class="keyword">module</span> <span class="constructor">Unix</span> = <span class="constructor">UnixLabels</span></code> in your implementation.<br>
</div>
<hr width="100%">
<br>
<br>
<a name="6_Errorreport"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Error report</span>
</div>
</td>
</tr>
</table>
<br><br>
<br><code><span class="keyword">type</span> <a name="TYPEerror"></a>error = <code class="type"><a href="Unix.html#TYPEerror">Unix.error</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">E2BIG</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Argument list too long</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EACCES</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Permission denied</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EAGAIN</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Resource temporarily unavailable; try again</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EBADF</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Bad file descriptor</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EBUSY</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Resource unavailable</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ECHILD</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>No child process</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EDEADLK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Resource deadlock would occur</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EDOM</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Domain error for math functions, etc.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EEXIST</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>File exists</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EFAULT</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Bad address</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EFBIG</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>File too large</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EINTR</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Function interrupted by signal</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EINVAL</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Invalid argument</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EIO</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Hardware I/O error</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EISDIR</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Is a directory</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EMFILE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Too many open files by the process</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EMLINK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Too many links</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENAMETOOLONG</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Filename too long</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENFILE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Too many open files in the system</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENODEV</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>No such device</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOENT</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>No such file or directory</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOEXEC</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Not an executable file</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOLCK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>No locks available</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOMEM</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Not enough memory</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOSPC</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>No space left on device</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOSYS</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Function not supported</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOTDIR</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Not a directory</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOTEMPTY</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Directory not empty</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOTTY</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Inappropriate I/O control operation</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENXIO</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>No such device or address</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EPERM</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Operation not permitted</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EPIPE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Broken pipe</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ERANGE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Result too large</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EROFS</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Read-only file system</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ESPIPE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Invalid seek e.g. on a pipe</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ESRCH</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>No such process</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EXDEV</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Invalid link</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EWOULDBLOCK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Operation would block</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EINPROGRESS</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Operation now in progress</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EALREADY</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Operation already in progress</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOTSOCK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Socket operation on non-socket</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EDESTADDRREQ</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Destination address required</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EMSGSIZE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Message too long</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EPROTOTYPE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Protocol wrong type for socket</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOPROTOOPT</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Protocol not available</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EPROTONOSUPPORT</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Protocol not supported</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ESOCKTNOSUPPORT</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Socket type not supported</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EOPNOTSUPP</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Operation not supported on socket</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EPFNOSUPPORT</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Protocol family not supported</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EAFNOSUPPORT</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Address family not supported by protocol family</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EADDRINUSE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Address already in use</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EADDRNOTAVAIL</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Can't assign requested address</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENETDOWN</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Network is down</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENETUNREACH</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Network is unreachable</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENETRESET</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Network dropped connection on reset</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ECONNABORTED</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Software caused connection abort</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ECONNRESET</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Connection reset by peer</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOBUFS</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>No buffer space available</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EISCONN</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Socket is already connected</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ENOTCONN</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Socket is not connected</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ESHUTDOWN</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Can't send after socket shutdown</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ETOOMANYREFS</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Too many references: can't splice</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ETIMEDOUT</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Connection timed out</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ECONNREFUSED</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Connection refused</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EHOSTDOWN</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Host is down</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EHOSTUNREACH</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>No route to host</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ELOOP</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Too many levels of symbolic links</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EOVERFLOW</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>File size or position not representable</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">EUNKNOWNERR</span> <span class="keyword">of</span> <code class="type">int</code></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Unknown error</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
The type of error codes.
Errors defined in the POSIX standard
and additional errors, mostly BSD.
All other errors are mapped to EUNKNOWNERR.<br>
</div>
<br>
<pre><span class="keyword">exception</span> <a name="EXCEPTIONUnix_error"></a>Unix_error <span class="keyword">of</span> <code class="type"><a href="UnixLabels.html#TYPEerror">error</a> * string * string</code></pre>
<div class="info">
Raised by the system calls below when an error is encountered.
The first component is the error code; the second component
is the function name; the third component is the string parameter
to the function, if it has one, or the empty string otherwise.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALerror_message"></a>error_message : <code class="type"><a href="UnixLabels.html#TYPEerror">error</a> -> string</code></pre><div class="info">
Return a string describing the given error code.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhandle_unix_error"></a>handle_unix_error : <code class="type">('a -> 'b) -> 'a -> 'b</code></pre><div class="info">
<code class="code">handle_unix_error f x</code> applies <code class="code">f</code> to <code class="code">x</code> and returns the result.
If the exception <code class="code"><span class="constructor">Unix_error</span></code> is raised, it prints a message
describing the error and exits with code 2.<br>
</div>
<br>
<br>
<a name="6_Accesstotheprocessenvironment"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Access to the process environment</span>
</div>
</td>
</tr>
</table>
<br><br>
<pre><span class="keyword">val</span> <a name="VALenvironment"></a>environment : <code class="type">unit -> string array</code></pre><div class="info">
Return the process environment, as an array of strings
with the format ``variable=value''.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetenv"></a>getenv : <code class="type">string -> string</code></pre><div class="info">
Return the value associated to a variable in the process
environment. Raise <code class="code"><span class="constructor">Not_found</span></code> if the variable is unbound.
(This function is identical to <code class="code"><span class="constructor">Sys</span>.getenv</code>.)<br>
</div>
<pre><span class="keyword">val</span> <a name="VALputenv"></a>putenv : <code class="type">string -> string -> unit</code></pre><div class="info">
<code class="code"><span class="constructor">Unix</span>.putenv name value</code> sets the value associated to a
variable in the process environment.
<code class="code">name</code> is the name of the environment variable,
and <code class="code">value</code> its new associated value.<br>
</div>
<br>
<br>
<a name="6_Processhandling"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Process handling</span>
</div>
</td>
</tr>
</table>
<br><br>
<br><code><span class="keyword">type</span> <a name="TYPEprocess_status"></a>process_status = <code class="type"><a href="Unix.html#TYPEprocess_status">Unix.process_status</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">WEXITED</span> <span class="keyword">of</span> <code class="type">int</code></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>The process terminated normally by <code class="code">exit</code>;
the argument is the return code.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">WSIGNALED</span> <span class="keyword">of</span> <code class="type">int</code></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>The process was killed by a signal;
the argument is the signal number.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">WSTOPPED</span> <span class="keyword">of</span> <code class="type">int</code></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>The process was stopped by a signal; the argument is the
signal number.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
The termination status of a process.<br>
</div>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEwait_flag"></a>wait_flag = <code class="type"><a href="Unix.html#TYPEwait_flag">Unix.wait_flag</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">WNOHANG</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>do not block if no child has
died yet, but immediately return with a pid equal to 0.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">WUNTRACED</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>report also the children that receive stop signals.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Flags for <a href="UnixLabels.html#VALwaitpid"><code class="code"><span class="constructor">UnixLabels</span>.waitpid</code></a>.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALexecv"></a>execv : <code class="type">prog:string -> args:string array -> unit</code></pre><div class="info">
<code class="code">execv prog args</code> execute the program in file <code class="code">prog</code>, with
the arguments <code class="code">args</code>, and the current process environment.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALexecve"></a>execve : <code class="type">prog:string -> args:string array -> env:string array -> unit</code></pre><div class="info">
Same as <a href="UnixLabels.html#VALexecv"><code class="code"><span class="constructor">UnixLabels</span>.execv</code></a>, except that the third argument provides the
environment to the program executed.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALexecvp"></a>execvp : <code class="type">prog:string -> args:string array -> unit</code></pre><div class="info">
Same as <a href="UnixLabels.html#VALexecv"><code class="code"><span class="constructor">UnixLabels</span>.execv</code></a> respectively, except that
the program is searched in the path.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALexecvpe"></a>execvpe : <code class="type">prog:string -> args:string array -> env:string array -> unit</code></pre><div class="info">
Same as <a href="UnixLabels.html#VALexecvp"><code class="code"><span class="constructor">UnixLabels</span>.execvp</code></a> respectively, except that
the program is searched in the path.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALfork"></a>fork : <code class="type">unit -> int</code></pre><div class="info">
Fork a new process. The returned integer is 0 for the child
process, the pid of the child process for the parent process.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALwait"></a>wait : <code class="type">unit -> int * <a href="UnixLabels.html#TYPEprocess_status">process_status</a></code></pre><div class="info">
Wait until one of the children processes die, and return its pid
and termination status.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALwaitpid"></a>waitpid : <code class="type">mode:<a href="UnixLabels.html#TYPEwait_flag">wait_flag</a> list -> int -> int * <a href="UnixLabels.html#TYPEprocess_status">process_status</a></code></pre><div class="info">
Same as <a href="UnixLabels.html#VALwait"><code class="code"><span class="constructor">UnixLabels</span>.wait</code></a>, but waits for the process whose pid is given.
A pid of <code class="code">-1</code> means wait for any child.
A pid of <code class="code">0</code> means wait for any child in the same process group
as the current process.
Negative pid arguments represent process groups.
The list of options indicates whether <code class="code">waitpid</code> should return
immediately without waiting, or also report stopped children.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsystem"></a>system : <code class="type">string -> <a href="UnixLabels.html#TYPEprocess_status">process_status</a></code></pre><div class="info">
Execute the given command, wait until it terminates, and return
its termination status. The string is interpreted by the shell
<code class="code">/bin/sh</code> and therefore can contain redirections, quotes, variables,
etc. The result <code class="code"><span class="constructor">WEXITED</span> 127</code> indicates that the shell couldn't
be executed.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetpid"></a>getpid : <code class="type">unit -> int</code></pre><div class="info">
Return the pid of the process.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetppid"></a>getppid : <code class="type">unit -> int</code></pre><div class="info">
Return the pid of the parent process.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALnice"></a>nice : <code class="type">int -> int</code></pre><div class="info">
Change the process priority. The integer argument is added to the
``nice'' value. (Higher values of the ``nice'' value mean
lower priorities.) Return the new nice value.<br>
</div>
<br>
<br>
<a name="6_Basicfileinputoutput"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Basic file input/output</span>
</div>
</td>
</tr>
</table>
<br><br>
<br><code><span class="keyword">type</span> <a name="TYPEfile_descr"></a>file_descr = <code class="type"><a href="Unix.html#TYPEfile_descr">Unix.file_descr</a></code> </code>
<div class="info">
The abstract type of file descriptors.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALstdin"></a>stdin : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a></code></pre><div class="info">
File descriptor for standard input.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALstdout"></a>stdout : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a></code></pre><div class="info">
File descriptor for standard output.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALstderr"></a>stderr : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a></code></pre><div class="info">
File descriptor for standard standard error.<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEopen_flag"></a>open_flag = <code class="type"><a href="Unix.html#TYPEopen_flag">Unix.open_flag</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">O_RDONLY</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Open for reading</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">O_WRONLY</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Open for writing</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">O_RDWR</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Open for reading and writing</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">O_NONBLOCK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Open in non-blocking mode</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">O_APPEND</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Open for append</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">O_CREAT</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Create if nonexistent</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">O_TRUNC</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Truncate to 0 length if existing</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">O_EXCL</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Fail if existing</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">O_NOCTTY</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Don't make this dev a controlling tty</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">O_DSYNC</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Writes complete as `Synchronised I/O data integrity completion'</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">O_SYNC</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Writes complete as `Synchronised I/O file integrity completion'</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">O_RSYNC</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Reads complete as writes (depending on O_SYNC/O_DSYNC)</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
The flags to <a href="UnixLabels.html#VALopenfile"><code class="code"><span class="constructor">UnixLabels</span>.openfile</code></a>.<br>
</div>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEfile_perm"></a>file_perm = <code class="type">int</code> </code>
<div class="info">
The type of file access rights.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALopenfile"></a>openfile : <code class="type">string -><br> mode:<a href="UnixLabels.html#TYPEopen_flag">open_flag</a> list -><br> perm:<a href="UnixLabels.html#TYPEfile_perm">file_perm</a> -> <a href="UnixLabels.html#TYPEfile_descr">file_descr</a></code></pre><div class="info">
Open the named file with the given flags. Third argument is
the permissions to give to the file if it is created. Return
a file descriptor on the named file.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALclose"></a>close : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> unit</code></pre><div class="info">
Close a file descriptor.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALread"></a>read : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> buf:string -> pos:int -> len:int -> int</code></pre><div class="info">
<code class="code">read fd buff ofs len</code> reads <code class="code">len</code> characters from descriptor
<code class="code">fd</code>, storing them in string <code class="code">buff</code>, starting at position <code class="code">ofs</code>
in string <code class="code">buff</code>. Return the number of characters actually read.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALwrite"></a>write : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> buf:string -> pos:int -> len:int -> int</code></pre><div class="info">
<code class="code">write fd buff ofs len</code> writes <code class="code">len</code> characters to descriptor
<code class="code">fd</code>, taking them from string <code class="code">buff</code>, starting at position <code class="code">ofs</code>
in string <code class="code">buff</code>. Return the number of characters actually
written.<br>
</div>
<br>
<br>
<a name="6_Interfacingwiththestandardinputoutputlibrary"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Interfacing with the standard input/output library</span>
</div>
</td>
</tr>
</table>
<br><br>
<pre><span class="keyword">val</span> <a name="VALin_channel_of_descr"></a>in_channel_of_descr : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a></code></pre><div class="info">
Create an input channel reading from the given descriptor.
The channel is initially in binary mode; use
<code class="code">set_binary_mode_in ic <span class="keyword">false</span></code> if text mode is desired.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALout_channel_of_descr"></a>out_channel_of_descr : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="Pervasives.html#TYPEout_channel">Pervasives.out_channel</a></code></pre><div class="info">
Create an output channel writing on the given descriptor.
The channel is initially in binary mode; use
<code class="code">set_binary_mode_out oc <span class="keyword">false</span></code> if text mode is desired.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALdescr_of_in_channel"></a>descr_of_in_channel : <code class="type"><a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a> -> <a href="UnixLabels.html#TYPEfile_descr">file_descr</a></code></pre><div class="info">
Return the descriptor corresponding to an input channel.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALdescr_of_out_channel"></a>descr_of_out_channel : <code class="type"><a href="Pervasives.html#TYPEout_channel">Pervasives.out_channel</a> -> <a href="UnixLabels.html#TYPEfile_descr">file_descr</a></code></pre><div class="info">
Return the descriptor corresponding to an output channel.<br>
</div>
<br>
<br>
<a name="6_Seekingandtruncating"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Seeking and truncating</span>
</div>
</td>
</tr>
</table>
<br><br>
<br><code><span class="keyword">type</span> <a name="TYPEseek_command"></a>seek_command = <code class="type"><a href="Unix.html#TYPEseek_command">Unix.seek_command</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SEEK_SET</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>indicates positions relative to the beginning of the file</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SEEK_CUR</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>indicates positions relative to the current position</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SEEK_END</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>indicates positions relative to the end of the file</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Positioning modes for <a href="UnixLabels.html#VALlseek"><code class="code"><span class="constructor">UnixLabels</span>.lseek</code></a>.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALlseek"></a>lseek : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> int -> mode:<a href="UnixLabels.html#TYPEseek_command">seek_command</a> -> int</code></pre><div class="info">
Set the current position for a file descriptor<br>
</div>
<pre><span class="keyword">val</span> <a name="VALtruncate"></a>truncate : <code class="type">string -> len:int -> unit</code></pre><div class="info">
Truncates the named file to the given size.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALftruncate"></a>ftruncate : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> len:int -> unit</code></pre><div class="info">
Truncates the file corresponding to the given descriptor
to the given size.<br>
</div>
<br>
<br>
<a name="6_Filestatistics"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">File statistics</span>
</div>
</td>
</tr>
</table>
<br><br>
<br><code><span class="keyword">type</span> <a name="TYPEfile_kind"></a>file_kind = <code class="type"><a href="Unix.html#TYPEfile_kind">Unix.file_kind</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">S_REG</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Regular file</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">S_DIR</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Directory</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">S_CHR</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Character device</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">S_BLK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Block device</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">S_LNK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Symbolic link</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">S_FIFO</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Named pipe</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">S_SOCK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Socket</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEstats"></a>stats = <code class="type"><a href="Unix.html#TYPEstats">Unix.stats</a></code> = {<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>st_dev : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Device number</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>st_ino : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Inode number</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>st_kind : <code class="type"><a href="UnixLabels.html#TYPEfile_kind">file_kind</a></code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Kind of the file</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>st_perm : <code class="type"><a href="UnixLabels.html#TYPEfile_perm">file_perm</a></code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Access rights</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>st_nlink : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Number of links</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>st_uid : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>User id of the owner</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>st_gid : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Group ID of the file's group</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>st_rdev : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Device minor number</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>st_size : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Size in bytes</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>st_atime : <code class="type">float</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Last access time</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>st_mtime : <code class="type">float</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Last modification time</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>st_ctime : <code class="type">float</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Last status change time</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info">
The informations returned by the <a href="UnixLabels.html#VALstat"><code class="code"><span class="constructor">UnixLabels</span>.stat</code></a> calls.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALstat"></a>stat : <code class="type">string -> <a href="UnixLabels.html#TYPEstats">stats</a></code></pre><div class="info">
Return the information for the named file.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlstat"></a>lstat : <code class="type">string -> <a href="UnixLabels.html#TYPEstats">stats</a></code></pre><div class="info">
Same as <a href="UnixLabels.html#VALstat"><code class="code"><span class="constructor">UnixLabels</span>.stat</code></a>, but in case the file is a symbolic link,
return the information for the link itself.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALfstat"></a>fstat : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEstats">stats</a></code></pre><div class="info">
Return the information for the file associated with the given
descriptor.<br>
</div>
<br>
<br>
<a name="6_Seekingtruncatingandstatisticsonlargefiles"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Seeking, truncating and statistics on large files</span>
</div>
</td>
</tr>
</table>
<br><br>
<pre><span class="keyword">module</span> <a href="UnixLabels.LargeFile.html">LargeFile</a>: <code class="type">sig end</code></pre><div class="info">
This sub-module provides 64-bit variants of the functions
<a href="UnixLabels.html#VALlseek"><code class="code"><span class="constructor">UnixLabels</span>.lseek</code></a> (for positioning a file descriptor),
<a href="UnixLabels.html#VALtruncate"><code class="code"><span class="constructor">UnixLabels</span>.truncate</code></a> and <a href="UnixLabels.html#VALftruncate"><code class="code"><span class="constructor">UnixLabels</span>.ftruncate</code></a>
(for changing the size of a file),
and <a href="UnixLabels.html#VALstat"><code class="code"><span class="constructor">UnixLabels</span>.stat</code></a>, <a href="UnixLabels.html#VALlstat"><code class="code"><span class="constructor">UnixLabels</span>.lstat</code></a> and <a href="UnixLabels.html#VALfstat"><code class="code"><span class="constructor">UnixLabels</span>.fstat</code></a>
(for obtaining information on files).
</div>
<br>
<br>
<a name="6_Operationsonfilenames"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Operations on file names</span>
</div>
</td>
</tr>
</table>
<br><br>
<pre><span class="keyword">val</span> <a name="VALunlink"></a>unlink : <code class="type">string -> unit</code></pre><div class="info">
Removes the named file<br>
</div>
<pre><span class="keyword">val</span> <a name="VALrename"></a>rename : <code class="type">src:string -> dst:string -> unit</code></pre><div class="info">
<code class="code">rename old <span class="keyword">new</span></code> changes the name of a file from <code class="code">old</code> to <code class="code"><span class="keyword">new</span></code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlink"></a>link : <code class="type">src:string -> dst:string -> unit</code></pre><div class="info">
<code class="code">link source dest</code> creates a hard link named <code class="code">dest</code> to the file
named <code class="code"><span class="keyword">new</span></code>.<br>
</div>
<br>
<br>
<a name="6_Filepermissionsandownership"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">File permissions and ownership</span>
</div>
</td>
</tr>
</table>
<br><br>
<br><code><span class="keyword">type</span> <a name="TYPEaccess_permission"></a>access_permission = <code class="type"><a href="Unix.html#TYPEaccess_permission">Unix.access_permission</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">R_OK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Read permission</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">W_OK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Write permission</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">X_OK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Execution permission</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">F_OK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>File exists</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Flags for the <a href="UnixLabels.html#VALaccess"><code class="code"><span class="constructor">UnixLabels</span>.access</code></a> call.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALchmod"></a>chmod : <code class="type">string -> perm:<a href="UnixLabels.html#TYPEfile_perm">file_perm</a> -> unit</code></pre><div class="info">
Change the permissions of the named file.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALfchmod"></a>fchmod : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> perm:<a href="UnixLabels.html#TYPEfile_perm">file_perm</a> -> unit</code></pre><div class="info">
Change the permissions of an opened file.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALchown"></a>chown : <code class="type">string -> uid:int -> gid:int -> unit</code></pre><div class="info">
Change the owner uid and owner gid of the named file.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALfchown"></a>fchown : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> uid:int -> gid:int -> unit</code></pre><div class="info">
Change the owner uid and owner gid of an opened file.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALumask"></a>umask : <code class="type">int -> int</code></pre><div class="info">
Set the process creation mask, and return the previous mask.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALaccess"></a>access : <code class="type">string -> perm:<a href="UnixLabels.html#TYPEaccess_permission">access_permission</a> list -> unit</code></pre><div class="info">
Check that the process has the given permissions over the named
file. Raise <code class="code"><span class="constructor">Unix_error</span></code> otherwise.<br>
</div>
<br>
<br>
<a name="6_Operationsonfiledescriptors"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Operations on file descriptors</span>
</div>
</td>
</tr>
</table>
<br><br>
<pre><span class="keyword">val</span> <a name="VALdup"></a>dup : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEfile_descr">file_descr</a></code></pre><div class="info">
Return a new file descriptor referencing the same file as
the given descriptor.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALdup2"></a>dup2 : <code class="type">src:<a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> dst:<a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> unit</code></pre><div class="info">
<code class="code">dup2 fd1 fd2</code> duplicates <code class="code">fd1</code> to <code class="code">fd2</code>, closing <code class="code">fd2</code> if already
opened.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALset_nonblock"></a>set_nonblock : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> unit</code></pre><div class="info">
Set the ``non-blocking'' flag on the given descriptor.
When the non-blocking flag is set, reading on a descriptor
on which there is temporarily no data available raises the
<code class="code"><span class="constructor">EAGAIN</span></code> or <code class="code"><span class="constructor">EWOULDBLOCK</span></code> error instead of blocking;
writing on a descriptor on which there is temporarily no room
for writing also raises <code class="code"><span class="constructor">EAGAIN</span></code> or <code class="code"><span class="constructor">EWOULDBLOCK</span></code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALclear_nonblock"></a>clear_nonblock : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> unit</code></pre><div class="info">
Clear the ``non-blocking'' flag on the given descriptor.
See <a href="UnixLabels.html#VALset_nonblock"><code class="code"><span class="constructor">UnixLabels</span>.set_nonblock</code></a>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALset_close_on_exec"></a>set_close_on_exec : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> unit</code></pre><div class="info">
Set the ``close-on-exec'' flag on the given descriptor.
A descriptor with the close-on-exec flag is automatically
closed when the current process starts another program with
one of the <code class="code">exec</code> functions.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALclear_close_on_exec"></a>clear_close_on_exec : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> unit</code></pre><div class="info">
Clear the ``close-on-exec'' flag on the given descriptor.
See <a href="UnixLabels.html#VALset_close_on_exec"><code class="code"><span class="constructor">UnixLabels</span>.set_close_on_exec</code></a>.<br>
</div>
<br>
<br>
<a name="6_Directories"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Directories</span>
</div>
</td>
</tr>
</table>
<br><br>
<pre><span class="keyword">val</span> <a name="VALmkdir"></a>mkdir : <code class="type">string -> perm:<a href="UnixLabels.html#TYPEfile_perm">file_perm</a> -> unit</code></pre><div class="info">
Create a directory with the given permissions.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALrmdir"></a>rmdir : <code class="type">string -> unit</code></pre><div class="info">
Remove an empty directory.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALchdir"></a>chdir : <code class="type">string -> unit</code></pre><div class="info">
Change the process working directory.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetcwd"></a>getcwd : <code class="type">unit -> string</code></pre><div class="info">
Return the name of the current working directory.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALchroot"></a>chroot : <code class="type">string -> unit</code></pre><div class="info">
Change the process root directory.<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEdir_handle"></a>dir_handle = <code class="type"><a href="Unix.html#TYPEdir_handle">Unix.dir_handle</a></code> </code>
<div class="info">
The type of descriptors over opened directories.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALopendir"></a>opendir : <code class="type">string -> <a href="UnixLabels.html#TYPEdir_handle">dir_handle</a></code></pre><div class="info">
Open a descriptor on a directory<br>
</div>
<pre><span class="keyword">val</span> <a name="VALreaddir"></a>readdir : <code class="type"><a href="UnixLabels.html#TYPEdir_handle">dir_handle</a> -> string</code></pre><div class="info">
Return the next entry in a directory.<br>
<b>Raises</b> <code>End_of_file</code> when the end of the directory has been reached.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALrewinddir"></a>rewinddir : <code class="type"><a href="UnixLabels.html#TYPEdir_handle">dir_handle</a> -> unit</code></pre><div class="info">
Reposition the descriptor to the beginning of the directory<br>
</div>
<pre><span class="keyword">val</span> <a name="VALclosedir"></a>closedir : <code class="type"><a href="UnixLabels.html#TYPEdir_handle">dir_handle</a> -> unit</code></pre><div class="info">
Close a directory descriptor.<br>
</div>
<br>
<br>
<a name="6_Pipesandredirections"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Pipes and redirections</span>
</div>
</td>
</tr>
</table>
<br><br>
<pre><span class="keyword">val</span> <a name="VALpipe"></a>pipe : <code class="type">unit -> <a href="UnixLabels.html#TYPEfile_descr">file_descr</a> * <a href="UnixLabels.html#TYPEfile_descr">file_descr</a></code></pre><div class="info">
Create a pipe. The first component of the result is opened
for reading, that's the exit to the pipe. The second component is
opened for writing, that's the entrance to the pipe.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALmkfifo"></a>mkfifo : <code class="type">string -> perm:<a href="UnixLabels.html#TYPEfile_perm">file_perm</a> -> unit</code></pre><div class="info">
Create a named pipe with the given permissions.<br>
</div>
<br>
<br>
<a name="6_Highlevelprocessandredirectionmanagement"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">High-level process and redirection management</span>
</div>
</td>
</tr>
</table>
<br><br>
<pre><span class="keyword">val</span> <a name="VALcreate_process"></a>create_process : <code class="type">prog:string -><br> args:string array -><br> stdin:<a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -><br> stdout:<a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> stderr:<a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> int</code></pre><div class="info">
<code class="code">create_process prog args new_stdin new_stdout new_stderr</code>
forks a new process that executes the program
in file <code class="code">prog</code>, with arguments <code class="code">args</code>. The pid of the new
process is returned immediately; the new process executes
concurrently with the current process.
The standard input and outputs of the new process are connected
to the descriptors <code class="code">new_stdin</code>, <code class="code">new_stdout</code> and <code class="code">new_stderr</code>.
Passing e.g. <code class="code">stdout</code> for <code class="code">new_stdout</code> prevents the redirection
and causes the new process to have the same standard output
as the current process.
The executable file <code class="code">prog</code> is searched in the path.
The new process has the same environment as the current process.
All file descriptors of the current process are closed in the
new process, except those redirected to standard input and
outputs.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcreate_process_env"></a>create_process_env : <code class="type">prog:string -><br> args:string array -><br> env:string array -><br> stdin:<a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -><br> stdout:<a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> stderr:<a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> int</code></pre><div class="info">
<code class="code">create_process_env prog args env new_stdin new_stdout new_stderr</code>
works as <a href="UnixLabels.html#VALcreate_process"><code class="code"><span class="constructor">UnixLabels</span>.create_process</code></a>, except that the extra argument
<code class="code">env</code> specifies the environment passed to the program.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALopen_process_in"></a>open_process_in : <code class="type">string -> <a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a></code></pre><div class="info">
High-level pipe and process management. These functions
(with <a href="UnixLabels.html#VALopen_process_out"><code class="code"><span class="constructor">UnixLabels</span>.open_process_out</code></a> and <a href="UnixLabels.html#VALopen_process"><code class="code"><span class="constructor">UnixLabels</span>.open_process</code></a>)
run the given command in parallel with the program,
and return channels connected to the standard input and/or
the standard output of the command. The command is interpreted
by the shell <code class="code">/bin/sh</code> (cf. <code class="code">system</code>). Warning: writes on channels
are buffered, hence be careful to call <a href="Pervasives.html#VALflush"><code class="code"><span class="constructor">Pervasives</span>.flush</code></a> at the right times
to ensure correct synchronization.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALopen_process_out"></a>open_process_out : <code class="type">string -> <a href="Pervasives.html#TYPEout_channel">Pervasives.out_channel</a></code></pre><div class="info">
See <a href="UnixLabels.html#VALopen_process_in"><code class="code"><span class="constructor">UnixLabels</span>.open_process_in</code></a>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALopen_process"></a>open_process : <code class="type">string -> <a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a> * <a href="Pervasives.html#TYPEout_channel">Pervasives.out_channel</a></code></pre><div class="info">
See <a href="UnixLabels.html#VALopen_process_in"><code class="code"><span class="constructor">UnixLabels</span>.open_process_in</code></a>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALopen_process_full"></a>open_process_full : <code class="type">string -><br> env:string array -><br> <a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a> * <a href="Pervasives.html#TYPEout_channel">Pervasives.out_channel</a> * <a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a></code></pre><div class="info">
Similar to <a href="UnixLabels.html#VALopen_process"><code class="code"><span class="constructor">UnixLabels</span>.open_process</code></a>, but the second argument specifies
the environment passed to the command. The result is a triple
of channels connected to the standard output, standard input,
and standard error of the command.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALclose_process_in"></a>close_process_in : <code class="type"><a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a> -> <a href="UnixLabels.html#TYPEprocess_status">process_status</a></code></pre><div class="info">
Close channels opened by <a href="UnixLabels.html#VALopen_process_in"><code class="code"><span class="constructor">UnixLabels</span>.open_process_in</code></a>,
wait for the associated command to terminate,
and return its termination status.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALclose_process_out"></a>close_process_out : <code class="type"><a href="Pervasives.html#TYPEout_channel">Pervasives.out_channel</a> -> <a href="UnixLabels.html#TYPEprocess_status">process_status</a></code></pre><div class="info">
Close channels opened by <a href="UnixLabels.html#VALopen_process_out"><code class="code"><span class="constructor">UnixLabels</span>.open_process_out</code></a>,
wait for the associated command to terminate,
and return its termination status.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALclose_process"></a>close_process : <code class="type"><a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a> * <a href="Pervasives.html#TYPEout_channel">Pervasives.out_channel</a> -> <a href="UnixLabels.html#TYPEprocess_status">process_status</a></code></pre><div class="info">
Close channels opened by <a href="UnixLabels.html#VALopen_process"><code class="code"><span class="constructor">UnixLabels</span>.open_process</code></a>,
wait for the associated command to terminate,
and return its termination status.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALclose_process_full"></a>close_process_full : <code class="type"><a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a> * <a href="Pervasives.html#TYPEout_channel">Pervasives.out_channel</a> * <a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a> -><br> <a href="UnixLabels.html#TYPEprocess_status">process_status</a></code></pre><div class="info">
Close channels opened by <a href="UnixLabels.html#VALopen_process_full"><code class="code"><span class="constructor">UnixLabels</span>.open_process_full</code></a>,
wait for the associated command to terminate,
and return its termination status.<br>
</div>
<br>
<br>
<a name="6_Symboliclinks"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Symbolic links</span>
</div>
</td>
</tr>
</table>
<br><br>
<pre><span class="keyword">val</span> <a name="VALsymlink"></a>symlink : <code class="type">src:string -> dst:string -> unit</code></pre><div class="info">
<code class="code">symlink source dest</code> creates the file <code class="code">dest</code> as a symbolic link
to the file <code class="code">source</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALreadlink"></a>readlink : <code class="type">string -> string</code></pre><div class="info">
Read the contents of a link.<br>
</div>
<br>
<br>
<a name="6_Polling"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Polling</span>
</div>
</td>
</tr>
</table>
<br><br>
<pre><span class="keyword">val</span> <a name="VALselect"></a>select : <code class="type">read:<a href="UnixLabels.html#TYPEfile_descr">file_descr</a> list -><br> write:<a href="UnixLabels.html#TYPEfile_descr">file_descr</a> list -><br> except:<a href="UnixLabels.html#TYPEfile_descr">file_descr</a> list -><br> timeout:float -><br> <a href="UnixLabels.html#TYPEfile_descr">file_descr</a> list * <a href="UnixLabels.html#TYPEfile_descr">file_descr</a> list *<br> <a href="UnixLabels.html#TYPEfile_descr">file_descr</a> list</code></pre><div class="info">
Wait until some input/output operations become possible on
some channels. The three list arguments are, respectively, a set
of descriptors to check for reading (first argument), for writing
(second argument), or for exceptional conditions (third argument).
The fourth argument is the maximal timeout, in seconds; a
negative fourth argument means no timeout (unbounded wait).
The result is composed of three sets of descriptors: those ready
for reading (first component), ready for writing (second component),
and over which an exceptional condition is pending (third
component).<br>
</div>
<br>
<br>
<a name="6_Locking"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Locking</span>
</div>
</td>
</tr>
</table>
<br><br>
<br><code><span class="keyword">type</span> <a name="TYPElock_command"></a>lock_command = <code class="type"><a href="Unix.html#TYPElock_command">Unix.lock_command</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">F_ULOCK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Unlock a region</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">F_LOCK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Lock a region for writing, and block if already locked</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">F_TLOCK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Lock a region for writing, or fail if already locked</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">F_TEST</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Test a region for other process locks</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">F_RLOCK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Lock a region for reading, and block if already locked</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">F_TRLOCK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Lock a region for reading, or fail if already locked</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Commands for <a href="UnixLabels.html#VALlockf"><code class="code"><span class="constructor">UnixLabels</span>.lockf</code></a>.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALlockf"></a>lockf : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> mode:<a href="UnixLabels.html#TYPElock_command">lock_command</a> -> len:int -> unit</code></pre><div class="info">
<code class="code">lockf fd cmd size</code> puts a lock on a region of the file opened
as <code class="code">fd</code>. The region starts at the current read/write position for
<code class="code">fd</code> (as set by <a href="UnixLabels.html#VALlseek"><code class="code"><span class="constructor">UnixLabels</span>.lseek</code></a>), and extends <code class="code">size</code> bytes forward if
<code class="code">size</code> is positive, <code class="code">size</code> bytes backwards if <code class="code">size</code> is negative,
or to the end of the file if <code class="code">size</code> is zero.
A write lock (set with <code class="code"><span class="constructor">F_LOCK</span></code> or <code class="code"><span class="constructor">F_TLOCK</span></code>) prevents any other
process from acquiring a read or write lock on the region.
A read lock (set with <code class="code"><span class="constructor">F_RLOCK</span></code> or <code class="code"><span class="constructor">F_TRLOCK</span></code>) prevents any other
process from acquiring a write lock on the region, but lets
other processes acquire read locks on it.<br>
</div>
<br>
<br>
<a name="6_Signals"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Signals</span>
</div>
</td>
</tr>
</table>
Note: installation of signal handlers is performed via
the functions <a href="Sys.html#VALsignal"><code class="code"><span class="constructor">Sys</span>.signal</code></a> and <a href="Sys.html#VALset_signal"><code class="code"><span class="constructor">Sys</span>.set_signal</code></a>.<br><br>
<pre><span class="keyword">val</span> <a name="VALkill"></a>kill : <code class="type">pid:int -> signal:int -> unit</code></pre><div class="info">
<code class="code">kill pid <span class="keyword">sig</span></code> sends signal number <code class="code"><span class="keyword">sig</span></code> to the process
with id <code class="code">pid</code>.<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEsigprocmask_command"></a>sigprocmask_command = <code class="type"><a href="Unix.html#TYPEsigprocmask_command">Unix.sigprocmask_command</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SIG_SETMASK</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SIG_BLOCK</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SIG_UNBLOCK</span></code></td>
</tr></table>
<br>
<pre><span class="keyword">val</span> <a name="VALsigprocmask"></a>sigprocmask : <code class="type">mode:<a href="UnixLabels.html#TYPEsigprocmask_command">sigprocmask_command</a> -> int list -> int list</code></pre><div class="info">
<code class="code">sigprocmask cmd sigs</code> changes the set of blocked signals.
If <code class="code">cmd</code> is <code class="code"><span class="constructor">SIG_SETMASK</span></code>, blocked signals are set to those in
the list <code class="code">sigs</code>.
If <code class="code">cmd</code> is <code class="code"><span class="constructor">SIG_BLOCK</span></code>, the signals in <code class="code">sigs</code> are added to
the set of blocked signals.
If <code class="code">cmd</code> is <code class="code"><span class="constructor">SIG_UNBLOCK</span></code>, the signals in <code class="code">sigs</code> are removed
from the set of blocked signals.
<code class="code">sigprocmask</code> returns the set of previously blocked signals.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsigpending"></a>sigpending : <code class="type">unit -> int list</code></pre><div class="info">
Return the set of blocked signals that are currently pending.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsigsuspend"></a>sigsuspend : <code class="type">int list -> unit</code></pre><div class="info">
<code class="code">sigsuspend sigs</code> atomically sets the blocked signals to <code class="code"><span class="keyword">sig</span></code>
and waits for a non-ignored, non-blocked signal to be delivered.
On return, the blocked signals are reset to their initial value.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALpause"></a>pause : <code class="type">unit -> unit</code></pre><div class="info">
Wait until a non-ignored, non-blocked signal is delivered.<br>
</div>
<br>
<br>
<a name="6_Timefunctions"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Time functions</span>
</div>
</td>
</tr>
</table>
<br><br>
<br><code><span class="keyword">type</span> <a name="TYPEprocess_times"></a>process_times = <code class="type"><a href="Unix.html#TYPEprocess_times">Unix.process_times</a></code> = {<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tms_utime : <code class="type">float</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>User time for the process</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tms_stime : <code class="type">float</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>System time for the process</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tms_cutime : <code class="type">float</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>User time for the children processes</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tms_cstime : <code class="type">float</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>System time for the children processes</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info">
The execution times (CPU times) of a process.<br>
</div>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEtm"></a>tm = <code class="type"><a href="Unix.html#TYPEtm">Unix.tm</a></code> = {<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tm_sec : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Seconds 0..59</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tm_min : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Minutes 0..59</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tm_hour : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Hours 0..23</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tm_mday : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Day of month 1..31</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tm_mon : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Month of year 0..11</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tm_year : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Year - 1900</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tm_wday : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Day of week (Sunday is 0)</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tm_yday : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Day of year 0..365</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tm_isdst : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Daylight time savings in effect</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info">
The type representing wallclock time and calendar date.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALtime"></a>time : <code class="type">unit -> float</code></pre><div class="info">
Return the current time since 00:00:00 GMT, Jan. 1, 1970,
in seconds.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgettimeofday"></a>gettimeofday : <code class="type">unit -> float</code></pre><div class="info">
Same as <a href="UnixLabels.html#VALtime"><code class="code"><span class="constructor">UnixLabels</span>.time</code></a>, but with resolution better than 1 second.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgmtime"></a>gmtime : <code class="type">float -> <a href="UnixLabels.html#TYPEtm">tm</a></code></pre><div class="info">
Convert a time in seconds, as returned by <a href="UnixLabels.html#VALtime"><code class="code"><span class="constructor">UnixLabels</span>.time</code></a>, into a date and
a time. Assumes Greenwich meridian time zone, also known as UTC.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlocaltime"></a>localtime : <code class="type">float -> <a href="UnixLabels.html#TYPEtm">tm</a></code></pre><div class="info">
Convert a time in seconds, as returned by <a href="UnixLabels.html#VALtime"><code class="code"><span class="constructor">UnixLabels</span>.time</code></a>, into a date and
a time. Assumes the local time zone.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALmktime"></a>mktime : <code class="type"><a href="UnixLabels.html#TYPEtm">tm</a> -> float * <a href="UnixLabels.html#TYPEtm">tm</a></code></pre><div class="info">
Convert a date and time, specified by the <code class="code">tm</code> argument, into
a time in seconds, as returned by <a href="UnixLabels.html#VALtime"><code class="code"><span class="constructor">UnixLabels</span>.time</code></a>. Also return a normalized
copy of the given <code class="code">tm</code> record, with the <code class="code">tm_wday</code>, <code class="code">tm_yday</code>,
and <code class="code">tm_isdst</code> fields recomputed from the other fields.
The <code class="code">tm</code> argument is interpreted in the local time zone.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALalarm"></a>alarm : <code class="type">int -> int</code></pre><div class="info">
Schedule a <code class="code"><span class="constructor">SIGALRM</span></code> signal after the given number of seconds.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsleep"></a>sleep : <code class="type">int -> unit</code></pre><div class="info">
Stop execution for the given number of seconds.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALtimes"></a>times : <code class="type">unit -> <a href="UnixLabels.html#TYPEprocess_times">process_times</a></code></pre><div class="info">
Return the execution times of the process.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALutimes"></a>utimes : <code class="type">string -> access:float -> modif:float -> unit</code></pre><div class="info">
Set the last access time (second arg) and last modification time
(third arg) for a file. Times are expressed in seconds from
00:00:00 GMT, Jan. 1, 1970.<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEinterval_timer"></a>interval_timer = <code class="type"><a href="Unix.html#TYPEinterval_timer">Unix.interval_timer</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ITIMER_REAL</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>decrements in real time, and sends the signal <code class="code"><span class="constructor">SIGALRM</span></code> when expired.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ITIMER_VIRTUAL</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>decrements in process virtual time, and sends <code class="code"><span class="constructor">SIGVTALRM</span></code> when expired.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ITIMER_PROF</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>(for profiling) decrements both when the process
is running and when the system is running on behalf of the
process; it sends <code class="code"><span class="constructor">SIGPROF</span></code> when expired.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
The three kinds of interval timers.<br>
</div>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEinterval_timer_status"></a>interval_timer_status = <code class="type"><a href="Unix.html#TYPEinterval_timer_status">Unix.interval_timer_status</a></code> = {<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>it_interval : <code class="type">float</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Period</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>it_value : <code class="type">float</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Current value of the timer</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info">
The type describing the status of an interval timer<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALgetitimer"></a>getitimer : <code class="type"><a href="UnixLabels.html#TYPEinterval_timer">interval_timer</a> -> <a href="UnixLabels.html#TYPEinterval_timer_status">interval_timer_status</a></code></pre><div class="info">
Return the current status of the given interval timer.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsetitimer"></a>setitimer : <code class="type"><a href="UnixLabels.html#TYPEinterval_timer">interval_timer</a> -><br> <a href="UnixLabels.html#TYPEinterval_timer_status">interval_timer_status</a> -> <a href="UnixLabels.html#TYPEinterval_timer_status">interval_timer_status</a></code></pre><div class="info">
<code class="code">setitimer t s</code> sets the interval timer <code class="code">t</code> and returns
its previous status. The <code class="code">s</code> argument is interpreted as follows:
<code class="code">s.it_value</code>, if nonzero, is the time to the next timer expiration;
<code class="code">s.it_interval</code>, if nonzero, specifies a value to
be used in reloading it_value when the timer expires.
Setting <code class="code">s.it_value</code> to zero disable the timer.
Setting <code class="code">s.it_interval</code> to zero causes the timer to be disabled
after its next expiration.<br>
</div>
<br>
<br>
<a name="6_Useridgroupid"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">User id, group id</span>
</div>
</td>
</tr>
</table>
<br><br>
<pre><span class="keyword">val</span> <a name="VALgetuid"></a>getuid : <code class="type">unit -> int</code></pre><div class="info">
Return the user id of the user executing the process.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgeteuid"></a>geteuid : <code class="type">unit -> int</code></pre><div class="info">
Return the effective user id under which the process runs.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsetuid"></a>setuid : <code class="type">int -> unit</code></pre><div class="info">
Set the real user id and effective user id for the process.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetgid"></a>getgid : <code class="type">unit -> int</code></pre><div class="info">
Return the group id of the user executing the process.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetegid"></a>getegid : <code class="type">unit -> int</code></pre><div class="info">
Return the effective group id under which the process runs.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsetgid"></a>setgid : <code class="type">int -> unit</code></pre><div class="info">
Set the real group id and effective group id for the process.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetgroups"></a>getgroups : <code class="type">unit -> int array</code></pre><div class="info">
Return the list of groups to which the user executing the process
belongs.<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEpasswd_entry"></a>passwd_entry = <code class="type"><a href="Unix.html#TYPEpasswd_entry">Unix.passwd_entry</a></code> = {<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>pw_name : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>pw_passwd : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>pw_uid : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>pw_gid : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>pw_gecos : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>pw_dir : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>pw_shell : <code class="type">string</code>;</code></td>
</tr></table>
}
<div class="info">
Structure of entries in the <code class="code">passwd</code> database.<br>
</div>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEgroup_entry"></a>group_entry = <code class="type"><a href="Unix.html#TYPEgroup_entry">Unix.group_entry</a></code> = {<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>gr_name : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>gr_passwd : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>gr_gid : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>gr_mem : <code class="type">string array</code>;</code></td>
</tr></table>
}
<div class="info">
Structure of entries in the <code class="code">groups</code> database.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALgetlogin"></a>getlogin : <code class="type">unit -> string</code></pre><div class="info">
Return the login name of the user executing the process.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetpwnam"></a>getpwnam : <code class="type">string -> <a href="UnixLabels.html#TYPEpasswd_entry">passwd_entry</a></code></pre><div class="info">
Find an entry in <code class="code">passwd</code> with the given name, or raise
<code class="code"><span class="constructor">Not_found</span></code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetgrnam"></a>getgrnam : <code class="type">string -> <a href="UnixLabels.html#TYPEgroup_entry">group_entry</a></code></pre><div class="info">
Find an entry in <code class="code">group</code> with the given name, or raise
<code class="code"><span class="constructor">Not_found</span></code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetpwuid"></a>getpwuid : <code class="type">int -> <a href="UnixLabels.html#TYPEpasswd_entry">passwd_entry</a></code></pre><div class="info">
Find an entry in <code class="code">passwd</code> with the given user id, or raise
<code class="code"><span class="constructor">Not_found</span></code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetgrgid"></a>getgrgid : <code class="type">int -> <a href="UnixLabels.html#TYPEgroup_entry">group_entry</a></code></pre><div class="info">
Find an entry in <code class="code">group</code> with the given group id, or raise
<code class="code"><span class="constructor">Not_found</span></code>.<br>
</div>
<br>
<br>
<a name="6_Internetaddresses"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Internet addresses</span>
</div>
</td>
</tr>
</table>
<br><br>
<br><code><span class="keyword">type</span> <a name="TYPEinet_addr"></a>inet_addr = <code class="type"><a href="Unix.html#TYPEinet_addr">Unix.inet_addr</a></code> </code>
<div class="info">
The abstract type of Internet addresses.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALinet_addr_of_string"></a>inet_addr_of_string : <code class="type">string -> <a href="UnixLabels.html#TYPEinet_addr">inet_addr</a></code></pre><div class="info">
Conversions between string with the format <code class="code"><span class="constructor">XXX</span>.<span class="constructor">YYY</span>.<span class="constructor">ZZZ</span>.<span class="constructor">TTT</span></code>
and Internet addresses. <code class="code">inet_addr_of_string</code> raises <code class="code"><span class="constructor">Failure</span></code>
when given a string that does not match this format.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALstring_of_inet_addr"></a>string_of_inet_addr : <code class="type"><a href="UnixLabels.html#TYPEinet_addr">inet_addr</a> -> string</code></pre><div class="info">
See <a href="UnixLabels.html#VALinet_addr_of_string"><code class="code"><span class="constructor">UnixLabels</span>.inet_addr_of_string</code></a>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALinet_addr_any"></a>inet_addr_any : <code class="type"><a href="UnixLabels.html#TYPEinet_addr">inet_addr</a></code></pre><div class="info">
A special Internet address, for use only with <code class="code">bind</code>, representing
all the Internet addresses that the host machine possesses.<br>
</div>
<br>
<br>
<a name="6_Sockets"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Sockets</span>
</div>
</td>
</tr>
</table>
<br><br>
<br><code><span class="keyword">type</span> <a name="TYPEsocket_domain"></a>socket_domain = <code class="type"><a href="Unix.html#TYPEsocket_domain">Unix.socket_domain</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">PF_UNIX</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Unix domain</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">PF_INET</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Internet domain</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
The type of socket domains.<br>
</div>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEsocket_type"></a>socket_type = <code class="type"><a href="Unix.html#TYPEsocket_type">Unix.socket_type</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SOCK_STREAM</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Stream socket</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SOCK_DGRAM</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Datagram socket</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SOCK_RAW</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Raw socket</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SOCK_SEQPACKET</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Sequenced packets socket</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
The type of socket kinds, specifying the semantics of
communications.<br>
</div>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEsockaddr"></a>sockaddr = <code class="type"><a href="Unix.html#TYPEsockaddr">Unix.sockaddr</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ADDR_UNIX</span> <span class="keyword">of</span> <code class="type">string</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">ADDR_INET</span> <span class="keyword">of</span> <code class="type"><a href="UnixLabels.html#TYPEinet_addr">inet_addr</a> * int</code></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>The type of socket addresses. <code class="code"><span class="constructor">ADDR_UNIX</span> name</code> is a socket
address in the Unix domain; <code class="code">name</code> is a file name in the file
system. <code class="code"><span class="constructor">ADDR_INET</span>(addr,port)</code> is a socket address in the Internet
domain; <code class="code">addr</code> is the Internet address of the machine, and
<code class="code">port</code> is the port number.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<br>
<pre><span class="keyword">val</span> <a name="VALsocket"></a>socket : <code class="type">domain:<a href="UnixLabels.html#TYPEsocket_domain">socket_domain</a> -><br> kind:<a href="UnixLabels.html#TYPEsocket_type">socket_type</a> -> protocol:int -> <a href="UnixLabels.html#TYPEfile_descr">file_descr</a></code></pre><div class="info">
Create a new socket in the given domain, and with the
given kind. The third argument is the protocol type; 0 selects
the default protocol for that kind of sockets.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsocketpair"></a>socketpair : <code class="type">domain:<a href="UnixLabels.html#TYPEsocket_domain">socket_domain</a> -><br> kind:<a href="UnixLabels.html#TYPEsocket_type">socket_type</a> -><br> protocol:int -> <a href="UnixLabels.html#TYPEfile_descr">file_descr</a> * <a href="UnixLabels.html#TYPEfile_descr">file_descr</a></code></pre><div class="info">
Create a pair of unnamed sockets, connected together.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALaccept"></a>accept : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEfile_descr">file_descr</a> * <a href="UnixLabels.html#TYPEsockaddr">sockaddr</a></code></pre><div class="info">
Accept connections on the given socket. The returned descriptor
is a socket connected to the client; the returned address is
the address of the connecting client.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALbind"></a>bind : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> addr:<a href="UnixLabels.html#TYPEsockaddr">sockaddr</a> -> unit</code></pre><div class="info">
Bind a socket to an address.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALconnect"></a>connect : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> addr:<a href="UnixLabels.html#TYPEsockaddr">sockaddr</a> -> unit</code></pre><div class="info">
Connect a socket to an address.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlisten"></a>listen : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> max:int -> unit</code></pre><div class="info">
Set up a socket for receiving connection requests. The integer
argument is the maximal number of pending requests.<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEshutdown_command"></a>shutdown_command = <code class="type"><a href="Unix.html#TYPEshutdown_command">Unix.shutdown_command</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SHUTDOWN_RECEIVE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Close for receiving</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SHUTDOWN_SEND</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Close for sending</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SHUTDOWN_ALL</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Close both</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
The type of commands for <code class="code">shutdown</code>.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALshutdown"></a>shutdown : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> mode:<a href="UnixLabels.html#TYPEshutdown_command">shutdown_command</a> -> unit</code></pre><div class="info">
Shutdown a socket connection. <code class="code"><span class="constructor">SHUTDOWN_SEND</span></code> as second argument
causes reads on the other end of the connection to return
an end-of-file condition.
<code class="code"><span class="constructor">SHUTDOWN_RECEIVE</span></code> causes writes on the other end of the connection
to return a closed pipe condition (<code class="code"><span class="constructor">SIGPIPE</span></code> signal).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetsockname"></a>getsockname : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEsockaddr">sockaddr</a></code></pre><div class="info">
Return the address of the given socket.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetpeername"></a>getpeername : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEsockaddr">sockaddr</a></code></pre><div class="info">
Return the address of the host connected to the given socket.<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEmsg_flag"></a>msg_flag = <code class="type"><a href="Unix.html#TYPEmsg_flag">Unix.msg_flag</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">MSG_OOB</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">MSG_DONTROUTE</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">MSG_PEEK</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>The flags for <a href="UnixLabels.html#VALrecv"><code class="code"><span class="constructor">UnixLabels</span>.recv</code></a>, <a href="UnixLabels.html#VALrecvfrom"><code class="code"><span class="constructor">UnixLabels</span>.recvfrom</code></a>,
<a href="UnixLabels.html#VALsend"><code class="code"><span class="constructor">UnixLabels</span>.send</code></a> and <a href="UnixLabels.html#VALsendto"><code class="code"><span class="constructor">UnixLabels</span>.sendto</code></a>.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<br>
<pre><span class="keyword">val</span> <a name="VALrecv"></a>recv : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -><br> buf:string -> pos:int -> len:int -> mode:<a href="UnixLabels.html#TYPEmsg_flag">msg_flag</a> list -> int</code></pre><div class="info">
Receive data from an unconnected socket.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALrecvfrom"></a>recvfrom : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -><br> buf:string -><br> pos:int -><br> len:int -> mode:<a href="UnixLabels.html#TYPEmsg_flag">msg_flag</a> list -> int * <a href="UnixLabels.html#TYPEsockaddr">sockaddr</a></code></pre><div class="info">
Receive data from an unconnected socket.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsend"></a>send : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -><br> buf:string -> pos:int -> len:int -> mode:<a href="UnixLabels.html#TYPEmsg_flag">msg_flag</a> list -> int</code></pre><div class="info">
Send data over an unconnected socket.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsendto"></a>sendto : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -><br> buf:string -><br> pos:int -><br> len:int -> mode:<a href="UnixLabels.html#TYPEmsg_flag">msg_flag</a> list -> addr:<a href="UnixLabels.html#TYPEsockaddr">sockaddr</a> -> int</code></pre><div class="info">
Send data over an unconnected socket.<br>
</div>
<br>
<br>
<a name="6_Socketoptions"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Socket options</span>
</div>
</td>
</tr>
</table>
<br><br>
<br><code><span class="keyword">type</span> <a name="TYPEsocket_bool_option"></a>socket_bool_option =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_DEBUG</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Record debugging information</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_BROADCAST</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Permit sending of broadcast messages</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_REUSEADDR</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Allow reuse of local addresses for bind</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_KEEPALIVE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Keep connection active</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_DONTROUTE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Bypass the standard routing algorithms</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_OOBINLINE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Leave out-of-band data in line</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_ACCEPTCONN</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Report whether socket listening is enabled</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
The socket options that can be consulted with <a href="UnixLabels.html#VALgetsockopt"><code class="code"><span class="constructor">UnixLabels</span>.getsockopt</code></a>
and modified with <a href="UnixLabels.html#VALsetsockopt"><code class="code"><span class="constructor">UnixLabels</span>.setsockopt</code></a>. These options have a boolean
(<code class="code"><span class="keyword">true</span></code>/<code class="code"><span class="keyword">false</span></code>) value.<br>
</div>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEsocket_int_option"></a>socket_int_option =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_SNDBUF</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Size of send buffer</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_RCVBUF</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Size of received buffer</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_ERROR</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Report the error status and clear it</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_TYPE</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Report the socket type</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_RCVLOWAT</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Minimum number of bytes to process for input operations</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_SNDLOWAT</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Minimum number of bytes to process for output operations</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
The socket options that can be consulted with <a href="UnixLabels.html#VALgetsockopt_int"><code class="code"><span class="constructor">UnixLabels</span>.getsockopt_int</code></a>
and modified with <a href="UnixLabels.html#VALsetsockopt_int"><code class="code"><span class="constructor">UnixLabels</span>.setsockopt_int</code></a>. These options have an
integer value.<br>
</div>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEsocket_optint_option"></a>socket_optint_option =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_LINGER</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Whether to linger on closed connections
that have data present, and for how long
(in seconds)</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
The socket options that can be consulted with <a href="UnixLabels.html#VALgetsockopt_optint"><code class="code"><span class="constructor">UnixLabels</span>.getsockopt_optint</code></a>
and modified with <a href="UnixLabels.html#VALsetsockopt_optint"><code class="code"><span class="constructor">UnixLabels</span>.setsockopt_optint</code></a>. These options have a
value of type <code class="code">int option</code>, with <code class="code"><span class="constructor">None</span></code> meaning ``disabled''.<br>
</div>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEsocket_float_option"></a>socket_float_option =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_RCVTIMEO</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Timeout for input operations</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">SO_SNDTIMEO</span></code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Timeout for output operations</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
The socket options that can be consulted with <a href="UnixLabels.html#VALgetsockopt_float"><code class="code"><span class="constructor">UnixLabels</span>.getsockopt_float</code></a>
and modified with <a href="UnixLabels.html#VALsetsockopt_float"><code class="code"><span class="constructor">UnixLabels</span>.setsockopt_float</code></a>. These options have a
floating-point value representing a time in seconds.
The value 0 means infinite timeout.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALgetsockopt"></a>getsockopt : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEsocket_bool_option">socket_bool_option</a> -> bool</code></pre><div class="info">
Return the current status of a boolean-valued option
in the given socket.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsetsockopt"></a>setsockopt : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEsocket_bool_option">socket_bool_option</a> -> bool -> unit</code></pre><div class="info">
Set or clear a boolean-valued option in the given socket.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetsockopt_int"></a>getsockopt_int : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEsocket_int_option">socket_int_option</a> -> int</code></pre><div class="info">
Same as <a href="UnixLabels.html#VALgetsockopt"><code class="code"><span class="constructor">UnixLabels</span>.getsockopt</code></a> for an integer-valued socket option.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsetsockopt_int"></a>setsockopt_int : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEsocket_int_option">socket_int_option</a> -> int -> unit</code></pre><div class="info">
Same as <a href="UnixLabels.html#VALsetsockopt"><code class="code"><span class="constructor">UnixLabels</span>.setsockopt</code></a> for an integer-valued socket option.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetsockopt_optint"></a>getsockopt_optint : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEsocket_optint_option">socket_optint_option</a> -> int option</code></pre><div class="info">
Same as <a href="UnixLabels.html#VALgetsockopt"><code class="code"><span class="constructor">UnixLabels</span>.getsockopt</code></a> for a socket option whose value is an <code class="code">int option</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsetsockopt_optint"></a>setsockopt_optint : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -><br> <a href="UnixLabels.html#TYPEsocket_optint_option">socket_optint_option</a> -> int option -> unit</code></pre><div class="info">
Same as <a href="UnixLabels.html#VALsetsockopt"><code class="code"><span class="constructor">UnixLabels</span>.setsockopt</code></a> for a socket option whose value is an <code class="code">int option</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetsockopt_float"></a>getsockopt_float : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEsocket_float_option">socket_float_option</a> -> float</code></pre><div class="info">
Same as <a href="UnixLabels.html#VALgetsockopt"><code class="code"><span class="constructor">UnixLabels</span>.getsockopt</code></a> for a socket option whose value is a floating-point number.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsetsockopt_float"></a>setsockopt_float : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEsocket_float_option">socket_float_option</a> -> float -> unit</code></pre><div class="info">
Same as <a href="UnixLabels.html#VALsetsockopt"><code class="code"><span class="constructor">UnixLabels</span>.setsockopt</code></a> for a socket option whose value is a floating-point number.<br>
</div>
<br>
<br>
<a name="6_Highlevelnetworkconnectionfunctions"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">High-level network connection functions</span>
</div>
</td>
</tr>
</table>
<br><br>
<pre><span class="keyword">val</span> <a name="VALopen_connection"></a>open_connection : <code class="type"><a href="UnixLabels.html#TYPEsockaddr">sockaddr</a> -> <a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a> * <a href="Pervasives.html#TYPEout_channel">Pervasives.out_channel</a></code></pre><div class="info">
Connect to a server at the given address.
Return a pair of buffered channels connected to the server.
Remember to call <a href="Pervasives.html#VALflush"><code class="code"><span class="constructor">Pervasives</span>.flush</code></a> on the output channel at the right times
to ensure correct synchronization.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALshutdown_connection"></a>shutdown_connection : <code class="type"><a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a> -> unit</code></pre><div class="info">
``Shut down'' a connection established with <a href="UnixLabels.html#VALopen_connection"><code class="code"><span class="constructor">UnixLabels</span>.open_connection</code></a>;
that is, transmit an end-of-file condition to the server reading
on the other side of the connection.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALestablish_server"></a>establish_server : <code class="type">(<a href="Pervasives.html#TYPEin_channel">Pervasives.in_channel</a> -> <a href="Pervasives.html#TYPEout_channel">Pervasives.out_channel</a> -> unit) -><br> addr:<a href="UnixLabels.html#TYPEsockaddr">sockaddr</a> -> unit</code></pre><div class="info">
Establish a server on the given address.
The function given as first argument is called for each connection
with two buffered channels connected to the client. A new process
is created for each connection. The function <a href="UnixLabels.html#VALestablish_server"><code class="code"><span class="constructor">UnixLabels</span>.establish_server</code></a>
never returns normally.<br>
</div>
<br>
<br>
<a name="6_Hostandprotocoldatabases"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Host and protocol databases</span>
</div>
</td>
</tr>
</table>
<br><br>
<br><code><span class="keyword">type</span> <a name="TYPEhost_entry"></a>host_entry = <code class="type"><a href="Unix.html#TYPEhost_entry">Unix.host_entry</a></code> = {<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>h_name : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>h_aliases : <code class="type">string array</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>h_addrtype : <code class="type"><a href="UnixLabels.html#TYPEsocket_domain">socket_domain</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>h_addr_list : <code class="type"><a href="UnixLabels.html#TYPEinet_addr">inet_addr</a> array</code>;</code></td>
</tr></table>
}
<div class="info">
Structure of entries in the <code class="code">hosts</code> database.<br>
</div>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEprotocol_entry"></a>protocol_entry = <code class="type"><a href="Unix.html#TYPEprotocol_entry">Unix.protocol_entry</a></code> = {<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>p_name : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>p_aliases : <code class="type">string array</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>p_proto : <code class="type">int</code>;</code></td>
</tr></table>
}
<div class="info">
Structure of entries in the <code class="code">protocols</code> database.<br>
</div>
<br>
<br><code><span class="keyword">type</span> <a name="TYPEservice_entry"></a>service_entry = <code class="type"><a href="Unix.html#TYPEservice_entry">Unix.service_entry</a></code> = {<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>s_name : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>s_aliases : <code class="type">string array</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>s_port : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>s_proto : <code class="type">string</code>;</code></td>
</tr></table>
}
<div class="info">
Structure of entries in the <code class="code">services</code> database.<br>
</div>
<br>
<pre><span class="keyword">val</span> <a name="VALgethostname"></a>gethostname : <code class="type">unit -> string</code></pre><div class="info">
Return the name of the local host.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgethostbyname"></a>gethostbyname : <code class="type">string -> <a href="UnixLabels.html#TYPEhost_entry">host_entry</a></code></pre><div class="info">
Find an entry in <code class="code">hosts</code> with the given name, or raise
<code class="code"><span class="constructor">Not_found</span></code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgethostbyaddr"></a>gethostbyaddr : <code class="type"><a href="UnixLabels.html#TYPEinet_addr">inet_addr</a> -> <a href="UnixLabels.html#TYPEhost_entry">host_entry</a></code></pre><div class="info">
Find an entry in <code class="code">hosts</code> with the given address, or raise
<code class="code"><span class="constructor">Not_found</span></code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetprotobyname"></a>getprotobyname : <code class="type">string -> <a href="UnixLabels.html#TYPEprotocol_entry">protocol_entry</a></code></pre><div class="info">
Find an entry in <code class="code">protocols</code> with the given name, or raise
<code class="code"><span class="constructor">Not_found</span></code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetprotobynumber"></a>getprotobynumber : <code class="type">int -> <a href="UnixLabels.html#TYPEprotocol_entry">protocol_entry</a></code></pre><div class="info">
Find an entry in <code class="code">protocols</code> with the given protocol number,
or raise <code class="code"><span class="constructor">Not_found</span></code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetservbyname"></a>getservbyname : <code class="type">string -> protocol:string -> <a href="UnixLabels.html#TYPEservice_entry">service_entry</a></code></pre><div class="info">
Find an entry in <code class="code">services</code> with the given name, or raise
<code class="code"><span class="constructor">Not_found</span></code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALgetservbyport"></a>getservbyport : <code class="type">int -> protocol:string -> <a href="UnixLabels.html#TYPEservice_entry">service_entry</a></code></pre><div class="info">
Find an entry in <code class="code">services</code> with the given service number,
or raise <code class="code"><span class="constructor">Not_found</span></code>.<br>
</div>
<br>
<br>
<a name="6_Terminalinterface"></a>
<table cellpadding=5 cellspacing=5 width="100%">
<tr class="title6"><td><div align=center>
<span class="title6">Terminal interface</span>
</div>
</td>
</tr>
</table>
<br><br>
<br>
The following functions implement the POSIX standard terminal
interface. They provide control over asynchronous communication ports
and pseudo-terminals. Refer to the <code class="code">termios</code> man page for a
complete description.<br><br>
<br><code><span class="keyword">type</span> <a name="TYPEterminal_io"></a>terminal_io = <code class="type"><a href="Unix.html#TYPEterminal_io">Unix.terminal_io</a></code> = {<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_ignbrk : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Ignore the break condition.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_brkint : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Signal interrupt on break condition.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_ignpar : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Ignore characters with parity errors.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_parmrk : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Mark parity errors.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_inpck : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Enable parity check on input.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_istrip : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Strip 8th bit on input characters.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_inlcr : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Map NL to CR on input.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_igncr : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Ignore CR on input.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_icrnl : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Map CR to NL on input.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_ixon : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Recognize XON/XOFF characters on input.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_ixoff : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Emit XON/XOFF chars to control input flow.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_opost : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Enable output processing.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_obaud : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Output baud rate (0 means close connection).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_ibaud : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Input baud rate.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_csize : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Number of bits per character (5-8).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_cstopb : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Number of stop bits (1-2).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_cread : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Reception is enabled.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_parenb : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Enable parity generation and detection.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_parodd : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Specify odd parity instead of even.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_hupcl : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Hang up on last close.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_clocal : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Ignore modem status lines.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_isig : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Generate signal on INTR, QUIT, SUSP.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_icanon : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Enable canonical processing
(line buffering and editing)</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_noflsh : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Disable flush after INTR, QUIT, SUSP.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_echo : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Echo input characters.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_echoe : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Echo ERASE (to erase previous character).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_echok : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Echo KILL (to erase the current line).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_echonl : <code class="type">bool</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Echo NL even if c_echo is not set.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_vintr : <code class="type">char</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Interrupt character (usually ctrl-C).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_vquit : <code class="type">char</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Quit character (usually ctrl-\).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_verase : <code class="type">char</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Erase character (usually DEL or ctrl-H).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_vkill : <code class="type">char</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Kill line character (usually ctrl-U).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_veof : <code class="type">char</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>End-of-file character (usually ctrl-D).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_veol : <code class="type">char</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Alternate end-of-line char. (usually none).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_vmin : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Minimum number of characters to read
before the read request is satisfied.</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_vtime : <code class="type">int</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Maximum read wait (in 0.1s units).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_vstart : <code class="type">char</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Start character (usually ctrl-Q).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c_vstop : <code class="type">char</code>;</code></td>
<td align="left" valign="top" ><code>(*</code></td><td align="left" valign="top" ><code>Stop character (usually ctrl-S).</code></td><td align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<br>
<pre><span class="keyword">val</span> <a name="VALtcgetattr"></a>tcgetattr : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> <a href="UnixLabels.html#TYPEterminal_io">terminal_io</a></code></pre><div class="info">
Return the status of the terminal referred to by the given
file descriptor.<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEsetattr_when"></a>setattr_when = <code class="type"><a href="Unix.html#TYPEsetattr_when">Unix.setattr_when</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">TCSANOW</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">TCSADRAIN</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">TCSAFLUSH</span></code></td>
</tr></table>
<br>
<pre><span class="keyword">val</span> <a name="VALtcsetattr"></a>tcsetattr : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -><br> mode:<a href="UnixLabels.html#TYPEsetattr_when">setattr_when</a> -> <a href="UnixLabels.html#TYPEterminal_io">terminal_io</a> -> unit</code></pre><div class="info">
Set the status of the terminal referred to by the given
file descriptor. The second argument indicates when the
status change takes place: immediately (<code class="code"><span class="constructor">TCSANOW</span></code>),
when all pending output has been transmitted (<code class="code"><span class="constructor">TCSADRAIN</span></code>),
or after flushing all input that has been received but not
read (<code class="code"><span class="constructor">TCSAFLUSH</span></code>). <code class="code"><span class="constructor">TCSADRAIN</span></code> is recommended when changing
the output parameters; <code class="code"><span class="constructor">TCSAFLUSH</span></code>, when changing the input
parameters.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALtcsendbreak"></a>tcsendbreak : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> duration:int -> unit</code></pre><div class="info">
Send a break condition on the given file descriptor.
The second argument is the duration of the break, in 0.1s units;
0 means standard duration (0.25s).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALtcdrain"></a>tcdrain : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> unit</code></pre><div class="info">
Waits until all output written on the given file descriptor
has been transmitted.<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEflush_queue"></a>flush_queue = <code class="type"><a href="Unix.html#TYPEflush_queue">Unix.flush_queue</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">TCIFLUSH</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">TCOFLUSH</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">TCIOFLUSH</span></code></td>
</tr></table>
<br>
<pre><span class="keyword">val</span> <a name="VALtcflush"></a>tcflush : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> mode:<a href="UnixLabels.html#TYPEflush_queue">flush_queue</a> -> unit</code></pre><div class="info">
Discard data written on the given file descriptor but not yet
transmitted, or data received but not yet read, depending on the
second argument: <code class="code"><span class="constructor">TCIFLUSH</span></code> flushes data received but not read,
<code class="code"><span class="constructor">TCOFLUSH</span></code> flushes data written but not transmitted, and
<code class="code"><span class="constructor">TCIOFLUSH</span></code> flushes both.<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEflow_action"></a>flow_action = <code class="type"><a href="Unix.html#TYPEflow_action">Unix.flow_action</a></code> =<br></code><table border="0" cellpadding="1">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">TCOOFF</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">TCOON</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">TCIOFF</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">TCION</span></code></td>
</tr></table>
<br>
<pre><span class="keyword">val</span> <a name="VALtcflow"></a>tcflow : <code class="type"><a href="UnixLabels.html#TYPEfile_descr">file_descr</a> -> mode:<a href="UnixLabels.html#TYPEflow_action">flow_action</a> -> unit</code></pre><div class="info">
Suspend or restart reception or transmission of data on
the given file descriptor, depending on the second argument:
<code class="code"><span class="constructor">TCOOFF</span></code> suspends output, <code class="code"><span class="constructor">TCOON</span></code> restarts output,
<code class="code"><span class="constructor">TCIOFF</span></code> transmits a STOP character to suspend input,
and <code class="code"><span class="constructor">TCION</span></code> transmits a START character to restart input.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsetsid"></a>setsid : <code class="type">unit -> int</code></pre><div class="info">
Put the calling process in a new session and detach it from
its controlling terminal.<br>
</div>
</body></html>
