summaryrefslogtreecommitdiffstats
path: root/commands/cat.c
diff options
context:
space:
mode:
authorJuergen Beisert <jbe@isonoe.(none)>2007-10-19 14:56:45 +0200
committerJuergen Beisert <jbe@isonoe.(none)>2007-10-19 14:56:45 +0200
commitafe73cff56de417ce21096476928f53a7515ddec (patch)
treeca75b8b93cc2b4b69fc9923162ea7c80d5ff3d2a /commands/cat.c
parent18690c9c23d424f5a28d24f4369533745c4ddbb3 (diff)
downloadbarebox-afe73cff56de417ce21096476928f53a7515ddec.tar.gz
barebox-afe73cff56de417ce21096476928f53a7515ddec.tar.xz
doc added and some reorganised
Diffstat (limited to 'commands/cat.c')
-rw-r--r--commands/cat.c21
1 files changed, 19 insertions, 2 deletions
diff --git a/commands/cat.c b/commands/cat.c
index 7a8facd0e3..af33eca80c 100644
--- a/commands/cat.c
+++ b/commands/cat.c
@@ -1,6 +1,4 @@
/*
- * cat.c - conacatenate files
- *
* Copyright (c) 2007 Sascha Hauer <s.hauer@pengutronix.de>, Pengutronix
*
* See file CREDITS for list of people who contributed to this
@@ -20,6 +18,11 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/**
+ * @file
+ * @brief Concatenate files to stdout command
+ */
+
#include <common.h>
#include <command.h>
#include <fs.h>
@@ -29,6 +32,11 @@
#include <xfuncs.h>
#include <malloc.h>
+/**
+ * @param[in] cmdtp FIXME
+ * @param[in] argc Argument count from command line
+ * @param[in] argv List of input arguments
+ */
static int do_cat(cmd_tbl_t *cmdtp, int argc, char *argv[])
{
int ret;
@@ -85,3 +93,12 @@ U_BOOT_CMD_START(cat)
.usage = "concatenate file(s)",
U_BOOT_CMD_HELP(cmd_cat_help)
U_BOOT_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
+ */