1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
|
<html><head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.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="Cmdliner" rel="Chapter" href="Cmdliner.html"><title>Cmdliner.Term</title>
</head>
<body>
<code class="code"><span class="keyword">sig</span><br>
<span class="keyword">type</span> <span class="keywordsign">'</span>a t<br>
<span class="keyword">val</span> pure : <span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t<br>
<span class="keyword">val</span> ( $ ) :<br>
(<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t<br>
<span class="keyword">val</span> app :<br>
(<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>b <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t<br>
<span class="keyword">val</span> ret :<br>
[ <span class="keywordsign">`</span><span class="constructor">Error</span> <span class="keyword">of</span> bool * string<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Help</span> <span class="keyword">of</span> [ <span class="keywordsign">`</span><span class="constructor">Groff</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Pager</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Plain</span> ] * string option<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Ok</span> <span class="keyword">of</span> <span class="keywordsign">'</span>a ] <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t<br>
<span class="keyword">val</span> main_name : string <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t<br>
<span class="keyword">val</span> choice_names : string list <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t<br>
<span class="keyword">val</span> man_format : [ <span class="keywordsign">`</span><span class="constructor">Groff</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Pager</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Plain</span> ] <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t<br>
<span class="keyword">type</span> info<br>
<span class="keyword">val</span> info :<br>
?sdocs:string <span class="keywordsign">-></span><br>
?man:<span class="constructor">Cmdliner</span>.<span class="constructor">Manpage</span>.block list <span class="keywordsign">-></span><br>
?docs:string <span class="keywordsign">-></span><br>
?doc:string <span class="keywordsign">-></span> ?version:string <span class="keywordsign">-></span> string <span class="keywordsign">-></span> <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.info<br>
<span class="keyword">val</span> name : <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.info <span class="keywordsign">-></span> string<br>
<span class="keyword">type</span> <span class="keywordsign">'</span>a result =<br>
[ <span class="keywordsign">`</span><span class="constructor">Error</span> <span class="keyword">of</span> [ <span class="keywordsign">`</span><span class="constructor">Exn</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Parse</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Term</span> ] <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Help</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Ok</span> <span class="keyword">of</span> <span class="keywordsign">'</span>a <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Version</span> ]<br>
<span class="keyword">val</span> eval :<br>
?help:<span class="constructor">Format</span>.formatter <span class="keywordsign">-></span><br>
?err:<span class="constructor">Format</span>.formatter <span class="keywordsign">-></span><br>
?catch:bool <span class="keywordsign">-></span><br>
?argv:string array <span class="keywordsign">-></span><br>
<span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t * <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.info <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.result<br>
<span class="keyword">val</span> eval_choice :<br>
?help:<span class="constructor">Format</span>.formatter <span class="keywordsign">-></span><br>
?err:<span class="constructor">Format</span>.formatter <span class="keywordsign">-></span><br>
?catch:bool <span class="keywordsign">-></span><br>
?argv:string array <span class="keywordsign">-></span><br>
<span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t * <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.info <span class="keywordsign">-></span><br>
(<span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t * <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.info) list <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.result<br>
<span class="keyword">end</span></code></body></html>
|