Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update doc API

  • Loading branch information...
commit 4c111a9829e3d328b28e6270d782650218a55399 1 parent df9eb37
@samoht samoht authored
Showing with 642 additions and 128 deletions.
  1. +9 −0 doc/html/OpamClient.API.CONFIG.html
  2. +2 −2 doc/html/OpamClient.API.SWITCH.html
  3. +3 −3 doc/html/OpamClient.API.html
  4. +3 −2 doc/html/OpamCompiler.html
  5. +9 −0 doc/html/OpamConfigCommand.html
  6. +3 −1 doc/html/OpamFile.Filenames.html
  7. +3 −0  doc/html/OpamFile.OPAM.html
  8. +79 −0 doc/html/OpamFile.Prefix.html
  9. +3 −0  doc/html/OpamFile.html
  10. +19 −3 doc/html/OpamFilename.html
  11. +3 −0  doc/html/OpamFormat.html
  12. +10 −1 doc/html/OpamMisc.html
  13. +4 −6 doc/html/OpamPackage.html
  14. +14 −14 doc/html/OpamPath.Repository.html
  15. +3 −0  doc/html/OpamPath.html
  16. +12 −6 doc/html/OpamRepository.html
  17. +3 −2 doc/html/OpamRepositoryCommand.html
  18. +19 −3 doc/html/OpamState.html
  19. +2 −2 doc/html/OpamSwitchCommand.html
  20. +5 −1 doc/html/OpamSystem.html
  21. +54 −0 doc/html/OpamTypes.html
  22. +5 −0 doc/html/index_modules.html
  23. +15 −0 doc/html/index_types.html
  24. +144 −32 doc/html/index_values.html
  25. +4 −0 doc/html/type_OpamClient.API.CONFIG.html
  26. +4 −2 doc/html/type_OpamClient.API.SWITCH.html
  27. +15 −4 doc/html/type_OpamClient.API.html
  28. +15 −4 doc/html/type_OpamClient.SafeAPI.html
  29. +30 −8 doc/html/type_OpamClient.html
  30. +2 −1  doc/html/type_OpamCompiler.html
  31. +4 −0 doc/html/type_OpamConfigCommand.html
  32. +1 −0  doc/html/type_OpamFile.OPAM.html
  33. +52 −0 doc/html/type_OpamFile.Prefix.html
  34. +11 −0 doc/html/type_OpamFile.html
  35. +7 −3 doc/html/type_OpamFilename.html
  36. +1 −0  doc/html/type_OpamFormat.html
  37. +4 −1 doc/html/type_OpamMisc.html
  38. +1 −2  doc/html/type_OpamPackage.html
  39. +13 −8 doc/html/type_OpamPath.Repository.html
  40. +14 −8 doc/html/type_OpamPath.html
  41. +12 −4 doc/html/type_OpamRepository.html
  42. +2 −1  doc/html/type_OpamRepositoryCommand.html
  43. +12 −2 doc/html/type_OpamState.html
  44. +4 −2 doc/html/type_OpamSwitchCommand.html
  45. +1 −0  doc/html/type_OpamSystem.html
  46. +7 −0 doc/html/type_OpamTypes.html
