Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package minicli
Exceptions
Initialization
val init : unit -> int * argsCall init before using any of the other funtions (unless you really know what you are doing). let argc, args = CLI.init () in ... will compute argc and transform Sys.argv into the string list args.
Finalization
You can (but you are not forced to) call finalize in case options parsing is finished. Meaning, the program will not try to process command line options anymore. finalize will enforce that there are no unused options left on the command line. In case there are some options left unused on the command line, finalize will raise an Unused_options exception listing them all.
Parse mandatory options
val get_int : option_strings -> args -> intread a mandatory int from the command line
val get_char : option_strings -> args -> charread a mandatory char from the command line
val get_string : option_strings -> args -> stringread a mandatory string from the command line
val get_float : option_strings -> args -> floatread a mandatory float from the command line
val get_bool : option_strings -> args -> boolundocumented
val get_set_bool : option_strings -> args -> boolreturn true if flag was present on the command line, false otherwise
val get_reset_bool : option_strings -> args -> boolreturn false if flag was present on the command line, true otherwise
Parse optional options
val get_int_opt : option_strings -> args -> int optionread an optional int from the command line
val get_char_opt : option_strings -> args -> char optionread an optional char from the command line
val get_string_opt : option_strings -> args -> string optionread an optional string from the command line
val get_float_opt : option_strings -> args -> float optionread an optional float from the command line
val get_bool_opt : option_strings -> args -> bool optionundocumented
Parse optional options with a default value
val get_int_def : option_strings -> args -> int -> intread an optional int from the command line, or use the provided default if option was not seen on the command line
val get_string_def : option_strings -> args -> string -> stringread an optional string from the command line, or use the provided default if option was not seen on the command line
val get_char_def : option_strings -> args -> char -> charread an optional char from the command line, or use the provided default if option was not seen on the command line
val get_float_def : option_strings -> args -> float -> floatread an optional float from the command line, or use the provided default if option was not seen on the command line
val get_bool_def : option_strings -> args -> bool -> boolundocumented