/usr/share/doc/liboasis-ocaml-doc/oasis/BaseSetup.html is in liboasis-ocaml-doc 0.4.5-1build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 | <!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="BaseOCamlcConfig.html">
<link rel="next" href="BaseStandardVar.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="FormatExt" rel="Chapter" href="FormatExt.html">
<link title="ODNFunc" rel="Chapter" href="ODNFunc.html">
<link title="PropList" rel="Chapter" href="PropList.html">
<link title="OASISUtils" rel="Chapter" href="OASISUtils.html">
<link title="OASISUnixPath" rel="Chapter" href="OASISUnixPath.html">
<link title="OASISContext" rel="Chapter" href="OASISContext.html">
<link title="OASISGettext" rel="Chapter" href="OASISGettext.html">
<link title="OASISMessage" rel="Chapter" href="OASISMessage.html">
<link title="OASISText" rel="Chapter" href="OASISText.html">
<link title="OASISTypes" rel="Chapter" href="OASISTypes.html">
<link title="OASISParse" rel="Chapter" href="OASISParse.html">
<link title="OASISValues" rel="Chapter" href="OASISValues.html">
<link title="OASISExpr" rel="Chapter" href="OASISExpr.html">
<link title="OASISVersion" rel="Chapter" href="OASISVersion.html">
<link title="OASISLicense" rel="Chapter" href="OASISLicense.html">
<link title="OASISFileTemplate" rel="Chapter" href="OASISFileTemplate.html">
<link title="OASISBuildSection" rel="Chapter" href="OASISBuildSection.html">
<link title="OASISDocument" rel="Chapter" href="OASISDocument.html">
<link title="OASISExecutable" rel="Chapter" href="OASISExecutable.html">
<link title="OASISFlag" rel="Chapter" href="OASISFlag.html">
<link title="OASISSetupUpdate" rel="Chapter" href="OASISSetupUpdate.html">
<link title="OASISLibrary" rel="Chapter" href="OASISLibrary.html">
<link title="OASISObject" rel="Chapter" href="OASISObject.html">
<link title="OASISPackage" rel="Chapter" href="OASISPackage.html">
<link title="OASISSourceRepository" rel="Chapter" href="OASISSourceRepository.html">
<link title="OASISTest" rel="Chapter" href="OASISTest.html">
<link title="OASISPlugin" rel="Chapter" href="OASISPlugin.html">
<link title="OASISFindlib" rel="Chapter" href="OASISFindlib.html">
<link title="OASISSchema" rel="Chapter" href="OASISSchema.html">
<link title="OASISSection" rel="Chapter" href="OASISSection.html">
<link title="OASISData" rel="Chapter" href="OASISData.html">
<link title="OASISString" rel="Chapter" href="OASISString.html">
<link title="OASISExec" rel="Chapter" href="OASISExec.html">
<link title="OASISFileUtil" rel="Chapter" href="OASISFileUtil.html">
<link title="OASISHostPath" rel="Chapter" href="OASISHostPath.html">
<link title="OASISGraph" rel="Chapter" href="OASISGraph.html">
<link title="OASISFeatures" rel="Chapter" href="OASISFeatures.html">
<link title="BaseArgExt" rel="Chapter" href="BaseArgExt.html">
<link title="BaseBuilt" rel="Chapter" href="BaseBuilt.html">
<link title="BaseCheck" rel="Chapter" href="BaseCheck.html">
<link title="BaseCustom" rel="Chapter" href="BaseCustom.html">
<link title="BaseData" rel="Chapter" href="BaseData.html">
<link title="BaseDoc" rel="Chapter" href="BaseDoc.html">
<link title="BaseEnvLight" rel="Chapter" href="BaseEnvLight.html">
<link title="BaseEnv" rel="Chapter" href="BaseEnv.html">
<link title="BaseFileAB" rel="Chapter" href="BaseFileAB.html">
<link title="BaseGenerate" rel="Chapter" href="BaseGenerate.html">
<link title="BaseLog" rel="Chapter" href="BaseLog.html">
<link title="BaseOCamlcConfig" rel="Chapter" href="BaseOCamlcConfig.html">
<link title="BaseSetup" rel="Chapter" href="BaseSetup.html">
<link title="BaseStandardVar" rel="Chapter" href="BaseStandardVar.html">
<link title="BaseTest" rel="Chapter" href="BaseTest.html">
<link title="BaseDynVar" rel="Chapter" href="BaseDynVar.html">
<link title="BaseMessage" rel="Chapter" href="BaseMessage.html">
<link title="BaseContext" rel="Chapter" href="BaseContext.html">
<link title="CLISubCommand" rel="Chapter" href="CLISubCommand.html">
<link title="CLIArgExt" rel="Chapter" href="CLIArgExt.html">
<link title="CLICommon" rel="Chapter" href="CLICommon.html">
<link title="CLIPager" rel="Chapter" href="CLIPager.html"><title>BaseSetup</title>
</head>
<body>
<div class="navbar"><a class="pre" href="BaseOCamlcConfig.html" title="BaseOCamlcConfig">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="BaseStandardVar.html" title="BaseStandardVar">Next</a>
</div>
<h1>Module <a href="type_BaseSetup.html">BaseSetup</a></h1>
<pre><span class="keyword">module</span> BaseSetup: <code class="code">sig</code> <a href="BaseSetup.html">..</a> <code class="code">end</code></pre><div class="info module top">
Entry points for 'setup.ml'<br>
<b>Author(s):</b> Sylvain Le Gall<br>
</div>
<hr width="100%">
<pre><span id="TYPEstd_args_fun"><span class="keyword">type</span> <code class="type"></code>std_args_fun</span> = <code class="type"><a href="OASISTypes.html#TYPEpackage">OASISTypes.package</a> -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> unit</code> </pre>
<pre><span id="TYPEsection_args_fun"><span class="keyword">type</span> <code class="type">('a, 'b)</code> section_args_fun</span> = <code class="type"><a href="OASISTypes.html#TYPEname">OASISTypes.name</a> *<br> (<a href="OASISTypes.html#TYPEpackage">OASISTypes.package</a> -><br> <a href="OASISTypes.html#TYPEcommon_section">OASISTypes.common_section</a> * 'a -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> 'b)</code> </pre>
<pre><code><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.configure">configure</span> : <code class="type"><a href="BaseSetup.html#TYPEstd_args_fun">std_args_fun</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.build">build</span> : <code class="type"><a href="BaseSetup.html#TYPEstd_args_fun">std_args_fun</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.doc">doc</span> : <code class="type">(<a href="OASISTypes.html#TYPEdoc">OASISTypes.doc</a>, unit) <a href="BaseSetup.html#TYPEsection_args_fun">section_args_fun</a> list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.test">test</span> : <code class="type">(<a href="OASISTypes.html#TYPEtest">OASISTypes.test</a>, float) <a href="BaseSetup.html#TYPEsection_args_fun">section_args_fun</a> list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.install">install</span> : <code class="type"><a href="BaseSetup.html#TYPEstd_args_fun">std_args_fun</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.uninstall">uninstall</span> : <code class="type"><a href="BaseSetup.html#TYPEstd_args_fun">std_args_fun</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.clean">clean</span> : <code class="type"><a href="BaseSetup.html#TYPEstd_args_fun">std_args_fun</a> list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.clean_doc">clean_doc</span> : <code class="type">(<a href="OASISTypes.html#TYPEdoc">OASISTypes.doc</a>, unit) <a href="BaseSetup.html#TYPEsection_args_fun">section_args_fun</a> list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.clean_test">clean_test</span> : <code class="type">(<a href="OASISTypes.html#TYPEtest">OASISTypes.test</a>, unit) <a href="BaseSetup.html#TYPEsection_args_fun">section_args_fun</a> list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.distclean">distclean</span> : <code class="type"><a href="BaseSetup.html#TYPEstd_args_fun">std_args_fun</a> list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.distclean_doc">distclean_doc</span> : <code class="type">(<a href="OASISTypes.html#TYPEdoc">OASISTypes.doc</a>, unit) <a href="BaseSetup.html#TYPEsection_args_fun">section_args_fun</a> list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.distclean_test">distclean_test</span> : <code class="type">(<a href="OASISTypes.html#TYPEtest">OASISTypes.test</a>, unit) <a href="BaseSetup.html#TYPEsection_args_fun">section_args_fun</a> list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.package">package</span> : <code class="type"><a href="OASISTypes.html#TYPEpackage">OASISTypes.package</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.oasis_fn">oasis_fn</span> : <code class="type">string option</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
Filename of _oasis that matches the package field.<br>
</div>
</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="TYPEELTt.oasis_version">oasis_version</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" ><div class="info ">
OASIS version that has generated this structure.<br>
</div>
</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="TYPEELTt.oasis_digest">oasis_digest</span> : <code class="type">Digest.t option</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
Digest of _oasis that matches the package field.<br>
</div>
</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="TYPEELTt.oasis_exec">oasis_exec</span> : <code class="type">string option</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
Name of oasis executable to use, only for testing.<br>
</div>
</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="TYPEELTt.oasis_setup_args">oasis_setup_args</span> : <code class="type">string list</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
Args to use when updating the setup.ml.<br>
</div>
</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="TYPEELTt.setup_update">setup_update</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" ><div class="info ">
Are we allowed to update the setup.ml (eq. of -setup-update weak).<br>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<pre><span id="VALconfigure"><span class="keyword">val</span> configure</span> : <code class="type"><a href="BaseSetup.html#TYPEt">t</a> -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> unit</code></pre><div class="info ">
Run the configure step.<br>
</div>
<pre><span id="VALbuild"><span class="keyword">val</span> build</span> : <code class="type"><a href="BaseSetup.html#TYPEt">t</a> -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> unit</code></pre><div class="info ">
Run the build step.<br>
</div>
<pre><span id="VALdoc"><span class="keyword">val</span> doc</span> : <code class="type"><a href="BaseSetup.html#TYPEt">t</a> -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> unit</code></pre><div class="info ">
Run the doc step: build all documents.<br>
</div>
<pre><span id="VALtest"><span class="keyword">val</span> test</span> : <code class="type"><a href="BaseSetup.html#TYPEt">t</a> -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> unit</code></pre><div class="info ">
Run the test step: run all tests.<br>
</div>
<pre><span id="VALinstall"><span class="keyword">val</span> install</span> : <code class="type"><a href="BaseSetup.html#TYPEt">t</a> -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> unit</code></pre><div class="info ">
Run the install step.<br>
</div>
<pre><span id="VALuninstall"><span class="keyword">val</span> uninstall</span> : <code class="type"><a href="BaseSetup.html#TYPEt">t</a> -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> unit</code></pre><div class="info ">
Run the uninstall step.<br>
</div>
<pre><span id="VALclean"><span class="keyword">val</span> clean</span> : <code class="type"><a href="BaseSetup.html#TYPEt">t</a> -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> unit</code></pre><div class="info ">
Run the clean step.<br>
</div>
<pre><span id="VALdistclean"><span class="keyword">val</span> distclean</span> : <code class="type"><a href="BaseSetup.html#TYPEt">t</a> -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> unit</code></pre><div class="info ">
Run the distclean step.<br>
</div>
<pre><span id="VALreinstall"><span class="keyword">val</span> reinstall</span> : <code class="type"><a href="BaseSetup.html#TYPEt">t</a> -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> unit</code></pre><div class="info ">
Run the reinstall step: deinstall and install.<br>
</div>
<pre><span id="VALall"><span class="keyword">val</span> all</span> : <code class="type"><a href="BaseSetup.html#TYPEt">t</a> -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> unit</code></pre><div class="info ">
Run all steps: configure, build, doc, test and install.<br>
</div>
<pre><span id="VALversion"><span class="keyword">val</span> version</span> : <code class="type"><a href="BaseSetup.html#TYPEt">t</a> -> <a href="OASISTypes.html#TYPEarg">OASISTypes.arg</a> array -> unit</code></pre><div class="info ">
Display OASIS version used to generate this setup.ml<br>
</div>
<pre><span id="VALsetup"><span class="keyword">val</span> setup</span> : <code class="type"><a href="BaseSetup.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
The first function called when running 'setup.ml'.<br>
</div>
<pre><span id="VALdefault_oasis_fn"><span class="keyword">val</span> default_oasis_fn</span> : <code class="type"><a href="OASISTypes.html#TYPEhost_filename">OASISTypes.host_filename</a></code></pre><div class="info ">
Default filename for '_oasis'.<br>
</div>
<pre><span id="VALdefault_filename"><span class="keyword">val</span> default_filename</span> : <code class="type"><a href="OASISTypes.html#TYPEhost_filename">OASISTypes.host_filename</a></code></pre><div class="info ">
Default filename for 'setup.ml'. <b>Not exported</b><br>
</div>
<pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type"><a href="OASISPlugin.html#TYPEcontext_act">OASISPlugin.context_act</a> -> <a href="OASISFileTemplate.html#TYPEtemplate">OASISFileTemplate.template</a></code></pre><div class="info ">
Get template 'setup.ml' file out of the plugin context.
<b>Not exported</b>.<br>
</div>
<pre><span id="VALof_package"><span class="keyword">val</span> of_package</span> : <code class="type">?oasis_fn:<a href="OASISTypes.html#TYPEhost_filename">OASISTypes.host_filename</a> -><br> ?oasis_exec:<a href="OASISTypes.html#TYPEhost_filename">OASISTypes.host_filename</a> -><br> ?oasis_setup_args:string list -><br> setup_update:bool -><br> <a href="OASISSetupUpdate.html#TYPEt">OASISSetupUpdate.t</a> -><br> <a href="OASISTypes.html#TYPEpackage">OASISTypes.package</a> -> <a href="OASISPlugin.html#TYPEcontext_act">OASISPlugin.context_act</a> * <a href="BaseSetup.html#TYPEt">t</a></code></pre><div class="info ">
Create <code class="code">t</code> and plugin context from an OASIS package and the
matching _oasis. <b>Not exported</b>.<br>
</div>
</body></html>
|