blob: 15f8271ef4d083184bd9c6bc61a24115a60a71bb [file] [log] [blame]
/* help.c - Show help for toybox commands
*
* Copyright 2007 Rob Landley <rob@landley.net>
*
* Often a shell builtin.
USE_HELP(NEWTOY(help, ""USE_HELP_EXTRAS("ah"), TOYFLAG_BIN))
config HELP
bool "help"
default y
depends on TOYBOX_HELP
help
usage: help [command]
Show usage information for toybox commands.
Run "toybox" with no arguments for a list of available commands.
config HELP_EXTRAS
bool "help -ah"
default y
depends on TOYBOX
depends on HELP
help
usage: help [-ah]
-a All commands
-h HTML output
*/
#define FOR_help
#include "toys.h"
static void do_help(struct toy_list *t)
{
if (toys.optflags & FLAG_h)
xprintf("<a name=\"%s\"><h1>%s</h1><blockquote><pre>\n", t->name, t->name);
toys.which = t;
show_help();
if (toys.optflags & FLAG_h) xprintf("</blockquote></pre>\n");
}
// The simple help is just toys.which = toy_find("name"); show_help();
// But iterating through html output and all commands is a big more
void help_main(void)
{
int i;
if (!(toys.optflags & FLAG_a)) {
struct toy_list *t = toys.which;
if (*toys.optargs && !(t = toy_find(*toys.optargs)))
error_exit("Unknown command '%s'", *toys.optargs);
do_help(t);
return;
}
if (toys.optflags & FLAG_h) {
xprintf("<html>\n<title>Toybox command list</title>\n<body>\n<p>\n");
for (i=0; i < toys.toycount; i++)
xprintf("<a href=\"#%s\">%s</a>\n", toy_list[i].name,
toy_list[i].name);
xprintf("</p>\n");
}
for (i = 0; i < toys.toycount; i++) {
if (toys.optflags & FLAG_h) xprintf("<hr>\n<pre>\n");
do_help(toy_list+i);
if (toys.optflags & FLAG_h) xprintf("</pre>\n");
}
if (toys.optflags & FLAG_h) xprintf("</html>");
}