Cmdliner

Command line arguments as terms.

Sourcetype 'a parser = string -> [ `Ok of 'a | `Error of string ]

Sourcetype 'a printer = Stdlib.Format.formatter -> 'a -> unit

Sourcetype 'a conv = 'a parser * 'a printer

Sourcetype 'a converter = 'a conv

val conv : 
  ?docv:string ->
  ((string -> ('a, [ `Msg of string ]) Stdlib.result) * 'a printer) ->
  'a conv

Source

val conv' : 
  ?docv:string ->
  ((string -> ('a, string) Stdlib.result) * 'a printer) ->
  'a conv

Sourceval pconv : ?docv:string -> ('a parser * 'a printer) -> 'a conv

Sourceval conv_parser : 'a conv -> string -> ('a, [ `Msg of string ]) Stdlib.result

Sourceval conv_printer : 'a conv -> 'a printer

Sourceval conv_docv : 'a conv -> string

Source

val parser_of_kind_of_string : 
  kind:string ->
  (string -> 'a option) ->
  string ->
  ('a, [ `Msg of string ]) Stdlib.result

Sourceval some : ?none:string -> 'a converter -> 'a option converter

Sourceval some' : ?none:'a -> 'a converter -> 'a option converter

Sourcetype env = Cmdliner_info.Env.info

Source

val env_var : 
  ?deprecated:string ->
  ?docs:string ->
  ?doc:string ->
  string ->
  env

Sourcetype 'a t = 'a Cmdliner_term.t

Sourcetype info

Source

val info : 
  ?deprecated:string ->
  ?absent:string ->
  ?docs:string ->
  ?docv:string ->
  ?doc:string ->
  ?env:env ->
  string list ->
  info

Sourceval (&) : ('a -> 'b) -> 'a -> 'b

Sourceval flag : info -> bool t

Sourceval flag_all : info -> bool list t

Sourceval vflag : 'a -> ('a * info) list -> 'a t

Sourceval vflag_all : 'a list -> ('a * info) list -> 'a list t

Sourceval opt : ?vopt:'a -> 'a converter -> 'a -> info -> 'a t

Sourceval opt_all : ?vopt:'a -> 'a converter -> 'a list -> info -> 'a list t

Sourceval pos : ?rev:bool -> int -> 'a converter -> 'a -> info -> 'a t

Sourceval pos_all : 'a converter -> 'a list -> info -> 'a list t

Sourceval pos_left : ?rev:bool -> int -> 'a converter -> 'a list -> info -> 'a list t

Source

val pos_right : 
  ?rev:bool ->
  int ->
  'a converter ->
  'a list ->
  info ->
  'a list t

As terms

Sourceval value : 'a t -> 'a Cmdliner_term.t

Sourceval required : 'a option t -> 'a Cmdliner_term.t

Sourceval non_empty : 'a list t -> 'a list Cmdliner_term.t

Sourceval last : 'a list t -> 'a Cmdliner_term.t

Predefined arguments

Sourceval man_format : Cmdliner_manpage.format Cmdliner_term.t

Sourceval stdopt_version : docs:string -> bool Cmdliner_term.t

Sourceval stdopt_help : docs:string -> Cmdliner_manpage.format option Cmdliner_term.t

Converters

Sourceval bool : bool converter

Sourceval char : char converter

Sourceval int : int converter

Sourceval nativeint : nativeint converter

Sourceval int32 : int32 converter

Sourceval int64 : int64 converter

Sourceval float : float converter

Sourceval string : string converter

Sourceval enum : (string * 'a) list -> 'a converter

Sourceval file : string converter

Sourceval dir : string converter

Sourceval non_dir_file : string converter

Sourceval list : ?sep:char -> 'a converter -> 'a list converter

Sourceval array : ?sep:char -> 'a converter -> 'a array converter

Sourceval pair : ?sep:char -> 'a converter -> 'b converter -> ('a * 'b) converter

Sourceval t2 : ?sep:char -> 'a converter -> 'b converter -> ('a * 'b) converter

Source

val t3 : 
  ?sep:char ->
  'a converter ->
  'b converter ->
  'c converter ->
  ('a * 'b * 'c) converter

Source

val t4 : 
  ?sep:char ->
  'a converter ->
  'b converter ->
  'c converter ->
  'd converter ->
  ('a * 'b * 'c * 'd) converter

Sourceval doc_quote : string -> string

Sourceval doc_alts : ?quoted:bool -> string list -> string

Sourceval doc_alts_enum : ?quoted:bool -> (string * 'a) list -> string

Jump To

Table of Contents

As terms

Predefined arguments

Converters