diff options
| author | Roland McGrath <roland@hack.frob.com> | 2012-06-11 16:20:09 -0700 |
|---|---|---|
| committer | Roland McGrath <roland@hack.frob.com> | 2012-06-11 16:21:44 -0700 |
| commit | eb55f5c21f2755488c4edb6f65b2594ea743b243 (patch) | |
| tree | 08f6cbca307fbcab7faba2904ca5299fb44d1da0 /manual | |
| parent | 99ff6e5c49c10bb1827e102c7a8eb6b504f0886f (diff) | |
| download | glibc-eb55f5c21f2755488c4edb6f65b2594ea743b243.tar glibc-eb55f5c21f2755488c4edb6f65b2594ea743b243.tar.gz glibc-eb55f5c21f2755488c4edb6f65b2594ea743b243.tar.bz2 glibc-eb55f5c21f2755488c4edb6f65b2594ea743b243.zip | |
BZ#14218: Reword argp_parse description slightly.
Diffstat (limited to 'manual')
| -rw-r--r-- | manual/argp.texi | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/manual/argp.texi b/manual/argp.texi index b37232306b..097c5c6a74 100644 --- a/manual/argp.texi +++ b/manual/argp.texi @@ -38,13 +38,13 @@ needed in @code{main}. @deftypefun {error_t} argp_parse (const struct argp *@var{argp}, int @var{argc}, char **@var{argv}, unsigned @var{flags}, int *@var{arg_index}, void *@var{input}) The @code{argp_parse} function parses the arguments in @var{argv}, of length @var{argc}, using the argp parser @var{argp}. @xref{Argp -Parsers}. +Parsers}. Passing a null pointer for @var{argp} is the same as using +a @code{struct argp} containing all zeros. -A value of zero is the same as a @code{struct argp}containing all -zeros. @var{flags} is a set of flag bits that modify the parsing -behavior. @xref{Argp Flags}. @var{input} is passed through to the argp -parser @var{argp}, and has meaning defined by @var{argp}. A typical -usage is to pass a pointer to a structure which is used for specifying +@var{flags} is a set of flag bits that modify the parsing behavior. +@xref{Argp Flags}. @var{input} is passed through to the argp parser +@var{argp}, and has meaning defined by @var{argp}. A typical usage is +to pass a pointer to a structure which is used for specifying parameters to the parser and passing back the results. Unless the @code{ARGP_NO_EXIT} or @code{ARGP_NO_HELP} flags are included |