<!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="Event.html">
<link rel="next" href="Format.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Arg" rel="Chapter" href="Arg.html">
<link title="Arith_status" rel="Chapter" href="Arith_status.html">
<link title="Array" rel="Chapter" href="Array.html">
<link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html">
<link title="Big_int" rel="Chapter" href="Big_int.html">
<link title="Bigarray" rel="Chapter" href="Bigarray.html">
<link title="Buffer" rel="Chapter" href="Buffer.html">
<link title="Callback" rel="Chapter" href="Callback.html">
<link title="CamlinternalLazy" rel="Chapter" href="CamlinternalLazy.html">
<link title="CamlinternalMod" rel="Chapter" href="CamlinternalMod.html">
<link title="CamlinternalOO" rel="Chapter" href="CamlinternalOO.html">
<link title="Char" rel="Chapter" href="Char.html">
<link title="Complex" rel="Chapter" href="Complex.html">
<link title="Condition" rel="Chapter" href="Condition.html">
<link title="Digest" rel="Chapter" href="Digest.html">
<link title="Dynlink" rel="Chapter" href="Dynlink.html">
<link title="Event" rel="Chapter" href="Event.html">
<link title="Filename" rel="Chapter" href="Filename.html">
<link title="Format" rel="Chapter" href="Format.html">
<link title="Gc" rel="Chapter" href="Gc.html">
<link title="Genlex" rel="Chapter" href="Genlex.html">
<link title="Graphics" rel="Chapter" href="Graphics.html">
<link title="GraphicsX11" rel="Chapter" href="GraphicsX11.html">
<link title="Hashtbl" rel="Chapter" href="Hashtbl.html">
<link title="Int32" rel="Chapter" href="Int32.html">
<link title="Int64" rel="Chapter" href="Int64.html">
<link title="Lazy" rel="Chapter" href="Lazy.html">
<link title="Lexing" rel="Chapter" href="Lexing.html">
<link title="List" rel="Chapter" href="List.html">
<link title="ListLabels" rel="Chapter" href="ListLabels.html">
<link title="Map" rel="Chapter" href="Map.html">
<link title="Marshal" rel="Chapter" href="Marshal.html">
<link title="MoreLabels" rel="Chapter" href="MoreLabels.html">
<link title="Mutex" rel="Chapter" href="Mutex.html">
<link title="Nativeint" rel="Chapter" href="Nativeint.html">
<link title="Num" rel="Chapter" href="Num.html">
<link title="Obj" rel="Chapter" href="Obj.html">
<link title="Oo" rel="Chapter" href="Oo.html">
<link title="Parsing" rel="Chapter" href="Parsing.html">
<link title="Pervasives" rel="Chapter" href="Pervasives.html">
<link title="Printexc" rel="Chapter" href="Printexc.html">
<link title="Printf" rel="Chapter" href="Printf.html">
<link title="Queue" rel="Chapter" href="Queue.html">
<link title="Random" rel="Chapter" href="Random.html">
<link title="Ratio" rel="Chapter" href="Ratio.html">
<link title="Scanf" rel="Chapter" href="Scanf.html">
<link title="Set" rel="Chapter" href="Set.html">
<link title="Sort" rel="Chapter" href="Sort.html">
<link title="Stack" rel="Chapter" href="Stack.html">
<link title="StdLabels" rel="Chapter" href="StdLabels.html">
<link title="Str" rel="Chapter" href="Str.html">
<link title="Stream" rel="Chapter" href="Stream.html">
<link title="String" rel="Chapter" href="String.html">
<link title="StringLabels" rel="Chapter" href="StringLabels.html">
<link title="Sys" rel="Chapter" href="Sys.html">
<link title="Thread" rel="Chapter" href="Thread.html">
<link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html">
<link title="Tk" rel="Chapter" href="Tk.html">
<link title="Unix" rel="Chapter" href="Unix.html">
<link title="UnixLabels" rel="Chapter" href="UnixLabels.html">
<link title="Weak" rel="Chapter" href="Weak.html"><title>Filename</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Event.html" title="Event">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Format.html" title="Format">Next</a>
</div>
<h1>Module <a href="type_Filename.html">Filename</a></h1>
<pre><span class="keyword">module</span> Filename: <code class="code"><span class="keyword">sig</span></code> <a href="Filename.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
Operations on file names.<br>
</div>
<hr width="100%">
<pre><span id="VALcurrent_dir_name"><span class="keyword">val</span> current_dir_name</span> : <code class="type">string</code></pre><div class="info ">
The conventional name for the current directory (e.g. <code class="code">.</code> in Unix).<br>
</div>
<pre><span id="VALparent_dir_name"><span class="keyword">val</span> parent_dir_name</span> : <code class="type">string</code></pre><div class="info ">
The conventional name for the parent of the current directory
(e.g. <code class="code">..</code> in Unix).<br>
</div>
<pre><span id="VALdir_sep"><span class="keyword">val</span> dir_sep</span> : <code class="type">string</code></pre><div class="info ">
The directory separator (e.g. <code class="code">/</code> in Unix).<br>
<b>Since</b> 3.11.2<br>
</div>
<pre><span id="VALconcat"><span class="keyword">val</span> concat</span> : <code class="type">string -> string -> string</code></pre><div class="info ">
<code class="code">concat dir file</code> returns a file name that designates file
<code class="code">file</code> in directory <code class="code">dir</code>.<br>
</div>
<pre><span id="VALis_relative"><span class="keyword">val</span> is_relative</span> : <code class="type">string -> bool</code></pre><div class="info ">
Return <code class="code"><span class="keyword">true</span></code> if the file name is relative to the current
directory, <code class="code"><span class="keyword">false</span></code> if it is absolute (i.e. in Unix, starts
with <code class="code">/</code>).<br>
</div>
<pre><span id="VALis_implicit"><span class="keyword">val</span> is_implicit</span> : <code class="type">string -> bool</code></pre><div class="info ">
Return <code class="code"><span class="keyword">true</span></code> if the file name is relative and does not start
with an explicit reference to the current directory (<code class="code">./</code> or
<code class="code">../</code> in Unix), <code class="code"><span class="keyword">false</span></code> if it starts with an explicit reference
to the root directory or the current directory.<br>
</div>
<pre><span id="VALcheck_suffix"><span class="keyword">val</span> check_suffix</span> : <code class="type">string -> string -> bool</code></pre><div class="info ">
<code class="code">check_suffix name suff</code> returns <code class="code"><span class="keyword">true</span></code> if the filename <code class="code">name</code>
ends with the suffix <code class="code">suff</code>.<br>
</div>
<pre><span id="VALchop_suffix"><span class="keyword">val</span> chop_suffix</span> : <code class="type">string -> string -> string</code></pre><div class="info ">
<code class="code">chop_suffix name suff</code> removes the suffix <code class="code">suff</code> from
the filename <code class="code">name</code>. The behavior is undefined if <code class="code">name</code> does not
end with the suffix <code class="code">suff</code>.<br>
</div>
<pre><span id="VALchop_extension"><span class="keyword">val</span> chop_extension</span> : <code class="type">string -> string</code></pre><div class="info ">
Return the given file name without its extension. The extension
is the shortest suffix starting with a period and not including
a directory separator, <code class="code">.xyz</code> for instance.
<p>
Raise <code class="code"><span class="constructor">Invalid_argument</span></code> if the given name does not contain
an extension.<br>
</div>
<pre><span id="VALbasename"><span class="keyword">val</span> basename</span> : <code class="type">string -> string</code></pre><div class="info ">
Split a file name into directory name / base file name.
If <code class="code">name</code> is a valid file name, then <code class="code">concat (dirname name) (basename name)</code>
returns a file name which is equivalent to <code class="code">name</code>. Moreover,
after setting the current directory to <code class="code">dirname name</code> (with <a href="Sys.html#VALchdir"><code class="code"><span class="constructor">Sys</span>.chdir</code></a>),
references to <code class="code">basename name</code> (which is a relative file name)
designate the same file as <code class="code">name</code> before the call to <a href="Sys.html#VALchdir"><code class="code"><span class="constructor">Sys</span>.chdir</code></a>.
<p>
This function conforms to the specification of POSIX.1-2008 for the
<code class="code">basename</code> utility.<br>
</div>
<pre><span id="VALdirname"><span class="keyword">val</span> dirname</span> : <code class="type">string -> string</code></pre><div class="info ">
See <a href="Filename.html#VALbasename"><code class="code"><span class="constructor">Filename</span>.basename</code></a>.
This function conforms to the specification of POSIX.1-2008 for the
<code class="code">dirname</code> utility.<br>
</div>
<pre><span id="VALtemp_file"><span class="keyword">val</span> temp_file</span> : <code class="type">?temp_dir:string -> string -> string -> string</code></pre><div class="info ">
<code class="code">temp_file prefix suffix</code> returns the name of a
fresh temporary file in the temporary directory.
The base name of the temporary file is formed by concatenating
<code class="code">prefix</code>, then a suitably chosen integer number, then <code class="code">suffix</code>.
The optional argument <code class="code">temp_dir</code> indicates the temporary directory
to use, defaulting to the current result of <a href="Filename.html#VALget_temp_dir_name"><code class="code"><span class="constructor">Filename</span>.get_temp_dir_name</code></a>.
The temporary file is created empty, with permissions <code class="code">0o600</code>
(readable and writable only by the file owner). The file is
guaranteed to be different from any other file that existed when
<code class="code">temp_file</code> was called.
Raise <code class="code"><span class="constructor">Sys_error</span></code> if the file could not be created.<br>
<b>Before 3.11.2 </b> no ?temp_dir optional argument<br>
</div>
<pre><span id="VALopen_temp_file"><span class="keyword">val</span> open_temp_file</span> : <code class="type">?mode:<a href="Pervasives.html#TYPEopen_flag">open_flag</a> list -><br> ?temp_dir:string -> string -> string -> string * <a href="Pervasives.html#TYPEout_channel">out_channel</a></code></pre><div class="info ">
Same as <a href="Filename.html#VALtemp_file"><code class="code"><span class="constructor">Filename</span>.temp_file</code></a>, but returns both the name of a fresh
temporary file, and an output channel opened (atomically) on
this file. This function is more secure than <code class="code">temp_file</code>: there
is no risk that the temporary file will be modified (e.g. replaced
by a symbolic link) before the program opens it. The optional argument
<code class="code">mode</code> is a list of additional flags to control the opening of the file.
It can contain one or several of <code class="code"><span class="constructor">Open_append</span></code>, <code class="code"><span class="constructor">Open_binary</span></code>,
and <code class="code"><span class="constructor">Open_text</span></code>. The default is <code class="code">[<span class="constructor">Open_text</span>]</code> (open in text mode).
Raise <code class="code"><span class="constructor">Sys_error</span></code> if the file could not be opened.<br>
<b>Before 3.11.2 </b> no ?temp_dir optional argument<br>
</div>
<pre><span id="VALget_temp_dir_name"><span class="keyword">val</span> get_temp_dir_name</span> : <code class="type">unit -> string</code></pre><div class="info ">
The name of the temporary directory:
Under Unix, the value of the <code class="code"><span class="constructor">TMPDIR</span></code> environment variable, or "/tmp"
if the variable is not set.
Under Windows, the value of the <code class="code"><span class="constructor">TEMP</span></code> environment variable, or "."
if the variable is not set.
The temporary directory can be changed with <a href="Filename.html#VALset_temp_dir_name"><code class="code"><span class="constructor">Filename</span>.set_temp_dir_name</code></a>.<br>
<b>Since</b> 4.00.0<br>
</div>
<pre><span id="VALset_temp_dir_name"><span class="keyword">val</span> set_temp_dir_name</span> : <code class="type">string -> unit</code></pre><div class="info ">
Change the temporary directory returned by <a href="Filename.html#VALget_temp_dir_name"><code class="code"><span class="constructor">Filename</span>.get_temp_dir_name</code></a>
and used by <a href="Filename.html#VALtemp_file"><code class="code"><span class="constructor">Filename</span>.temp_file</code></a> and <a href="Filename.html#VALopen_temp_file"><code class="code"><span class="constructor">Filename</span>.open_temp_file</code></a>.<br>
<b>Since</b> 4.00.0<br>
</div>
<pre><span id="VALtemp_dir_name"><span class="keyword">val</span> temp_dir_name</span> : <code class="type">string</code></pre><div class="info ">
<span class="warning">Deprecated.</span>The name of the initial temporary directory:
Under Unix, the value of the <code class="code"><span class="constructor">TMPDIR</span></code> environment variable, or "/tmp"
if the variable is not set.
Under Windows, the value of the <code class="code"><span class="constructor">TEMP</span></code> environment variable, or "."
if the variable is not set.
This function is deprecated; <a href="Filename.html#VALget_temp_dir_name"><code class="code"><span class="constructor">Filename</span>.get_temp_dir_name</code></a> should be
used instead.<br>
<b>Since</b> 3.09.1<br>
</div>
<pre><span id="VALquote"><span class="keyword">val</span> quote</span> : <code class="type">string -> string</code></pre><div class="info ">
Return a quoted version of a file name, suitable for use as
one argument in a command line, escaping all meta-characters.
Warning: under Windows, the output is only suitable for use
with programs that follow the standard Windows quoting
conventions.<br>
</div>
</body></html>
