Index of values

Add an option to the option parser.

Add a group to the option parser.

append e1 e2 returns an enumeration that will enumerate over all elements of e1 followed by all elements of e2.

Make a callback option which takes a single argument.

char_of u returns the Latin-1 representation of u.

code n returns the Unicode character with the code number n.

chr_of_uint n returns the Unicode character of the code number n.

clone e creates a new enumeration that is copy of e.

code u returns the Unicode code number of u.

compare u1 u2 returns, a value > 0 if u1 has a larger Unicode code number than u2, 0 if u1 and u2 are the same Unicode character, a value < 0 if u1 has a smaller Unicode code number than u2.

concat e returns an enumeration over all elements of all enumerations of e.

count e returns the number of remaining elements in e without consuming the enumeration.

Create a counting option which increments its value each time the option is encountered on the command line.

Exactly identical to count_option ~dest:dest ~increment:(-1) ().

default x (Some v) returns v and default x None returns x.

Returns an new named empty global.

The empty enumeration : contains no element

Equality by code point comparison

Display an error message and exit the program.

For users worried about the speed of count you can call the fast_count function that will give an hint about count implementation.

See OptParse.Formatter.wrap.

filter f e returns an enumeration over all elements x of e such as f x returns true.

filter_map f e returns an enumeration over all elements x such as f y returns Some x , where y is an element of e.

find f e returns the first element x of e such that f x returns true, consuming the enumeration up to and including the found element, or, raises Not_found if no such element exists in the enumeration, consuming the whole enumeration in the search.

See OptParse.StdOpt.int_callback.

See OptParse.StdOpt.int_option.

fold f v e returns v if e is empty, otherwise f (... (f (f v a1) a2) ...) aN where a1..N are the elements of e.

fold2 is similar to fold but will fold over two enumerations at the same time until one of the two enumerations ends.

force e forces the application of all lazy functions and the enumeration of all elements, exhausting the enumeration.

from next creates an enumeration from the next function.

get (Some x) returns x and get None raises No_value.

Get the value of an option.

Get the global value contents - raise Global_not_initialized if not defined.

get e returns None if e is empty or Some x where x is the next element of e, in which case the element is removed from the enumeration.

help_option () returns the standard help option which displays a usage message and exits the program when encountered on the command line.

Exactly identical to count_option ~dest:dest ~increment:1 ().

Create an "indented" formatter with the given options.

init n f creates a new enumeration over elements f 0, f 1, ..., f (n-1)

int_callback ?metavar f returns an option which takes a single integer argument and calls f with that argument when encountered on the command line.

Alias of uint_code

int_option ?default ?metavar () returns an option which takes a single integer argument.

is_empty e returns true if e does not contains any element.

is_none None returns true otherwise it returns false.

Find out if the option has a value (either by default or from the command line).

is_some (Some x) returns true otherwise it returns false.

Return true if the global value has been set.

iter f e calls the function f with each elements of e in turn.

iter2 f e1 e2 calls the function f with the next elements of e and e2 repeatedly until one of the two enumerations ends.

junk e removes the first element from the enumeration, if any.

Creates a new option parser with the given options.

This function creates a fully defined enumeration.

map f (Some x) returns Some (f x) and map None returns None.

map f e returns an enumeration over (f a1, f a2, ... , f aN) where a1...N are the elements of e.

map_default f x (Some v) returns f v and map_default f x None returns x.

mapi is similar to map except that f is passed one extra argument which is the index of the element in the enumeration, starting from 0.

may f (Some x) calls f x and may f None does nothing.

Retrieve the name of a global.

of_char c returns the Unicode character of the Latin-1 character c

Get the value of an option as an optional value.

Return None if the global is undefined, else Some v where v is the current global value contents.

Parse arguments as if the arguments args.(first), args.(first+1), ..., args.(last) had been given on the command line.

Parse all the arguments in Sys.argv.

peek e returns None if e is empty or Some x where x is the next element of e.

push e x will add x at the beginning of e.

Set the value of an option.

Set the global value contents.

store_const ?default const returns a flag option which stores the constant value const when the option is encountered on the command line.

store_false () returns an option which is set to false when it is encountered on the command line.

store_true () returns an option which is set to true when it is encountered on the command line.

See OptParse.StdOpt.int_callback.

See OptParse.StdOpt.int_option.

Creates a titled formatter which is quite similar to the indented formatter.

Alias of chr_of_uint

uint_code u returns the Unicode code number of u.

Reset the global value contents to undefined.

Unsafe version of UChar.chr_of_uint.

Display the usage message to the channel chn (default is Pervasives.stdout) and return.

Make an option which takes a single argument.

version_option f returns the standard version option which displays the string returned by f () (and nothing else) on standard output and exits.

wrap text width reflows the given text paragraph into lines of width at most width (lines may exceed this if the are single words that exceed this limit).