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.
23 static char argv0_buf
[ARGV0_BUF_SIZE
];
25 #define USAGE_SHORT 1U
27 #define USAGE_OPTIONS 4U
28 #define USAGE_LISTING 8U
30 static int do_usage_one_command(const char * const *usagestr
,
31 unsigned int flags
, FILE *outf
)
35 if (!usagestr
|| !*usagestr
)
38 fprintf(outf
, "%s%s\n", (flags
& USAGE_LISTING
) ? " " : "usage: ",
41 /* a short one-line description (mandatory) */
42 if ((flags
& USAGE_SHORT
) == 0)
47 if (flags
& USAGE_LISTING
)
52 fprintf(outf
, "%*s%s\n", pad
, "", *usagestr
++);
54 /* a long (possibly multi-line) description (optional) */
55 if (!*usagestr
|| ((flags
& USAGE_LONG
) == 0))
60 while (*usagestr
&& **usagestr
)
61 fprintf(outf
, "%*s%s\n", pad
, "", *usagestr
++);
63 /* options (optional) */
64 if (!*usagestr
|| ((flags
& USAGE_OPTIONS
) == 0))
68 * options (if present) should always (even if there is no long
69 * description) be prepended with an empty line, skip it
75 fprintf(outf
, "%*s%s\n", pad
, "", *usagestr
++);
80 static int usage_command_internal(const char * const *usagestr
,
81 const char *token
, int full
, int lst
,
84 unsigned int flags
= USAGE_SHORT
;
88 flags
|= USAGE_LONG
| USAGE_OPTIONS
;
90 flags
|= USAGE_LISTING
;
92 ret
= do_usage_one_command(usagestr
, flags
, outf
);
95 fprintf(outf
, "No usage for '%s'\n", token
);
98 fprintf(outf
, "No short description for '%s'\n", token
);
105 static void usage_command_usagestr(const char * const *usagestr
,
106 const char *token
, int full
, int err
)
108 FILE *outf
= err
? stderr
: stdout
;
111 ret
= usage_command_internal(usagestr
, token
, full
, 0, outf
);
116 void usage_command(const struct cmd_struct
*cmd
, int full
, int err
)
118 usage_command_usagestr(cmd
->usagestr
, cmd
->token
, full
, err
);
121 void usage(const char * const *usagestr
)
123 usage_command_usagestr(usagestr
, NULL
, 1, 1);
127 static void usage_command_group_internal(const struct cmd_group
*grp
, int full
,
130 const struct cmd_struct
*cmd
= grp
->commands
;
133 for (; cmd
->token
; cmd
++) {
137 if (full
&& cmd
!= grp
->commands
)
146 usage_command_internal(cmd
->usagestr
, cmd
->token
, full
,
151 /* this is an entry point to a nested command group */
153 if (!full
&& cmd
!= grp
->commands
)
156 usage_command_group_internal(cmd
->next
, full
, outf
);
163 void usage_command_group(const struct cmd_group
*grp
, int full
, int err
)
165 const char * const *usagestr
= grp
->usagestr
;
166 FILE *outf
= err
? stderr
: stdout
;
168 if (usagestr
&& *usagestr
) {
169 fprintf(outf
, "usage: %s\n", *usagestr
++);
171 fprintf(outf
, " or: %s\n", *usagestr
++);
175 usage_command_group_internal(grp
, full
, outf
);
179 fprintf(outf
, "%s\n", grp
->infostr
);
182 void help_unknown_token(const char *arg
, const struct cmd_group
*grp
)
184 fprintf(stderr
, "%s: unknown token '%s'\n", argv0_buf
, arg
);
185 usage_command_group(grp
, 0, 1);
189 void help_ambiguous_token(const char *arg
, const struct cmd_group
*grp
)
191 const struct cmd_struct
*cmd
= grp
->commands
;
193 fprintf(stderr
, "%s: ambiguous token '%s'\n", argv0_buf
, arg
);
194 fprintf(stderr
, "\nDid you mean one of these ?\n");
196 for (; cmd
->token
; cmd
++) {
197 if (!prefixcmp(cmd
->token
, arg
))
198 fprintf(stderr
, "\t%s\n", cmd
->token
);
204 void help_command_group(const struct cmd_group
*grp
, int argc
, char **argv
)
209 if (!strcmp(argv
[1], "--full"))
213 usage_command_group(grp
, full
, 0);