summaryrefslogtreecommitdiff
path: root/doc/ref/mod-getopt-long.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ref/mod-getopt-long.texi')
-rw-r--r--doc/ref/mod-getopt-long.texi6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/ref/mod-getopt-long.texi b/doc/ref/mod-getopt-long.texi
index 07fab813b..cf043418f 100644
--- a/doc/ref/mod-getopt-long.texi
+++ b/doc/ref/mod-getopt-long.texi
@@ -7,6 +7,12 @@
@node getopt-long
@section The (ice-9 getopt-long) Module
+The @code{(ice-9 getopt-long)} facility is designed to help parse
+arguments that are passed to Guile programs on the command line, and is
+modelled after the C library's facility of the same name
+(@pxref{Getopt,,,libc,The GNU C Library Reference Manual}). For a more
+low-level interface to command-line argument parsing, @xref{SRFI-37}.
+
The @code{(ice-9 getopt-long)} module exports two procedures:
@code{getopt-long} and @code{option-ref}.