2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
33 #include "bootstrap.h"
36 /* XXX should have procedural interface for setting, size limit? */
37 char command_errbuf[COMMAND_ERRBUFSZ];
39 static int page_file(char *filename);
42 * Help is read from a formatted text file.
44 * Entries in the file are formatted as
46 # Ttopic [Ssubtopic] Ddescription
53 * Note that for code simplicity's sake, the above format must be followed
56 * Subtopic entries must immediately follow the topic (this is used to
57 * produce the listing of subtopics).
59 * If no argument(s) are supplied by the user, the help for 'help' is displayed.
61 COMMAND_SET(help, "help", "detailed help", command_help);
64 help_getnext(int fd, char **topic, char **subtopic, char **desc)
66 char line[81], *cp, *ep;
69 if (fgetstr(line, 80, fd) < 0)
72 if ((strlen(line) < 3) || (line[0] != '#') || (line[1] != ' '))
75 *topic = *subtopic = *desc = NULL;
77 while((cp != NULL) && (*cp != 0)) {
79 if ((*cp == 'T') && (*topic == NULL)) {
82 *topic = strdup(cp + 1);
83 } else if ((*cp == 'S') && (*subtopic == NULL)) {
86 *subtopic = strdup(cp + 1);
87 } else if (*cp == 'D') {
88 *desc = strdup(cp + 1);
103 help_emitsummary(char *topic, char *subtopic, char *desc)
110 if (subtopic != NULL) {
112 pager_output(subtopic);
113 i += strlen(subtopic) + 1;
121 return (pager_output("\n"));
126 command_help(int argc, char *argv[])
128 char buf[81]; /* XXX buffer size? */
129 int hfd, matched, doindex;
130 char *topic, *subtopic, *t, *s, *d;
132 /* page the help text from our load path */
133 snprintf(buf, sizeof(buf), "%s/boot/loader.help", getenv("loaddev"));
134 if ((hfd = open(buf, O_RDONLY)) < 0) {
135 printf("Verbose help not available, use '?' to list commands\n");
139 /* pick up request from arguments */
140 topic = subtopic = NULL;
143 subtopic = strdup(argv[2]);
145 topic = strdup(argv[1]);
148 topic = strdup("help");
151 command_errmsg = "usage is 'help <topic> [<subtopic>]";
156 /* magic "index" keyword */
157 doindex = !strcmp(topic, "index");
160 /* Scan the helpfile looking for help matching the request */
162 while(help_getnext(hfd, &t, &s, &d)) {
164 if (doindex) { /* dink around formatting */
165 if (help_emitsummary(t, s, d))
168 } else if (strcmp(topic, t)) {
170 if (matched) /* nothing more on this topic, stop scanning */
176 if (((subtopic == NULL) && (s == NULL)) ||
177 ((subtopic != NULL) && (s != NULL) && !strcmp(subtopic, s))) {
178 /* exact match, print text */
179 while ((fgetstr(buf, 80, hfd) >= 0) && (buf[0] != '#')) {
180 if (pager_output(buf))
182 if (pager_output("\n"))
185 } else if ((subtopic == NULL) && (s != NULL)) {
186 /* topic match, list subtopics */
187 if (help_emitsummary(t, s, d))
202 snprintf(command_errbuf, sizeof(command_errbuf),
203 "no help available for '%s'", topic);
213 COMMAND_SET(commandlist, "?", "list commands", command_commandlist);
216 * Please note: although we use the pager for the list of commands,
217 * this routine is called from the ? FORTH function which then
218 * unconditionally prints some commands. This will lead to anomalous
219 * behavior. There's no 'pager_output' binding to FORTH to allow
220 * things to work right, so I'm documenting the bug rather than
224 command_commandlist(int argc, char *argv[])
226 struct bootblk_command **cmdp;
232 res = pager_output("Available commands:\n");
233 SET_FOREACH(cmdp, Xcommand_set) {
236 if (((*cmdp)->c_name != NULL) && ((*cmdp)->c_desc != NULL)) {
237 sprintf(name, " %-15s ", (*cmdp)->c_name);
239 pager_output((*cmdp)->c_desc);
240 res = pager_output("\n");
248 * XXX set/show should become set/echo if we have variable
249 * substitution happening.
252 COMMAND_SET(show, "show", "show variable(s)", command_show);
255 command_show(int argc, char *argv[])
262 * With no arguments, print everything.
265 for (ev = environ; ev != NULL; ev = ev->ev_next) {
266 pager_output(ev->ev_name);
267 cp = getenv(ev->ev_name);
272 if (pager_output("\n"))
277 if ((cp = getenv(argv[1])) != NULL) {
280 snprintf(command_errbuf, sizeof(command_errbuf),
281 "variable '%s' not found", argv[1]);
288 COMMAND_SET(set, "set", "set a variable", command_set);
291 command_set(int argc, char *argv[])
296 command_errmsg = "wrong number of arguments";
299 if ((err = putenv(argv[1])) != 0) {
300 command_errmsg = strerror(err);
307 COMMAND_SET(unset, "unset", "unset a variable", command_unset);
310 command_unset(int argc, char *argv[])
315 command_errmsg = "wrong number of arguments";
318 if ((err = unsetenv(argv[1])) != 0) {
319 command_errmsg = strerror(err);
326 COMMAND_SET(echo, "echo", "echo arguments", command_echo);
329 command_echo(int argc, char *argv[])
337 while ((ch = getopt(argc, argv, "n")) != -1) {
344 /* getopt has already reported an error */
351 s = unargv(argc, argv);
362 * A passable emulation of the sh(1) command of the same name.
365 COMMAND_SET(read, "read", "read input from the terminal", command_read);
368 command_read(int argc, char *argv[])
375 char buf[256]; /* XXX size? */
382 while ((c = getopt(argc, argv, "p:t:")) != -1) {
389 timeout = strtol(optarg, &cp, 0);
391 snprintf(command_errbuf, sizeof(command_errbuf),
392 "bad timeout '%s'", optarg);
403 name = (argc > 0) ? argv[0]: NULL;
406 printf("%s", prompt);
408 when = time(NULL) + timeout;
410 if (time(NULL) >= when)
411 return(CMD_OK); /* is timeout an error? */
414 ngets(buf, sizeof(buf));
417 setenv(name, buf, 1);
424 COMMAND_SET(more, "more", "show contents of a file", command_more);
427 command_more(int argc, char *argv[])
435 for (i = 1; (i < argc) && (res == 0); i++) {
436 sprintf(line, "*** FILE %s BEGIN ***\n", argv[i]);
437 if (pager_output(line))
439 res = page_file(argv[i]);
441 sprintf(line, "*** FILE %s END ***\n", argv[i]);
442 res = pager_output(line);
454 page_file(char *filename)
458 result = pager_file(filename);
461 snprintf(command_errbuf, sizeof(command_errbuf),
462 "error showing %s", filename);
469 * List all disk-like devices
471 COMMAND_SET(lsdev, "lsdev", "list all devices", command_lsdev);
474 command_lsdev(int argc, char *argv[])
482 while ((ch = getopt(argc, argv, "v")) != -1) {
489 /* getopt has already reported an error */
497 for (i = 0; devsw[i] != NULL; i++) {
498 if (devsw[i]->dv_print != NULL){
499 if (devsw[i]->dv_print(verbose))
502 sprintf(line, "%s: (unknown)\n", devsw[i]->dv_name);
503 if (pager_output(line))