View
9 doc/html/OpamClient.API.CONFIG.html
@@ -59,6 +59,15 @@
<pre><span id="VALenv"><span class="keyword">val</span> env</span> : <code class="type">csh:bool -> unit</code></pre><div class="info">
Display environment.<br>
</div>
+<pre><span id="VALsetup"><span class="keyword">val</span> setup</span> : <code class="type"><a href="OpamTypes.html#TYPEuser_config">OpamTypes.user_config</a> option -> <a href="OpamTypes.html#TYPEglobal_config">OpamTypes.global_config</a> option -> unit</code></pre><div class="info">
+Global and user setup of OPAM.<br>
+</div>
+<pre><span id="VALsetup_list"><span class="keyword">val</span> setup_list</span> : <code class="type"><a href="OpamTypes.html#TYPEshell">OpamTypes.shell</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> -> unit</code></pre><div class="info">
+Display global and user informations about OPAM setup.<br>
+</div>
+<pre><span id="VALexec"><span class="keyword">val</span> exec</span> : <code class="type">string -> unit</code></pre><div class="info">
+Execute a command in a subshell with the right environment variables.<br>
+</div>
<pre><span id="VALincludes"><span class="keyword">val</span> includes</span> : <code class="type">is_rec:bool -> <a href="OpamTypes.html#TYPEname">OpamTypes.name</a> list -> unit</code></pre><div class="info">
Display includes files.<br>
</div>
View
4 doc/html/OpamClient.API.SWITCH.html
@@ -55,10 +55,10 @@
Switch API<br>
</div>
<hr width="100%">
-<pre><span id="VALswitch"><span class="keyword">val</span> switch</span> : <code class="type">quiet:bool -> <a href="OpamTypes.html#TYPEswitch">OpamTypes.switch</a> -> unit</code></pre><div class="info">
+<pre><span id="VALswitch"><span class="keyword">val</span> switch</span> : <code class="type">quiet:bool -> warning:bool -> <a href="OpamTypes.html#TYPEswitch">OpamTypes.switch</a> -> unit</code></pre><div class="info">
Switch to the given compiler. Take the global file lock.<br>
</div>
-<pre><span id="VALinstall"><span class="keyword">val</span> install</span> : <code class="type">quiet:bool -> <a href="OpamTypes.html#TYPEswitch">OpamTypes.switch</a> -> <a href="OpamTypes.html#TYPEcompiler">OpamTypes.compiler</a> -> unit</code></pre><div class="info">
+<pre><span id="VALinstall"><span class="keyword">val</span> install</span> : <code class="type">quiet:bool -> warning:bool -> <a href="OpamTypes.html#TYPEswitch">OpamTypes.switch</a> -> <a href="OpamTypes.html#TYPEcompiler">OpamTypes.compiler</a> -> unit</code></pre><div class="info">
Install the given compiler.<br>
</div>
<pre><span id="VALimport"><span class="keyword">val</span> import</span> : <code class="type"><a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> option -> unit</code></pre><div class="info">
View
6 doc/html/OpamClient.API.html
@@ -53,10 +53,10 @@
OPAM API.<br>
</div>
<hr width="100%">
-<pre><span id="VALinit"><span class="keyword">val</span> init</span> : <code class="type"><a href="OpamTypes.html#TYPErepository">OpamTypes.repository</a> -> <a href="OpamTypes.html#TYPEcompiler">OpamTypes.compiler</a> -> jobs:int -> unit</code></pre><div class="info">
+<pre><span id="VALinit"><span class="keyword">val</span> init</span> : <code class="type"><a href="OpamTypes.html#TYPErepository">OpamTypes.repository</a> -><br> <a href="OpamTypes.html#TYPEcompiler">OpamTypes.compiler</a> -><br> jobs:int -><br> <a href="OpamTypes.html#TYPEshell">OpamTypes.shell</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> -> [ `ask | `no | `yes ] -> unit</code></pre><div class="info">
Initialize the client a consistent state.<br>
</div>
-<pre><span id="VALlist"><span class="keyword">val</span> list</span> : <code class="type">print_short:bool -><br> installed_only:bool -><br> ?name_only:bool -> ?case_sensitive:bool -> string list -> unit</code></pre><div class="info">
+<pre><span id="VALlist"><span class="keyword">val</span> list</span> : <code class="type">print_short:bool -><br> installed_only:bool -><br> installed_roots:bool -><br> ?name_only:bool -> ?case_sensitive:bool -> string list -> unit</code></pre><div class="info">
Display all available packages that matches any of the
regexps.<br>
</div>
@@ -80,7 +80,7 @@
<pre><span id="VALupload"><span class="keyword">val</span> upload</span> : <code class="type"><a href="OpamTypes.html#TYPEupload">OpamTypes.upload</a> -> <a href="OpamTypes.html#TYPErepository_name">OpamTypes.repository_name</a> -> unit</code></pre><div class="info">
Upload a package to a remote repository.<br>
</div>
-<pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type"><a href="OpamTypes.html#TYPEname_set">OpamTypes.name_set</a> -> unit</code></pre><div class="info">
+<pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type">autoremove:bool -> <a href="OpamTypes.html#TYPEname_set">OpamTypes.name_set</a> -> unit</code></pre><div class="info">
Remove the given set of packages.<br>
</div>
<pre><span class="keyword">module</span> <a href="OpamClient.API.CONFIG.html">CONFIG</a>: <code class="code">sig</code> <a href="OpamClient.API.CONFIG.html">..</a> <code class="code">end</code></pre><div class="info">
View
5 doc/html/OpamCompiler.html
@@ -65,8 +65,9 @@
<pre><span id="VALof_filename"><span class="keyword">val</span> of_filename</span> : <code class="type">OpamFilename.t -> t</code></pre><div class="info">
Convert a filename into a compiler name<br>
</div>
-<pre><span id="VALlist"><span class="keyword">val</span> list</span> : <code class="type">OpamFilename.Dir.t -> Set.t</code></pre><div class="info">
-List the compiler available in a directory<br>
+<pre><span id="VALlist"><span class="keyword">val</span> list</span> : <code class="type">OpamFilename.Dir.t -> (OpamFilename.t * OpamFilename.t option) Map.t</code></pre><div class="info">
+List the compiler available in a directory (and their eventual
+ descrition file)<br>
</div>
<pre><span id="VALsystem"><span class="keyword">val</span> system</span> : <code class="type">t</code></pre><div class="info">
System compiler<br>
View
9 doc/html/OpamConfigCommand.html
@@ -73,4 +73,13 @@
<pre><span id="VALsubst"><span class="keyword">val</span> subst</span> : <code class="type"><a href="OpamTypes.html#TYPEbasename">OpamTypes.basename</a> list -> unit</code></pre><div class="info">
Substitute files<br>
</div>
+<pre><span id="VALsetup"><span class="keyword">val</span> setup</span> : <code class="type"><a href="OpamTypes.html#TYPEuser_config">OpamTypes.user_config</a> option -> <a href="OpamTypes.html#TYPEglobal_config">OpamTypes.global_config</a> option -> unit</code></pre><div class="info">
+Update the global and user configuration to use OPAM.<br>
+</div>
+<pre><span id="VALsetup_list"><span class="keyword">val</span> setup_list</span> : <code class="type"><a href="OpamTypes.html#TYPEshell">OpamTypes.shell</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> -> unit</code></pre><div class="info">
+Display the global and user configuration for OPAM.<br>
+</div>
+<pre><span id="VALexec"><span class="keyword">val</span> exec</span> : <code class="type">string -> unit</code></pre><div class="info">
+Execute a command in a subshell<br>
+</div>
</body></html>
View
4 doc/html/OpamFile.Filenames.html
@@ -5,6 +5,7 @@
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="OpamFile.Urls_txt.html">
+<link rel="next" href="OpamFile.Prefix.html">
<link rel="Up" href="OpamFile.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
@@ -47,7 +48,8 @@
<body>
<div class="navbar"><a class="pre" href="OpamFile.Urls_txt.html" title="OpamFile.Urls_txt">Previous</a>
&nbsp;<a class="up" href="OpamFile.html" title="OpamFile">Up</a>
-&nbsp;</div>
+&nbsp;<a class="post" href="OpamFile.Prefix.html" title="OpamFile.Prefix">Next</a>
+</div>
<h1>Module <a href="type_OpamFile.Filenames.html">OpamFile.Filenames</a></h1>
<pre><span class="keyword">module</span> Filenames: <code class="type"><a href="OpamFile.IO_FILE.html">IO_FILE</a></code><code class="type"> with type t = filename_set</code></pre><div class="info">
List of filenames<br>
View
3  doc/html/OpamFile.OPAM.html
@@ -119,6 +119,9 @@
<pre><span id="VALdoc"><span class="keyword">val</span> doc</span> : <code class="type">t -> string option</code></pre><div class="info">
API documentation<br>
</div>
+<pre><span id="VALtags"><span class="keyword">val</span> tags</span> : <code class="type">t -> string list</code></pre><div class="info">
+Classification tags<br>
+</div>
<pre><span id="VALbuild_test"><span class="keyword">val</span> build_test</span> : <code class="type">t -> <a href="OpamTypes.html#TYPEcommand">OpamTypes.command</a> list</code></pre><div class="info">
Commands to build and run the tests<br>
</div>
View
79 doc/html/OpamFile.Prefix.html
@@ -0,0 +1,79 @@
+<!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="OpamFile.Filenames.html">
+<link rel="Up" href="OpamFile.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="OpamAction" rel="Chapter" href="OpamAction.html">
+<link title="OpamClient" rel="Chapter" href="OpamClient.html">
+<link title="OpamConfigCommand" rel="Chapter" href="OpamConfigCommand.html">
+<link title="OpamPinCommand" rel="Chapter" href="OpamPinCommand.html">
+<link title="OpamRepositoryCommand" rel="Chapter" href="OpamRepositoryCommand.html">
+<link title="OpamSolution" rel="Chapter" href="OpamSolution.html">
+<link title="OpamState" rel="Chapter" href="OpamState.html">
+<link title="OpamSwitchCommand" rel="Chapter" href="OpamSwitchCommand.html">
+<link title="OpamCompiler" rel="Chapter" href="OpamCompiler.html">
+<link title="OpamFile" rel="Chapter" href="OpamFile.html">
+<link title="OpamFilename" rel="Chapter" href="OpamFilename.html">
+<link title="OpamFormat" rel="Chapter" href="OpamFormat.html">
+<link title="OpamFormula" rel="Chapter" href="OpamFormula.html">
+<link title="OpamMisc" rel="Chapter" href="OpamMisc.html">
+<link title="OpamPackage" rel="Chapter" href="OpamPackage.html">
+<link title="OpamParallel" rel="Chapter" href="OpamParallel.html">
+<link title="OpamPath" rel="Chapter" href="OpamPath.html">
+<link title="OpamProcess" rel="Chapter" href="OpamProcess.html">
+<link title="OpamRepository" rel="Chapter" href="OpamRepository.html">
+<link title="OpamRepositoryName" rel="Chapter" href="OpamRepositoryName.html">
+<link title="OpamSwitch" rel="Chapter" href="OpamSwitch.html">
+<link title="OpamSystem" rel="Chapter" href="OpamSystem.html">
+<link title="OpamTypes" rel="Chapter" href="OpamTypes.html">
+<link title="OpamVariable" rel="Chapter" href="OpamVariable.html">
+<link title="OpamVersion" rel="Chapter" href="OpamVersion.html">
+<link title="OpamDarcs" rel="Chapter" href="OpamDarcs.html">
+<link title="OpamGit" rel="Chapter" href="OpamGit.html">
+<link title="OpamHTTP" rel="Chapter" href="OpamHTTP.html">
+<link title="OpamLocal" rel="Chapter" href="OpamLocal.html">
+<link title="OpamCudf" rel="Chapter" href="OpamCudf.html">
+<link title="OpamHeuristic" rel="Chapter" href="OpamHeuristic.html">
+<link title="OpamSolver" rel="Chapter" href="OpamSolver.html"><title>OpamFile.Prefix</title>
+</head>
+<body>
+<div class="navbar"><a class="pre" href="OpamFile.Filenames.html" title="OpamFile.Filenames">Previous</a>
+&nbsp;<a class="up" href="OpamFile.html" title="OpamFile">Up</a>
+&nbsp;</div>
+<h1>Module <a href="type_OpamFile.Prefix.html">OpamFile.Prefix</a></h1>
+<pre><span class="keyword">module</span> Prefix: <code class="type"><a href="OpamFile.IO_FILE.html">IO_FILE</a></code><code class="type"> with type t = string name_map</code></pre><div class="info">
+Prefix of package directories<br>
+</div>
+<hr width="100%">
+<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
+<div class="info">
+File contents<br>
+</div>
+
+<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type"><a href="OpamFile.IO_FILE.html#TYPEt">t</a></code></pre><div class="info">
+Empty file<br>
+</div>
+<pre><span id="VALwrite"><span class="keyword">val</span> write</span> : <code class="type"><a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> -> <a href="OpamFile.IO_FILE.html#TYPEt">t</a> -> unit</code></pre><div class="info">
+Write some contents to a file<br>
+</div>
+<pre><span id="VALread"><span class="keyword">val</span> read</span> : <code class="type"><a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> -> <a href="OpamFile.IO_FILE.html#TYPEt">t</a></code></pre><div class="info">
+Read file contents. Raise an error if the file does not exist.<br>
+</div>
+<pre><span id="VALsafe_read"><span class="keyword">val</span> safe_read</span> : <code class="type"><a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> -> <a href="OpamFile.IO_FILE.html#TYPEt">t</a></code></pre><div class="info">
+Read file contents. Return <code class="code">empty</code> if the file does not exist.<br>
+</div>
+<pre><span id="VALread_from_channel"><span class="keyword">val</span> read_from_channel</span> : <code class="type">Pervasives.in_channel -> <a href="OpamFile.IO_FILE.html#TYPEt">t</a></code></pre><div class="info">
+Read from channel.<br>
+</div>
+<pre><span id="VALwrite_to_channel"><span class="keyword">val</span> write_to_channel</span> : <code class="type">Pervasives.out_channel -> <a href="OpamFile.IO_FILE.html#TYPEt">t</a> -> unit</code></pre><div class="info">
+Write to channel.<br>
+</div>
+</body></html>
View
3  doc/html/OpamFile.html
@@ -130,6 +130,9 @@ <h2 id="2_Substitutionfiles">Substitution files</h2><br>
<pre><span class="keyword">module</span> <a href="OpamFile.Filenames.html">Filenames</a>: <code class="type"><a href="OpamFile.IO_FILE.html">IO_FILE</a></code><code class="type"> with type t = filename_set</code></pre><div class="info">
List of filenames
</div>
+<pre><span class="keyword">module</span> <a href="OpamFile.Prefix.html">Prefix</a>: <code class="type"><a href="OpamFile.IO_FILE.html">IO_FILE</a></code><code class="type"> with type t = string name_map</code></pre><div class="info">
+Prefix of package directories
+</div>
<pre><span id="VALprint_stats"><span class="keyword">val</span> print_stats</span> : <code class="type">unit -> unit</code></pre><div class="info">
Display statistics about file access.<br>
</div>
View
22 doc/html/OpamFilename.html
@@ -70,7 +70,10 @@
<pre><span id="VALmkdir"><span class="keyword">val</span> mkdir</span> : <code class="type">Dir.t -> unit</code></pre><div class="info">
Create a directory<br>
</div>
-<pre><span id="VALlist_dirs"><span class="keyword">val</span> list_dirs</span> : <code class="type">Dir.t -> Dir.t list</code></pre><div class="info">
+<pre><span id="VALrec_dirs"><span class="keyword">val</span> rec_dirs</span> : <code class="type">Dir.t -> Dir.t list</code></pre><div class="info">
+List the sub-directory recursively<br>
+</div>
+<pre><span id="VALsub_dirs"><span class="keyword">val</span> sub_dirs</span> : <code class="type">Dir.t -> Dir.t list</code></pre><div class="info">
List the sub-directory<br>
</div>
<pre><span id="VALin_dir"><span class="keyword">val</span> in_dir</span> : <code class="type">Dir.t -> (unit -> 'a) -> 'a</code></pre><div class="info">
@@ -117,6 +120,16 @@
<pre><span id="VALraw_file"><span class="keyword">val</span> raw_file</span> : <code class="type">string -> t</code></pre><div class="info">
Creation from a raw string (as <i>http://&lt;path&gt;</i>)<br>
</div>
+<pre><span id="VALprettify"><span class="keyword">val</span> prettify</span> : <code class="type">t -> string</code></pre><div class="info">
+Prettify a filename:<ul>
+<li>replace /path/to/opam/foo by &lt;opam&gt;/foo</li>
+<li>replace /path/to/home/foo by ~/foo</li>
+</ul>
+<br>
+</div>
+<pre><span id="VALprettify_dir"><span class="keyword">val</span> prettify_dir</span> : <code class="type">Dir.t -> string</code></pre><div class="info">
+Prettify a dirname.<br>
+</div>
<pre><span id="VALdirname"><span class="keyword">val</span> dirname</span> : <code class="type">t -> Dir.t</code></pre><div class="info">
Return the directory name<br>
</div>
@@ -144,7 +157,7 @@
<pre><span id="VALchop_extension"><span class="keyword">val</span> chop_extension</span> : <code class="type">t -> t</code></pre><div class="info">
Remove the file extension<br>
</div>
-<pre><span id="VALlist_files"><span class="keyword">val</span> list_files</span> : <code class="type">Dir.t -> t list</code></pre><div class="info">
+<pre><span id="VALrec_files"><span class="keyword">val</span> rec_files</span> : <code class="type">Dir.t -> t list</code></pre><div class="info">
List all the filenames, recursively<br>
</div>
<pre><span id="VALwith_contents"><span class="keyword">val</span> with_contents</span> : <code class="type">(string -> 'a) -> t -> 'a</code></pre><div class="info">
@@ -175,9 +188,12 @@
<pre><span id="VALstarts_with"><span class="keyword">val</span> starts_with</span> : <code class="type">Dir.t -> t -> bool</code></pre><div class="info">
Check wether a filename starts by a given Dir.t<br>
</div>
-<pre><span id="VALremove_prefix"><span class="keyword">val</span> remove_prefix</span> : <code class="type">prefix:Dir.t -> t -> string</code></pre><div class="info">
+<pre><span id="VALremove_prefix"><span class="keyword">val</span> remove_prefix</span> : <code class="type">Dir.t -> t -> string</code></pre><div class="info">
Remove a prefix from a file name<br>
</div>
+<pre><span id="VALremove_suffix"><span class="keyword">val</span> remove_suffix</span> : <code class="type">Base.t -> t -> string</code></pre><div class="info">
+Remove a suffix from a filename<br>
+</div>
<pre><span id="VALdownload"><span class="keyword">val</span> download</span> : <code class="type">overwrite:bool -> t -> Dir.t -> t</code></pre><div class="info">
download a remote file in a given directory. Return the location
of the downloaded file if the download is successful.<br>
View
3  doc/html/OpamFormat.html
@@ -152,6 +152,9 @@ <h2 id="2_Creationfunctions">Creation functions</h2><br>
<pre><span id="VALmake_list"><span class="keyword">val</span> make_list</span> : <code class="type">('a -> <a href="OpamTypes.html#TYPEvalue">OpamTypes.value</a>) -> 'a list -> <a href="OpamTypes.html#TYPEvalue">OpamTypes.value</a></code></pre><div class="info">
Create a list of 'things'<br>
</div>
+<pre><span id="VALmake_string_list"><span class="keyword">val</span> make_string_list</span> : <code class="type">string list -> <a href="OpamTypes.html#TYPEvalue">OpamTypes.value</a></code></pre><div class="info">
+Create a list of strings<br>
+</div>
<pre><span id="VALmake_group"><span class="keyword">val</span> make_group</span> : <code class="type">('a -> <a href="OpamTypes.html#TYPEvalue">OpamTypes.value</a>) -> 'a list -> <a href="OpamTypes.html#TYPEvalue">OpamTypes.value</a></code></pre><div class="info">
Create a group of 'things'<br>
</div>
View
11 doc/html/OpamMisc.html
@@ -93,6 +93,9 @@ <h2 id="2_Integermanipulation">Integer manipulation</h2><br>
<pre><span id="VALstring_of_list"><span class="keyword">val</span> string_of_list</span> : <code class="type">('a -> string) -> 'a list -> string</code></pre><div class="info">
Display a list of strings<br>
</div>
+<pre><span id="VALpretty_list"><span class="keyword">val</span> pretty_list</span> : <code class="type">string list -> string</code></pre><div class="info">
+Display a pretty list: <code class="code">"x";"y";"z"</code> -&gt; "x, y and z"<br>
+</div>
<br>
<h2 id="2_Stringmanipulation">String manipulation</h2><br>
<pre><span class="keyword">module</span> <a href="OpamMisc.StringMap.html">StringMap</a>: <code class="type"><a href="OpamMisc.MAP.html">MAP</a></code><code class="type"> with type key = string</code></pre><div class="info">
@@ -116,9 +119,12 @@ <h2 id="2_Stringmanipulation">String manipulation</h2><br>
<pre><span id="VALends_with"><span class="keyword">val</span> ends_with</span> : <code class="type">suffix:string -> string -> bool</code></pre><div class="info">
Does a string ends with the given suffix ?<br>
</div>
-<pre><span id="VALremove_prefix"><span class="keyword">val</span> remove_prefix</span> : <code class="type">prefix:string -> string -> string option</code></pre><div class="info">
+<pre><span id="VALremove_prefix"><span class="keyword">val</span> remove_prefix</span> : <code class="type">prefix:string -> string -> string</code></pre><div class="info">
Remove a prefix<br>
</div>
+<pre><span id="VALremove_suffix"><span class="keyword">val</span> remove_suffix</span> : <code class="type">suffix:string -> string -> string</code></pre><div class="info">
+Remove a suffix<br>
+</div>
<pre><span id="VALcut_at"><span class="keyword">val</span> cut_at</span> : <code class="type">string -> char -> (string * string) option</code></pre><div class="info">
Cut a string at the first occurence of the given char<br>
</div>
@@ -176,4 +182,7 @@ <h2 id="2_Misc">Misc</h2><br>
<pre><span id="VALuname_s"><span class="keyword">val</span> uname_s</span> : <code class="type">unit -> string option</code></pre><div class="info">
Get the output of <code class="code">uname -s</code><br>
</div>
+<pre><span id="VALguess_shell_compat"><span class="keyword">val</span> guess_shell_compat</span> : <code class="type">unit -> [ `csh | `sh | `zsh ]</code></pre><div class="info">
+Guess the shell compat-mode<br>
+</div>
</body></html>
View
10 doc/html/OpamPackage.html
@@ -78,9 +78,10 @@ <h2 id="2_Packagenameandversions">Package name and versions</h2><br>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">Name.t -> Version.t -> t</code></pre><div class="info">
Create a new pair (name x version)<br>
</div>
-<pre><span id="VALof_filename"><span class="keyword">val</span> of_filename</span> : <code class="type">OpamFilename.t -> t option</code></pre><div class="info">
-Create a new pair from a filename. This function extracts <i> $name</i> and <i>$version</i> from <i>/path/to/$name.$version.XXX</i>
- with various heuristics.<br>
+<pre><span id="VALof_filename"><span class="keyword">val</span> of_filename</span> : <code class="type">all:bool -> OpamFilename.t -> t option</code></pre><div class="info">
+Create a new pair from a filename. This function extracts <i> $name</i> and <i>$version</i> from <i>/path/to/$name.$version.XXX</i> with
+ various heuristics. If <code class="code">all</code> is unset, discard "opam" and "url"
+ files.<br>
</div>
<pre><span id="VALof_dirname"><span class="keyword">val</span> of_dirname</span> : <code class="type">OpamFilename.Dir.t -> t option</code></pre><div class="info">
Create a new pair from a directory name. This function extracts <i> $name</i> and <i>$version</i> from <i>/path/to/$name.$version/</i><br>
@@ -100,9 +101,6 @@ <h2 id="2_Packagenameandversions">Package name and versions</h2><br>
<pre><span id="VALpackages_of_name"><span class="keyword">val</span> packages_of_name</span> : <code class="type">Set.t -> Name.t -> Set.t</code></pre><div class="info">
Return all the packages with the given names<br>
</div>
-<pre><span id="VALopam_files"><span class="keyword">val</span> opam_files</span> : <code class="type">OpamFilename.Dir.t -> Set.t</code></pre><div class="info">
-Look for all .opam files in directory<br>
-</div>
<pre><span id="VALcompare"><span class="keyword">val</span> compare</span> : <code class="type">t -> t -> int</code></pre><div class="info">
Compare two packages<br>
</div>
View
28 doc/html/OpamPath.Repository.html
@@ -56,8 +56,8 @@
<pre><span id="VALroot"><span class="keyword">val</span> root</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEdirname">OpamTypes.dirname</a></code></pre><div class="info">
Get the directory root<br>
</div>
-<pre><span id="VALlock"><span class="keyword">val</span> lock</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a></code></pre><div class="info">
-lock file<br>
+<pre><span id="VALprefix"><span class="keyword">val</span> prefix</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a></code></pre><div class="info">
+Prefix file <i>$opam/repo/prefix</i><br>
</div>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -><br> <a href="OpamTypes.html#TYPErepository_name">OpamTypes.repository_name</a> -> <a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a></code></pre><div class="info">
Return the repository folder: <i>$opam/repo/$repo</i><br>
@@ -71,16 +71,22 @@
<pre><span id="VALpackages_dir"><span class="keyword">val</span> packages_dir</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEdirname">OpamTypes.dirname</a></code></pre><div class="info">
Packages folder: <i>$opam/repo/$repo/packages</i><br>
</div>
-<pre><span id="VALpackage"><span class="keyword">val</span> package</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEdirname">OpamTypes.dirname</a></code></pre><div class="info">
-Package folder: <i>$opam/repo/$repo/packages/$NAME.$VERSION</i><br>
+<pre><span id="VALpackage"><span class="keyword">val</span> package</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -><br> string option -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEdirname">OpamTypes.dirname</a></code></pre><div class="info">
+Package folder: <i>$opam/repo/$repo/packages/XXX/$NAME.$VERSION</i><br>
</div>
-<pre><span id="VALopam"><span class="keyword">val</span> opam</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a></code></pre><div class="info">
+<pre><span id="VALopam"><span class="keyword">val</span> opam</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -><br> string option -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a></code></pre><div class="info">
Return the OPAM file for a given package:
- <i>$opam/repo/$repo/packages/$NAME.$VERSION/opam</i><br>
+ <i>$opam/repo/$repo/packages/XXX/$NAME.$VERSION/opam</i><br>
</div>
-<pre><span id="VALdescr"><span class="keyword">val</span> descr</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a></code></pre><div class="info">
+<pre><span id="VALdescr"><span class="keyword">val</span> descr</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -><br> string option -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a></code></pre><div class="info">
Return the description file for a given package:
- <i>$opam/repo/$repo/packages/$NAME.VERSION/descr</i><br>
+ <i>$opam/repo/$repo/packages/XXX/$NAME.VERSION/descr</i><br>
+</div>
+<pre><span id="VALurl"><span class="keyword">val</span> url</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -><br> string option -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a></code></pre><div class="info">
+urls <i>$opma/repo/$repo/package/XXX/$NAME.$VERSION/url</i><br>
+</div>
+<pre><span id="VALfiles"><span class="keyword">val</span> files</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -><br> string option -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEdirname">OpamTypes.dirname</a></code></pre><div class="info">
+files <i>$opam/repo/$repo/packages/XXX/$NAME.$VERSION/files</i><br>
</div>
<pre><span id="VALarchive"><span class="keyword">val</span> archive</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a></code></pre><div class="info">
Return the archive for a given package:
@@ -106,12 +112,6 @@
<pre><span id="VALcompilers_dir"><span class="keyword">val</span> compilers_dir</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEdirname">OpamTypes.dirname</a></code></pre><div class="info">
Compiler files: <i>$opam/repo/$repo/compilers/</i><br>
</div>
-<pre><span id="VALurl"><span class="keyword">val</span> url</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a></code></pre><div class="info">
-urls <i>$opma/repo/$repo/package/$NAME.$VERSION/url</i><br>
-</div>
-<pre><span id="VALfiles"><span class="keyword">val</span> files</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEdirname">OpamTypes.dirname</a></code></pre><div class="info">
-files <i>$opam/repo/$repo/packages/$NAME.$VERSION/files</i><br>
-</div>
<pre><span id="VALtmp"><span class="keyword">val</span> tmp</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEdirname">OpamTypes.dirname</a></code></pre><div class="info">
Tempory folder <i>$opam/repo/$repo/tmp</i><br>
</div>
View
3  doc/html/OpamPath.html
@@ -111,6 +111,9 @@ <h2 id="2_Globalpaths">Global paths</h2><br>
<pre><span id="VALrepo_index"><span class="keyword">val</span> repo_index</span> : <code class="type"><a href="OpamPath.html#TYPEt">t</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a></code></pre><div class="info">
Return the repository index: <i>$opam/repo/index</i><br>
</div>
+<pre><span id="VALinit"><span class="keyword">val</span> init</span> : <code class="type"><a href="OpamPath.html#TYPEt">t</a> -> <a href="OpamTypes.html#TYPEdirname">OpamTypes.dirname</a></code></pre><div class="info">
+Init scripts<br>
+</div>
<pre><span class="keyword">module</span> <a href="OpamPath.Switch.html">Switch</a>: <code class="code">sig</code> <a href="OpamPath.Switch.html">..</a> <code class="code">end</code></pre><div class="info">
Switch related paths
</div>
View
18 doc/html/OpamRepository.html
@@ -109,16 +109,22 @@ <h2 id="2_Repositorybackends">Repository backends</h2><br>
<i>$NAME.$VERSION/url</i> is not modified,
unless <code class="code">gener_digest = true</code> is given.<br>
</div>
-<pre><span id="VALpackages"><span class="keyword">val</span> packages</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEpackage_set">OpamTypes.package_set</a></code></pre><div class="info">
+<pre><span id="VALpackages"><span class="keyword">val</span> packages</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -><br> string <a href="OpamTypes.html#TYPEname_map">OpamTypes.name_map</a> * <a href="OpamTypes.html#TYPEpackage_set">OpamTypes.package_set</a></code></pre><div class="info">
Get the list of packages<br>
</div>
-<pre><span id="VALcompilers"><span class="keyword">val</span> compilers</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEcompiler_set">OpamTypes.compiler_set</a></code></pre><div class="info">
-Get the list of compilers<br>
-</div>
-<pre><span id="VALversions"><span class="keyword">val</span> versions</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEname">OpamTypes.name</a> -> <a href="OpamTypes.html#TYPEversion_set">OpamTypes.version_set</a></code></pre><div class="info">
-Get the available versions for a given compiler<br>
+<pre><span id="VALcompilers"><span class="keyword">val</span> compilers</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -><br> (<a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> * <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> option) <a href="OpamTypes.html#TYPEcompiler_map">OpamTypes.compiler_map</a></code></pre><div class="info">
+Get the list of compilers (and their eventual description file)<br>
</div>
<pre><span id="VALfiles"><span class="keyword">val</span> files</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEfilename_set">OpamTypes.filename_set</a></code></pre><div class="info">
Get the external files associated to a package<br>
</div>
+<pre><span id="VALprefix"><span class="keyword">val</span> prefix</span> : <code class="type"><a href="OpamTypes.html#TYPErepository_root">OpamTypes.repository_root</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> string option</code></pre><div class="info">
+Check if a package has a given prefix in the repository<br>
+</div>
+<pre><span id="VALfind_prefix"><span class="keyword">val</span> find_prefix</span> : <code class="type">string <a href="OpamTypes.html#TYPEname_map">OpamTypes.name_map</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> string option</code></pre><div class="info">
+Find an eventual prefix in a map<br>
+</div>
+<pre><span id="VALinvalid_checksum"><span class="keyword">val</span> invalid_checksum</span> : <code class="type"><a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> -> actual:string -> expected:string -> 'a</code></pre><div class="info">
+Raise an error when a checksum is invalid.<br>
+</div>
</body></html>
View
5 doc/html/OpamRepositoryCommand.html
@@ -55,8 +55,9 @@
Repository sub-command functions.<br>
</div>
<hr width="100%">
-<pre><span id="VALupdate_index"><span class="keyword">val</span> update_index</span> : <code class="type"><a href="OpamState.Types.html#TYPEt">OpamState.Types.t</a> -> unit</code></pre><div class="info">
-Update the repository index.<br>
+<pre><span id="VALupdate_index"><span class="keyword">val</span> update_index</span> : <code class="type"><a href="OpamState.Types.html#TYPEt">OpamState.Types.t</a> -> <a href="OpamTypes.html#TYPErepository">OpamTypes.repository</a> <a href="OpamTypes.html#TYPEpackage_map">OpamTypes.package_map</a></code></pre><div class="info">
+Update the repository index. Return the new (package -&gt; repo)
+ map.<br>
</div>
<pre><span id="VALlist"><span class="keyword">val</span> list</span> : <code class="type">short:bool -> unit</code></pre><div class="info">
List the available repositories.<br>
View
22 doc/html/OpamState.html
@@ -44,6 +44,7 @@
<link title="OpamCudf" rel="Chapter" href="OpamCudf.html">
<link title="OpamHeuristic" rel="Chapter" href="OpamHeuristic.html">
<link title="OpamSolver" rel="Chapter" href="OpamSolver.html"><link title="Environment" rel="Section" href="#2_Environment">
+<link title="Initialisation" rel="Section" href="#2_Initialisation">
<link title="Substitutions" rel="Section" href="#2_Substitutions">
<link title="Filters" rel="Section" href="#2_Filters">
<link title="Repositories" rel="Section" href="#2_Repositories">
@@ -225,10 +226,24 @@ <h2 id="2_Environment">Environment</h2><br>
<pre><span id="VALadd_to_env"><span class="keyword">val</span> add_to_env</span> : <code class="type"><a href="OpamState.html#TYPEstate">state</a> -><br> <a href="OpamTypes.html#TYPEenv">OpamTypes.env</a> -> (string * string * string) list -> <a href="OpamTypes.html#TYPEenv">OpamTypes.env</a></code></pre><div class="info">
Update an environment.<br>
</div>
-<pre><span id="VALprint_env_warning"><span class="keyword">val</span> print_env_warning</span> : <code class="type">?add_profile:bool -> <a href="OpamState.html#TYPEstate">state</a> -> unit</code></pre><div class="info">
+<pre><span id="VALprint_env_warning"><span class="keyword">val</span> print_env_warning</span> : <code class="type"><a href="OpamState.html#TYPEstate">state</a> -> <a href="OpamTypes.html#TYPEuser_config">OpamTypes.user_config</a> option -> unit</code></pre><div class="info">
Print a warning if the environment is not set-up properly.<br>
</div>
<br>
+<h2 id="2_Initialisation">Initialisation</h2><br>
+<pre><span id="VALupdate_setup_interactive"><span class="keyword">val</span> update_setup_interactive</span> : <code class="type"><a href="OpamState.html#TYPEstate">state</a> -> <a href="OpamTypes.html#TYPEshell">OpamTypes.shell</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> -> unit</code></pre><div class="info">
+Update the global and user configuration by asking some questions.<br>
+</div>
+<pre><span id="VALdisplay_setup"><span class="keyword">val</span> display_setup</span> : <code class="type"><a href="OpamState.html#TYPEstate">state</a> -> <a href="OpamTypes.html#TYPEshell">OpamTypes.shell</a> -> <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> -> unit</code></pre><div class="info">
+Display the global and user configuration for OPAM.<br>
+</div>
+<pre><span id="VALupdate_setup"><span class="keyword">val</span> update_setup</span> : <code class="type"><a href="OpamState.html#TYPEstate">state</a> -><br> <a href="OpamTypes.html#TYPEuser_config">OpamTypes.user_config</a> option -> <a href="OpamTypes.html#TYPEglobal_config">OpamTypes.global_config</a> option -> unit</code></pre><div class="info">
+Update the user configuration.<br>
+</div>
+<pre><span id="VALupdate_env_variables"><span class="keyword">val</span> update_env_variables</span> : <code class="type"><a href="OpamState.html#TYPEstate">state</a> -> unit</code></pre><div class="info">
+Update the global environment variables.<br>
+</div>
+<br>
<h2 id="2_Substitutions">Substitutions</h2><br>
<pre><span id="VALcontents_of_variable"><span class="keyword">val</span> contents_of_variable</span> : <code class="type"><a href="OpamState.html#TYPEstate">state</a> -> <a href="OpamTypes.html#TYPEfull_variable">OpamTypes.full_variable</a> -> <a href="OpamTypes.html#TYPEvariable_contents">OpamTypes.variable_contents</a></code></pre><div class="info">
Compute the value of a variable<br>
@@ -270,9 +285,10 @@ <h2 id="2_Repositories">Repositories</h2><br>
</div>
<pre><span id="VALpackage_repository_map"><span class="keyword">val</span> package_repository_map</span> : <code class="type"><a href="OpamState.html#TYPEstate">state</a> -> <a href="OpamTypes.html#TYPErepository">OpamTypes.repository</a> <a href="OpamTypes.html#TYPEpackage_map">OpamTypes.package_map</a></code></pre><div class="info">
Build a map which says in which repository the latest metadata for
- a given package is.<br>
+ a given package is. This function is *very* costly (need to scan all the
+ files in the repositories, so don't abuse).<br>
</div>
-<pre><span id="VALcompiler_repository_map"><span class="keyword">val</span> compiler_repository_map</span> : <code class="type"><a href="OpamState.html#TYPEstate">state</a> -> <a href="OpamTypes.html#TYPErepository">OpamTypes.repository</a> <a href="OpamTypes.html#TYPEcompiler_map">OpamTypes.compiler_map</a></code></pre><div class="info">
+<pre><span id="VALcompiler_repository_map"><span class="keyword">val</span> compiler_repository_map</span> : <code class="type"><a href="OpamState.html#TYPEstate">state</a> -><br> (<a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> * <a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> option) <a href="OpamTypes.html#TYPEcompiler_map">OpamTypes.compiler_map</a></code></pre><div class="info">
Build a map which says in which repository the latest metadata for
a given compiler is.<br>
</div>
View
4 doc/html/OpamSwitchCommand.html
@@ -55,7 +55,7 @@
Switch commands.<br>
</div>
<hr width="100%">
-<pre><span id="VALinstall"><span class="keyword">val</span> install</span> : <code class="type">quiet:bool -> <a href="OpamTypes.html#TYPEswitch">OpamTypes.switch</a> -> <a href="OpamTypes.html#TYPEcompiler">OpamTypes.compiler</a> -> unit</code></pre><div class="info">
+<pre><span id="VALinstall"><span class="keyword">val</span> install</span> : <code class="type">quiet:bool -> warning:bool -> <a href="OpamTypes.html#TYPEswitch">OpamTypes.switch</a> -> <a href="OpamTypes.html#TYPEcompiler">OpamTypes.compiler</a> -> unit</code></pre><div class="info">
Install a new switch.<br>
</div>
<pre><span id="VALimport"><span class="keyword">val</span> import</span> : <code class="type"><a href="OpamTypes.html#TYPEfilename">OpamTypes.filename</a> option -> unit</code></pre><div class="info">
@@ -67,7 +67,7 @@
<pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type"><a href="OpamTypes.html#TYPEswitch">OpamTypes.switch</a> -> unit</code></pre><div class="info">
Remove the given compiler switch.<br>
</div>
-<pre><span id="VALswitch"><span class="keyword">val</span> switch</span> : <code class="type">quiet:bool -> <a href="OpamTypes.html#TYPEswitch">OpamTypes.switch</a> -> unit</code></pre><div class="info">
+<pre><span id="VALswitch"><span class="keyword">val</span> switch</span> : <code class="type">quiet:bool -> warning:bool -> <a href="OpamTypes.html#TYPEswitch">OpamTypes.switch</a> -> unit</code></pre><div class="info">
Switch to the given compiler switch.<br>
</div>
<pre><span id="VALreinstall"><span class="keyword">val</span> reinstall</span> : <code class="type"><a href="OpamTypes.html#TYPEswitch">OpamTypes.switch</a> -> unit</code></pre><div class="info">
View
6 doc/html/OpamSystem.html
@@ -121,9 +121,13 @@
recursively.
Links behaving like directory are crossed.<br>
</div>
+<pre><span id="VALrec_dirs"><span class="keyword">val</span> rec_dirs</span> : <code class="type">string -> string list</code></pre><div class="info">
+<code class="code">rec_dirs dir</code> return the list list of all directories recursively
+ (going through symbolink links).<br>
+</div>
<pre><span id="VALocaml_version"><span class="keyword">val</span> ocaml_version</span> : <code class="type">string option Lazy.t</code></pre><div class="info">
Return the version of the current OCaml compiler. If no OCaml
- compiler is present in the path, then it returns <code class="code">None</code>.<br>
+ compiler is present in the path, then it returns <code class="code">None</code>.<br>
</div>
<pre><span id="VALsystem_ocamlc_where"><span class="keyword">val</span> system_ocamlc_where</span> : <code class="type">string option Lazy.t</code></pre><div class="info">
Return the path where the system ocamlc library is installed<br>
View
54 doc/html/OpamTypes.html
@@ -860,6 +860,60 @@ <h2 id="2_Commandlinearguments">Command line arguments</h2><br>
Configuration requests<br>
</div>
+<pre><span id="TYPEshell"><span class="keyword">type</span> <code class="type"></code>shell</span> = <code class="type">[ `csh | `sh | `zsh ]</code> </pre>
+<div class="info">
+Shell compatibility modes<br>
+</div>
+
+<pre><code><span id="TYPEglobal_config"><span class="keyword">type</span> <code class="type"></code>global_config</span> = {</code></pre><table class="typetable">
+<tr>
+<td align="left" valign="top" >
+<code>&nbsp;&nbsp;</code></td>
+<td align="left" valign="top" >
+<code><span id="TYPEELTglobal_config.complete">complete</span>&nbsp;:<code class="type">bool</code>;</code></td>
+
+</tr>
+<tr>
+<td align="left" valign="top" >
+<code>&nbsp;&nbsp;</code></td>
+<td align="left" valign="top" >
+<code><span id="TYPEELTglobal_config.switch_eval">switch_eval</span>&nbsp;:<code class="type">bool</code>;</code></td>
+
+</tr></table>
+}
+
+<div class="info">
+Global configuration option<br>
+</div>
+
+<pre><code><span id="TYPEuser_config"><span class="keyword">type</span> <code class="type"></code>user_config</span> = {</code></pre><table class="typetable">
+<tr>
+<td align="left" valign="top" >
+<code>&nbsp;&nbsp;</code></td>
+<td align="left" valign="top" >
+<code><span id="TYPEELTuser_config.shell">shell</span>&nbsp;:<code class="type"><a href="OpamTypes.html#TYPEshell">shell</a></code>;</code></td>
+
+</tr>
+<tr>
+<td align="left" valign="top" >
+<code>&nbsp;&nbsp;</code></td>
+<td align="left" valign="top" >
+<code><span id="TYPEELTuser_config.ocamlinit">ocamlinit</span>&nbsp;:<code class="type">bool</code>;</code></td>
+
+</tr>
+<tr>
+<td align="left" valign="top" >
+<code>&nbsp;&nbsp;</code></td>
+<td align="left" valign="top" >
+<code><span id="TYPEELTuser_config.dot_profile">dot_profile</span>&nbsp;:<code class="type"><a href="OpamTypes.html#TYPEfilename">filename</a> option</code>;</code></td>
+
+</tr></table>
+}
+
+<div class="info">
+User configuration option<br>
+</div>
+
<br>
<h2 id="2_Filteredcommands">Filtered commands</h2><br>
<pre><code><span id="TYPEsymbol"><span class="keyword">type</span> <code class="type"></code>symbol</span> = </code></pre><table class="typetable">
View
5 doc/html/index_modules.html
@@ -419,6 +419,11 @@
Pinned package files
</div>
</td></tr>
+<tr><td><a href="OpamFile.Prefix.html">Prefix</a> [<a href="OpamFile.html">OpamFile</a>]</td>
+<td><div class="info">
+Prefix of package directories
+</div>
+</td></tr>
<tr><td align="left"><br>R</td></tr>
<tr><td><a href="OpamClient.API.REPOSITORY.html">REPOSITORY</a> [<a href="OpamClient.API.html">OpamClient.API</a>]</td>
<td><div class="info">
View
15 doc/html/index_types.html
@@ -260,6 +260,11 @@
A generic formula
</div>
</td></tr>
+<tr><td><a href="OpamTypes.html#TYPEglobal_config">global_config</a> [<a href="OpamTypes.html">OpamTypes</a>]</td>
+<td><div class="info">
+Global configuration option
+</div>
+</td></tr>
<tr><td align="left"><br>I</td></tr>
<tr><td><a href="OpamFormat.html#TYPEindent_variable">indent_variable</a> [<a href="OpamFormat.html">OpamFormat</a>]</td>
<td><div class="info">
@@ -401,6 +406,11 @@
Section names
</div>
</td></tr>
+<tr><td><a href="OpamTypes.html#TYPEshell">shell</a> [<a href="OpamTypes.html">OpamTypes</a>]</td>
+<td><div class="info">
+Shell compatibility modes
+</div>
+</td></tr>
<tr><td><a href="OpamTypes.html#TYPEsimple_arg">simple_arg</a> [<a href="OpamTypes.html">OpamTypes</a>]</td>
<td><div class="info">
A command argument
@@ -512,6 +522,11 @@
user request action
</div>
</td></tr>
+<tr><td><a href="OpamTypes.html#TYPEuser_config">user_config</a> [<a href="OpamTypes.html">OpamTypes</a>]</td>
+<td><div class="info">
+User configuration option
+</div>
+</td></tr>
<tr><td align="left"><br>V</td></tr>
<tr><td><a href="OpamTypes.html#TYPEvalue">value</a> [<a href="OpamTypes.html">OpamTypes</a>]</td>
<td><div class="info">
View
176 doc/html/index_values.html
@@ -482,7 +482,7 @@
</td></tr>
<tr><td><a href="OpamRepository.html#VALcompilers">compilers</a> [<a href="OpamRepository.html">OpamRepository</a>]</td>
<td><div class="info">
-Get the list of compilers
+Get the list of compilers (and their eventual description file)
</div>
</td></tr>
<tr><td><a href="OpamState.html#VALcompilers">compilers</a> [<a href="OpamState.html">OpamState</a>]</td>
@@ -738,7 +738,7 @@
<tr><td><a href="OpamPath.Repository.html#VALdescr">descr</a> [<a href="OpamPath.Repository.html">OpamPath.Repository</a>]</td>
<td><div class="info">
Return the description file for a given package:
- <i>$opam/repo/$repo/packages/$NAME.VERSION/descr</i>
+ <i>$opam/repo/$repo/packages/XXX/$NAME.VERSION/descr</i>
</div>
</td></tr>
<tr><td><a href="OpamPath.html#VALdescr">descr</a> [<a href="OpamPath.html">OpamPath</a>]</td>
@@ -776,6 +776,11 @@
Return the parent directory
</div>
</td></tr>
+<tr><td><a href="OpamState.html#VALdisplay_setup">display_setup</a> [<a href="OpamState.html">OpamState</a>]</td>
+<td><div class="info">
+Display the global and user configuration for OPAM.
+</div>
+</td></tr>
<tr><td><a href="OpamFormula.html#VALdnf_of_formula">dnf_of_formula</a> [<a href="OpamFormula.html">OpamFormula</a>]</td>
<td><div class="info">
Convert a formula to DNF
@@ -922,6 +927,16 @@
Execute a list of commands in a given directory
</div>
</td></tr>
+<tr><td><a href="OpamConfigCommand.html#VALexec">exec</a> [<a href="OpamConfigCommand.html">OpamConfigCommand</a>]</td>
+<td><div class="info">
+Execute a command in a subshell
+</div>
+</td></tr>
+<tr><td><a href="OpamClient.API.CONFIG.html#VALexec">exec</a> [<a href="OpamClient.API.CONFIG.html">OpamClient.API.CONFIG</a>]</td>
+<td><div class="info">
+Execute a command in a subshell with the right environment variables.
+</div>
+</td></tr>
<tr><td><a href="OpamFilename.html#VALexists">exists</a> [<a href="OpamFilename.html">OpamFilename</a>]</td>
<td><div class="info">
see <code class="code">Sys.file_exists</code>
@@ -978,7 +993,7 @@
</td></tr>
<tr><td><a href="OpamPath.Repository.html#VALfiles">files</a> [<a href="OpamPath.Repository.html">OpamPath.Repository</a>]</td>
<td><div class="info">
-files <i>$opam/repo/$repo/packages/$NAME.$VERSION/files</i>
+files <i>$opam/repo/$repo/packages/XXX/$NAME.$VERSION/files</i>
</div>
</td></tr>
<tr><td><a href="OpamSystem.html#VALfiles_with_links">files_with_links</a> [<a href="OpamSystem.html">OpamSystem</a>]</td>
@@ -1028,6 +1043,11 @@
Return all the packages with the given name
</div>
</td></tr>
+<tr><td><a href="OpamRepository.html#VALfind_prefix">find_prefix</a> [<a href="OpamRepository.html">OpamRepository</a>]</td>
+<td><div class="info">
+Find an eventual prefix in a map
+</div>
+</td></tr>
<tr><td><a href="OpamState.html#VALfind_repository_name">find_repository_name</a> [<a href="OpamState.html">OpamState</a>]</td>
<td><div class="info">
Find a repository state, given its name
@@ -1111,6 +1131,11 @@
Iteration in topological order
</div>
</td></tr>
+<tr><td><a href="OpamMisc.html#VALguess_shell_compat">guess_shell_compat</a> [<a href="OpamMisc.html">OpamMisc</a>]</td>
+<td><div class="info">
+Guess the shell compat-mode
+</div>
+</td></tr>
<tr><td align="left"><br>H</td></tr>
<tr><td><a href="OpamParallel.G.html#VALhas_cycle">has_cycle</a> [<a href="OpamParallel.G.html">OpamParallel.G</a>]</td>
<td></td></tr>
@@ -1180,6 +1205,11 @@
Initialize <i>$opam/repo/$repo</i>
</div>
</td></tr>
+<tr><td><a href="OpamPath.html#VALinit">init</a> [<a href="OpamPath.html">OpamPath</a>]</td>
+<td><div class="info">
+Init scripts
+</div>
+</td></tr>
<tr><td><a href="OpamClient.API.html#VALinit">init</a> [<a href="OpamClient.API.html">OpamClient.API</a>]</td>
<td><div class="info">
Initialize the client a consistent state.
@@ -1252,6 +1282,11 @@
Raise <code class="code">Internal_error</code>
</div>
</td></tr>
+<tr><td><a href="OpamRepository.html#VALinvalid_checksum">invalid_checksum</a> [<a href="OpamRepository.html">OpamRepository</a>]</td>
+<td><div class="info">
+Raise an error when a checksum is invalid.
+</div>
+</td></tr>
<tr><td><a href="OpamFormat.html#VALinvalid_fields">invalid_fields</a> [<a href="OpamFormat.html">OpamFormat</a>]</td>
<td><div class="info">
Find all the invalid fields
@@ -1368,7 +1403,8 @@
</td></tr>
<tr><td><a href="OpamCompiler.html#VALlist">list</a> [<a href="OpamCompiler.html">OpamCompiler</a>]</td>
<td><div class="info">
-List the compiler available in a directory
+List the compiler available in a directory (and their eventual
+ descrition file)
</div>
</td></tr>
<tr><td><a href="OpamSwitchCommand.html#VALlist">list</a> [<a href="OpamSwitchCommand.html">OpamSwitchCommand</a>]</td>
@@ -1417,16 +1453,6 @@
regexps.
</div>
</td></tr>
-<tr><td><a href="OpamFilename.html#VALlist_dirs">list_dirs</a> [<a href="OpamFilename.html">OpamFilename</a>]</td>
-<td><div class="info">
-List the sub-directory
-</div>
-</td></tr>
-<tr><td><a href="OpamFilename.html#VALlist_files">list_files</a> [<a href="OpamFilename.html">OpamFilename</a>]</td>
-<td><div class="info">
-List all the filenames, recursively
-</div>
-</td></tr>
<tr><td><a href="OpamState.html#VALload_env_state">load_env_state</a> [<a href="OpamState.html">OpamState</a>]</td>
<td><div class="info">
Load state associated to env variables.
@@ -1447,11 +1473,6 @@
Create a dummy local repository
</div>
</td></tr>
-<tr><td><a href="OpamPath.Repository.html#VALlock">lock</a> [<a href="OpamPath.Repository.html">OpamPath.Repository</a>]</td>
-<td><div class="info">
-lock file
-</div>
-</td></tr>
<tr><td><a href="OpamPath.Switch.html#VALlock">lock</a> [<a href="OpamPath.Switch.html">OpamPath.Switch</a>]</td>
<td><div class="info">
lock file
@@ -1561,6 +1582,11 @@
Create a string
</div>
</td></tr>
+<tr><td><a href="OpamFormat.html#VALmake_string_list">make_string_list</a> [<a href="OpamFormat.html">OpamFormat</a>]</td>
+<td><div class="info">
+Create a list of strings
+</div>
+</td></tr>
<tr><td><a href="OpamFormat.html#VALmake_string_pair">make_string_pair</a> [<a href="OpamFormat.html">OpamFormat</a>]</td>
<td><div class="info">
Create a pair of strings
@@ -1752,7 +1778,7 @@
<tr><td><a href="OpamPath.Repository.html#VALopam">opam</a> [<a href="OpamPath.Repository.html">OpamPath.Repository</a>]</td>
<td><div class="info">
Return the OPAM file for a given package:
- <i>$opam/repo/$repo/packages/$NAME.$VERSION/opam</i>
+ <i>$opam/repo/$repo/packages/XXX/$NAME.$VERSION/opam</i>
</div>
</td></tr>
<tr><td><a href="OpamPath.html#VALopam">opam</a> [<a href="OpamPath.html">OpamPath</a>]</td>
@@ -1770,11 +1796,6 @@
OPAM files folder: <i>$opam/opam/</i>
</div>
</td></tr>
-<tr><td><a href="OpamPackage.html#VALopam_files">opam_files</a> [<a href="OpamPackage.html">OpamPackage</a>]</td>
-<td><div class="info">
-Look for all .opam files in directory
-</div>
-</td></tr>
<tr><td><a href="OpamFile.Config.html#VALopam_version">opam_version</a> [<a href="OpamFile.Config.html">OpamFile.Config</a>]</td>
<td><div class="info">
Return the OPAM version
@@ -1803,7 +1824,7 @@
</td></tr>
<tr><td><a href="OpamPath.Repository.html#VALpackage">package</a> [<a href="OpamPath.Repository.html">OpamPath.Repository</a>]</td>
<td><div class="info">
-Package folder: <i>$opam/repo/$repo/packages/$NAME.$VERSION</i>
+Package folder: <i>$opam/repo/$repo/packages/XXX/$NAME.$VERSION</i>
</div>
</td></tr>
<tr><td><a href="OpamState.html#VALpackage_repository_map">package_repository_map</a> [<a href="OpamState.html">OpamState</a>]</td>
@@ -2035,16 +2056,41 @@
Preprocessing options
</div>
</td></tr>
+<tr><td><a href="OpamRepository.html#VALprefix">prefix</a> [<a href="OpamRepository.html">OpamRepository</a>]</td>
+<td><div class="info">
+Check if a package has a given prefix in the repository
+</div>
+</td></tr>
+<tr><td><a href="OpamPath.Repository.html#VALprefix">prefix</a> [<a href="OpamPath.Repository.html">OpamPath.Repository</a>]</td>
+<td><div class="info">
+Prefix file <i>$opam/repo/prefix</i>
+</div>
+</td></tr>
<tr><td><a href="OpamFile.Comp.html#VALpreinstalled">preinstalled</a> [<a href="OpamFile.Comp.html">OpamFile.Comp</a>]</td>
<td><div class="info">
Is it a pre-installed compiler description file
</div>
</td></tr>
+<tr><td><a href="OpamFilename.html#VALprettify">prettify</a> [<a href="OpamFilename.html">OpamFilename</a>]</td>
+<td><div class="info">
+Prettify a filename: replace /path/to/opam/foo by &lt;opam&gt;/foo, replace /path/to/home/foo by ~/foo
+</div>
+</td></tr>
+<tr><td><a href="OpamFilename.html#VALprettify_dir">prettify_dir</a> [<a href="OpamFilename.html">OpamFilename</a>]</td>
+<td><div class="info">
+Prettify a dirname.
+</div>
+</td></tr>
<tr><td><a href="OpamMisc.html#VALpretty_backtrace">pretty_backtrace</a> [<a href="OpamMisc.html">OpamMisc</a>]</td>
<td><div class="info">
Return a pretty-printed backtrace
</div>
</td></tr>
+<tr><td><a href="OpamMisc.html#VALpretty_list">pretty_list</a> [<a href="OpamMisc.html">OpamMisc</a>]</td>
+<td><div class="info">
+Display a pretty list: <code class="code">"x";"y";"z"</code> -&gt; "x, y and z"
+</div>
+</td></tr>
<tr><td><a href="OpamState.html#VALprint_env_warning">print_env_warning</a> [<a href="OpamState.html">OpamState</a>]</td>
<td><div class="info">
Print a warning if the environment is not set-up properly.
@@ -2143,12 +2189,28 @@
Rebuild the state cache.
</div>
</td></tr>
+<tr><td><a href="OpamSystem.html#VALrec_dirs">rec_dirs</a> [<a href="OpamSystem.html">OpamSystem</a>]</td>
+<td><div class="info">
+<code class="code">rec_dirs dir</code> return the list list of all directories recursively
+ (going through symbolink links).
+</div>
+</td></tr>
+<tr><td><a href="OpamFilename.html#VALrec_dirs">rec_dirs</a> [<a href="OpamFilename.html">OpamFilename</a>]</td>
+<td><div class="info">
+List the sub-directory recursively
+</div>
+</td></tr>
<tr><td><a href="OpamSystem.html#VALrec_files">rec_files</a> [<a href="OpamSystem.html">OpamSystem</a>]</td>
<td><div class="info">
<code class="code">rec_files dir</code> returns the list of all files in <code class="code">dir</code>,
recursively.
</div>
</td></tr>
+<tr><td><a href="OpamFilename.html#VALrec_files">rec_files</a> [<a href="OpamFilename.html">OpamFilename</a>]</td>
+<td><div class="info">
+List all the filenames, recursively
+</div>
+</td></tr>
<tr><td><a href="OpamLocal.html#VALregister">register</a> [<a href="OpamLocal.html">OpamLocal</a>]</td>
<td></td></tr>
<tr><td><a href="OpamHTTP.html#VALregister">register</a> [<a href="OpamHTTP.html">OpamHTTP</a>]</td>
@@ -2263,6 +2325,16 @@
Remove the state cache
</div>
</td></tr>
+<tr><td><a href="OpamMisc.html#VALremove_suffix">remove_suffix</a> [<a href="OpamMisc.html">OpamMisc</a>]</td>
+<td><div class="info">
+Remove a suffix
+</div>
+</td></tr>
+<tr><td><a href="OpamFilename.html#VALremove_suffix">remove_suffix</a> [<a href="OpamFilename.html">OpamFilename</a>]</td>
+<td><div class="info">
+Remove a suffix from a filename
+</div>
+</td></tr>
<tr><td><a href="OpamFile.Subst.html#VALreplace">replace</a> [<a href="OpamFile.Subst.html">OpamFile.Subst</a>]</td>
<td><div class="info">
Substitute the variables appearing in a file
@@ -2416,6 +2488,26 @@
Create a sequential solution from a list of actions
</div>
</td></tr>
+<tr><td><a href="OpamConfigCommand.html#VALsetup">setup</a> [<a href="OpamConfigCommand.html">OpamConfigCommand</a>]</td>
+<td><div class="info">
+Update the global and user configuration to use OPAM.
+</div>
+</td></tr>
+<tr><td><a href="OpamClient.API.CONFIG.html#VALsetup">setup</a> [<a href="OpamClient.API.CONFIG.html">OpamClient.API.CONFIG</a>]</td>
+<td><div class="info">
+Global and user setup of OPAM.
+</div>
+</td></tr>
+<tr><td><a href="OpamConfigCommand.html#VALsetup_list">setup_list</a> [<a href="OpamConfigCommand.html">OpamConfigCommand</a>]</td>
+<td><div class="info">
+Display the global and user configuration for OPAM.
+</div>
+</td></tr>
+<tr><td><a href="OpamClient.API.CONFIG.html#VALsetup_list">setup_list</a> [<a href="OpamClient.API.CONFIG.html">OpamClient.API.CONFIG</a>]</td>
+<td><div class="info">
+Display global and user informations about OPAM setup.
+</div>
+</td></tr>
<tr><td><a href="OpamPath.Switch.html#VALshare">share</a> [<a href="OpamPath.Switch.html">OpamPath.Switch</a>]</td>
<td><div class="info">
Share directory for a given package: <i>$opam/$OVERSION/share/$package</i>
@@ -2651,6 +2743,11 @@
Cut a string
</div>
</td></tr>
+<tr><td><a href="OpamFilename.html#VALsub_dirs">sub_dirs</a> [<a href="OpamFilename.html">OpamFilename</a>]</td>
+<td><div class="info">
+List the sub-directory
+</div>
+</td></tr>
<tr><td><a href="OpamConfigCommand.html#VALsubst">subst</a> [<a href="OpamConfigCommand.html">OpamConfigCommand</a>]</td>
<td><div class="info">
Substitute files
@@ -2737,6 +2834,11 @@
</div>
</td></tr>
<tr><td align="left"><br>T</td></tr>
+<tr><td><a href="OpamFile.OPAM.html#VALtags">tags</a> [<a href="OpamFile.OPAM.html">OpamFile.OPAM</a>]</td>
+<td><div class="info">
+Classification tags
+</div>
+</td></tr>
<tr><td><a href="OpamSystem.html#VALtemp_file">temp_file</a> [<a href="OpamSystem.html">OpamSystem</a>]</td>
<td><div class="info">
Create a tempory file in <i>~/.opam/logs/&lt;name&gt;XXX</i>
@@ -2896,6 +2998,11 @@
Refresh the available packages.
</div>
</td></tr>
+<tr><td><a href="OpamState.html#VALupdate_env_variables">update_env_variables</a> [<a href="OpamState.html">OpamState</a>]</td>
+<td><div class="info">
+Update the global environment variables.
+</div>
+</td></tr>
<tr><td><a href="OpamState.html#VALupdate_hook">update_hook</a> [<a href="OpamState.html">OpamState</a>]</td>
<td><div class="info">
Update hook.
@@ -2916,6 +3023,16 @@
Update pinned package
</div>
</td></tr>
+<tr><td><a href="OpamState.html#VALupdate_setup">update_setup</a> [<a href="OpamState.html">OpamState</a>]</td>
+<td><div class="info">
+Update the user configuration.
+</div>
+</td></tr>
+<tr><td><a href="OpamState.html#VALupdate_setup_interactive">update_setup_interactive</a> [<a href="OpamState.html">OpamState</a>]</td>
+<td><div class="info">
+Update the global and user configuration by asking some questions.
+</div>
+</td></tr>
<tr><td><a href="OpamPath.Repository.html#VALupdated">updated</a> [<a href="OpamPath.Repository.html">OpamPath.Repository</a>]</td>
<td><div class="info">
Return the list of updated packages:
@@ -2953,7 +3070,7 @@
</td></tr>
<tr><td><a href="OpamPath.Repository.html#VALurl">url</a> [<a href="OpamPath.Repository.html">OpamPath.Repository</a>]</td>
<td><div class="info">
-urls <i>$opma/repo/$repo/package/$NAME.$VERSION/url</i>
+urls <i>$opma/repo/$repo/package/XXX/$NAME.$VERSION/url</i>
</div>
</td></tr>
<tr><td><a href="OpamFile.URL.html#VALurl">url</a> [<a href="OpamFile.URL.html">OpamFile.URL</a>]</td>
@@ -3027,11 +3144,6 @@
Package version
</div>
</td></tr>
-<tr><td><a href="OpamRepository.html#VALversions">versions</a> [<a href="OpamRepository.html">OpamRepository</a>]</td>
-<td><div class="info">
-Get the available versions for a given compiler
-</div>
-</td></tr>
<tr><td><a href="OpamPackage.html#VALversions_of_name">versions_of_name</a> [<a href="OpamPackage.html">OpamPackage</a>]</td>
<td><div class="info">
Return the list of versions for a given package
View
4 doc/html/type_OpamClient.API.CONFIG.html
@@ -44,6 +44,10 @@
<code class="code"><span class="keyword">sig</span><br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;config&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.config&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;env&nbsp;:&nbsp;csh:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;setup&nbsp;:<br>
+&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.user_config&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.global_config&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;setup_list&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.shell&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;exec&nbsp;:&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;includes&nbsp;:&nbsp;is_rec:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.name&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;list&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;variable&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.full_variable&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
View
6 doc/html/type_OpamClient.API.SWITCH.html
@@ -42,8 +42,10 @@
</head>
<body>
<code class="code"><span class="keyword">sig</span><br>
-&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;switch&nbsp;:&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
-&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;install&nbsp;:&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;switch&nbsp;:&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;warning:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;install&nbsp;:<br>
+&nbsp;&nbsp;&nbsp;&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;warning:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;import&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;export&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;remove&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
View
19 doc/html/type_OpamClient.API.html
@@ -42,10 +42,15 @@
</head>
<body>
<code class="code"><span class="keyword">sig</span><br>
-&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;init&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.repository&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;jobs:int&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;init&nbsp;:<br>
+&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.repository&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;jobs:int&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.shell&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;[&nbsp;<span class="keywordsign">`</span>ask&nbsp;<span class="keywordsign">|</span>&nbsp;<span class="keywordsign">`</span>no&nbsp;<span class="keywordsign">|</span>&nbsp;<span class="keywordsign">`</span>yes&nbsp;]&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;list&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;print_short:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;installed_only:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;installed_roots:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;?name_only:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;?case_sensitive:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;info&nbsp;:&nbsp;fields:string&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;install&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
@@ -53,11 +58,16 @@
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;update&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.repository_name&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;upgrade&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;upload&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.upload&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.repository_name&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
-&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;remove&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;remove&nbsp;:&nbsp;autoremove:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">CONFIG</span>&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">sig</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;config&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.config&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;env&nbsp;:&nbsp;csh:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;setup&nbsp;:<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.user_config&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.global_config&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;setup_list&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.shell&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;exec&nbsp;:&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;includes&nbsp;:&nbsp;is_rec:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.name&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;list&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;variable&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.full_variable&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
@@ -75,9 +85,10 @@
&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">end</span><br>
&nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">SWITCH</span>&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">sig</span><br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;switch&nbsp;:&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;switch&nbsp;:&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;warning:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;install&nbsp;:<br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;warning:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;import&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;export&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;remove&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
View
19 doc/html/type_OpamClient.SafeAPI.html
@@ -42,10 +42,15 @@
</head>
<body>
<code class="code"><span class="keyword">sig</span><br>
-&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;init&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.repository&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;jobs:int&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;init&nbsp;:<br>
+&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.repository&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;jobs:int&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.shell&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;[&nbsp;<span class="keywordsign">`</span>ask&nbsp;<span class="keywordsign">|</span>&nbsp;<span class="keywordsign">`</span>no&nbsp;<span class="keywordsign">|</span>&nbsp;<span class="keywordsign">`</span>yes&nbsp;]&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;list&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;print_short:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;installed_only:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;installed_roots:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;?name_only:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;?case_sensitive:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;info&nbsp;:&nbsp;fields:string&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;install&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
@@ -53,11 +58,16 @@
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;update&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.repository_name&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;upgrade&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;upload&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.upload&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.repository_name&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
-&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;remove&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;remove&nbsp;:&nbsp;autoremove:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">CONFIG</span>&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">sig</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;config&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.config&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;env&nbsp;:&nbsp;csh:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;setup&nbsp;:<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.user_config&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.global_config&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;setup_list&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.shell&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;exec&nbsp;:&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;includes&nbsp;:&nbsp;is_rec:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.name&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;list&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;variable&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.full_variable&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
@@ -75,9 +85,10 @@
&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">end</span><br>
&nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">SWITCH</span>&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">sig</span><br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;switch&nbsp;:&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;switch&nbsp;:&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;warning:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;install&nbsp;:<br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;warning:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;import&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;export&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;remove&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
View
38 doc/html/type_OpamClient.html
@@ -45,10 +45,15 @@
&nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">API</span>&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">sig</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;init&nbsp;:<br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.repository&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;jobs:int&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.repository&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;jobs:int&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.shell&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;[&nbsp;<span class="keywordsign">`</span>ask&nbsp;<span class="keywordsign">|</span>&nbsp;<span class="keywordsign">`</span>no&nbsp;<span class="keywordsign">|</span>&nbsp;<span class="keywordsign">`</span>yes&nbsp;]&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;list&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;print_short:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;installed_only:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;installed_roots:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;?name_only:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;?case_sensitive:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;info&nbsp;:&nbsp;fields:string&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;install&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
@@ -56,11 +61,16 @@
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;update&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.repository_name&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;upgrade&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;upload&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.upload&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.repository_name&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;remove&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;remove&nbsp;:&nbsp;autoremove:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">CONFIG</span>&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">sig</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;config&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.config&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;env&nbsp;:&nbsp;csh:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;setup&nbsp;:<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.user_config&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.global_config&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;setup_list&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.shell&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;exec&nbsp;:&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;includes&nbsp;:&nbsp;is_rec:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.name&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;list&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;variable&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.full_variable&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
@@ -78,9 +88,10 @@
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">end</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">SWITCH</span>&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">sig</span><br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;switch&nbsp;:&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;switch&nbsp;:&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;warning:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;install&nbsp;:<br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;quiet:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;warning:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;import&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;export&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;remove&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.switch&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
@@ -100,10 +111,15 @@
&nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">SafeAPI</span>&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">sig</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;init&nbsp;:<br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.repository&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;jobs:int&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.repository&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.compiler&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;jobs:int&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.shell&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">OpamTypes</span>.filename&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;[&nbsp;<span class="keywordsign">`</span>ask&nbsp;<span class="keywordsign">|</span>&nbsp;<span class="keywordsign">`</span>no&nbsp;<span class="keywordsign">|</span>&nbsp;<span class="keywordsign">`</span>yes&nbsp;]&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;list&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;print_short:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;installed_only:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;installed_roots:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;?name_only:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;?case_sensitive:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;info&nbsp;:&nbsp;fields:string&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;install&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.name_set&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
@@ -111,11 +127,16 @@
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;update&nbsp;:&nbsp;<span class="constructor">OpamTypes</span>.repository_name&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;upgrade&nbsp;:&nbsp;<span class="