Module Cmdliner.Term

type +'a t
val const : 'a -> 'a t
val ($) : ('a -> 'b) t -> 'a t -> 'b t
val app : ('a -> 'b) t -> 'a t -> 'b t
val map : ('a -> 'b) -> 'a t -> 'b t
val product : 'a t -> 'b t -> ('a * 'b) t
module Syntax : sig ... end
val term_result : ?usage:bool -> ('a, [ `Msg of string ]) result t -> 'a t
val term_result' : ?usage:bool -> ('a, string) result t -> 'a t
val cli_parse_result : ('a, [ `Msg of string ]) result t -> 'a t
val cli_parse_result' : ('a, string) result t -> 'a t
val main_name : string t
val choice_names : string list t
val with_used_args : 'a t -> ('a * string list) t
type !'a ret = [
  1. | `Error of bool * string
  2. | `Help of Manpage.format * string option
  3. | `Ok of 'a
]
val ret : 'a ret t -> 'a t
type exit_info
  • deprecated Use Cmd.Exit.info instead.
val exit_info : ?docs:string -> ?doc:string -> ?max:int -> int -> exit_info
  • deprecated Use Cmd.Exit.info instead.
val default_exits : exit_info list
  • deprecated Use Cmd.Exit.defaults or Cmd.info's defaults ~exits value instead.
val default_error_exits : exit_info list
  • deprecated List.filter the Cmd.Exit.defaults value instead.
type env_info
  • deprecated Use Cmd.Env.info instead.
val env_info : ?docs:string -> ?doc:string -> string -> env_info
  • deprecated Use Cmd.Env.info instead.
type info
  • deprecated Use Cmd.info instead.
val info : ?man_xrefs:Manpage.xref list -> ?man:Manpage.block list -> ?envs:env_info list -> ?exits:exit_info list -> ?sdocs:string -> ?docs:string -> ?doc:string -> ?version:string -> string -> info
  • deprecated Use Cmd.info instead.
val name : info -> string
  • deprecated Use Cmd.name instead.
type !'a result = [
  1. | `Error of [ `Exn | `Parse | `Term ]
  2. | `Help
  3. | `Ok of 'a
  4. | `Version
]
val eval : ?help:Format.formatter -> ?err:Format.formatter -> ?catch:bool -> ?env:(string -> string option) -> ?argv:string array -> ('a t * info) -> 'a result
  • deprecated Use Cmd.v and one of Cmd.eval* instead.
val eval_choice : ?help:Format.formatter -> ?err:Format.formatter -> ?catch:bool -> ?env:(string -> string option) -> ?argv:string array -> ('a t * info) -> ('a t * info) list -> 'a result
  • deprecated Use Cmd.group and one of Cmd.eval* instead.
val eval_peek_opts : ?version_opt:bool -> ?env:(string -> string option) -> ?argv:string array -> 'a t -> 'a option * 'a result
  • deprecated Use Cmd.eval_peek_opts instead.
val exit_status_success : int
  • deprecated Use Cmd.Exit.ok instead.
val exit_status_cli_error : int
  • deprecated Use Cmd.Exit.cli_error instead.
val exit_status_internal_error : int
  • deprecated Use Cmd.Exit.internal_error instead.
val exit_status_of_result : ?term_err:int -> unit result -> int
  • deprecated Use Cmd.eval instead.
val exit_status_of_status_result : ?term_err:int -> int result -> int
  • deprecated Use Cmd.eval' instead.
val exit : ?term_err:int -> unit result -> unit
  • deprecated Use Stdlib.exit and Cmd.eval instead.
val exit_status : ?term_err:int -> int result -> unit
  • deprecated Use Stdlib.exit and Cmd.eval' instead.
val pure : 'a -> 'a t
  • deprecated Use Term.const instead.
val man_format : Manpage.format t
  • deprecated Use Arg.man_format instead.