summaryrefslogtreecommitdiffstats
path: root/apps/include
diff options
context:
space:
mode:
authorRich Salz <rsalz@akamai.com>2019-09-19 21:33:17 -0400
committerTomas Mraz <tmraz@fedoraproject.org>2019-11-20 09:49:52 +0100
commit92de469fbd62a77a36dad5fde3a0ac7034071a59 (patch)
treebd2dfc3fc90d85af938a0e837813f66c5d3fa16c /apps/include
parent1838580037a47b42c5b2326b0b988c50c7c64c3c (diff)
Document command parameters.
Add documentation for all commands that have parameters. Fix a couple of minor doc and programming bugs, too. Fixes #10313 Reviewed-by: Paul Dale <paul.dale@oracle.com> Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10371)
Diffstat (limited to 'apps/include')
-rw-r--r--apps/include/opt.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/apps/include/opt.h b/apps/include/opt.h
index 59bfdcfefb..ac2c236024 100644
--- a/apps/include/opt.h
+++ b/apps/include/opt.h
@@ -271,6 +271,8 @@
extern const char OPT_HELP_STR[];
extern const char OPT_MORE_STR[];
extern const char OPT_SECTION_STR[];
+extern const char OPT_PARAM_STR[];
+
typedef struct options_st {
const char *name;
int retval;
@@ -314,6 +316,7 @@ typedef struct string_int_pair_st {
/* Divide options into sections when displaying usage */
#define OPT_SECTION(sec) { OPT_SECTION_STR, 1, '-', sec " options:\n" }
+#define OPT_PARAMETERS() { OPT_PARAM_STR, 1, '-', "Parameters:\n" }
char *opt_progname(const char *argv0);
char *opt_getprog(void);
@@ -346,7 +349,7 @@ int opt_num_rest(void);
int opt_verify(int i, X509_VERIFY_PARAM *vpm);
int opt_rand(int i);
void opt_help(const OPTIONS * list);
-void opt_print(const OPTIONS * opt, int width);
+void opt_print(const OPTIONS * opt, int doingparams, int width);
int opt_format_error(const char *s, unsigned long flags);
int opt_isdir(const char *name);
int opt_printf_stderr(const char *fmt, ...);