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>
29 GRUB_MOD_LICENSE ("GPLv3+");
32 grub_cmd_help (grub_extcmd_context_t ctxt
__attribute__ ((unused
)), int argc
,
43 if ((cmd
->prio
& GRUB_COMMAND_FLAG_ACTIVE
))
45 struct grub_term_output
*term
;
46 const char *summary_translated
= _(cmd
->summary
);
48 grub_uint32_t
*unicode_command_help
;
49 grub_uint32_t
*unicode_last_position
;
51 command_help
= grub_xasprintf ("%s %s", cmd
->name
, summary_translated
);
55 grub_utf8_to_ucs4_alloc (command_help
, &unicode_command_help
,
56 &unicode_last_position
);
58 FOR_ACTIVE_TERM_OUTPUTS(term
)
61 grub_uint32_t
*unicode_last_screen_position
;
63 unicode_last_screen_position
= unicode_command_help
;
67 while (unicode_last_screen_position
< unicode_last_position
&&
68 stringwidth
< ((grub_term_width (term
) / 2) - 2))
70 struct grub_unicode_glyph glyph
;
71 unicode_last_screen_position
72 += grub_unicode_aglomerate_comb (unicode_last_screen_position
,
74 - unicode_last_screen_position
,
78 += grub_term_getcharwidth (term
, &glyph
);
81 grub_print_ucs4 (unicode_command_help
,
82 unicode_last_screen_position
, 0, 0, term
);
84 grub_print_spaces (term
, grub_term_width (term
) / 2
92 grub_free (command_help
);
93 grub_free (unicode_command_help
);
102 grub_command_t cmd_iter
, cmd
, cmd_next
;
104 for (i
= 0; i
< argc
; i
++)
108 FOR_COMMANDS_SAFE (cmd_iter
, cmd_next
)
110 if (!(cmd_iter
->prio
& GRUB_COMMAND_FLAG_ACTIVE
))
113 if (grub_strncmp (cmd_iter
->name
, currarg
,
114 grub_strlen (currarg
)) != 0)
116 if (cmd_iter
->flags
& GRUB_COMMAND_FLAG_DYNCMD
)
117 cmd
= grub_dyncmd_get_cmd (cmd_iter
);
126 grub_printf ("\n\n");
128 if ((cmd
->flags
& GRUB_COMMAND_FLAG_EXTCMD
) &&
129 ! (cmd
->flags
& GRUB_COMMAND_FLAG_DYNCMD
))
130 grub_arg_show_help ((grub_extcmd_t
) cmd
->data
);
132 grub_printf ("%s %s %s\n%s\n", _("Usage:"), cmd
->name
,
133 _(cmd
->summary
), _(cmd
->description
));
141 static grub_extcmd_t cmd
;
145 cmd
= grub_register_extcmd ("help", grub_cmd_help
, 0,
147 N_("Show a help message."), 0);
152 grub_unregister_extcmd (cmd
);