Files
ipxe/src/hci/shell.c
Michael Brown 7d5dcc9299 [parseopt] Refer to online documentation for command help
The online documentation (e.g. http://ipxe.org/cmd/ifopen), though not
yet complete, is far more comprehensive than could be provided within
the iPXE binary.  Save around 200 bytes (compressed) by removing the
command descriptions from the interactive help, and instead referring
users directly to the web page describing the relevant command.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2011-03-04 12:18:51 +00:00

129 lines
2.8 KiB
C

/*
* Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
FILE_LICENCE ( GPL2_OR_LATER );
#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <getopt.h>
#include <readline/readline.h>
#include <ipxe/command.h>
#include <ipxe/parseopt.h>
#include <ipxe/shell.h>
/** @file
*
* Minimal command shell
*
*/
/** The shell prompt string */
static const char shell_prompt[] = "iPXE> ";
/**
* "help" command
*
* @v argc Argument count
* @v argv Argument list
* @ret rc Return status code
*/
static int help_exec ( int argc __unused, char **argv __unused ) {
struct command *command;
unsigned int hpos = 0;
printf ( "\nAvailable commands:\n\n" );
for_each_table_entry ( command, COMMANDS ) {
hpos += printf ( " %s", command->name );
if ( hpos > ( 16 * 4 ) ) {
printf ( "\n" );
hpos = 0;
} else {
while ( hpos % 16 ) {
printf ( " " );
hpos++;
}
}
}
printf ( "\n\nType \"<command> --help\" for further information\n\n" );
return 0;
}
/** "help" command */
struct command help_command __command = {
.name = "help",
.exec = help_exec,
};
/**
* Start command shell
*
*/
int shell ( void ) {
char *line;
int rc = 0;
do {
line = readline ( shell_prompt );
if ( line ) {
rc = system ( line );
free ( line );
}
} while ( ! shell_stopped ( SHELL_STOP_COMMAND_SEQUENCE ) );
return rc;
}
/** "shell" options */
struct shell_options {};
/** "shell" option list */
static struct option_descriptor shell_opts[] = {};
/** "shell" command descriptor */
static struct command_descriptor shell_cmd =
COMMAND_DESC ( struct shell_options, shell_opts, 0, 0, "" );
/**
* "shell" command
*
* @v argc Argument count
* @v argv Argument list
* @ret rc Return status code
*/
static int shell_exec ( int argc, char **argv ) {
struct shell_options opts;
int rc;
/* Parse options */
if ( ( rc = parse_options ( argc, argv, &shell_cmd, &opts ) ) != 0 )
return rc;
/* Start shell */
if ( ( rc = shell() ) != 0 )
return rc;
return 0;
}
/** "shell" command */
struct command shell_command __command = {
.name = "shell",
.exec = shell_exec,
};