This module contains the option parser itself.
It provides functions to create, populate and use option parsers to parse command line arguments.
Option_conflict name is raised by OptParse.OptParser.add when two different options are added with identical names. Usually this doesn't need to be caught since this error is usually easily fixed permanently by removing/renaming the conflicting option names.
val make :
?usage:string ->
?description:string ->
?version:string ->
?suppress_usage:bool ->
?suppress_help:bool ->
?only_leading_opts:bool ->
?prog:string ->
?formatter:Formatter.t ->
unit ->
tCreates a new option parser with the given options.
Usage message. The default is a reasonable usage message for most programs. Any occurrence of the substring "%prog" in usage is replaced with the name of the program (see prog).
Program name. The default is the base name of the executable.
Suppress the usage message if set.
Suppress the 'help' option which is otherwise added by default.
Only consider leading options (options appearing before the first non-option argument). All arguments from the first non-option argument on are returned as the arguments.
Version string. If set, a '--version' option is automatically added. When encountered on the command line it causes version to be printed to the standard output and the program to exit.
description of the main purpose of the program.
the new option parser.
val add :
t ->
?group:group ->
?help:string ->
?hide:bool ->
?short_name:char ->
?short_names:char list ->
?long_name:string ->
?long_names:string list ->
'a Opt.t ->
unitAdd an option to the option parser.
Option_conflict if the short name(s) or long name(s) have already been used for some other option.
Short help message describing the option (for the usage message).
If true, hide the option from the usage message. This can be used to implement "secret" options which are not shown, but work just the same as regular options in all other respects.
is the name for the short form of the option (e.g. 'x' means that the option is invoked with -x on the command line).
is a list of names for the short form of the option (see short_name).
is the name for the long form of the option (e.g. "xyzzy" means that the option is invoked with --xyzzy on the command line).
is a list of names for the long form of the option (see long_name).
Add a group to the option parser.
is the parent group (if any).
is a description of the group.
the new group.
val error : t -> ?chn:out_channel -> ?status:int -> string -> unitDisplay an error message and exit the program. The error message is printed to the channel chn (default is Pervasives.stderr) and the program exits with exit status status (default is 1).
val usage : t -> ?chn:out_channel -> unit -> unitDisplay the usage message to the channel chn (default is Pervasives.stdout) and return.
val parse : t -> ?first:int -> ?last:int -> string array -> string listParse arguments as if the arguments args.(first), args.(first+1), ..., args.(last) had been given on the command line. By default first is 0 and last is the index of the last element of the array.
val parse_argv : t -> string listParse all the arguments in Sys.argv.