Module Posix_getopt

Short option: a single character (e.g., 'v' for -v).

Long option: a pair of (long name, short equivalent). For example, ("verbose", 'v') matches both --verbose and -v.

Argument specification for an option.

• `None f - Option takes no argument. f () is called when matched.
• `Optional f - Option has an optional argument. f (Some arg) or f None.
• `Required f - Option requires an argument. f arg is called with the value.

Option specification combining name and argument handler.

Raised when an unknown option is encountered.

Raised when a required argument is missing for the given option.

true if the system supports GNU-style long options via getopt_long.

true if the system supports getopt_long_only (long options with single dash).

Enable or disable error messages printed to stderr by getopt. Default is true (errors are printed).

Reset the getopt state for parsing a new set of arguments. Call this before parsing a new argv if you've already parsed arguments.

Parse command-line arguments using short options only.

See getopt(3).

• parameter argv

  The argument array to parse (typically Sys.argv).

• parameter opts

  List of short option specifications.

• returns

  Array of non-option arguments (positional arguments).

• raises Unknown_option

  if an unrecognized option is found.

• raises Missing_argument

  if a required argument is missing.

Example:

  let verbose = ref false in
  let output = ref "out.txt" in
  let opts = [
    { name = 'v'; arg = `None (fun () -> verbose := true) };
    { name = 'o'; arg = `Required (fun s -> output := s) };
  ] in
  let args = getopt Sys.argv opts in
  (* args contains non-option arguments *)

Parse command-line arguments using long options (GNU extension).

See getopt_long(3).

Long options are specified as --name or --name=value. Each long option also has a short equivalent.

• parameter argv

  The argument array to parse.

• parameter opts

  List of long option specifications.

• returns

  Array of non-option arguments.

• raises Unknown_option

  if an unrecognized option is found.

• raises Missing_argument

  if a required argument is missing.

Like getopt_long but also accepts long options with a single dash.

For example, -verbose is treated the same as --verbose.

• parameter argv

  The argument array to parse.

• parameter opts

  List of long option specifications.

• returns

  Array of non-option arguments.