<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</title> </head> <body> <code class="code"><span class="keyword">sig</span><br> <span class="keyword">module</span> <span class="constructor">Manpage</span> :<br> <span class="keyword">sig</span><br> <span class="keyword">type</span> block =<br> [ <span class="keywordsign">`</span><span class="constructor">I</span> <span class="keyword">of</span> string * string <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Noblank</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">P</span> <span class="keyword">of</span> string <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">S</span> <span class="keyword">of</span> string ]<br> <span class="keyword">type</span> title = string * int * string * string * string<br> <span class="keyword">type</span> t = <span class="constructor">Cmdliner</span>.<span class="constructor">Manpage</span>.title * <span class="constructor">Cmdliner</span>.<span class="constructor">Manpage</span>.block list<br> <span class="keyword">val</span> print :<br> ?subst:(string <span class="keywordsign">-></span> string) <span class="keywordsign">-></span><br> [ <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="keywordsign">-></span><br> <span class="constructor">Format</span>.formatter <span class="keywordsign">-></span> <span class="constructor">Cmdliner</span>.<span class="constructor">Manpage</span>.t <span class="keywordsign">-></span> unit<br> <span class="keyword">end</span><br> <span class="keyword">module</span> <span class="constructor">Term</span> :<br> <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><br> <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><br> <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> ]<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Help</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Ok</span> <span class="keyword">of</span> <span class="keywordsign">'</span>a<br> <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><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.result<br> <span class="keyword">end</span><br> <span class="keyword">module</span> <span class="constructor">Arg</span> :<br> <span class="keyword">sig</span><br> <span class="keyword">type</span> <span class="keywordsign">'</span>a <span class="keyword">parser</span> = string <span class="keywordsign">-></span> [ <span class="keywordsign">`</span><span class="constructor">Error</span> <span class="keyword">of</span> string <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Ok</span> <span class="keyword">of</span> <span class="keywordsign">'</span>a ]<br> <span class="keyword">type</span> <span class="keywordsign">'</span>a printer = <span class="constructor">Format</span>.formatter <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> unit<br> <span class="keyword">type</span> <span class="keywordsign">'</span>a converter = <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.<span class="keyword">parser</span> * <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.printer<br> <span class="keyword">val</span> some :<br> ?none:string <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span> <span class="keywordsign">'</span>a option <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">type</span> <span class="keywordsign">'</span>a t<br> <span class="keyword">type</span> info<br> <span class="keyword">val</span> info :<br> ?docs:string <span class="keywordsign">-></span><br> ?docv:string <span class="keywordsign">-></span> ?doc:string <span class="keywordsign">-></span> string list <span class="keywordsign">-></span> <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.info<br> <span class="keyword">val</span> ( <span class="keywordsign">&</span> ) : (<span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b) <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="keywordsign">'</span>b<br> <span class="keyword">val</span> flag : <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.info <span class="keywordsign">-></span> bool <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.t<br> <span class="keyword">val</span> flag_all : <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.info <span class="keywordsign">-></span> bool list <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.t<br> <span class="keyword">val</span> vflag : <span class="keywordsign">'</span>a <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a * <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.info) list <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.t<br> <span class="keyword">val</span> vflag_all :<br> <span class="keywordsign">'</span>a list <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a * <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.info) list <span class="keywordsign">-></span> <span class="keywordsign">'</span>a list <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.t<br> <span class="keyword">val</span> opt :<br> ?vopt:<span class="keywordsign">'</span>a <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.info <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.t<br> <span class="keyword">val</span> opt_all :<br> ?vopt:<span class="keywordsign">'</span>a <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a list <span class="keywordsign">-></span> <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.info <span class="keywordsign">-></span> <span class="keywordsign">'</span>a list <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.t<br> <span class="keyword">val</span> pos :<br> ?rev:bool <span class="keywordsign">-></span><br> int <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="keywordsign">-></span> <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.info <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.t<br> <span class="keyword">val</span> pos_all :<br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a list <span class="keywordsign">-></span> <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.info <span class="keywordsign">-></span> <span class="keywordsign">'</span>a list <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.t<br> <span class="keyword">val</span> pos_left :<br> ?rev:bool <span class="keywordsign">-></span><br> int <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a list <span class="keywordsign">-></span> <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.info <span class="keywordsign">-></span> <span class="keywordsign">'</span>a list <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.t<br> <span class="keyword">val</span> pos_right :<br> ?rev:bool <span class="keywordsign">-></span><br> int <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a list <span class="keywordsign">-></span> <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.info <span class="keywordsign">-></span> <span class="keywordsign">'</span>a list <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.t<br> <span class="keyword">val</span> value : <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</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> required : <span class="keywordsign">'</span>a option <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</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> non_empty : <span class="keywordsign">'</span>a list <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.t <span class="keywordsign">-></span> <span class="keywordsign">'</span>a list <span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t<br> <span class="keyword">val</span> last : <span class="keywordsign">'</span>a list <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</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> bool : bool <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> char : char <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> int : int <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> nativeint : nativeint <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> int32 : int32 <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> int64 : int64 <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> float : float <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> string : string <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> enum : (string * <span class="keywordsign">'</span>a) list <span class="keywordsign">-></span> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> file : string <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> dir : string <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> non_dir_file : string <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> list :<br> ?sep:char <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span> <span class="keywordsign">'</span>a list <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> array :<br> ?sep:char <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span> <span class="keywordsign">'</span>a array <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> pair :<br> ?sep:char <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>b <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a * <span class="keywordsign">'</span>b) <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> t2 :<br> ?sep:char <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>b <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a * <span class="keywordsign">'</span>b) <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> t3 :<br> ?sep:char <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>b <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>c <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span> (<span class="keywordsign">'</span>a * <span class="keywordsign">'</span>b * <span class="keywordsign">'</span>c) <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">val</span> t4 :<br> ?sep:char <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>a <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>b <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>c <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> <span class="keywordsign">'</span>d <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter <span class="keywordsign">-></span><br> (<span class="keywordsign">'</span>a * <span class="keywordsign">'</span>b * <span class="keywordsign">'</span>c * <span class="keywordsign">'</span>d) <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.converter<br> <span class="keyword">end</span><br> <span class="keyword">end</span></code></body></html>
