aboutsummaryrefslogtreecommitdiff
path: root/doc/ref/general/options.texi
blob: 675e91f328e871e8077800a9cacdb9e531db76d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
@node Getopt-Long Extensions
@section Getopt-Long extensions

The module @code{(hnh util options)} extend Guile's
@code{(ice-9 getopt-long)}. The extra keys which can be specified on
an option are

@table @samp
@item (description string)
A propper description of the value. Should be written for human
consumption.

@item (value value-spec)
Value is from the core library, but here ...
@c TODO document me
@end table

@defun getopt-opt options
Remove extensions from @var{options}, turning it into a structure
which can be passed to @code{getopt-long}.
@end defun

@defun format-arg-help options
Pretty print an option summary.

Each description will be parsed as XML and then fed through our markup
system @xref{Markup}.
@end defun

@defun print-arg-help options [port=(current-error-port)]
Formats and prints option spec.
@end defun