1
/* help.c - command to show a help text. */
3
* GRUB -- GRand Unified Bootloader
4
* Copyright (C) 2005 Free Software Foundation, Inc.
6
* GRUB is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation; either version 2 of the License, or
9
* (at your option) any later version.
11
* This program is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public License
17
* along with GRUB; if not, write to the Free Software
18
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21
#include <grub/normal.h>
24
#include <grub/misc.h>
26
/* XXX: This has to be changed into a function so the screen can be
31
grub_cmd_help (struct grub_arg_list *state __attribute__ ((unused)), int argc,
38
auto int print_command_info (grub_command_t cmd);
39
auto int print_command_help (grub_command_t cmd);
41
int print_command_info (grub_command_t cmd)
43
if (grub_command_find (cmd->name))
45
if (cmd->flags & GRUB_COMMAND_FLAG_CMDLINE)
47
char description[TERM_WIDTH / 2];
48
int desclen = grub_strlen (cmd->summary);
50
/* Make a string with a length of TERM_WIDTH / 2 - 1 filled
51
with the description followed by spaces. */
52
grub_memset (description, ' ', TERM_WIDTH / 2 - 1);
53
description[TERM_WIDTH / 2 - 1] = '\0';
54
grub_memcpy (description, cmd->summary,
55
(desclen < TERM_WIDTH / 2 - 1
56
? desclen : TERM_WIDTH / 2 - 1));
58
grub_printf ("%s%s", description, (cnt++) % 2 ? "\n" : " ");
64
int print_command_help (grub_command_t cmd)
66
if (grub_command_find (cmd->name))
68
if (! grub_strncmp (cmd->name, currarg, grub_strlen (currarg)))
73
grub_arg_show_help (cmd);
80
grub_iterate_commands (print_command_info);
85
for (i = 0; i < argc; i++)
88
grub_iterate_commands (print_command_help);
99
(void)mod; /* To stop warning. */
100
grub_register_command ("help", grub_cmd_help, GRUB_COMMAND_FLAG_CMDLINE,
101
"help [PATTERN ...]", "Show a help message.", 0);
106
grub_unregister_command ("help");