<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Batteries.Sys.html">
<link rel="next" href="Batteries.Big_int.html">
<link rel="Up" href="Batteries.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 class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.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="BatArray" rel="Chapter" href="BatArray.html">
<link title="BatAvlTree" rel="Chapter" href="BatAvlTree.html">
<link title="BatBase64" rel="Chapter" href="BatBase64.html">
<link title="BatBig_int" rel="Chapter" href="BatBig_int.html">
<link title="BatBigarray" rel="Chapter" href="BatBigarray.html">
<link title="BatBitSet" rel="Chapter" href="BatBitSet.html">
<link title="BatBool" rel="Chapter" href="BatBool.html">
<link title="BatBounded" rel="Chapter" href="BatBounded.html">
<link title="BatBuffer" rel="Chapter" href="BatBuffer.html">
<link title="BatCache" rel="Chapter" href="BatCache.html">
<link title="BatChar" rel="Chapter" href="BatChar.html">
<link title="BatCharParser" rel="Chapter" href="BatCharParser.html">
<link title="BatComplex" rel="Chapter" href="BatComplex.html">
<link title="BatConcurrent" rel="Chapter" href="BatConcurrent.html">
<link title="BatDeque" rel="Chapter" href="BatDeque.html">
<link title="BatDigest" rel="Chapter" href="BatDigest.html">
<link title="BatDllist" rel="Chapter" href="BatDllist.html">
<link title="BatDynArray" rel="Chapter" href="BatDynArray.html">
<link title="BatEnum" rel="Chapter" href="BatEnum.html">
<link title="BatFile" rel="Chapter" href="BatFile.html">
<link title="BatFingerTree" rel="Chapter" href="BatFingerTree.html">
<link title="BatFloat" rel="Chapter" href="BatFloat.html">
<link title="BatFormat" rel="Chapter" href="BatFormat.html">
<link title="BatGc" rel="Chapter" href="BatGc.html">
<link title="BatGenlex" rel="Chapter" href="BatGenlex.html">
<link title="BatGlobal" rel="Chapter" href="BatGlobal.html">
<link title="BatHashcons" rel="Chapter" href="BatHashcons.html">
<link title="BatHashtbl" rel="Chapter" href="BatHashtbl.html">
<link title="BatHeap" rel="Chapter" href="BatHeap.html">
<link title="BatIMap" rel="Chapter" href="BatIMap.html">
<link title="BatIO" rel="Chapter" href="BatIO.html">
<link title="BatISet" rel="Chapter" href="BatISet.html">
<link title="BatInnerIO" rel="Chapter" href="BatInnerIO.html">
<link title="BatInnerPervasives" rel="Chapter" href="BatInnerPervasives.html">
<link title="BatInnerWeaktbl" rel="Chapter" href="BatInnerWeaktbl.html">
<link title="BatInt" rel="Chapter" href="BatInt.html">
<link title="BatInt32" rel="Chapter" href="BatInt32.html">
<link title="BatInt64" rel="Chapter" href="BatInt64.html">
<link title="BatInterfaces" rel="Chapter" href="BatInterfaces.html">
<link title="BatLazyList" rel="Chapter" href="BatLazyList.html">
<link title="BatLexing" rel="Chapter" href="BatLexing.html">
<link title="BatList" rel="Chapter" href="BatList.html">
<link title="BatLog" rel="Chapter" href="BatLog.html">
<link title="BatLogger" rel="Chapter" href="BatLogger.html">
<link title="BatMap" rel="Chapter" href="BatMap.html">
<link title="BatMarshal" rel="Chapter" href="BatMarshal.html">
<link title="BatMultiMap" rel="Chapter" href="BatMultiMap.html">
<link title="BatMultiPMap" rel="Chapter" href="BatMultiPMap.html">
<link title="BatMutex" rel="Chapter" href="BatMutex.html">
<link title="BatNativeint" rel="Chapter" href="BatNativeint.html">
<link title="BatNum" rel="Chapter" href="BatNum.html">
<link title="BatNumber" rel="Chapter" href="BatNumber.html">
<link title="BatOo" rel="Chapter" href="BatOo.html">
<link title="BatOptParse" rel="Chapter" href="BatOptParse.html">
<link title="BatOption" rel="Chapter" href="BatOption.html">
<link title="BatOrd" rel="Chapter" href="BatOrd.html">
<link title="BatParserCo" rel="Chapter" href="BatParserCo.html">
<link title="BatPathGen" rel="Chapter" href="BatPathGen.html">
<link title="BatPervasives" rel="Chapter" href="BatPervasives.html">
<link title="BatPrintexc" rel="Chapter" href="BatPrintexc.html">
<link title="BatPrintf" rel="Chapter" href="BatPrintf.html">
<link title="BatQueue" rel="Chapter" href="BatQueue.html">
<link title="BatRMutex" rel="Chapter" href="BatRMutex.html">
<link title="BatRandom" rel="Chapter" href="BatRandom.html">
<link title="BatRef" rel="Chapter" href="BatRef.html">
<link title="BatRefList" rel="Chapter" href="BatRefList.html">
<link title="BatResult" rel="Chapter" href="BatResult.html">
<link title="BatReturn" rel="Chapter" href="BatReturn.html">
<link title="BatScanf" rel="Chapter" href="BatScanf.html">
<link title="BatSeq" rel="Chapter" href="BatSeq.html">
<link title="BatSet" rel="Chapter" href="BatSet.html">
<link title="BatSplay" rel="Chapter" href="BatSplay.html">
<link title="BatStack" rel="Chapter" href="BatStack.html">
<link title="BatStream" rel="Chapter" href="BatStream.html">
<link title="BatString" rel="Chapter" href="BatString.html">
<link title="BatSubstring" rel="Chapter" href="BatSubstring.html">
<link title="BatSys" rel="Chapter" href="BatSys.html">
<link title="BatText" rel="Chapter" href="BatText.html">
<link title="BatTuple" rel="Chapter" href="BatTuple.html">
<link title="BatUChar" rel="Chapter" href="BatUChar.html">
<link title="BatUTF8" rel="Chapter" href="BatUTF8.html">
<link title="BatUnit" rel="Chapter" href="BatUnit.html">
<link title="BatUnix" rel="Chapter" href="BatUnix.html">
<link title="BatUref" rel="Chapter" href="BatUref.html">
<link title="BatVect" rel="Chapter" href="BatVect.html">
<link title="Batteries" rel="Chapter" href="Batteries.html">
<link title="BatteriesConfig" rel="Chapter" href="BatteriesConfig.html">
<link title="BatteriesPrint" rel="Chapter" href="BatteriesPrint.html">
<link title="BatteriesThread" rel="Chapter" href="BatteriesThread.html">
<link title="Extlib" rel="Chapter" href="Extlib.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="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 status" rel="Section" href="#6_Filestatus">
<link title="File operations on large files" rel="Section" href="#6_Fileoperationsonlargefiles">
<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">
<link title="Small tools" rel="Section" href="#6_Smalltools">
<link title="Thread-safety internals" rel="Section" href="#6_Threadsafetyinternals">
<link title="Obsolete stuff" rel="Section" href="#6_Obsoletestuff">
<title>Batteries user guide : Batteries.Unix</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Batteries.Sys.html" title="Batteries.Sys">Previous</a>
<a class="up" href="Batteries.html" title="Batteries">Up</a>
<a class="post" href="Batteries.Big_int.html" title="Batteries.Big_int">Next</a>
</div>
<h1>Module <a href="type_Batteries.Unix.html">Batteries.Unix</a></h1>
<pre><span class="keyword">module</span> Unix: <code class="type">BatUnix</code></pre><hr width="100%">
<br>
Low-level interface to the operating system (both Unix and Windows).
<p>
This module only provides low-level functions and types. Unless you
know that you need low-level access to the operating system, you
probably don't. For higher-level functions, see modules <a href="BatIO.html"><code class="code"><span class="constructor">BatIO</span></code></a>,
<a href="BatFile.html"><code class="code"><span class="constructor">BatFile</span></code></a>.
<p>
<b>Note</b> This module is thread-safe.<br>
<br>
<h6 id="6_Errorreport">Error report</h6><br>
<pre><span id="TYPEerror"><span class="keyword">type</span> <code class="type"></code>error</span> = <code class="type">Unix.error</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTerror.E2BIG"><span class="constructor">E2BIG</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Argument list too long</td><td class="typefieldcomment" 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 id="TYPEELTerror.EACCES"><span class="constructor">EACCES</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Permission denied</td><td class="typefieldcomment" 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 id="TYPEELTerror.EAGAIN"><span class="constructor">EAGAIN</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Resource temporarily unavailable; try again</td><td class="typefieldcomment" 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 id="TYPEELTerror.EBADF"><span class="constructor">EBADF</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Bad file descriptor</td><td class="typefieldcomment" 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 id="TYPEELTerror.EBUSY"><span class="constructor">EBUSY</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Resource unavailable</td><td class="typefieldcomment" 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 id="TYPEELTerror.ECHILD"><span class="constructor">ECHILD</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >No child process</td><td class="typefieldcomment" 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 id="TYPEELTerror.EDEADLK"><span class="constructor">EDEADLK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Resource deadlock would occur</td><td class="typefieldcomment" 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 id="TYPEELTerror.EDOM"><span class="constructor">EDOM</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Domain error for math functions, etc.</td><td class="typefieldcomment" 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 id="TYPEELTerror.EEXIST"><span class="constructor">EEXIST</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >File exists</td><td class="typefieldcomment" 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 id="TYPEELTerror.EFAULT"><span class="constructor">EFAULT</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Bad address</td><td class="typefieldcomment" 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 id="TYPEELTerror.EFBIG"><span class="constructor">EFBIG</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >File too large</td><td class="typefieldcomment" 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 id="TYPEELTerror.EINTR"><span class="constructor">EINTR</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Function interrupted by signal</td><td class="typefieldcomment" 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 id="TYPEELTerror.EINVAL"><span class="constructor">EINVAL</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Invalid argument</td><td class="typefieldcomment" 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 id="TYPEELTerror.EIO"><span class="constructor">EIO</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Hardware I/O error</td><td class="typefieldcomment" 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 id="TYPEELTerror.EISDIR"><span class="constructor">EISDIR</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Is a directory</td><td class="typefieldcomment" 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 id="TYPEELTerror.EMFILE"><span class="constructor">EMFILE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Too many open files by the process</td><td class="typefieldcomment" 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 id="TYPEELTerror.EMLINK"><span class="constructor">EMLINK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Too many links</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENAMETOOLONG"><span class="constructor">ENAMETOOLONG</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Filename too long</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENFILE"><span class="constructor">ENFILE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Too many open files in the system</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENODEV"><span class="constructor">ENODEV</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >No such device</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOENT"><span class="constructor">ENOENT</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >No such file or directory</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOEXEC"><span class="constructor">ENOEXEC</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Not an executable file</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOLCK"><span class="constructor">ENOLCK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >No locks available</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOMEM"><span class="constructor">ENOMEM</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Not enough memory</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOSPC"><span class="constructor">ENOSPC</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >No space left on device</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOSYS"><span class="constructor">ENOSYS</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Function not supported</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOTDIR"><span class="constructor">ENOTDIR</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Not a directory</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOTEMPTY"><span class="constructor">ENOTEMPTY</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Directory not empty</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOTTY"><span class="constructor">ENOTTY</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Inappropriate I/O control operation</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENXIO"><span class="constructor">ENXIO</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >No such device or address</td><td class="typefieldcomment" 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 id="TYPEELTerror.EPERM"><span class="constructor">EPERM</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Operation not permitted</td><td class="typefieldcomment" 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 id="TYPEELTerror.EPIPE"><span class="constructor">EPIPE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Broken pipe</td><td class="typefieldcomment" 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 id="TYPEELTerror.ERANGE"><span class="constructor">ERANGE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Result too large</td><td class="typefieldcomment" 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 id="TYPEELTerror.EROFS"><span class="constructor">EROFS</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Read-only file system</td><td class="typefieldcomment" 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 id="TYPEELTerror.ESPIPE"><span class="constructor">ESPIPE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Invalid seek e.g. on a pipe</td><td class="typefieldcomment" 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 id="TYPEELTerror.ESRCH"><span class="constructor">ESRCH</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >No such process</td><td class="typefieldcomment" 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 id="TYPEELTerror.EXDEV"><span class="constructor">EXDEV</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Invalid link</td><td class="typefieldcomment" 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 id="TYPEELTerror.EWOULDBLOCK"><span class="constructor">EWOULDBLOCK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Operation would block</td><td class="typefieldcomment" 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 id="TYPEELTerror.EINPROGRESS"><span class="constructor">EINPROGRESS</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Operation now in progress</td><td class="typefieldcomment" 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 id="TYPEELTerror.EALREADY"><span class="constructor">EALREADY</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Operation already in progress</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOTSOCK"><span class="constructor">ENOTSOCK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Socket operation on non-socket</td><td class="typefieldcomment" 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 id="TYPEELTerror.EDESTADDRREQ"><span class="constructor">EDESTADDRREQ</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Destination address required</td><td class="typefieldcomment" 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 id="TYPEELTerror.EMSGSIZE"><span class="constructor">EMSGSIZE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Message too long</td><td class="typefieldcomment" 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 id="TYPEELTerror.EPROTOTYPE"><span class="constructor">EPROTOTYPE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Protocol wrong type for socket</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOPROTOOPT"><span class="constructor">ENOPROTOOPT</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Protocol not available</td><td class="typefieldcomment" 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 id="TYPEELTerror.EPROTONOSUPPORT"><span class="constructor">EPROTONOSUPPORT</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Protocol not supported</td><td class="typefieldcomment" 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 id="TYPEELTerror.ESOCKTNOSUPPORT"><span class="constructor">ESOCKTNOSUPPORT</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Socket type not supported</td><td class="typefieldcomment" 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 id="TYPEELTerror.EOPNOTSUPP"><span class="constructor">EOPNOTSUPP</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Operation not supported on socket</td><td class="typefieldcomment" 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 id="TYPEELTerror.EPFNOSUPPORT"><span class="constructor">EPFNOSUPPORT</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Protocol family not supported</td><td class="typefieldcomment" 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 id="TYPEELTerror.EAFNOSUPPORT"><span class="constructor">EAFNOSUPPORT</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Address family not supported by protocol family</td><td class="typefieldcomment" 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 id="TYPEELTerror.EADDRINUSE"><span class="constructor">EADDRINUSE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Address already in use</td><td class="typefieldcomment" 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 id="TYPEELTerror.EADDRNOTAVAIL"><span class="constructor">EADDRNOTAVAIL</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Can't assign requested address</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENETDOWN"><span class="constructor">ENETDOWN</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Network is down</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENETUNREACH"><span class="constructor">ENETUNREACH</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Network is unreachable</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENETRESET"><span class="constructor">ENETRESET</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Network dropped connection on reset</td><td class="typefieldcomment" 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 id="TYPEELTerror.ECONNABORTED"><span class="constructor">ECONNABORTED</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Software caused connection abort</td><td class="typefieldcomment" 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 id="TYPEELTerror.ECONNRESET"><span class="constructor">ECONNRESET</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Connection reset by peer</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOBUFS"><span class="constructor">ENOBUFS</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >No buffer space available</td><td class="typefieldcomment" 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 id="TYPEELTerror.EISCONN"><span class="constructor">EISCONN</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Socket is already connected</td><td class="typefieldcomment" 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 id="TYPEELTerror.ENOTCONN"><span class="constructor">ENOTCONN</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Socket is not connected</td><td class="typefieldcomment" 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 id="TYPEELTerror.ESHUTDOWN"><span class="constructor">ESHUTDOWN</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Can't send after socket shutdown</td><td class="typefieldcomment" 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 id="TYPEELTerror.ETOOMANYREFS"><span class="constructor">ETOOMANYREFS</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Too many references: can't splice</td><td class="typefieldcomment" 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 id="TYPEELTerror.ETIMEDOUT"><span class="constructor">ETIMEDOUT</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Connection timed out</td><td class="typefieldcomment" 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 id="TYPEELTerror.ECONNREFUSED"><span class="constructor">ECONNREFUSED</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Connection refused</td><td class="typefieldcomment" 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 id="TYPEELTerror.EHOSTDOWN"><span class="constructor">EHOSTDOWN</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Host is down</td><td class="typefieldcomment" 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 id="TYPEELTerror.EHOSTUNREACH"><span class="constructor">EHOSTUNREACH</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >No route to host</td><td class="typefieldcomment" 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 id="TYPEELTerror.ELOOP"><span class="constructor">ELOOP</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Too many levels of symbolic links</td><td class="typefieldcomment" 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 id="TYPEELTerror.EOVERFLOW"><span class="constructor">EOVERFLOW</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >File size or position not representable</td><td class="typefieldcomment" 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 id="TYPEELTerror.EUNKNOWNERR"><span class="constructor">EUNKNOWNERR</span></span> <span class="keyword">of</span> <code class="type">int</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Unknown error</td><td class="typefieldcomment" 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 from UNIX98 and BSD.
All other errors are mapped to EUNKNOWNERR.<br>
</div>
<pre><span id="EXCEPTIONUnix_error"><span class="keyword">exception</span> Unix_error</span> <span class="keyword">of</span> <code class="type"><a href="BatUnix.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 id="VALerror_message"><span class="keyword">val</span> error_message</span> : <code class="type"><a href="BatUnix.html#TYPEerror">error</a> -> string</code></pre><div class="info ">
Return a string describing the given error code.<br>
</div>
<pre><span id="VALhandle_unix_error"><span class="keyword">val</span> handle_unix_error</span> : <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>
<h6 id="6_Accesstotheprocessenvironment">Access to the process environment</h6><br>
<pre><span id="VALenvironment"><span class="keyword">val</span> environment</span> : <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 id="VALgetenv"><span class="keyword">val</span> getenv</span> : <code class="type">string -> string</code></pre><div class="info ">
Return the value associated to a variable in the process
environment.<br>
<b>Raises</b> <code>Not_found</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 id="VALputenv"><span class="keyword">val</span> putenv</span> : <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>
<h6 id="6_Processhandling">Process handling</h6><br>
<pre><span id="TYPEprocess_status"><span class="keyword">type</span> <code class="type"></code>process_status</span> = <code class="type">Unix.process_status</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprocess_status.WEXITED"><span class="constructor">WEXITED</span></span> <span class="keyword">of</span> <code class="type">int</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The process terminated normally by <code class="code">exit</code>;
the argument is the return code.</td><td class="typefieldcomment" 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 id="TYPEELTprocess_status.WSIGNALED"><span class="constructor">WSIGNALED</span></span> <span class="keyword">of</span> <code class="type">int</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The process was killed by a signal;
the argument is the signal number.</td><td class="typefieldcomment" 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 id="TYPEELTprocess_status.WSTOPPED"><span class="constructor">WSTOPPED</span></span> <span class="keyword">of</span> <code class="type">int</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The process was stopped by a signal; the argument is the
signal number.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
The termination status of a process. See module <code class="code"><span class="constructor">Sys</span></code> for the
definitions of the standard signal numbers. Note that they are
not the numbers used by the OS.<br>
</div>
<pre><span id="TYPEwait_flag"><span class="keyword">type</span> <code class="type"></code>wait_flag</span> = <code class="type">Unix.wait_flag</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTwait_flag.WNOHANG"><span class="constructor">WNOHANG</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >do not block if no child has
died yet, but immediately return with a pid equal to 0.</td><td class="typefieldcomment" 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 id="TYPEELTwait_flag.WUNTRACED"><span class="constructor">WUNTRACED</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >report also the children that receive stop signals.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
Flags for <code class="code"><span class="constructor">Unix</span>.waitpid</code>.<br>
</div>
<pre><span id="VALexecv"><span class="keyword">val</span> execv</span> : <code class="type">string -> string array -> 'a</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.
These <code class="code">execv*</code> functions never return: on success, the current
program is replaced by the new one;<br>
<b>Raises</b> <code>Unix.Unix_error</code> on failure.<br>
</div>
<pre><span id="VALexecve"><span class="keyword">val</span> execve</span> : <code class="type">string -> string array -> string array -> 'a</code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.execv</code>, except that the third argument provides the
environment to the program executed.<br>
</div>
<pre><span id="VALexecvp"><span class="keyword">val</span> execvp</span> : <code class="type">string -> string array -> 'a</code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.execv</code>, except that
the program is searched in the path.<br>
</div>
<pre><span id="VALexecvpe"><span class="keyword">val</span> execvpe</span> : <code class="type">string -> string array -> string array -> 'a</code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.execve</code>, except that
the program is searched in the path.<br>
</div>
<pre><span id="VALfork"><span class="keyword">val</span> fork</span> : <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 id="VALwait"><span class="keyword">val</span> wait</span> : <code class="type">unit -> int * <a href="BatUnix.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 id="VALwaitpid"><span class="keyword">val</span> waitpid</span> : <code class="type"><a href="BatUnix.html#TYPEwait_flag">wait_flag</a> list -> int -> int * <a href="BatUnix.html#TYPEprocess_status">process_status</a></code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.wait</code>, but waits for the child 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 id="VALsystem"><span class="keyword">val</span> system</span> : <code class="type">string -> <a href="BatUnix.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 id="VALgetpid"><span class="keyword">val</span> getpid</span> : <code class="type">unit -> int</code></pre><div class="info ">
Return the pid of the process.<br>
</div>
<pre><span id="VALgetppid"><span class="keyword">val</span> getppid</span> : <code class="type">unit -> int</code></pre><div class="info ">
Return the pid of the parent process.<br>
</div>
<pre><span id="VALnice"><span class="keyword">val</span> nice</span> : <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>
<h6 id="6_Basicfileinputoutput">Basic file input/output</h6><br>
<pre><span id="TYPEfile_descr"><span class="keyword">type</span> <code class="type"></code>file_descr</span> = <code class="type">Unix.file_descr</code> </pre>
<div class="info ">
The abstract type of file descriptors.<br>
</div>
<pre><span id="VALstdin"><span class="keyword">val</span> stdin</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a></code></pre><div class="info ">
File descriptor for standard input.<br>
</div>
<pre><span id="VALstdout"><span class="keyword">val</span> stdout</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a></code></pre><div class="info ">
File descriptor for standard output.<br>
</div>
<pre><span id="VALstderr"><span class="keyword">val</span> stderr</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a></code></pre><div class="info ">
File descriptor for standard error.<br>
</div>
<pre><span id="TYPEopen_flag"><span class="keyword">type</span> <code class="type"></code>open_flag</span> = <code class="type">Unix.open_flag</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTopen_flag.O_RDONLY"><span class="constructor">O_RDONLY</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Open for reading</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_WRONLY"><span class="constructor">O_WRONLY</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Open for writing</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_RDWR"><span class="constructor">O_RDWR</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Open for reading and writing</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_NONBLOCK"><span class="constructor">O_NONBLOCK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Open in non-blocking mode</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_APPEND"><span class="constructor">O_APPEND</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Open for append</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_CREAT"><span class="constructor">O_CREAT</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Create if nonexistent</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_TRUNC"><span class="constructor">O_TRUNC</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Truncate to 0 length if existing</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_EXCL"><span class="constructor">O_EXCL</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Fail if existing</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_NOCTTY"><span class="constructor">O_NOCTTY</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Don't make this dev a controlling tty</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_DSYNC"><span class="constructor">O_DSYNC</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Writes complete as `Synchronised I/O data
integrity completion'</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_SYNC"><span class="constructor">O_SYNC</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Writes complete as `Synchronised I/O file
integrity completion'</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_RSYNC"><span class="constructor">O_RSYNC</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Reads complete as writes (depending on
O_SYNC/O_DSYNC)</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_SHARE_DELETE"><span class="constructor">O_SHARE_DELETE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >OCaml 4 and Windows only: allow the file to be deleted
while still open</td><td class="typefieldcomment" 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 id="TYPEELTopen_flag.O_CLOEXEC"><span class="constructor">O_CLOEXEC</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Set the close-on-exec flag on the
descriptor returned by <a href="BatUnix.html#VALopenfile"><code class="code"><span class="constructor">BatUnix</span>.openfile</code></a>
<p>
Since OCaml 4.1</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
The flags to <code class="code"><span class="constructor">Unix</span>.openfile</code>.<br>
</div>
<pre><span id="TYPEfile_perm"><span class="keyword">type</span> <code class="type"></code>file_perm</span> = <code class="type">int</code> </pre>
<div class="info ">
The type of file access rights, e.g. <code class="code">0o640</code> is read and write for user,
read for group, none for others<br>
</div>
<pre><span id="VALopenfile"><span class="keyword">val</span> openfile</span> : <code class="type">string -> <a href="BatUnix.html#TYPEopen_flag">open_flag</a> list -> <a href="BatUnix.html#TYPEfile_perm">file_perm</a> -> <a href="BatUnix.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 id="VALclose"><span class="keyword">val</span> close</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> unit</code></pre><div class="info ">
Close a file descriptor.<br>
</div>
<pre><span id="VALread"><span class="keyword">val</span> read</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> string -> int -> 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 id="VALwrite"><span class="keyword">val</span> write</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> string -> int -> 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. <code class="code">write</code> repeats the writing operation until all characters
have been written or an error occurs.<br>
</div>
<pre><span id="VALsingle_write"><span class="keyword">val</span> single_write</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> string -> int -> int -> int</code></pre><div class="info ">
Same as <code class="code">write</code>, but attempts to write only once.
Thus, if an error occurs, <code class="code">single_write</code> guarantees that no data
has been written.<br>
</div>
<br>
<h6 id="6_Interfacingwiththestandardinputoutputlibrary">Interfacing with the standard input/output library</h6><br>
<pre><span id="VALin_channel_of_descr"><span class="keyword">val</span> in_channel_of_descr</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</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 id="VALout_channel_of_descr"><span class="keyword">val</span> out_channel_of_descr</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</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 id="VALdescr_of_in_channel"><span class="keyword">val</span> descr_of_in_channel</span> : <code class="type"><a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a> -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a></code></pre><div class="info ">
Return the descriptor corresponding to an input channel.<br>
</div>
<pre><span id="VALdescr_of_out_channel"><span class="keyword">val</span> descr_of_out_channel</span> : <code class="type">unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a> -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a></code></pre><div class="info ">
Return the descriptor corresponding to an output channel.<br>
</div>
<br>
<h6 id="6_Interfacingwiththestandardinputoutputlibrary">Interfacing with the standard input/output library</h6><br>
<pre><span id="VALinput_of_descr"><span class="keyword">val</span> input_of_descr</span> : <code class="type">?autoclose:bool -> ?cleanup:bool -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a></code></pre><div class="info ">
Create an <code class="code">input</code> reading from the given descriptor.
The <code class="code">input</code> 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>
<div class="param_info"><code class="code">autoclose</code> : If true (default value), close the input
automatically once there is no more content to read. Otherwise,
the input will be closed according to the usual rules of module
<a href="BatIO.html"><code class="code"><span class="constructor">BatIO</span></code></a>. Barring very specific needs (e.g. using file descriptors as
locks), you probably want <code class="code">autoclose</code> to be <code class="code"><span class="keyword">true</span></code>.</div>
<div class="param_info"><code class="code">cleanup</code> : If true, close the underlying file descriptor
when the <code class="code">input</code> is closed. If false or unspecified,
do nothing, in which case you will need to close the underlying
file descriptor yourself to ensure proper cleanup.</div>
<pre><span id="VALoutput_of_descr"><span class="keyword">val</span> output_of_descr</span> : <code class="type">?cleanup:bool -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a></code></pre><div class="info ">
Create an <code class="code">output</code> writing on the given descriptor.
The <code class="code">output</code> 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>
<div class="param_info"><code class="code">cleanup</code> : If true, close the underlying file descriptor
when the <code class="code">output</code> is closed. If false or unspecified,
do nothing, in which case you will need to close the underlying
file descriptor yourself to ensure proper cleanup.</div>
<pre><span id="VALdescr_of_input"><span class="keyword">val</span> descr_of_input</span> : <code class="type"><a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a> -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a></code></pre><div class="info ">
Return the descriptor corresponding to an input.
<p>
Not all inputs have file descriptors. This function works
only for inputs which have been created using module <code class="code"><span class="constructor">Unix</span></code>.<br>
<b>Raises</b> <code>Invalid_argument</code> if this input
channel doesn't have a file descriptor<br>
</div>
<pre><span id="VALdescr_of_output"><span class="keyword">val</span> descr_of_output</span> : <code class="type">unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a> -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a></code></pre><div class="info ">
Return the descriptor corresponding to an output.
<p>
Not all inputs have file descriptors. This function works
only for inputs which have been created from module Unix.<br>
<b>Raises</b> <code>Invalid_argument</code> if this input
channel doesn't have a file descriptor<br>
</div>
<br>
<h6 id="6_Seekingandtruncating">Seeking and truncating</h6><br>
<pre><span id="TYPEseek_command"><span class="keyword">type</span> <code class="type"></code>seek_command</span> = <code class="type">Unix.seek_command</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTseek_command.SEEK_SET"><span class="constructor">SEEK_SET</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >indicates positions relative to the beginning of the file</td><td class="typefieldcomment" 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 id="TYPEELTseek_command.SEEK_CUR"><span class="constructor">SEEK_CUR</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >indicates positions relative to the current position</td><td class="typefieldcomment" 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 id="TYPEELTseek_command.SEEK_END"><span class="constructor">SEEK_END</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >indicates positions relative to the end of the file</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
Positioning modes for <code class="code"><span class="constructor">Unix</span>.lseek</code>.<br>
</div>
<pre><span id="VALlseek"><span class="keyword">val</span> lseek</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> int -> <a href="BatUnix.html#TYPEseek_command">seek_command</a> -> int</code></pre><div class="info ">
Set the current position for a file descriptor<br>
</div>
<pre><span id="VALtruncate"><span class="keyword">val</span> truncate</span> : <code class="type">string -> int -> unit</code></pre><div class="info ">
Truncates the named file to the given size.<br>
</div>
<pre><span id="VALftruncate"><span class="keyword">val</span> ftruncate</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> int -> unit</code></pre><div class="info ">
Truncates the file corresponding to the given descriptor
to the given size.<br>
</div>
<br>
<h6 id="6_Filestatus">File status</h6><br>
<pre><span id="TYPEfile_kind"><span class="keyword">type</span> <code class="type"></code>file_kind</span> = <code class="type">Unix.file_kind</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTfile_kind.S_REG"><span class="constructor">S_REG</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Regular file</td><td class="typefieldcomment" 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 id="TYPEELTfile_kind.S_DIR"><span class="constructor">S_DIR</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Directory</td><td class="typefieldcomment" 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 id="TYPEELTfile_kind.S_CHR"><span class="constructor">S_CHR</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Character device</td><td class="typefieldcomment" 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 id="TYPEELTfile_kind.S_BLK"><span class="constructor">S_BLK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Block device</td><td class="typefieldcomment" 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 id="TYPEELTfile_kind.S_LNK"><span class="constructor">S_LNK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Symbolic link</td><td class="typefieldcomment" 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 id="TYPEELTfile_kind.S_FIFO"><span class="constructor">S_FIFO</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Named pipe</td><td class="typefieldcomment" 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 id="TYPEELTfile_kind.S_SOCK"><span class="constructor">S_SOCK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Socket</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<pre><span id="TYPEstats"><span class="keyword">type</span> <code class="type"></code>stats</span> = <code class="type">Unix.stats</code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstats.st_dev">st_dev</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Device number</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstats.st_ino">st_ino</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Inode number</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstats.st_kind">st_kind</span> : <code class="type"><a href="BatUnix.html#TYPEfile_kind">file_kind</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Kind of the file</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstats.st_perm">st_perm</span> : <code class="type"><a href="BatUnix.html#TYPEfile_perm">file_perm</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Access rights</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstats.st_nlink">st_nlink</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Number of links</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstats.st_uid">st_uid</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >User id of the owner</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstats.st_gid">st_gid</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Group ID of the file's group</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstats.st_rdev">st_rdev</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Device minor number</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstats.st_size">st_size</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Size in bytes</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstats.st_atime">st_atime</span> : <code class="type">float</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Last access time</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstats.st_mtime">st_mtime</span> : <code class="type">float</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Last modification time</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstats.st_ctime">st_ctime</span> : <code class="type">float</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Last status change time</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info ">
The information returned by the <code class="code"><span class="constructor">Unix</span>.stat</code> calls.<br>
</div>
<pre><span id="VALstat"><span class="keyword">val</span> stat</span> : <code class="type">string -> <a href="BatUnix.html#TYPEstats">stats</a></code></pre><div class="info ">
Return the information for the named file.<br>
</div>
<pre><span id="VALlstat"><span class="keyword">val</span> lstat</span> : <code class="type">string -> <a href="BatUnix.html#TYPEstats">stats</a></code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.stat</code>, but in case the file is a symbolic link,
return the information for the link itself.<br>
</div>
<pre><span id="VALfstat"><span class="keyword">val</span> fstat</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEstats">stats</a></code></pre><div class="info ">
Return the information for the file associated with the given
descriptor.<br>
</div>
<pre><span id="VALisatty"><span class="keyword">val</span> isatty</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> bool</code></pre><div class="info ">
Return <code class="code"><span class="keyword">true</span></code> if the given file descriptor refers to a terminal or
console window, <code class="code"><span class="keyword">false</span></code> otherwise.<br>
</div>
<br>
<h6 id="6_Fileoperationsonlargefiles">File operations on large files</h6><br>
<pre><span class="keyword">module</span> <a href="BatUnix.LargeFile.html">LargeFile</a>: <code class="code"><span class="keyword">sig</span></code> <a href="BatUnix.LargeFile.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
File operations on large files.
</div>
<br>
<h6 id="6_Operationsonfilenames">Operations on file names</h6><br>
<pre><span id="VALunlink"><span class="keyword">val</span> unlink</span> : <code class="type">string -> unit</code></pre><div class="info ">
Removes the named file<br>
</div>
<pre><span id="VALrename"><span class="keyword">val</span> rename</span> : <code class="type">string -> 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 id="VALlink"><span class="keyword">val</span> link</span> : <code class="type">string -> 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">source</code>.<br>
</div>
<br>
<h6 id="6_Filepermissionsandownership">File permissions and ownership</h6><br>
<pre><span id="TYPEaccess_permission"><span class="keyword">type</span> <code class="type"></code>access_permission</span> = <code class="type">Unix.access_permission</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTaccess_permission.R_OK"><span class="constructor">R_OK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Read permission</td><td class="typefieldcomment" 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 id="TYPEELTaccess_permission.W_OK"><span class="constructor">W_OK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Write permission</td><td class="typefieldcomment" 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 id="TYPEELTaccess_permission.X_OK"><span class="constructor">X_OK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Execution permission</td><td class="typefieldcomment" 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 id="TYPEELTaccess_permission.F_OK"><span class="constructor">F_OK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >File exists</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
Flags for the <code class="code"><span class="constructor">Unix</span>.access</code> call.<br>
</div>
<pre><span id="VALchmod"><span class="keyword">val</span> chmod</span> : <code class="type">string -> <a href="BatUnix.html#TYPEfile_perm">file_perm</a> -> unit</code></pre><div class="info ">
Change the permissions of the named file.<br>
</div>
<pre><span id="VALfchmod"><span class="keyword">val</span> fchmod</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEfile_perm">file_perm</a> -> unit</code></pre><div class="info ">
Change the permissions of an opened file.<br>
</div>
<pre><span id="VALchown"><span class="keyword">val</span> chown</span> : <code class="type">string -> int -> int -> unit</code></pre><div class="info ">
Change the owner uid and owner gid of the named file.<br>
</div>
<pre><span id="VALfchown"><span class="keyword">val</span> fchown</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> int -> int -> unit</code></pre><div class="info ">
Change the owner uid and owner gid of an opened file.<br>
</div>
<pre><span id="VALumask"><span class="keyword">val</span> umask</span> : <code class="type">int -> int</code></pre><div class="info ">
Set the process's file mode creation mask, and return the previous
mask.<br>
</div>
<pre><span id="VALaccess"><span class="keyword">val</span> access</span> : <code class="type">string -> <a href="BatUnix.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.<br>
<b>Raises</b> <code>Unix_error</code> otherwise.<br>
</div>
<br>
<h6 id="6_Operationsonfiledescriptors">Operations on file descriptors</h6><br>
<pre><span id="VALdup"><span class="keyword">val</span> dup</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.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 id="VALdup2"><span class="keyword">val</span> dup2</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.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 id="VALset_nonblock"><span class="keyword">val</span> set_nonblock</span> : <code class="type"><a href="BatUnix.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 EAGAIN or EWOULDBLOCK error instead of blocking;
writing on a descriptor on which there is temporarily no room
for writing also raises EAGAIN or EWOULDBLOCK.<br>
</div>
<pre><span id="VALclear_nonblock"><span class="keyword">val</span> clear_nonblock</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> unit</code></pre><div class="info ">
Clear the ``non-blocking'' flag on the given descriptor.
See <code class="code"><span class="constructor">Unix</span>.set_nonblock</code>.<br>
</div>
<pre><span id="VALset_close_on_exec"><span class="keyword">val</span> set_close_on_exec</span> : <code class="type"><a href="BatUnix.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 id="VALclear_close_on_exec"><span class="keyword">val</span> clear_close_on_exec</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> unit</code></pre><div class="info ">
Clear the ``close-on-exec'' flag on the given descriptor.
See <code class="code"><span class="constructor">Unix</span>.set_close_on_exec</code>.<br>
</div>
<br>
<h6 id="6_Directories">Directories</h6><br>
<pre><span id="VALmkdir"><span class="keyword">val</span> mkdir</span> : <code class="type">string -> <a href="BatUnix.html#TYPEfile_perm">file_perm</a> -> unit</code></pre><div class="info ">
Create a directory with the given permissions.<br>
</div>
<pre><span id="VALrmdir"><span class="keyword">val</span> rmdir</span> : <code class="type">string -> unit</code></pre><div class="info ">
Remove an empty directory.<br>
</div>
<pre><span id="VALchdir"><span class="keyword">val</span> chdir</span> : <code class="type">string -> unit</code></pre><div class="info ">
Change the process working directory.<br>
</div>
<pre><span id="VALgetcwd"><span class="keyword">val</span> getcwd</span> : <code class="type">unit -> string</code></pre><div class="info ">
Return the name of the current working directory.<br>
</div>
<pre><span id="VALchroot"><span class="keyword">val</span> chroot</span> : <code class="type">string -> unit</code></pre><div class="info ">
Change the process root directory.<br>
</div>
<pre><span id="TYPEdir_handle"><span class="keyword">type</span> <code class="type"></code>dir_handle</span> = <code class="type">Unix.dir_handle</code> </pre>
<div class="info ">
The type of descriptors over opened directories.<br>
</div>
<pre><span id="VALopendir"><span class="keyword">val</span> opendir</span> : <code class="type">string -> <a href="BatUnix.html#TYPEdir_handle">dir_handle</a></code></pre><div class="info ">
Open a descriptor on a directory<br>
</div>
<pre><span id="VALreaddir"><span class="keyword">val</span> readdir</span> : <code class="type"><a href="BatUnix.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 id="VALrewinddir"><span class="keyword">val</span> rewinddir</span> : <code class="type"><a href="BatUnix.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 id="VALclosedir"><span class="keyword">val</span> closedir</span> : <code class="type"><a href="BatUnix.html#TYPEdir_handle">dir_handle</a> -> unit</code></pre><div class="info ">
Close a directory descriptor.<br>
</div>
<br>
<h6 id="6_Pipesandredirections">Pipes and redirections</h6><br>
<pre><span id="VALpipe"><span class="keyword">val</span> pipe</span> : <code class="type">unit -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a> * <a href="BatUnix.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 id="VALmkfifo"><span class="keyword">val</span> mkfifo</span> : <code class="type">string -> <a href="BatUnix.html#TYPEfile_perm">file_perm</a> -> unit</code></pre><div class="info ">
Create a named pipe with the given permissions.<br>
</div>
<br>
<h6 id="6_Highlevelprocessandredirectionmanagement">High-level process and redirection management</h6><br>
<pre><span id="VALopen_process_in"><span class="keyword">val</span> open_process_in</span> : <code class="type">?autoclose:bool -> ?cleanup:bool -> string -> <a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a></code></pre><div class="info ">
High-level pipe and process management. This function
runs the given command in parallel with the program.
The standard output of the command is redirected to a pipe,
which can be read via the returned input.
The command is interpreted by the shell <code class="code">/bin/sh</code> (cf. <code class="code">system</code>).<br>
</div>
<div class="param_info"><code class="code">autoclose</code> : If true (default value), close the input
automatically once there is no more content to read. Otherwise,
the input will be closed according to the usual rules of module
<a href="BatIO.html"><code class="code"><span class="constructor">BatIO</span></code></a>. Barring very specific needs (e.g. using file descriptors as
locks), you probably want <code class="code">autoclose</code> to be <code class="code"><span class="keyword">true</span></code>.</div>
<div class="param_info"><code class="code">cleanup</code> : If true or unspecified, close the process when the <code class="code">input</code>
is closed. If false, do nothing, in which case you
will need to close the process yourself to ensure proper cleanup.</div>
<pre><span id="VALopen_process_out"><span class="keyword">val</span> open_process_out</span> : <code class="type">?cleanup:bool -> string -> unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a></code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.open_process_in</code>, but redirect the standard input of
the command to a pipe. Data written to the returned output
is sent to the standard input of the command.
<p>
<b>Warning</b> writes on outputs are buffered, hence be careful
to call <code class="code"><span class="constructor">Pervasives</span>.flush</code> at the right times to ensure
correct synchronization.<br>
</div>
<div class="param_info"><code class="code">cleanup</code> : If true or unspecified, close the process when the <code class="code">output</code>
is closed. If false, do nothing, in which case you
will need to close the process yourself to ensure proper cleanup.</div>
<pre><span id="VALopen_process"><span class="keyword">val</span> open_process</span> : <code class="type">?autoclose:bool -><br> ?cleanup:bool -> string -> <a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a> * unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a></code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.open_process_out</code>, but redirects both the
standard input and standard output of the command to pipes
connected to the two returned <code class="code">input</code>/<code class="code">output</code>.
The returned <code class="code">input</code> is connected to the output of the
command, and the returned <code class="code">output</code> to the input of the
command.<br>
</div>
<div class="param_info"><code class="code">autoclose</code> : If true (default value), close the input
automatically once there is no more content to read. Otherwise,
the input will be closed according to the usual rules of module
<a href="BatIO.html"><code class="code"><span class="constructor">BatIO</span></code></a>. Barring very specific needs (e.g. using file descriptors as
locks), you probably want <code class="code">autoclose</code> to be <code class="code"><span class="keyword">true</span></code>.</div>
<div class="param_info"><code class="code">cleanup</code> : If true or unspecified, close the process when either the
<code class="code">output</code> or the <code class="code">output</code> is closed. If false,
do nothing, in which case you will need to close
the process yourself to ensure proper cleanup.</div>
<pre><span id="VALopen_process_full"><span class="keyword">val</span> open_process_full</span> : <code class="type">?autoclose:bool -><br> ?cleanup:bool -><br> string -><br> string array -> <a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a> * unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a> * <a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a></code></pre><div class="info ">
Similar to <code class="code"><span class="constructor">Unix</span>.open_process</code>, but the second argument
specifies the environment passed to the command. The result is
a triple of <code class="code">input</code>/<code class="code">output</code> connected respectively
to the standard output, standard input, and standard error of
the command.<br>
</div>
<div class="param_info"><code class="code">autoclose</code> : If true (default value), close the input
automatically once there is no more content to read. Otherwise,
the input will be closed according to the usual rules of module
<a href="BatIO.html"><code class="code"><span class="constructor">BatIO</span></code></a>. Barring very specific needs (e.g. using file descriptors as
locks), you probably want <code class="code">autoclose</code> to be <code class="code"><span class="keyword">true</span></code>.</div>
<div class="param_info"><code class="code">cleanup</code> : If true or unspecified, close the process when either the
<code class="code">output</code> or the <code class="code">output</code> is closed. If false,
do nothing, in which case you will need to close
the process yourself to ensure proper cleanup.</div>
<pre><span id="VALclose_process_in"><span class="keyword">val</span> close_process_in</span> : <code class="type"><a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a> -> <a href="BatUnix.html#TYPEprocess_status">process_status</a></code></pre><div class="info ">
Close <code class="code">input</code> opened by <code class="code"><span class="constructor">Unix</span>.open_process_in</code>,
wait for the associated command to terminate,
and return its termination status.<br>
<b>Raises</b> <code>Unix_error(EBADF,</code> "close_process_in", "") if the argument
is not an <code class="code">input</code> opened by <code class="code"><span class="constructor">Unix</span>.open_process_in</code>.<br>
</div>
<pre><span id="VALclose_process_out"><span class="keyword">val</span> close_process_out</span> : <code class="type">unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a> -> <a href="BatUnix.html#TYPEprocess_status">process_status</a></code></pre><div class="info ">
Close <code class="code">output</code> opened by <code class="code"><span class="constructor">Unix</span>.open_process_out</code>,
wait for the associated command to terminate,
and return its termination status.<br>
<b>Raises</b> <code>Unix_error(EBADF,</code> "close_process_out", "") if the argument
is not an <code class="code">output</code> opened by <code class="code"><span class="constructor">Unix</span>.open_process_out</code>.<br>
</div>
<pre><span id="VALclose_process"><span class="keyword">val</span> close_process</span> : <code class="type"><a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a> * unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a> -> <a href="BatUnix.html#TYPEprocess_status">process_status</a></code></pre><div class="info ">
Close <code class="code">input</code>/<code class="code">output</code> opened by <code class="code"><span class="constructor">Unix</span>.open_process</code>,
wait for the associated command to terminate,
and return its termination status.<br>
<b>Raises</b> <code>Unix_error(EBADF,</code> "close_process", "") if the argument
is not pair of <code class="code">input</code>/<code class="code">output</code> opened by <code class="code"><span class="constructor">Unix</span>.open_process</code>.<br>
</div>
<pre><span id="VALclose_process_full"><span class="keyword">val</span> close_process_full</span> : <code class="type"><a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a> * unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a> * <a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a> -><br> <a href="BatUnix.html#TYPEprocess_status">process_status</a></code></pre><div class="info ">
Close i/o opened by <code class="code"><span class="constructor">Unix</span>.open_process_full</code>,
wait for the associated command to terminate,
and return its termination status.<br>
<b>Raises</b> <code>Unix_error(EBADF,</code> "close_process_full", "") if the argument
is not a triple of <code class="code">input</code>/<code class="code">output</code> opened by <code class="code"><span class="constructor">Unix</span>.open_process_full</code>.<br>
</div>
<pre><span id="VALcreate_process"><span class="keyword">val</span> create_process</span> : <code class="type">string -><br> string array -><br> <a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.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.<br>
</div>
<pre><span id="VALcreate_process_env"><span class="keyword">val</span> create_process_env</span> : <code class="type">string -><br> string array -><br> string array -><br> <a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.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 <code class="code"><span class="constructor">Unix</span>.create_process</code>, except that the extra argument
<code class="code">env</code> specifies the environment passed to the program.<br>
</div>
<br>
<h6 id="6_Symboliclinks">Symbolic links</h6><br>
<pre><span id="VALsymlink"><span class="keyword">val</span> symlink</span> : <code class="type">string -> 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 id="VALreadlink"><span class="keyword">val</span> readlink</span> : <code class="type">string -> string</code></pre><div class="info ">
Read the contents of a link.<br>
</div>
<br>
<h6 id="6_Polling">Polling</h6><br>
<pre><span id="VALselect"><span class="keyword">val</span> select</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> list -><br> <a href="BatUnix.html#TYPEfile_descr">file_descr</a> list -><br> <a href="BatUnix.html#TYPEfile_descr">file_descr</a> list -><br> float -><br> <a href="BatUnix.html#TYPEfile_descr">file_descr</a> list * <a href="BatUnix.html#TYPEfile_descr">file_descr</a> list * <a href="BatUnix.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>
<h6 id="6_Locking">Locking</h6><br>
<pre><span id="TYPElock_command"><span class="keyword">type</span> <code class="type"></code>lock_command</span> = <code class="type">Unix.lock_command</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTlock_command.F_ULOCK"><span class="constructor">F_ULOCK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Unlock a region</td><td class="typefieldcomment" 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 id="TYPEELTlock_command.F_LOCK"><span class="constructor">F_LOCK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Lock a region for writing, and block if already locked</td><td class="typefieldcomment" 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 id="TYPEELTlock_command.F_TLOCK"><span class="constructor">F_TLOCK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Lock a region for writing, or fail if already locked</td><td class="typefieldcomment" 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 id="TYPEELTlock_command.F_TEST"><span class="constructor">F_TEST</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Test a region for other process locks</td><td class="typefieldcomment" 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 id="TYPEELTlock_command.F_RLOCK"><span class="constructor">F_RLOCK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Lock a region for reading, and block if already locked</td><td class="typefieldcomment" 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 id="TYPEELTlock_command.F_TRLOCK"><span class="constructor">F_TRLOCK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Lock a region for reading, or fail if already locked</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
Commands for <code class="code"><span class="constructor">Unix</span>.lockf</code>.<br>
</div>
<pre><span id="VALlockf"><span class="keyword">val</span> lockf</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPElock_command">lock_command</a> -> 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 <code class="code"><span class="constructor">Unix</span>.lseek</code>), 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 prevents any other
process from acquiring a read or write lock on the region.
A read lock prevents any other
process from acquiring a write lock on the region, but lets
other processes acquire read locks on it.
<p>
The <code class="code"><span class="constructor">F_LOCK</span></code> and <code class="code"><span class="constructor">F_TLOCK</span></code> commands attempts to put a write lock
on the specified region.
The <code class="code"><span class="constructor">F_RLOCK</span></code> and <code class="code"><span class="constructor">F_TRLOCK</span></code> commands attempts to put a read lock
on the specified region.
If one or several locks put by another process prevent the current process
from acquiring the lock, <code class="code"><span class="constructor">F_LOCK</span></code> and <code class="code"><span class="constructor">F_RLOCK</span></code> block until these locks
are removed, while <code class="code"><span class="constructor">F_TLOCK</span></code> and <code class="code"><span class="constructor">F_TRLOCK</span></code> fail immediately with an
exception.
The <code class="code"><span class="constructor">F_ULOCK</span></code> removes whatever locks the current process has on
the specified region.
Finally, the <code class="code"><span class="constructor">F_TEST</span></code> command tests whether a write lock can be
acquired on the specified region, without actually putting a lock.
It returns immediately if successful, or fails otherwise.<br>
</div>
<br>
<h6 id="6_Signals">Signals</h6>
Note: installation of signal handlers is performed via
the functions <code class="code"><span class="constructor">Sys</span>.signal</code> and <code class="code"><span class="constructor">Sys</span>.set_signal</code>.<br>
<pre><span id="VALkill"><span class="keyword">val</span> kill</span> : <code class="type">int -> 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>
<pre><span id="TYPEsigprocmask_command"><span class="keyword">type</span> <code class="type"></code>sigprocmask_command</span> = <code class="type">Unix.sigprocmask_command</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsigprocmask_command.SIG_SETMASK"><span class="constructor">SIG_SETMASK</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsigprocmask_command.SIG_BLOCK"><span class="constructor">SIG_BLOCK</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsigprocmask_command.SIG_UNBLOCK"><span class="constructor">SIG_UNBLOCK</span></span></code></td>
</tr></table>
<pre><span id="VALsigprocmask"><span class="keyword">val</span> sigprocmask</span> : <code class="type"><a href="BatUnix.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 id="VALsigpending"><span class="keyword">val</span> sigpending</span> : <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 id="VALsigsuspend"><span class="keyword">val</span> sigsuspend</span> : <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">sigs</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 id="VALpause"><span class="keyword">val</span> pause</span> : <code class="type">unit -> unit</code></pre><div class="info ">
Wait until a non-ignored, non-blocked signal is delivered.<br>
</div>
<br>
<h6 id="6_Timefunctions">Time functions</h6><br>
<pre><span id="TYPEprocess_times"><span class="keyword">type</span> <code class="type"></code>process_times</span> = <code class="type">Unix.process_times</code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprocess_times.tms_utime">tms_utime</span> : <code class="type">float</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >User time for the process</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprocess_times.tms_stime">tms_stime</span> : <code class="type">float</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >System time for the process</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprocess_times.tms_cutime">tms_cutime</span> : <code class="type">float</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >User time for the children processes</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprocess_times.tms_cstime">tms_cstime</span> : <code class="type">float</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >System time for the children processes</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info ">
The execution times (CPU times) of a process.<br>
</div>
<pre><span id="TYPEtm"><span class="keyword">type</span> <code class="type"></code>tm</span> = <code class="type">Unix.tm</code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtm.tm_sec">tm_sec</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Seconds 0..60</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtm.tm_min">tm_min</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Minutes 0..59</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtm.tm_hour">tm_hour</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Hours 0..23</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtm.tm_mday">tm_mday</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Day of month 1..31</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtm.tm_mon">tm_mon</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Month of year 0..11</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtm.tm_year">tm_year</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Year - 1900</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtm.tm_wday">tm_wday</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Day of week (Sunday is 0)</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtm.tm_yday">tm_yday</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Day of year 0..365</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTtm.tm_isdst">tm_isdst</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Daylight time savings in effect</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info ">
The type representing wallclock time and calendar date.<br>
</div>
<pre><span id="VALtime"><span class="keyword">val</span> time</span> : <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 id="VALgettimeofday"><span class="keyword">val</span> gettimeofday</span> : <code class="type">unit -> float</code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.time</code>, but with resolution better than 1 second.<br>
</div>
<pre><span id="VALgmtime"><span class="keyword">val</span> gmtime</span> : <code class="type">float -> <a href="BatUnix.html#TYPEtm">tm</a></code></pre><div class="info ">
Convert a time in seconds, as returned by <code class="code"><span class="constructor">Unix</span>.time</code>, into a date and
a time. Assumes UTC (Coordinated Universal Time), also known as GMT.<br>
</div>
<pre><span id="VALlocaltime"><span class="keyword">val</span> localtime</span> : <code class="type">float -> <a href="BatUnix.html#TYPEtm">tm</a></code></pre><div class="info ">
Convert a time in seconds, as returned by <code class="code"><span class="constructor">Unix</span>.time</code>, into a date and
a time. Assumes the local time zone.<br>
</div>
<pre><span id="VALmktime"><span class="keyword">val</span> mktime</span> : <code class="type"><a href="BatUnix.html#TYPEtm">tm</a> -> float * <a href="BatUnix.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 <code class="code"><span class="constructor">Unix</span>.time</code>. The <code class="code">tm_isdst</code>,
<code class="code">tm_wday</code> and <code class="code">tm_yday</code> fields of <code class="code">tm</code> are ignored. 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,
and the other fields normalized (so that, e.g., 40 October is
changed into 9 November). The <code class="code">tm</code> argument is interpreted in the
local time zone.<br>
</div>
<pre><span id="VALalarm"><span class="keyword">val</span> alarm</span> : <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 id="VALsleep"><span class="keyword">val</span> sleep</span> : <code class="type">int -> unit</code></pre><div class="info ">
Stop execution for the given number of seconds.<br>
</div>
<pre><span id="VALtimes"><span class="keyword">val</span> times</span> : <code class="type">unit -> <a href="BatUnix.html#TYPEprocess_times">process_times</a></code></pre><div class="info ">
Return the execution times of the process.<br>
</div>
<pre><span id="VALutimes"><span class="keyword">val</span> utimes</span> : <code class="type">string -> float -> 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. A time of <code class="code">0.0</code> is interpreted as the
current time.<br>
</div>
<pre><span id="TYPEinterval_timer"><span class="keyword">type</span> <code class="type"></code>interval_timer</span> = <code class="type">Unix.interval_timer</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTinterval_timer.ITIMER_REAL"><span class="constructor">ITIMER_REAL</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >decrements in real time, and sends the signal <code class="code"><span class="constructor">SIGALRM</span></code> when
expired.</td><td class="typefieldcomment" 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 id="TYPEELTinterval_timer.ITIMER_VIRTUAL"><span class="constructor">ITIMER_VIRTUAL</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >decrements in process virtual time, and sends <code class="code"><span class="constructor">SIGVTALRM</span></code>
when expired.</td><td class="typefieldcomment" 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 id="TYPEELTinterval_timer.ITIMER_PROF"><span class="constructor">ITIMER_PROF</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >(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.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
The three kinds of interval timers.<br>
</div>
<pre><span id="TYPEinterval_timer_status"><span class="keyword">type</span> <code class="type"></code>interval_timer_status</span> = <code class="type">Unix.interval_timer_status</code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTinterval_timer_status.it_interval">it_interval</span> : <code class="type">float</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Period</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTinterval_timer_status.it_value">it_value</span> : <code class="type">float</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Current value of the timer</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info ">
The type describing the status of an interval timer<br>
</div>
<pre><span id="VALgetitimer"><span class="keyword">val</span> getitimer</span> : <code class="type"><a href="BatUnix.html#TYPEinterval_timer">interval_timer</a> -> <a href="BatUnix.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 id="VALsetitimer"><span class="keyword">val</span> setitimer</span> : <code class="type"><a href="BatUnix.html#TYPEinterval_timer">interval_timer</a> -><br> <a href="BatUnix.html#TYPEinterval_timer_status">interval_timer_status</a> -> <a href="BatUnix.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>
<h6 id="6_Useridgroupid">User id, group id</h6><br>
<pre><span id="VALgetuid"><span class="keyword">val</span> getuid</span> : <code class="type">unit -> int</code></pre><div class="info ">
Return the user id of the user executing the process.<br>
</div>
<pre><span id="VALgeteuid"><span class="keyword">val</span> geteuid</span> : <code class="type">unit -> int</code></pre><div class="info ">
Return the effective user id under which the process runs.<br>
</div>
<pre><span id="VALsetuid"><span class="keyword">val</span> setuid</span> : <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 id="VALgetgid"><span class="keyword">val</span> getgid</span> : <code class="type">unit -> int</code></pre><div class="info ">
Return the group id of the user executing the process.<br>
</div>
<pre><span id="VALgetegid"><span class="keyword">val</span> getegid</span> : <code class="type">unit -> int</code></pre><div class="info ">
Return the effective group id under which the process runs.<br>
</div>
<pre><span id="VALsetgid"><span class="keyword">val</span> setgid</span> : <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 id="VALgetgroups"><span class="keyword">val</span> getgroups</span> : <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>
<pre><span id="VALsetgroups"><span class="keyword">val</span> setgroups</span> : <code class="type">int array -> unit</code></pre><div class="info ">
<code class="code">setgroups groups</code> sets the supplementary group IDs for the
calling process. Appropriate privileges are required.<br>
</div>
<pre><span id="VALinitgroups"><span class="keyword">val</span> initgroups</span> : <code class="type">string -> int -> unit</code></pre><div class="info ">
<code class="code">initgroups user group</code> initializes the group access list by
reading the group database /etc/group and using all groups of
which <code class="code">user</code> is a member. The additional group <code class="code">group</code> is also
added to the list.<br>
</div>
<pre><span id="TYPEpasswd_entry"><span class="keyword">type</span> <code class="type"></code>passwd_entry</span> = <code class="type">Unix.passwd_entry</code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpasswd_entry.pw_name">pw_name</span> : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpasswd_entry.pw_passwd">pw_passwd</span> : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpasswd_entry.pw_uid">pw_uid</span> : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpasswd_entry.pw_gid">pw_gid</span> : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpasswd_entry.pw_gecos">pw_gecos</span> : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpasswd_entry.pw_dir">pw_dir</span> : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpasswd_entry.pw_shell">pw_shell</span> : <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>
<pre><span id="TYPEgroup_entry"><span class="keyword">type</span> <code class="type"></code>group_entry</span> = <code class="type">Unix.group_entry</code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTgroup_entry.gr_name">gr_name</span> : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTgroup_entry.gr_passwd">gr_passwd</span> : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTgroup_entry.gr_gid">gr_gid</span> : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTgroup_entry.gr_mem">gr_mem</span> : <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>
<pre><span id="VALgetlogin"><span class="keyword">val</span> getlogin</span> : <code class="type">unit -> string</code></pre><div class="info ">
Return the login name of the user executing the process.<br>
</div>
<pre><span id="VALgetpwnam"><span class="keyword">val</span> getpwnam</span> : <code class="type">string -> <a href="BatUnix.html#TYPEpasswd_entry">passwd_entry</a></code></pre><div class="info ">
Find an entry in <code class="code">passwd</code> with the given name.<br>
<b>Raises</b> <code>Not_found</code> if no such entry can be found.<br>
</div>
<pre><span id="VALgetgrnam"><span class="keyword">val</span> getgrnam</span> : <code class="type">string -> <a href="BatUnix.html#TYPEgroup_entry">group_entry</a></code></pre><div class="info ">
Find an entry in <code class="code">group</code> with the given name.<br>
<b>Raises</b> <code>Not_found</code> if no such entry can be found.<br>
</div>
<pre><span id="VALgetpwuid"><span class="keyword">val</span> getpwuid</span> : <code class="type">int -> <a href="BatUnix.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.<br>
<b>Raises</b> <code>Not_found</code> if no such entry can be found.<br>
</div>
<pre><span id="VALgetgrgid"><span class="keyword">val</span> getgrgid</span> : <code class="type">int -> <a href="BatUnix.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.<br>
<b>Raises</b> <code>Not_found</code> if no such entry can be found.<br>
</div>
<br>
<h6 id="6_Internetaddresses">Internet addresses</h6><br>
<pre><span id="TYPEinet_addr"><span class="keyword">type</span> <code class="type"></code>inet_addr</span> = <code class="type">Unix.inet_addr</code> </pre>
<div class="info ">
The abstract type of Internet addresses.<br>
</div>
<pre><span id="VALinet_addr_of_string"><span class="keyword">val</span> inet_addr_of_string</span> : <code class="type">string -> <a href="BatUnix.html#TYPEinet_addr">inet_addr</a></code></pre><div class="info ">
Conversion from the printable representation of an Internet
address to its internal representation. The argument string
consists of 4 numbers separated by periods (<code class="code"><span class="constructor">XXX</span>.<span class="constructor">YYY</span>.<span class="constructor">ZZZ</span>.<span class="constructor">TTT</span></code>)
for IPv4 addresses, and up to 8 numbers separated by colons
for IPv6 addresses.<br>
<b>Raises</b> <code>Failure</code> when given a string that
does not match these formats.<br>
</div>
<pre><span id="VALstring_of_inet_addr"><span class="keyword">val</span> string_of_inet_addr</span> : <code class="type"><a href="BatUnix.html#TYPEinet_addr">inet_addr</a> -> string</code></pre><div class="info ">
Return the printable representation of the given Internet address.
See <code class="code"><span class="constructor">Unix</span>.inet_addr_of_string</code> for a description of the
printable representation.<br>
</div>
<pre><span id="VALinet_addr_any"><span class="keyword">val</span> inet_addr_any</span> : <code class="type"><a href="BatUnix.html#TYPEinet_addr">inet_addr</a></code></pre><div class="info ">
A special IPv4 address, for use only with <code class="code">bind</code>, representing
all the Internet addresses that the host machine possesses.<br>
</div>
<pre><span id="VALinet_addr_loopback"><span class="keyword">val</span> inet_addr_loopback</span> : <code class="type"><a href="BatUnix.html#TYPEinet_addr">inet_addr</a></code></pre><div class="info ">
A special IPv4 address representing the host machine (<code class="code">127.0.0.1</code>).<br>
</div>
<pre><span id="VALinet6_addr_any"><span class="keyword">val</span> inet6_addr_any</span> : <code class="type"><a href="BatUnix.html#TYPEinet_addr">inet_addr</a></code></pre><div class="info ">
A special IPv6 address, for use only with <code class="code">bind</code>, representing
all the Internet addresses that the host machine possesses.<br>
</div>
<pre><span id="VALinet6_addr_loopback"><span class="keyword">val</span> inet6_addr_loopback</span> : <code class="type"><a href="BatUnix.html#TYPEinet_addr">inet_addr</a></code></pre><div class="info ">
A special IPv6 address representing the host machine (<code class="code">::1</code>).<br>
</div>
<br>
<h6 id="6_Sockets">Sockets</h6><br>
<pre><span id="TYPEsocket_domain"><span class="keyword">type</span> <code class="type"></code>socket_domain</span> = <code class="type">Unix.socket_domain</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsocket_domain.PF_UNIX"><span class="constructor">PF_UNIX</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Unix domain</td><td class="typefieldcomment" 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 id="TYPEELTsocket_domain.PF_INET"><span class="constructor">PF_INET</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Internet domain (IPv4)</td><td class="typefieldcomment" 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 id="TYPEELTsocket_domain.PF_INET6"><span class="constructor">PF_INET6</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Internet domain (IPv6)</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
The type of socket domains. Not all platforms support
IPv6 sockets (type <code class="code"><span class="constructor">PF_INET6</span></code>).<br>
</div>
<pre><span id="TYPEsocket_type"><span class="keyword">type</span> <code class="type"></code>socket_type</span> = <code class="type">Unix.socket_type</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsocket_type.SOCK_STREAM"><span class="constructor">SOCK_STREAM</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Stream socket</td><td class="typefieldcomment" 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 id="TYPEELTsocket_type.SOCK_DGRAM"><span class="constructor">SOCK_DGRAM</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Datagram socket</td><td class="typefieldcomment" 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 id="TYPEELTsocket_type.SOCK_RAW"><span class="constructor">SOCK_RAW</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Raw socket</td><td class="typefieldcomment" 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 id="TYPEELTsocket_type.SOCK_SEQPACKET"><span class="constructor">SOCK_SEQPACKET</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Sequenced packets socket</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
The type of socket kinds, specifying the semantics of
communications.<br>
</div>
<pre><span id="TYPEsockaddr"><span class="keyword">type</span> <code class="type"></code>sockaddr</span> = <code class="type">Unix.sockaddr</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsockaddr.ADDR_UNIX"><span class="constructor">ADDR_UNIX</span></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 id="TYPEELTsockaddr.ADDR_INET"><span class="constructor">ADDR_INET</span></span> <span class="keyword">of</span> <code class="type"><a href="BatUnix.html#TYPEinet_addr">inet_addr</a> * int</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >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.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<pre><span id="VALsocket"><span class="keyword">val</span> socket</span> : <code class="type"><a href="BatUnix.html#TYPEsocket_domain">socket_domain</a> -> <a href="BatUnix.html#TYPEsocket_type">socket_type</a> -> int -> <a href="BatUnix.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 id="VALdomain_of_sockaddr"><span class="keyword">val</span> domain_of_sockaddr</span> : <code class="type"><a href="BatUnix.html#TYPEsockaddr">sockaddr</a> -> <a href="BatUnix.html#TYPEsocket_domain">socket_domain</a></code></pre><div class="info ">
Return the socket domain adequate for the given socket address.<br>
</div>
<pre><span id="VALsocketpair"><span class="keyword">val</span> socketpair</span> : <code class="type"><a href="BatUnix.html#TYPEsocket_domain">socket_domain</a> -><br> <a href="BatUnix.html#TYPEsocket_type">socket_type</a> -> int -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a> * <a href="BatUnix.html#TYPEfile_descr">file_descr</a></code></pre><div class="info ">
Create a pair of unnamed sockets, connected together.<br>
</div>
<pre><span id="VALaccept"><span class="keyword">val</span> accept</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a> * <a href="BatUnix.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 id="VALbind"><span class="keyword">val</span> bind</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEsockaddr">sockaddr</a> -> unit</code></pre><div class="info ">
Bind a socket to an address.<br>
</div>
<pre><span id="VALconnect"><span class="keyword">val</span> connect</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEsockaddr">sockaddr</a> -> unit</code></pre><div class="info ">
Connect a socket to an address.<br>
</div>
<pre><span id="VALlisten"><span class="keyword">val</span> listen</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> 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>
<pre><span id="TYPEshutdown_command"><span class="keyword">type</span> <code class="type"></code>shutdown_command</span> = <code class="type">Unix.shutdown_command</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTshutdown_command.SHUTDOWN_RECEIVE"><span class="constructor">SHUTDOWN_RECEIVE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Close for receiving</td><td class="typefieldcomment" 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 id="TYPEELTshutdown_command.SHUTDOWN_SEND"><span class="constructor">SHUTDOWN_SEND</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Close for sending</td><td class="typefieldcomment" 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 id="TYPEELTshutdown_command.SHUTDOWN_ALL"><span class="constructor">SHUTDOWN_ALL</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Close both</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
The type of commands for <code class="code">shutdown</code>.<br>
</div>
<pre><span id="VALshutdown"><span class="keyword">val</span> shutdown</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.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 id="VALgetsockname"><span class="keyword">val</span> getsockname</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEsockaddr">sockaddr</a></code></pre><div class="info ">
Return the address of the given socket.<br>
</div>
<pre><span id="VALgetpeername"><span class="keyword">val</span> getpeername</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEsockaddr">sockaddr</a></code></pre><div class="info ">
Return the address of the host connected to the given socket.<br>
</div>
<pre><span id="TYPEmsg_flag"><span class="keyword">type</span> <code class="type"></code>msg_flag</span> = <code class="type">Unix.msg_flag</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmsg_flag.MSG_OOB"><span class="constructor">MSG_OOB</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmsg_flag.MSG_DONTROUTE"><span class="constructor">MSG_DONTROUTE</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmsg_flag.MSG_PEEK"><span class="constructor">MSG_PEEK</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The flags for <code class="code"><span class="constructor">Unix</span>.recv</code>, <code class="code"><span class="constructor">Unix</span>.recvfrom</code>,
<code class="code"><span class="constructor">Unix</span>.send</code> and <code class="code"><span class="constructor">Unix</span>.sendto</code>.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<pre><span id="VALrecv"><span class="keyword">val</span> recv</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> string -> int -> int -> <a href="BatUnix.html#TYPEmsg_flag">msg_flag</a> list -> int</code></pre><div class="info ">
Receive data from a connected socket.<br>
</div>
<pre><span id="VALrecvfrom"><span class="keyword">val</span> recvfrom</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -><br> string -> int -> int -> <a href="BatUnix.html#TYPEmsg_flag">msg_flag</a> list -> int * <a href="BatUnix.html#TYPEsockaddr">sockaddr</a></code></pre><div class="info ">
Receive data from an unconnected socket.<br>
</div>
<pre><span id="VALsend"><span class="keyword">val</span> send</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> string -> int -> int -> <a href="BatUnix.html#TYPEmsg_flag">msg_flag</a> list -> int</code></pre><div class="info ">
Send data over a connected socket.<br>
</div>
<pre><span id="VALsendto"><span class="keyword">val</span> sendto</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -><br> string -> int -> int -> <a href="BatUnix.html#TYPEmsg_flag">msg_flag</a> list -> <a href="BatUnix.html#TYPEsockaddr">sockaddr</a> -> int</code></pre><div class="info ">
Send data over an unconnected socket.<br>
</div>
<br>
<h6 id="6_Socketoptions">Socket options</h6><br>
<pre><span id="TYPEsocket_bool_option"><span class="keyword">type</span> <code class="type"></code>socket_bool_option</span> = <code class="type">Unix.socket_bool_option</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsocket_bool_option.SO_DEBUG"><span class="constructor">SO_DEBUG</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Record debugging information</td><td class="typefieldcomment" 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 id="TYPEELTsocket_bool_option.SO_BROADCAST"><span class="constructor">SO_BROADCAST</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Permit sending of broadcast messages</td><td class="typefieldcomment" 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 id="TYPEELTsocket_bool_option.SO_REUSEADDR"><span class="constructor">SO_REUSEADDR</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Allow reuse of local addresses for bind</td><td class="typefieldcomment" 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 id="TYPEELTsocket_bool_option.SO_KEEPALIVE"><span class="constructor">SO_KEEPALIVE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Keep connection active</td><td class="typefieldcomment" 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 id="TYPEELTsocket_bool_option.SO_DONTROUTE"><span class="constructor">SO_DONTROUTE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Bypass the standard routing algorithms</td><td class="typefieldcomment" 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 id="TYPEELTsocket_bool_option.SO_OOBINLINE"><span class="constructor">SO_OOBINLINE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Leave out-of-band data in line</td><td class="typefieldcomment" 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 id="TYPEELTsocket_bool_option.SO_ACCEPTCONN"><span class="constructor">SO_ACCEPTCONN</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Report whether socket listening is enabled</td><td class="typefieldcomment" 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 id="TYPEELTsocket_bool_option.TCP_NODELAY"><span class="constructor">TCP_NODELAY</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Control the Nagle algorithm for TCP sockets</td><td class="typefieldcomment" 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 id="TYPEELTsocket_bool_option.IPV6_ONLY"><span class="constructor">IPV6_ONLY</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Forbid binding an IPv6 socket to an IPv4 address</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
The socket options that can be consulted with <code class="code"><span class="constructor">Unix</span>.getsockopt</code>
and modified with <code class="code"><span class="constructor">Unix</span>.setsockopt</code>. 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>
<pre><span id="TYPEsocket_int_option"><span class="keyword">type</span> <code class="type"></code>socket_int_option</span> = <code class="type">Unix.socket_int_option</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsocket_int_option.SO_SNDBUF"><span class="constructor">SO_SNDBUF</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Size of send buffer</td><td class="typefieldcomment" 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 id="TYPEELTsocket_int_option.SO_RCVBUF"><span class="constructor">SO_RCVBUF</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Size of received buffer</td><td class="typefieldcomment" 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 id="TYPEELTsocket_int_option.SO_ERROR"><span class="constructor">SO_ERROR</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Deprecated. Use <code class="code"><span class="constructor">Unix</span>.getsockopt_error</code> instead.</td><td class="typefieldcomment" 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 id="TYPEELTsocket_int_option.SO_TYPE"><span class="constructor">SO_TYPE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Report the socket type</td><td class="typefieldcomment" 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 id="TYPEELTsocket_int_option.SO_RCVLOWAT"><span class="constructor">SO_RCVLOWAT</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Minimum number of bytes to process for input operations</td><td class="typefieldcomment" 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 id="TYPEELTsocket_int_option.SO_SNDLOWAT"><span class="constructor">SO_SNDLOWAT</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Minimum number of bytes to process for output
operations</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
The socket options that can be consulted with <code class="code"><span class="constructor">Unix</span>.getsockopt_int</code>
and modified with <code class="code"><span class="constructor">Unix</span>.setsockopt_int</code>. These options have an
integer value.<br>
</div>
<pre><span id="TYPEsocket_optint_option"><span class="keyword">type</span> <code class="type"></code>socket_optint_option</span> = <code class="type">Unix.socket_optint_option</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsocket_optint_option.SO_LINGER"><span class="constructor">SO_LINGER</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Whether to linger on closed connections
that have data present, and for how long
(in seconds)</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
The socket options that can be consulted with <code class="code"><span class="constructor">Unix</span>.getsockopt_optint</code>
and modified with <code class="code"><span class="constructor">Unix</span>.setsockopt_optint</code>. 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>
<pre><span id="TYPEsocket_float_option"><span class="keyword">type</span> <code class="type"></code>socket_float_option</span> = <code class="type">Unix.socket_float_option</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsocket_float_option.SO_RCVTIMEO"><span class="constructor">SO_RCVTIMEO</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Timeout for input operations</td><td class="typefieldcomment" 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 id="TYPEELTsocket_float_option.SO_SNDTIMEO"><span class="constructor">SO_SNDTIMEO</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Timeout for output operations</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
The socket options that can be consulted with <code class="code"><span class="constructor">Unix</span>.getsockopt_float</code>
and modified with <code class="code"><span class="constructor">Unix</span>.setsockopt_float</code>. These options have a
floating-point value representing a time in seconds.
The value 0 means infinite timeout.<br>
</div>
<pre><span id="VALgetsockopt"><span class="keyword">val</span> getsockopt</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.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 id="VALsetsockopt"><span class="keyword">val</span> setsockopt</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.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 id="VALgetsockopt_int"><span class="keyword">val</span> getsockopt_int</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEsocket_int_option">socket_int_option</a> -> int</code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.getsockopt</code> for an integer-valued socket option.<br>
</div>
<pre><span id="VALsetsockopt_int"><span class="keyword">val</span> setsockopt_int</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEsocket_int_option">socket_int_option</a> -> int -> unit</code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.setsockopt</code> for an integer-valued socket option.<br>
</div>
<pre><span id="VALgetsockopt_optint"><span class="keyword">val</span> getsockopt_optint</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEsocket_optint_option">socket_optint_option</a> -> int option</code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.getsockopt</code> for a socket option whose value is an
<code class="code">int option</code>.<br>
</div>
<pre><span id="VALsetsockopt_optint"><span class="keyword">val</span> setsockopt_optint</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEsocket_optint_option">socket_optint_option</a> -> int option -> unit</code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.setsockopt</code> for a socket option whose value is an
<code class="code">int option</code>.<br>
</div>
<pre><span id="VALgetsockopt_float"><span class="keyword">val</span> getsockopt_float</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEsocket_float_option">socket_float_option</a> -> float</code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.getsockopt</code> for a socket option whose value is a
floating-point number.<br>
</div>
<pre><span id="VALsetsockopt_float"><span class="keyword">val</span> setsockopt_float</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEsocket_float_option">socket_float_option</a> -> float -> unit</code></pre><div class="info ">
Same as <code class="code"><span class="constructor">Unix</span>.setsockopt</code> for a socket option whose value is a
floating-point number.<br>
</div>
<pre><span id="VALgetsockopt_error"><span class="keyword">val</span> getsockopt_error</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEerror">error</a> option</code></pre><div class="info ">
Return the error condition associated with the given socket,
and clear it.<br>
</div>
<br>
<h6 id="6_Highlevelnetworkconnectionfunctions">High-level network connection functions</h6><br>
<pre><span id="VALopen_connection"><span class="keyword">val</span> open_connection</span> : <code class="type">?autoclose:bool -><br> <a href="BatUnix.html#TYPEsockaddr">sockaddr</a> -> <a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a> * unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a></code></pre><div class="info ">
Connect to a server at the given address.
Return a pair of input/output connected to the server. The
connection is closed whenever either the input or the output
is closed.
<p>
Remember to call <code class="code"><span class="constructor">Pervasives</span>.flush</code> on the output at the right
times to ensure correct synchronization.<br>
</div>
<div class="param_info"><code class="code">autoclose</code> : If true (default value), close the input
automatically once there is no more content to read. Otherwise,
the input will be closed according to the usual rules of module
<a href="BatIO.html"><code class="code"><span class="constructor">BatIO</span></code></a>. Barring very specific needs (e.g. using file descriptors as
locks), you probably want <code class="code">autoclose</code> to be <code class="code"><span class="keyword">true</span></code>.</div>
<pre><span id="VALshutdown_connection"><span class="keyword">val</span> shutdown_connection</span> : <code class="type"><a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a> -> unit</code></pre><div class="info ">
<span class="warning">Deprecated.</span>Connections do not require a special function anymore.
Use regular function <a href="BatIO.html#VALclose_in"><code class="code"><span class="constructor">BatIO</span>.close_in</code></a> for closing connections.<br>
``Shut down'' a connection established with <code class="code"><span class="constructor">Unix</span>.open_connection</code>;
that is, transmit an end-of-file condition to the server reading
on the other side of the connection.<br>
</div>
<pre><span id="VALestablish_server"><span class="keyword">val</span> establish_server</span> : <code class="type">?autoclose:bool -><br> ?cleanup:bool -><br> (<a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a> -> unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a> -> unit) -><br> <a href="BatUnix.html#TYPEsockaddr">sockaddr</a> -> unit</code></pre><div class="info ">
Establish a server on the given address.
<p>
<code class="code">establish_server f addr</code> establishes a server on address
<code class="code">addr</code>. For each connection on this address, function <code class="code">f</code> is
called with two buffered channels connected to the client. A new
process is created for each connection. The function
<code class="code"><span class="constructor">Unix</span>.establish_server</code> never returns normally.<br>
</div>
<div class="param_info"><code class="code">autoclose</code> : If true (default value), inputs passed to <code class="code">f</code>
close the input automatically once there is no more content to
read. Otherwise, the input will be closed according to the usual
rules of module <a href="BatIO.html"><code class="code"><span class="constructor">BatIO</span></code></a>. Barring very specific needs (e.g. using
file descriptors as locks), you probably want <code class="code">autoclose</code> to be
<code class="code"><span class="keyword">true</span></code>.</div>
<div class="param_info"><code class="code">cleanup</code> : If true or unspecified, close the connection when
the <code class="code">input</code> or the <code class="code">output</code> is closed or
garbage-collected. If false, do nothing, in which case you will
need to shutdown the connection using <a href="BatUnix.html#VALshutdown_connection"><code class="code"><span class="constructor">BatUnix</span>.shutdown_connection</code></a> to
ensure proper cleanup.</div>
<br>
<h6 id="6_Hostandprotocoldatabases">Host and protocol databases</h6><br>
<pre><span id="TYPEhost_entry"><span class="keyword">type</span> <code class="type"></code>host_entry</span> = <code class="type">Unix.host_entry</code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELThost_entry.h_name">h_name</span> : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELThost_entry.h_aliases">h_aliases</span> : <code class="type">string array</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELThost_entry.h_addrtype">h_addrtype</span> : <code class="type"><a href="BatUnix.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><span id="TYPEELThost_entry.h_addr_list">h_addr_list</span> : <code class="type"><a href="BatUnix.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>
<pre><span id="TYPEprotocol_entry"><span class="keyword">type</span> <code class="type"></code>protocol_entry</span> = <code class="type">Unix.protocol_entry</code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprotocol_entry.p_name">p_name</span> : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprotocol_entry.p_aliases">p_aliases</span> : <code class="type">string array</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprotocol_entry.p_proto">p_proto</span> : <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>
<pre><span id="TYPEservice_entry"><span class="keyword">type</span> <code class="type"></code>service_entry</span> = <code class="type">Unix.service_entry</code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTservice_entry.s_name">s_name</span> : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTservice_entry.s_aliases">s_aliases</span> : <code class="type">string array</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTservice_entry.s_port">s_port</span> : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTservice_entry.s_proto">s_proto</span> : <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>
<pre><span id="VALgethostname"><span class="keyword">val</span> gethostname</span> : <code class="type">unit -> string</code></pre><div class="info ">
Return the name of the local host.<br>
</div>
<pre><span id="VALgethostbyname"><span class="keyword">val</span> gethostbyname</span> : <code class="type">string -> <a href="BatUnix.html#TYPEhost_entry">host_entry</a></code></pre><div class="info ">
Find an entry in <code class="code">hosts</code> with the given name.<br>
<b>Raises</b> <code>Not_found</code> if no such entry can be found.<br>
</div>
<pre><span id="VALgethostbyaddr"><span class="keyword">val</span> gethostbyaddr</span> : <code class="type"><a href="BatUnix.html#TYPEinet_addr">inet_addr</a> -> <a href="BatUnix.html#TYPEhost_entry">host_entry</a></code></pre><div class="info ">
Find an entry in <code class="code">hosts</code> with the given address.<br>
<b>Raises</b> <code>Not_found</code> if no such entry can be found.<br>
</div>
<pre><span id="VALgetprotobyname"><span class="keyword">val</span> getprotobyname</span> : <code class="type">string -> <a href="BatUnix.html#TYPEprotocol_entry">protocol_entry</a></code></pre><div class="info ">
Find an entry in <code class="code">protocols</code> with the given name<br>
<b>Raises</b> <code>Not_found</code> if no such entry can be found.<br>
</div>
<pre><span id="VALgetprotobynumber"><span class="keyword">val</span> getprotobynumber</span> : <code class="type">int -> <a href="BatUnix.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.<br>
<b>Raises</b> <code>Not_found</code> if no such entry can be found.<br>
</div>
<pre><span id="VALgetservbyname"><span class="keyword">val</span> getservbyname</span> : <code class="type">string -> string -> <a href="BatUnix.html#TYPEservice_entry">service_entry</a></code></pre><div class="info ">
Find an entry in <code class="code">services</code> with the given name.<br>
<b>Raises</b> <code>Not_found</code> if no such entry can be found.<br>
</div>
<pre><span id="VALgetservbyport"><span class="keyword">val</span> getservbyport</span> : <code class="type">int -> string -> <a href="BatUnix.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.<br>
<b>Raises</b> <code>Not_found</code> if no such entry can be found.<br>
</div>
<pre><span id="TYPEaddr_info"><span class="keyword">type</span> <code class="type"></code>addr_info</span> = <code class="type">Unix.addr_info</code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTaddr_info.ai_family">ai_family</span> : <code class="type"><a href="BatUnix.html#TYPEsocket_domain">socket_domain</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Socket domain</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTaddr_info.ai_socktype">ai_socktype</span> : <code class="type"><a href="BatUnix.html#TYPEsocket_type">socket_type</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Socket type</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTaddr_info.ai_protocol">ai_protocol</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Socket protocol number</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTaddr_info.ai_addr">ai_addr</span> : <code class="type"><a href="BatUnix.html#TYPEsockaddr">sockaddr</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Address</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTaddr_info.ai_canonname">ai_canonname</span> : <code class="type">string</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Canonical host name</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info ">
Address information returned by <code class="code"><span class="constructor">Unix</span>.getaddrinfo</code>.<br>
</div>
<pre><span id="TYPEgetaddrinfo_option"><span class="keyword">type</span> <code class="type"></code>getaddrinfo_option</span> = <code class="type">Unix.getaddrinfo_option</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTgetaddrinfo_option.AI_FAMILY"><span class="constructor">AI_FAMILY</span></span> <span class="keyword">of</span> <code class="type"><a href="BatUnix.html#TYPEsocket_domain">socket_domain</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Impose the given socket domain</td><td class="typefieldcomment" 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 id="TYPEELTgetaddrinfo_option.AI_SOCKTYPE"><span class="constructor">AI_SOCKTYPE</span></span> <span class="keyword">of</span> <code class="type"><a href="BatUnix.html#TYPEsocket_type">socket_type</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Impose the given socket type</td><td class="typefieldcomment" 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 id="TYPEELTgetaddrinfo_option.AI_PROTOCOL"><span class="constructor">AI_PROTOCOL</span></span> <span class="keyword">of</span> <code class="type">int</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Impose the given protocol</td><td class="typefieldcomment" 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 id="TYPEELTgetaddrinfo_option.AI_NUMERICHOST"><span class="constructor">AI_NUMERICHOST</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Do not call name resolver,
expect numeric IP address</td><td class="typefieldcomment" 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 id="TYPEELTgetaddrinfo_option.AI_CANONNAME"><span class="constructor">AI_CANONNAME</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Fill the <code class="code">ai_canonname</code> field
of the result</td><td class="typefieldcomment" 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 id="TYPEELTgetaddrinfo_option.AI_PASSIVE"><span class="constructor">AI_PASSIVE</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Set address to ``any'' address
for use with <code class="code"><span class="constructor">Unix</span>.bind</code></td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
Options to <code class="code"><span class="constructor">Unix</span>.getaddrinfo</code>.<br>
</div>
<pre><span id="VALgetaddrinfo"><span class="keyword">val</span> getaddrinfo</span> : <code class="type">string -> string -> <a href="BatUnix.html#TYPEgetaddrinfo_option">getaddrinfo_option</a> list -> <a href="BatUnix.html#TYPEaddr_info">addr_info</a> list</code></pre><div class="info ">
<code class="code">getaddrinfo host service opts</code> returns a list of <code class="code"><span class="constructor">Unix</span>.addr_info</code>
records describing socket parameters and addresses suitable for
communicating with the given host and service. The empty list is
returned if the host or service names are unknown, or the constraints
expressed in <code class="code">opts</code> cannot be satisfied.
<p>
<code class="code">host</code> is either a host name or the string representation of an IP
address. <code class="code">host</code> can be given as the empty string; in this case,
the ``any'' address or the ``loopback'' address are used,
depending whether <code class="code">opts</code> contains <code class="code"><span class="constructor">AI_PASSIVE</span></code>.
<code class="code">service</code> is either a service name or the string representation of
a port number. <code class="code">service</code> can be given as the empty string;
in this case, the port field of the returned addresses is set to 0.
<code class="code">opts</code> is a possibly empty list of options that allows the caller
to force a particular socket domain (e.g. IPv6 only or IPv4 only)
or a particular socket type (e.g. TCP only or UDP only).<br>
</div>
<pre><span id="TYPEname_info"><span class="keyword">type</span> <code class="type"></code>name_info</span> = <code class="type">Unix.name_info</code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTname_info.ni_hostname">ni_hostname</span> : <code class="type">string</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Name or IP address of host</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTname_info.ni_service">ni_service</span> : <code class="type">string</code>;</code></td>
</tr></table>
}
<div class="info ">
Name of service or port number<br>
</div>
<br>
Host and service information returned by <code class="code"><span class="constructor">Unix</span>.getnameinfo</code>.<br>
<pre><span id="TYPEgetnameinfo_option"><span class="keyword">type</span> <code class="type"></code>getnameinfo_option</span> = <code class="type">Unix.getnameinfo_option</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTgetnameinfo_option.NI_NOFQDN"><span class="constructor">NI_NOFQDN</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Do not qualify local host names</td><td class="typefieldcomment" 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 id="TYPEELTgetnameinfo_option.NI_NUMERICHOST"><span class="constructor">NI_NUMERICHOST</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Always return host as IP address</td><td class="typefieldcomment" 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 id="TYPEELTgetnameinfo_option.NI_NAMEREQD"><span class="constructor">NI_NAMEREQD</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Fail if host name cannot be determined</td><td class="typefieldcomment" 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 id="TYPEELTgetnameinfo_option.NI_NUMERICSERV"><span class="constructor">NI_NUMERICSERV</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Always return service as port number</td><td class="typefieldcomment" 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 id="TYPEELTgetnameinfo_option.NI_DGRAM"><span class="constructor">NI_DGRAM</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Consider the service as UDP-based
instead of the default TCP</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
Options to <code class="code"><span class="constructor">Unix</span>.getnameinfo</code>.<br>
</div>
<pre><span id="VALgetnameinfo"><span class="keyword">val</span> getnameinfo</span> : <code class="type"><a href="BatUnix.html#TYPEsockaddr">sockaddr</a> -> <a href="BatUnix.html#TYPEgetnameinfo_option">getnameinfo_option</a> list -> <a href="BatUnix.html#TYPEname_info">name_info</a></code></pre><div class="info ">
<code class="code">getnameinfo addr opts</code> returns the host name and service name
corresponding to the socket address <code class="code">addr</code>. <code class="code">opts</code> is a possibly
empty list of options that governs how these names are obtained.<br>
<b>Raises</b> <code>Not_found</code> if an error occurs.<br>
</div>
<br>
<h6 id="6_Terminalinterface">Terminal interface</h6><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>
<pre><span id="TYPEterminal_io"><span class="keyword">type</span> <code class="type"></code>terminal_io</span> = <code class="type">Unix.terminal_io</code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span><span id="TYPEELTterminal_io.c_ignbrk">c_ignbrk</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Ignore the break condition.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_brkint">c_brkint</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Signal interrupt on break condition.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_ignpar">c_ignpar</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Ignore characters with parity errors.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_parmrk">c_parmrk</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Mark parity errors.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_inpck">c_inpck</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Enable parity check on input.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_istrip">c_istrip</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Strip 8th bit on input characters.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_inlcr">c_inlcr</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Map NL to CR on input.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_igncr">c_igncr</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Ignore CR on input.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_icrnl">c_icrnl</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Map CR to NL on input.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_ixon">c_ixon</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Recognize XON/XOFF characters on input.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_ixoff">c_ixoff</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Emit XON/XOFF chars to control input flow.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_opost">c_opost</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Enable output processing.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_obaud">c_obaud</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Output baud rate (0 means close connection).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_ibaud">c_ibaud</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Input baud rate.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_csize">c_csize</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Number of bits per character (5-8).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_cstopb">c_cstopb</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Number of stop bits (1-2).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_cread">c_cread</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Reception is enabled.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_parenb">c_parenb</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Enable parity generation and detection.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_parodd">c_parodd</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Specify odd parity instead of even.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_hupcl">c_hupcl</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Hang up on last close.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_clocal">c_clocal</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Ignore modem status lines.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_isig">c_isig</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Generate signal on INTR, QUIT, SUSP.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_icanon">c_icanon</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Enable canonical processing
(line buffering and editing)</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_noflsh">c_noflsh</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Disable flush after INTR, QUIT, SUSP.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_echo">c_echo</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Echo input characters.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_echoe">c_echoe</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Echo ERASE (to erase previous character).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_echok">c_echok</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Echo KILL (to erase the current line).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_echonl">c_echonl</span> : <code class="type">bool</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Echo NL even if c_echo is not set.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_vintr">c_vintr</span> : <code class="type">char</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Interrupt character (usually ctrl-C).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_vquit">c_vquit</span> : <code class="type">char</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Quit character (usually ctrl-\).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_verase">c_verase</span> : <code class="type">char</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Erase character (usually DEL or ctrl-H).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_vkill">c_vkill</span> : <code class="type">char</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Kill line character (usually ctrl-U).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_veof">c_veof</span> : <code class="type">char</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >End-of-file character (usually ctrl-D).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_veol">c_veol</span> : <code class="type">char</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Alternate end-of-line char. (usually none).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_vmin">c_vmin</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Minimum number of characters to read
before the read request is satisfied.</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_vtime">c_vtime</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Maximum read wait (in 0.1s units).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_vstart">c_vstart</span> : <code class="type">char</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Start character (usually ctrl-Q).</td><td class="typefieldcomment" 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><span id="TYPEELTterminal_io.c_vstop">c_vstop</span> : <code class="type">char</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Stop character (usually ctrl-S).</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<pre><span id="VALtcgetattr"><span class="keyword">val</span> tcgetattr</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.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>
<pre><span id="TYPEsetattr_when"><span class="keyword">type</span> <code class="type"></code>setattr_when</span> = <code class="type">Unix.setattr_when</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsetattr_when.TCSANOW"><span class="constructor">TCSANOW</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsetattr_when.TCSADRAIN"><span class="constructor">TCSADRAIN</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsetattr_when.TCSAFLUSH"><span class="constructor">TCSAFLUSH</span></span></code></td>
</tr></table>
<pre><span id="VALtcsetattr"><span class="keyword">val</span> tcsetattr</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.html#TYPEsetattr_when">setattr_when</a> -> <a href="BatUnix.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 id="VALtcsendbreak"><span class="keyword">val</span> tcsendbreak</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> 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 id="VALtcdrain"><span class="keyword">val</span> tcdrain</span> : <code class="type"><a href="BatUnix.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>
<pre><span id="TYPEflush_queue"><span class="keyword">type</span> <code class="type"></code>flush_queue</span> = <code class="type">Unix.flush_queue</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTflush_queue.TCIFLUSH"><span class="constructor">TCIFLUSH</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTflush_queue.TCOFLUSH"><span class="constructor">TCOFLUSH</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTflush_queue.TCIOFLUSH"><span class="constructor">TCIOFLUSH</span></span></code></td>
</tr></table>
<pre><span id="VALtcflush"><span class="keyword">val</span> tcflush</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.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>
<pre><span id="TYPEflow_action"><span class="keyword">type</span> <code class="type"></code>flow_action</span> = <code class="type">Unix.flow_action</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTflow_action.TCOOFF"><span class="constructor">TCOOFF</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTflow_action.TCOON"><span class="constructor">TCOON</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTflow_action.TCIOFF"><span class="constructor">TCIOFF</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTflow_action.TCION"><span class="constructor">TCION</span></span></code></td>
</tr></table>
<pre><span id="VALtcflow"><span class="keyword">val</span> tcflow</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatUnix.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 id="VALsetsid"><span class="keyword">val</span> setsid</span> : <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>
<br>
<h6 id="6_Smalltools">Small tools</h6><br>
<pre><span id="VALis_directory"><span class="keyword">val</span> is_directory</span> : <code class="type">string -> bool</code></pre><div class="info ">
<code class="code">is_directory filename</code> returns true if <code class="code">filename</code> refers to a directory (or symlink of a directory)<br>
</div>
<pre><span id="VALrestart_on_EINTR"><span class="keyword">val</span> restart_on_EINTR</span> : <code class="type">('a -> 'b) -> 'a -> 'b</code></pre><div class="info ">
<code class="code">restart_on_EINTR f x</code> invokes <code class="code">f</code> on <code class="code">x</code> repetedly until the function returns
a value or raises another exception than EINTR.<br>
</div>
<br>
<h6 id="6_Threadsafetyinternals">Thread-safety internals</h6>
<p>
Unless you are attempting to adapt Batteries Included to a new model of
concurrency, you probably won't need this.<br>
<pre><span id="VALlock"><span class="keyword">val</span> lock</span> : <code class="type"><a href="BatConcurrent.html#TYPElock">BatConcurrent.lock</a> Pervasives.ref</code></pre><div class="info ">
A lock used to synchronize internal operations.
<p>
By default, this is <a href="BatConcurrent.html#VALnolock"><code class="code"><span class="constructor">BatConcurrent</span>.nolock</code></a>. However, if you're
using a version of Batteries compiled in threaded mode, this uses
<a href="BatMutex.html"><code class="code"><span class="constructor">BatMutex</span></code></a>. If you're attempting to use Batteries with another
concurrency model, set the lock appropriately.<br>
</div>
<br>
<h6 id="6_Obsoletestuff">Obsolete stuff</h6><br>
<pre><span id="VALin_channel_of_descr"><span class="keyword">val</span> in_channel_of_descr</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> <a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a></code></pre><div class="info ">
<span class="warning">Deprecated.</span>use <a href="BatUnix.html#VALinput_of_descr"><code class="code"><span class="constructor">BatUnix</span>.input_of_descr</code></a><br>
</div>
<pre><span id="VALout_channel_of_descr"><span class="keyword">val</span> out_channel_of_descr</span> : <code class="type"><a href="BatUnix.html#TYPEfile_descr">file_descr</a> -> unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a></code></pre><div class="info ">
<span class="warning">Deprecated.</span>use <a href="BatUnix.html#VALoutput_of_descr"><code class="code"><span class="constructor">BatUnix</span>.output_of_descr</code></a>.<br>
</div>
<pre><span id="VALdescr_of_in_channel"><span class="keyword">val</span> descr_of_in_channel</span> : <code class="type"><a href="BatInnerIO.html#TYPEinput">BatInnerIO.input</a> -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a></code></pre><div class="info ">
<span class="warning">Deprecated.</span>use <a href="BatUnix.html#VALdescr_of_input"><code class="code"><span class="constructor">BatUnix</span>.descr_of_input</code></a>.<br>
</div>
<pre><span id="VALdescr_of_out_channel"><span class="keyword">val</span> descr_of_out_channel</span> : <code class="type">unit <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a> -> <a href="BatUnix.html#TYPEfile_descr">file_descr</a></code></pre><div class="info ">
<span class="warning">Deprecated.</span>use <a href="BatUnix.html#VALdescr_of_output"><code class="code"><span class="constructor">BatUnix</span>.descr_of_output</code></a>.<br>
</div>
</body></html>
