X-Git-Url: http://erislabs.net/gitweb/?a=blobdiff_plain;f=doc%2Fposix-functions%2Fgetopt.texi;h=bab4922e191543227bda1983852e1257b077d364;hb=176cd193605775b290fee26568eec5d1ebd47f58;hp=6bc12302750d3f3d7d10dc7c2e4b8cef5821d60f;hpb=09ef7461110822a3970aa8eebcfaa740996a82f2;p=gnulib.git

diff --git a/doc/posix-functions/getopt.texi b/doc/posix-functions/getopt.texi
index 6bc123027..bab4922e1 100644
--- a/doc/posix-functions/getopt.texi
+++ b/doc/posix-functions/getopt.texi
@@ -2,12 +2,52 @@
 @section @code{getopt}
 @findex getopt
 
-POSIX specification: @url{http://www.opengroup.org/onlinepubs/9699919799/functions/getopt.html}
+POSIX specification:@* @url{http://www.opengroup.org/onlinepubs/9699919799/functions/getopt.html}
 
-Gnulib module: ---
+Gnulib module: getopt-posix or getopt-gnu
 
-Portability problems fixed by Gnulib:
+The module @code{getopt-gnu} has support for ``long options'' and for
+``options that take optional arguments''.  Compared to the API defined by POSIX,
+it adds a header file @code{<getopt.h>} and a function @code{getopt_long}.
+
+Portability problems fixed by either Gnulib module @code{getopt-posix} or @code{getopt-gnu}:
 @itemize
+@item
+The @code{getopt} function keeps some internal state that cannot be explicitly
+reset on some platforms:
+mingw.
+@item
+The value of @code{optind} after a missing required argument is wrong
+on some platforms:
+MacOS 10.5, AIX 7.1.
+@end itemize
+
+Portability problems fixed by Gnulib module @code{getopt-gnu}:
+@itemize
+@item
+The function @code{getopt} does not support the @samp{+} flag in the options
+string on some platforms:
+MacOS X 10.5, AIX 5.2, HP-UX 11, IRIX 6.5, OSF/1 5.1, Solaris 11 2010-11.
+@item
+The function @code{getopt} does not obey the combination of @samp{+}
+and @samp{:} flags in the options string on some platforms:
+glibc 2.11.
+@item
+The function @code{getopt} does not obey the @samp{-} flag in the options
+string when @env{POSIXLY_CORRECT} is set on some platforms:
+Cygwin 1.7.0.
+@item
+The function @code{getopt} does not support options with optional arguments
+on some platforms:
+MacOS X 10.5, OpenBSD 4.0, AIX 5.2, HP-UX 11, IRIX 6.5, OSF/1 5.1,
+Solaris 11 2010-11, Cygwin 1.5.x.
+@item
+The function @code{getopt_long} is missing on some platforms:
+AIX 5.1, HP-UX 11, IRIX 6.5, OSF/1 5.1, Solaris 9, Interix 3.5.
+@item
+The function @code{getopt_long_only} is missing on some platforms:
+MacOS X 10.3, FreeBSD 5.2.1, NetBSD 5.0, AIX 5.1, HP-UX 11, IRIX 6.5,
+OSF/1 5.1, Solaris 9, mingw, Interix 3.5.
 @end itemize
 
 Portability problems not fixed by Gnulib:
@@ -17,9 +57,18 @@ The default behavior of the glibc implementation of @code{getopt} allows
 mixing option and non-option arguments on the command line in any order.
 Other implementations, such as the one in Cygwin, enforce strict POSIX
 compliance: they require that the option arguments precede the non-option
-arguments.  This is something to watch out in your program's testsuite.
+arguments.  This is something to watch out in your program's
+testsuite.
+@item
+The glibc implementation allows a complete reset of the environment,
+including re-checking for @env{POSIXLY_CORRECT}, by setting
+@code{optind} to 0.  Several BSD implementations provide @code{optreset},
+causing a reset by setting it non-zero, although it does not
+necessarily re-read @env{POSIXLY_CORRECT}.  Solaris @code{getopt} does
+not support either reset method, but does not maintain state that
+needs the extra level of reset.
+@item
+On some platforms, this function does not set the stream error
+indicator on attempts to write to a read-only stream:
+glibc 2.13, Cygwin 1.7.9.
 @end itemize
-
-Gnulib provides a module @code{getopt} that has support for ``long options''.
-Compared to POSIX, it adds a header file @code{<getopt.h>} and functions
-@code{getopt_long} and @code{getopt_long_only}.