summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndy Wingo <wingo@pobox.com>2016-06-25 10:06:15 +0200
committerAndy Wingo <wingo@pobox.com>2016-06-25 10:06:15 +0200
commit73714b87aa920b8d29223f8de701c0713fb4e6af (patch)
tree73c88efa8083791a4627780635e8ed1cfc545652
parent5f9134c32d0c4d7497dfeabbcc219e35a66013d5 (diff)
downloadguile-73714b87aa920b8d29223f8de701c0713fb4e6af.tar.gz
Add documentation pointer from getopt-long to SRFI-37.
* doc/ref/mod-getopt-long.texi (getopt-long): Point to SRFI-37.
-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}.