diff options
Diffstat (limited to 'gnulib/doc/posix-functions/getopt.texi')
| m--------- | gnulib | 0 | ||||
| -rw-r--r-- | gnulib/doc/posix-functions/getopt.texi | 81 |
2 files changed, 81 insertions, 0 deletions
diff --git a/gnulib b/gnulib deleted file mode 160000 -Subproject 443bc5ffcf7429e557f4a371b0661abe98ddbc1 diff --git a/gnulib/doc/posix-functions/getopt.texi b/gnulib/doc/posix-functions/getopt.texi new file mode 100644 index 0000000..5f4d321 --- /dev/null +++ b/gnulib/doc/posix-functions/getopt.texi @@ -0,0 +1,81 @@ +@node getopt +@section @code{getopt} +@findex getopt + +POSIX specification:@* @url{http://www.opengroup.org/onlinepubs/9699919799/functions/getopt.html} + +Gnulib module: getopt-posix or getopt-gnu + +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 +This function is missing on some platforms: +MSVC 9. +@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, MSVC 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, MSVC 9, 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: +@itemize +@item +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. +@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 |