<!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="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="Augeas" rel="Chapter" href="Augeas.html"><title>Augeas</title>
</head>
<body>
<div class="navbar"> <a href="index.html">Up</a>
</div>
<center><h1>Module <a href="type_Augeas.html">Augeas</a></h1></center>
<br>
<pre><span class="keyword">module</span> Augeas: <code class="code">sig</code> <a href="Augeas.html">..</a> <code class="code">end</code></pre>Augeas OCaml bindings<br>
<hr width="100%">
<pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t </pre>
<div class="info">
Augeas library handle.<br>
</div>
<pre><span class="keyword">exception</span> <a name="EXCEPTIONError"></a>Error <span class="keyword">of</span> <code class="type">string</code></pre>
<div class="info">
This exception is thrown when the underlying Augeas library
returns an error.<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEflag"></a><code class="type"></code>flag = </code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">AugSaveBackup</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Rename original with .augsave</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 class="constructor">AugSaveNewFile</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Save changes to .augnew</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 class="constructor">AugTypeCheck</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Type-check lenses</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Flags passed to the <a href="Augeas.html#VALcreate"><code class="code">Augeas.create</code></a> function.<br>
</div>
<pre><span class="keyword">type</span> <a name="TYPEpath"></a><code class="type"></code>path = <code class="type">string</code> </pre>
<div class="info">
A path expression.
<p>
Note in future we may replace this with a type-safe path constructor.<br>
</div>
<pre><span class="keyword">type</span> <a name="TYPEvalue"></a><code class="type"></code>value = <code class="type">string</code> </pre>
<div class="info">
A value.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcreate"></a>create : <code class="type">string -> string option -> <a href="Augeas.html#TYPEflag">flag</a> list -> <a href="Augeas.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">create root loadpath flags</code> creates an Augeas handle.
<p>
<code class="code">root</code> is a file system path describing the location
of the configuration files.
<p>
<code class="code">loadpath</code> is an optional colon-separated list of directories
which are searched for schema definitions.
<p>
<code class="code">flags</code> is a list of flags.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALclose"></a>close : <code class="type"><a href="Augeas.html#TYPEt">t</a> -> unit</code></pre><div class="info">
<code class="code">close handle</code> closes the handle.
<p>
You don't need to close handles explicitly with this function:
they will be finalized eventually by the garbage collector.
However calling this function frees up any resources used by the
underlying Augeas library immediately.
<p>
Do not use the handle after closing it.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALget"></a>get : <code class="type"><a href="Augeas.html#TYPEt">t</a> -> <a href="Augeas.html#TYPEpath">path</a> -> <a href="Augeas.html#TYPEvalue">value</a> option</code></pre><div class="info">
<code class="code">get t path</code> returns the value at <code class="code">path</code>, or <code class="code">None</code> if there
is no value.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALexists"></a>exists : <code class="type"><a href="Augeas.html#TYPEt">t</a> -> <a href="Augeas.html#TYPEpath">path</a> -> bool</code></pre><div class="info">
<code class="code">exists t path</code> returns true iff there is a value at <code class="code">path</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALinsert"></a>insert : <code class="type"><a href="Augeas.html#TYPEt">t</a> -> ?before:bool -> <a href="Augeas.html#TYPEpath">path</a> -> string -> unit</code></pre><div class="info">
<code class="code">insert t ?before path label</code> inserts <code class="code">label</code> as a sibling
of <code class="code">path</code>. By default it is inserted after <code class="code">path</code>, unless
<code class="code">~before:true</code> is specified.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALrm"></a>rm : <code class="type"><a href="Augeas.html#TYPEt">t</a> -> <a href="Augeas.html#TYPEpath">path</a> -> int</code></pre><div class="info">
<code class="code">rm t path</code> removes all nodes matching <code class="code">path</code>.
<p>
Returns the number of nodes removed (which may be 0).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALmatches"></a>matches : <code class="type"><a href="Augeas.html#TYPEt">t</a> -> <a href="Augeas.html#TYPEpath">path</a> -> <a href="Augeas.html#TYPEpath">path</a> list</code></pre><div class="info">
<code class="code">matches t path</code> returns a list of path expressions
of all nodes matching <code class="code">path</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcount_matches"></a>count_matches : <code class="type"><a href="Augeas.html#TYPEt">t</a> -> <a href="Augeas.html#TYPEpath">path</a> -> int</code></pre><div class="info">
<code class="code">count_matches t path</code> counts the number of nodes matching
<code class="code">path</code> but does not return them (see <a href="Augeas.html#VALmatches"><code class="code">Augeas.matches</code></a>).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsave"></a>save : <code class="type"><a href="Augeas.html#TYPEt">t</a> -> unit</code></pre><div class="info">
<code class="code">save t</code> saves all pending changes to disk.<br>
</div>
</body></html>
