aboutsummaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
authorUlrich Drepper <drepper@redhat.com>2000-04-15 19:38:00 +0000
committerUlrich Drepper <drepper@redhat.com>2000-04-15 19:38:00 +0000
commit29094e48802f69927d59b5edf5afc90ec222c8b9 (patch)
tree9c5d3b0dba3e61c6d5e3f2023979529006ad983e /manual
parentafdda55ad55b49ee46e42976c42978460907baad (diff)
downloadglibc-29094e48802f69927d59b5edf5afc90ec222c8b9.zip
glibc-29094e48802f69927d59b5edf5afc90ec222c8b9.tar.gz
glibc-29094e48802f69927d59b5edf5afc90ec222c8b9.tar.bz2
Update.
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>.
Diffstat (limited to 'manual')
-rw-r--r--manual/argp.texi9
1 files changed, 6 insertions, 3 deletions
diff --git a/manual/argp.texi b/manual/argp.texi
index 0c4a85c..14a9df2 100644
--- a/manual/argp.texi
+++ b/manual/argp.texi
@@ -1,7 +1,7 @@
@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>.
@@ -74,6 +74,9 @@ in @var{flags}, calling @code{argp_parse} may result in the program
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
@@ -401,7 +404,7 @@ this parser function, or a unix error code if a real error occurred
@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
@@ -554,7 +557,7 @@ Some non-option argument was unrecognized.
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