NEWS.stable: log cherry-pick [ae006b4]->[4a9738e] strtoimax: Avoid link error on...

[gnulib.git] / doc / posix-functions / getopt.texi

diff --git a/doc/posix-functions/getopt.texi b/doc/posix-functions/getopt.texi
index 004b6e8..099c2e3 100644 (file)
--- a/doc/posix-functions/getopt.texi
+++ b/doc/posix-functions/getopt.texi
@@ -2,7 +2,7 @@
 @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: getopt-posix or getopt-gnu
 
@@ -16,6 +16,10 @@ Portability problems fixed by either Gnulib module @code{getopt-posix} or @code{
 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}:
@@ -23,15 +27,31 @@ Portability problems fixed by Gnulib module @code{getopt-gnu}:
 @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 10.
+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 10, Cygwin 1.5.x.
+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.
+@item
+This function crashes if the option string includes @code{W;} on some
+platforms:
+glibc 2.14.
 @end itemize
 
 Portability problems not fixed by Gnulib:
@@ -41,8 +61,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 function @code{getopt_long_only} is missing on some platforms:
-MacOS X 10.3, FreeBSD 5.2.1, NetBSD 3.0, AIX 5.1, HP-UX 11, IRIX 6.5, OSF/1 5.1, Solaris 9, mingw, Interix 3.5.
+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