Idris2Doc : System.Console.GetOpt

System.Console.GetOpt

ArgDescr : Type -> Type
Describes whether an option takes an argument or not, and if so
how the argument is injected into a value of type `a`.
Totality: total
Constructors:
NoArg : a -> ArgDescra
no argument expected
ReqArg : (String -> a) -> String -> ArgDescra
option requires argument
OptArg : (Maybe String -> a) -> String -> ArgDescra
optional argument
ArgOrder : Type -> Type
What to do with options following non-options
Totality: total
Constructors:
RequireOrder : ArgOrdera
no option processing after first non-option
Permute : ArgOrdera
freely intersperse options and non-options
ReturnInOrder : (String -> a) -> ArgOrdera
wrap non-options into options
OptDescr : Type -> Type
Each `OptDescr` describes a single option.

The arguments to 'Option' are:

* list of short option characters
* list of long option strings (without \"--\")
* argument descriptor
* explanation of option for user
Totality: total
Constructor: 
Result : Type -> Type
Result of parsing the command line arguments accoring to a list
of `OptDescr`s. (see also function `getOpt`).
Totality: total
Constructor: 
emptyRes : Resulta
Totality: total
getOpt : ArgOrdera -> List (OptDescra) -> List String -> Resulta
Process the command-line, and return the list of values that matched
(and those that didn't). The arguments are:

* The order requirements (see `ArgOrder`)

* The option descriptions (see `OptDescr`)

* The actual command line arguments (presumably got from
`System.getArgs`).
Totality: total
usageInfo : String -> List (OptDescra) -> String
Return a string describing the usage of a command, derived from
the header (first argument) and the options described by the
second argument.
Totality: total