2 * This program is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU General Public
4 * License v2 as published by the Free Software Foundation.
6 * This program is distributed in the hope that it will be useful,
7 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9 * General Public License for more details.
11 * You should have received a copy of the GNU General Public
12 * License along with this program; if not, write to the
13 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
14 * Boston, MA 021110-1307, USA.
17 #define ARGV0_BUF_SIZE 64
21 int (*fn)(int, char **);
26 * A NULL-terminated array of the following format:
28 * usagestr[0] - one-line synopsis (required)
29 * usagestr[1] - one-line short description (required)
30 * usagestr[2..m] - a long (possibly multi-line) description
32 * usagestr[m + 1] - an empty line separator (required if at least one
33 * option string is given, not needed otherwise)
34 * usagestr[m + 2..n] - option strings, one option per line
36 * usagestr[n + 1] - NULL terminator
38 * Options (if present) should always (even if there is no long
39 * description) be prepended with an empty line. Supplied strings are
40 * indented but otherwise printed as-is, no automatic wrapping is done.
42 * Grep for cmd_*_usage[] for examples.
44 const char * const *usagestr;
46 /* should be NULL if token is not a subgroup */
47 const struct cmd_group *next;
49 /* if true don't list this token in help listings */
57 const struct cmd_struct commands[];
61 int prefixcmp(const char *str, const char *prefix);
63 int check_argc_exact(int nargs, int expected);
64 int check_argc_min(int nargs, int expected);
65 int check_argc_max(int nargs, int expected);
67 int handle_command_group(const struct cmd_group *grp, int argc,
71 extern const char * const generic_cmd_help_usage[];
73 void usage(const char * const *usagestr);
74 void usage_command(const struct cmd_struct *cmd, int full, int err);
75 void usage_command_group(const struct cmd_group *grp, int all, int err);
77 void help_unknown_token(const char *arg, const struct cmd_group *grp);
78 void help_ambiguous_token(const char *arg, const struct cmd_group *grp);
80 void help_command_group(const struct cmd_group *grp, int argc, char **argv);