On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package extlib
On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
This module contains various standard options.
Flag options
val store_const : ?default:'a -> 'a -> 'a Opt.tstore_const ?default const returns a flag option which stores the constant value const when the option is encountered on the command line.
val store_true : unit -> bool Opt.tstore_true () returns an option which is set to true when it is encountered on the command line. The default value is false.
val store_false : unit -> bool Opt.tstore_false () returns an option which is set to false when it is encountered on the command line. The default value is true.
val count_option : ?dest:int Stdlib.ref -> ?increment:int -> unit -> int Opt.tCreate a counting option which increments its value each time the option is encountered on the command line.
val incr_option : ?dest:int Stdlib.ref -> unit -> int Opt.tExactly identical to count_option ~dest:dest ~increment:1 ().
val decr_option : ?dest:int Stdlib.ref -> unit -> int Opt.tExactly identical to count_option ~dest:dest ~increment:(-1) ().
Value options
val int_option : ?default:int -> ?metavar:string -> unit -> int Opt.tint_option ?default ?metavar () returns an option which takes a single integer argument. If ~default is given it is the default value returned when the option has not been encountered on the command line.
val float_option : ?default:float -> ?metavar:string -> unit -> float Opt.tval str_option : ?default:string -> ?metavar:string -> unit -> string Opt.tCallback options
val int_callback : ?metavar:string -> (int -> unit) -> unit Opt.tint_callback ?metavar f returns an option which takes a single integer argument and calls f with that argument when encountered on the command line.
val float_callback : ?metavar:string -> (float -> unit) -> unit Opt.tval str_callback : ?metavar:string -> (string -> unit) -> unit Opt.tSpecial options
val help_option : unit -> 'a Opt.thelp_option () returns the standard help option which displays a usage message and exits the program when encountered on the command line.
val version_option : (unit -> string) -> 'a Opt.tversion_option f returns the standard version option which displays the string returned by f () (and nothing else) on standard output and exits.
On This Page