package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type

INRIA's original command-line parsing library.

The Command module is generally recommended over direct use of this library.

type spec = Stdlib__arg.spec =
  1. | Unit of unit -> unit
  2. | Bool of bool -> unit
  3. | Set of bool Stdlib.ref
  4. | Clear of bool Stdlib.ref
  5. | String of string -> unit
  6. | Set_string of string Stdlib.ref
  7. | Int of int -> unit
  8. | Set_int of int Stdlib.ref
  9. | Float of float -> unit
  10. | Set_float of float Stdlib.ref
  11. | Tuple of spec list
  12. | Symbol of string list * string -> unit
  13. | Rest of string -> unit
  14. | Expand of string -> string array
type key = string
type doc = string
type usage_msg = string
type anon_fun = string -> unit
val parse : (key * spec * doc) list -> anon_fun -> usage_msg -> unit
val parse_dynamic : (key * spec * doc) list Stdlib.ref -> anon_fun -> usage_msg -> unit
val parse_argv : ?current:int Stdlib.ref -> string array -> (key * spec * doc) list -> anon_fun -> usage_msg -> unit
val parse_argv_dynamic : ?current:int Stdlib.ref -> string array -> (key * spec * doc) list Stdlib.ref -> anon_fun -> string -> unit
val parse_and_expand_argv_dynamic : int Stdlib.ref -> string array Stdlib.ref -> (key * spec * doc) list Stdlib.ref -> anon_fun -> string -> unit
val parse_expand : (key * spec * doc) list -> anon_fun -> usage_msg -> unit
exception Help of string
exception Bad of string
val usage : (key * spec * doc) list -> usage_msg -> unit
val usage_string : (key * spec * doc) list -> usage_msg -> string
val align : ?limit:int -> (key * spec * doc) list -> (key * spec * doc) list
val current : int Stdlib.ref
val read_arg : string -> string array
val read_arg0 : string -> string array
val write_arg : string -> string array -> unit
val write_arg0 : string -> string array -> unit
type t = key * spec * doc
val sort_and_align : (key * spec * doc) Base.List.t -> (key * spec * doc) Base.List.t

Like align, except that the specification list is also sorted by key

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct