summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRical Jasan <ricaljasan@pacific.net>2017-05-26 03:59:15 -0700
committerRical Jasan <ricaljasan@pacific.net>2017-06-16 01:19:30 -0700
commit76b9ffef87fa2328bf491257bc6379add1344f2d (patch)
tree575bb5746ed3482bfff2d912479f521c97f6b7fc
parentd08a7e4cbe43d5e4e4b14dea950fea623d96c1a1 (diff)
downloadglibc-76b9ffef87fa2328bf491257bc6379add1344f2d.tar.gz
manual: Complete @standards in argp.texi.
* manual/argp.texi (ARGP_HELP_USAGE): Add missing header and standard annotation. (ARGP_HELP_SHORT_USAGE): Likewise. (ARGP_HELP_SEE): Likewise. (ARGP_HELP_LONG): Likewise. (ARGP_HELP_PRE_DOC): Likewise. (ARGP_HELP_POST_DOC): Likewise. (ARGP_HELP_DOC): Likewise. (ARGP_HELP_BUG_ADDR): Likewise. (ARGP_HELP_LONG_ONLY): Likewise. (ARGP_HELP_EXIT_ERR): Likewise. (ARGP_HELP_EXIT_OK): Likewise. (ARGP_HELP_STD_ERR): Likewise. (ARGP_HELP_STD_USAGE): Likewise. (ARGP_HELP_STD_HELP): Likewise.
-rw-r--r--ChangeLog18
-rw-r--r--manual/argp.texi14
2 files changed, 32 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index e9bb612d5b..d26979335c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,21 @@
+2017-06-16 Rical Jasan <ricaljasan@pacific.net>
+
+ * manual/argp.texi (ARGP_HELP_USAGE): Add missing header and
+ standard annotation.
+ (ARGP_HELP_SHORT_USAGE): Likewise.
+ (ARGP_HELP_SEE): Likewise.
+ (ARGP_HELP_LONG): Likewise.
+ (ARGP_HELP_PRE_DOC): Likewise.
+ (ARGP_HELP_POST_DOC): Likewise.
+ (ARGP_HELP_DOC): Likewise.
+ (ARGP_HELP_BUG_ADDR): Likewise.
+ (ARGP_HELP_LONG_ONLY): Likewise.
+ (ARGP_HELP_EXIT_ERR): Likewise.
+ (ARGP_HELP_EXIT_OK): Likewise.
+ (ARGP_HELP_STD_ERR): Likewise.
+ (ARGP_HELP_STD_USAGE): Likewise.
+ (ARGP_HELP_STD_HELP): Likewise.
+
2017-06-15 Rical Jasan <ricaljasan@pacific.net>
* manual/Makefile: Generate summary.texi with summary.pl. Force
diff --git a/manual/argp.texi b/manual/argp.texi
index 854c71b017..0023441812 100644
--- a/manual/argp.texi
+++ b/manual/argp.texi
@@ -1092,35 +1092,44 @@ the following flags, or'd together:
@vtable @code
@item ARGP_HELP_USAGE
+@standards{GNU, argp.h}
A unix @samp{Usage:} message that explicitly lists all options.
@item ARGP_HELP_SHORT_USAGE
+@standards{GNU, argp.h}
A unix @samp{Usage:} message that displays an appropriate placeholder to
indicate where the options go; useful for showing the non-option
argument syntax.
@item ARGP_HELP_SEE
+@standards{GNU, argp.h}
A @samp{Try @dots{} for more help} message; @samp{@dots{}} contains the
program name and @samp{--help}.
@item ARGP_HELP_LONG
+@standards{GNU, argp.h}
A verbose option help message that gives each option available along
with its documentation string.
@item ARGP_HELP_PRE_DOC
+@standards{GNU, argp.h}
The part of the argp parser doc string preceding the verbose option help.
@item ARGP_HELP_POST_DOC
+@standards{GNU, argp.h}
The part of the argp parser doc string that following the verbose option help.
@item ARGP_HELP_DOC
+@standards{GNU, argp.h}
@code{(ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)}
@item ARGP_HELP_BUG_ADDR
+@standards{GNU, argp.h}
A message that prints where to report bugs for this program, if the
@code{argp_program_bug_address} variable contains this information.
@item ARGP_HELP_LONG_ONLY
+@standards{GNU, argp.h}
This will modify any output to reflect the @code{ARGP_LONG_ONLY} mode.
@end vtable
@@ -1130,9 +1139,11 @@ printing its output, or terminates the program:
@vtable @code
@item ARGP_HELP_EXIT_ERR
+@standards{GNU, argp.h}
This will terminate the program with @code{exit (argp_err_exit_status)}.
@item ARGP_HELP_EXIT_OK
+@standards{GNU, argp.h}
This will terminate the program with @code{exit (0)}.
@end vtable
@@ -1141,16 +1152,19 @@ standard messages:
@vtable @code
@item ARGP_HELP_STD_ERR
+@standards{GNU, argp.h}
Assuming that an error message for a parsing error has printed, this
prints a message on how to get help, and terminates the program with an
error.
@item ARGP_HELP_STD_USAGE
+@standards{GNU, argp.h}
This prints a standard usage message and terminates the program with an
error. This is used when no other specific error messages are
appropriate or available.
@item ARGP_HELP_STD_HELP
+@standards{GNU, argp.h}
This prints the standard response for a @samp{--help} option, and
terminates the program successfully.
@end vtable