+2000-04-15 Ulrich Drepper <drepper@redhat.com>
+
+ * manual/argp.texi: Document index parameter of argp_parse.
+ Fix typo.
+ Reported by Andrew Schulman <SCHULMAN.ANDREW@epamail.epa.gov>.
+
2000-04-14 Andreas Jaeger <aj@suse.de>
* sysdeps/unix/sysv/linux/shm_open.c: Include linux_fsinfo for
@ignore
Documentation for the argp argument parser
- Copyright (C) 1995, 1996, 1997, 1998 Free Software Foundation, Inc.
+ Copyright (C) 1995, 1996, 1997, 1998, 2000 Free Software Foundation, Inc.
This file is part of the GNU C Library.
Written by Miles Bader <miles@gnu.ai.mit.edu>.
exiting---for instance when an unknown option is encountered.
@xref{Program Termination}.
+If @var{arg_index} is non-NULL, the index of the first unparsed option
+in @var{argv} is returned in it.
+
The return value is zero for successful parsing, or a unix error code
(@pxref{Error Codes}) if an error was detected. Different argp parsers
may return arbitrary error codes, but standard ones are @code{ENOMEM} if
@deftypevr Macro int ARGP_ERR_UNKNOWN
Argp parser functions should return @code{ARGP_ERR_UNKNOWN} for any
@var{key} value they do not recognize, or for non-option arguments
-(@code{@var{key} == ARGP_KEY_ARG}) that they do not which to handle.
+(@code{@var{key} == ARGP_KEY_ARG}) that they do not wish to handle.
@end deftypevr
@need 3000
This occurs when every parser function returns @code{ARGP_KEY_UNKNOWN}
for an argument, in which case parsing stops at that argument. If a
-non-zero value for @var{arg_index} was passed to @code{argp_parse}, the
+non-NULL value for @var{arg_index} was passed to @code{argp_parse}, the
index of this argument is returned in it, otherwise an error occurs.
@end table