Module Gnuarg

module Gnuarg: sig  end

Gnu style parameters to executables

type part =

`\|`	`Name`	`(*`	`The name of the program`	`*)`
`\|`	`Synopsis`	`(*`	`General description of the parameters`	`*)`
`\|`	`Short_description`	`(*`	`Single line description of the program`	`*)`
`\|`	`Description`	`(*`	`More indepth description`	`*)`
`\|`	`Examples`	`(*`	`Examples of the usage of the program`	`*)`
`\|`	`Author`	`(*`	`Name of the author`	`*)`
`\|`	`Reporting_bugs`	`(*`	`The prefered way to contact the author for bug reports`	`*)`
`\|`	`Copyright`	`(*`	`The copyright message of this software`	`*)`
`\|`	`Version`	`(*`	`The current version description`	`*)`
`\|`	`See_also`	`(*`	`Related programs for the same tasks`	`*)`

val parse : (string * (char * string * string * string * (string -> unit)) list) list ->
       (string -> unit) -> (part * string) list -> unit

Usage Gnuarg.parse param_sections extra_params documentation

parm_sections consists of [(section, [(letter_parm, keyword_parm, sub_parameter, description, function)]]:

section: This is a list of sections. Sections are groups of options bundeled together to find them back more easy. When there is no need of sections just provide one section with an empty name.
letter_parm: Inside a section a parameter can have 2 formats. The single character parameters can be grouped together into one parameter.
keyword_parm: A word indicating the function of this parameter. (examle: --keyword)
sub_parameter: This parameter should be given a value (example: --keyw=DIR or -k DIR)
description: A sentence describing the function of this parameter.
function: The function to call when this parameter is provided.

extra_params is the function that is called for the unknown parameters that are given to this program. This is done after all the other parameters are called so the order of parameters is somewhat free.

documentation consists of [(part, description)]

part: This is the part of the documentation
string: The description of this part