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
26 * $FreeBSD: src/sys/boot/common/commands.c,v 1.19 2003/08/25 23:30:41 obrien Exp $
27 * $DragonFly: src/sys/boot/common/commands.c,v 1.4 2008/09/02 17:21:12 dillon Exp $
33 #include "bootstrap.h"
36 char command_errbuf[256]; /* XXX should have procedural interface for setting, size limit? */
38 static int page_file(char *filename);
41 * Help is read from a formatted text file.
43 * Entries in the file are formatted as
45 # Ttopic [Ssubtopic] Ddescription
52 * Note that for code simplicity's sake, the above format must be followed
55 * Subtopic entries must immediately follow the topic (this is used to
56 * produce the listing of subtopics).
58 * If no argument(s) are supplied by the user, the help for 'help' is displayed.
60 COMMAND_SET(help, "help", "detailed help", command_help);
63 help_getnext(int fd, char **topic, char **subtopic, char **desc)
65 char line[81], *cp, *ep;
68 if (fgetstr(line, 80, fd) < 0)
71 if ((strlen(line) < 3) || (line[0] != '#') || (line[1] != ' '))
74 *topic = *subtopic = *desc = NULL;
76 while((cp != NULL) && (*cp != 0)) {
78 if ((*cp == 'T') && (*topic == NULL)) {
81 *topic = strdup(cp + 1);
82 } else if ((*cp == 'S') && (*subtopic == NULL)) {
85 *subtopic = strdup(cp + 1);
86 } else if (*cp == 'D') {
87 *desc = strdup(cp + 1);
93 if (*subtopic != NULL)
104 help_emitsummary(char *topic, char *subtopic, char *desc)
111 if (subtopic != NULL) {
113 pager_output(subtopic);
114 i += strlen(subtopic) + 1;
127 command_help(int argc, char *argv[])
129 char buf[81]; /* XXX buffer size? */
130 int hfd, matched, doindex;
131 char *topic, *subtopic, *t, *s, *d;
133 /* page the help text from our load path */
134 /* sprintf(buf, "%s/boot/loader.help", getenv("loaddev")); */
135 if ((hfd = rel_open("loader.help", O_RDONLY)) < 0) {
136 printf("Verbose help not available, use '?' to list commands\n");
140 /* pick up request from arguments */
141 topic = subtopic = NULL;
144 subtopic = strdup(argv[2]);
146 topic = strdup(argv[1]);
149 topic = strdup("help");
152 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 help_emitsummary(t, s, d);
167 } else if (strcmp(topic, t)) {
169 if(matched) /* nothing more on this topic, stop scanning */
175 if (((subtopic == NULL) && (s == NULL)) ||
176 ((subtopic != NULL) && (s != NULL) && !strcmp(subtopic, s))) {
177 /* exact match, print text */
178 while((fgetstr(buf, 80, hfd) >= 0) && (buf[0] != '#')) {
179 if (pager_output(buf))
181 if (pager_output("\n"))
184 } else if ((subtopic == NULL) && (s != NULL)) {
185 /* topic match, list subtopics */
186 help_emitsummary(t, s, d);
196 sprintf(command_errbuf, "no help available for '%s'", topic);
209 COMMAND_SET(commandlist, "?", "list commands", command_commandlist);
212 command_commandlist(int argc, char *argv[])
214 struct bootblk_command **cmdp;
216 printf("Available commands:\n");
217 SET_FOREACH(cmdp, Xcommand_set) {
218 if (((*cmdp)->c_name != NULL) && ((*cmdp)->c_desc != NULL))
219 printf(" %-15s %s\n", (*cmdp)->c_name, (*cmdp)->c_desc);
225 * XXX set/show should become set/echo if we have variable
226 * substitution happening.
229 COMMAND_SET(show, "show", "show variable(s)", command_show);
232 command_show(int argc, char *argv[])
239 * With no arguments, print everything.
242 for (ev = environ; ev != NULL; ev = ev->ev_next) {
243 pager_output(ev->ev_name);
244 cp = getenv(ev->ev_name);
249 if (pager_output("\n"))
254 if ((cp = getenv(argv[1])) != NULL) {
257 sprintf(command_errbuf, "variable '%s' not found", argv[1]);
264 COMMAND_SET(set, "set", "set a variable", command_set);
267 command_set(int argc, char *argv[])
272 command_errmsg = "wrong number of arguments";
275 if ((err = putenv(argv[1])) != 0) {
276 command_errmsg = strerror(err);
283 COMMAND_SET(unset, "unset", "unset a variable", command_unset);
286 command_unset(int argc, char *argv[])
291 command_errmsg = "wrong number of arguments";
294 if ((err = unsetenv(argv[1])) != 0) {
295 command_errmsg = strerror(err);
302 COMMAND_SET(echo, "echo", NULL, command_echo);
305 command_echo(int argc, char *argv[])
313 while ((ch = getopt(argc, argv, "n")) != -1) {
320 /* getopt has already reported an error */
327 s = unargv(argc, argv);
338 * A passable emulation of the sh(1) command of the same name.
341 COMMAND_SET(read, "read", NULL, command_read);
344 command_read(int argc, char *argv[])
351 char buf[256]; /* XXX size? */
358 while ((c = getopt(argc, argv, "p:t:")) != -1) {
365 timeout = strtol(optarg, &cp, 0);
367 sprintf(command_errbuf, "bad timeout '%s'", optarg);
378 name = (argc > 0) ? argv[0]: NULL;
381 printf("%s", prompt);
383 when = time(NULL) + timeout;
385 if (time(NULL) >= when)
386 return(CMD_OK); /* is timeout an error? */
389 ngets(buf, sizeof(buf));
392 setenv(name, buf, 1);
399 COMMAND_SET(more, "more", "show contents of a file", command_more);
402 command_more(int argc, char *argv[])
410 for (i = 1; (i < argc) && (res == 0); i++) {
411 sprintf(line, "*** FILE %s BEGIN ***\n", argv[i]);
412 if (pager_output(line))
414 res = page_file(argv[i]);
416 sprintf(line, "*** FILE %s END ***\n", argv[i]);
417 res = pager_output(line);
429 page_file(char *filename)
433 result = pager_file(filename);
436 sprintf(command_errbuf, "error showing %s", filename);
442 * List all disk-like devices
444 COMMAND_SET(lsdev, "lsdev", "list all devices", command_lsdev);
447 command_lsdev(int argc, char *argv[])
455 while ((ch = getopt(argc, argv, "v")) != -1) {
462 /* getopt has already reported an error */
470 for (i = 0; devsw[i] != NULL; i++) {
471 if (devsw[i]->dv_print != NULL){
472 sprintf(line, "%s devices:\n", devsw[i]->dv_name);
473 if (pager_output(line))
475 devsw[i]->dv_print(verbose);
477 sprintf(line, "%s: (unknown)\n", devsw[i]->dv_name);
478 if (pager_output(line))