Added descriptive text for settings and setting types, and display it in
[people/xl0/gpxe.git] / src / hci / shell.c
1 /*
2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <stdint.h>
20 #include <stdlib.h>
21 #include <console.h>
22 #include <readline/readline.h>
23 #include <gpxe/command.h>
24 #include <gpxe/shell.h>
25
26 /** @file
27  *
28  * Minimal command shell
29  *
30  */
31
32 static struct command commands[0] __table_start ( commands );
33 static struct command commands_end[0] __table_end ( commands );
34
35 /** The shell prompt string */
36 static const char shell_prompt[] = "gPXE> ";
37
38 /** Flag set in order to exit shell */
39 static int exit_flag = 0;
40
41 /** "exit" command body */
42 static int exit_exec ( int argc, char **argv __unused ) {
43
44         if ( argc == 1 ) {
45                 exit_flag = 1;
46         } else {
47                 printf ( "Usage: exit\n"
48                          "Exits the command shell\n" );
49         }
50
51         return 0;
52 }
53
54 /** "exit" command definition */
55 struct command exit_command __command = {
56         .name = "exit",
57         .exec = exit_exec,
58 };
59
60 /** "help" command body */
61 static int help_exec ( int argc __unused, char **argv __unused ) {
62         struct command *command;
63
64         printf ( "\nAvailable commands:\n\n" );
65         for ( command = commands ; command < commands_end ; command++ ) {
66                 printf ( "  %s\n", command->name );
67         }
68         printf ( "\nType \"<command> --help\" for further information\n\n" );
69         return 0;
70 }
71
72 /** "help" command definition */
73 struct command help_command __command = {
74         .name = "help",
75         .exec = help_exec,
76 };
77
78 /**
79  * Start command shell
80  *
81  */
82 void shell ( void ) {
83         char *line;
84
85         exit_flag = 0;
86         while ( ! exit_flag ) {
87                 line = readline ( shell_prompt );
88                 if ( line ) {
89                         system ( line );
90                         free ( line );
91                 }
92         }
93 }