[PATCH 20/32] doc: add documentation for 'bmp'
Robert Schwebel
r.schwebel at pengutronix.de
Fri Oct 22 12:45:12 EDT 2010
Signed-off-by: Robert Schwebel <r.schwebel at pengutronix.de>
---
Documentation/commands.dox | 1 +
commands/bmp.c | 16 ++++++++--------
2 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 5404483..da95e85 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -2,6 +2,7 @@
* @page command_reference Supported Shell Commands
@li @subpage addpart_command
+ at li @subpage bmp_command
@li @subpage cat_command
@li @subpage cd_command
@li @subpage cp_command
diff --git a/commands/bmp.c b/commands/bmp.c
index 6e17200..242965a 100644
--- a/commands/bmp.c
+++ b/commands/bmp.c
@@ -193,17 +193,17 @@ failed_memmap:
return 1;
}
-static const __maybe_unused char cmd_bmp_help[] =
-"Usage: bmp [OPTION]... FILE\n"
-"show bmp image FILE.\n"
-" -f <fb> framebuffer device (/dev/fb0)\n"
-" -x <xofs> x offset (default center)\n"
-" -y <yofs> y offset (default center)\n"
-" -o render offscreen\n";
+BAREBOX_CMD_HELP_START(bmp)
+BAREBOX_CMD_HELP_USAGE("bmp [OPTIONS] FILE")
+BAREBOX_CMD_HELP_SHORT("Show the bitmap FILE on the framebuffer.")
+BAREBOX_CMD_HELP_OPT ("-f <fb>", "framebuffer device (/dev/fb0)")
+BAREBOX_CMD_HELP_OPT ("-x <xofs>", "x offset (default center)")
+BAREBOX_CMD_HELP_OPT ("-y <yofs>", "y offset (default center)")
+BAREBOX_CMD_HELP_OPT ("-o", "render offscreen")
+BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(bmp)
.cmd = do_bmp,
.usage = "show a bmp image",
BAREBOX_CMD_HELP(cmd_bmp_help)
BAREBOX_CMD_END
-
--
1.7.2.3
More information about the barebox
mailing list