1 /* help.c - command to show a help text. */
3 * GRUB -- GRand Unified Bootloader
4 * Copyright (C) 2005,2007,2008,2009 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 3 of the License, or
9 * (at your option) any later version.
11 * GRUB 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, see <http://www.gnu.org/licenses/>.
21 #include <grub/misc.h>
22 #include <grub/term.h>
23 #include <grub/extcmd.h>
24 #include <grub/i18n.h>
26 #include <grub/normal.h>
27 #include <grub/charset.h>
30 grub_cmd_help (grub_extcmd_t ext
__attribute__ ((unused
)), int argc
,
36 auto int print_command_info (grub_command_t cmd
);
37 auto int print_command_help (grub_command_t cmd
);
39 int print_command_info (grub_command_t cmd
)
41 if ((cmd
->prio
& GRUB_PRIO_LIST_FLAG_ACTIVE
) &&
42 (cmd
->flags
& GRUB_COMMAND_FLAG_CMDLINE
))
44 struct grub_term_output
*term
;
45 const char *summary_translated
= _(cmd
->summary
);
47 grub_uint32_t
*unicode_command_help
;
48 grub_uint32_t
*unicode_last_position
;
50 command_help
= grub_xasprintf ("%s %s", cmd
->name
, summary_translated
);
54 grub_utf8_to_ucs4_alloc (command_help
, &unicode_command_help
,
55 &unicode_last_position
);
57 FOR_ACTIVE_TERM_OUTPUTS(term
)
60 grub_uint32_t
*unicode_last_screen_position
;
62 unicode_last_screen_position
= unicode_command_help
;
66 while (unicode_last_screen_position
< unicode_last_position
&&
67 stringwidth
< ((grub_term_width (term
) / 2) - 2))
70 += grub_term_getcharwidth (term
,
71 *unicode_last_screen_position
);
72 unicode_last_screen_position
++;
75 grub_print_ucs4 (unicode_command_help
,
76 unicode_last_screen_position
, term
);
78 grub_print_spaces (term
, grub_term_width (term
) / 2
85 grub_free (command_help
);
86 grub_free (unicode_command_help
);
91 int print_command_help (grub_command_t cmd
)
93 if (cmd
->prio
& GRUB_PRIO_LIST_FLAG_ACTIVE
)
95 if (! grub_strncmp (cmd
->name
, currarg
, grub_strlen (currarg
)))
100 if (cmd
->flags
& GRUB_COMMAND_FLAG_EXTCMD
)
101 grub_arg_show_help ((grub_extcmd_t
) cmd
->data
);
103 grub_printf ("%s %s %s\n%s\n", _("Usage:"), cmd
->name
, _(cmd
->summary
),
104 _(cmd
->description
));
112 grub_command_iterate (print_command_info
);
120 for (i
= 0; i
< argc
; i
++)
123 grub_command_iterate (print_command_help
);
130 static grub_extcmd_t cmd
;
134 cmd
= grub_register_extcmd ("help", grub_cmd_help
,
135 GRUB_COMMAND_FLAG_CMDLINE
,
137 N_("Show a help message."), 0);
142 grub_unregister_extcmd (cmd
);