diff options
author | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-07-12 19:18:56 +0200 |
---|---|---|
committer | Sascha Hauer <s.hauer@pengutronix.de> | 2010-11-01 16:23:08 +0100 |
commit | 95a4698dd1f6165500d41bf149ae4005998387cb (patch) | |
tree | dd8dcd851e12cf45ba01b2734a0dc10c890febfb /commands/cat.c | |
parent | 016e05cd9168111ff82a860614fe648cbfae6443 (diff) | |
download | barebox-95a4698dd1f6165500d41bf149ae4005998387cb.tar.gz barebox-95a4698dd1f6165500d41bf149ae4005998387cb.tar.xz |
doc: unify documentation for 'cat'
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Diffstat (limited to 'commands/cat.c')
-rw-r--r-- | commands/cat.c | 19 |
1 files changed, 6 insertions, 13 deletions
diff --git a/commands/cat.c b/commands/cat.c index 41b3324300..37e65050c3 100644 --- a/commands/cat.c +++ b/commands/cat.c @@ -85,22 +85,15 @@ out: return err; } -static const __maybe_unused char cmd_cat_help[] = -"Usage: cat [FILES]\n" -"Concatenate files on stdout. Currently only printable characters\n" -"and \\n and \\t are printed, but this should be optional\n"; +BAREBOX_CMD_HELP_START(cat) +BAREBOX_CMD_HELP_USAGE("cat [FILES]\n") +BAREBOX_CMD_HELP_SHORT("Concatenate files on stdout.\n") +BAREBOX_CMD_HELP_TEXT ("Currently only printable characters and \\ n and \\ t are printed,\n") +BAREBOX_CMD_HELP_TEXT ("but this should be optional.\n") +BAREBOX_CMD_HELP_END BAREBOX_CMD_START(cat) .cmd = do_cat, .usage = "concatenate file(s)", BAREBOX_CMD_HELP(cmd_cat_help) BAREBOX_CMD_END - -/** - * @page cat_command cat (concatenate) - * - * Usage is: cat \<file\> [\<file\> ...] - * - * Concatenate files to stdout. Currently only printable characters - * and \\n and \\t are printed, but this should be optional - */ |