diff options
author | Juergen Beisert <j.beisert@pengutronix.de> | 2007-11-08 12:01:52 +0100 |
---|---|---|
committer | Juergen Beisert <j.beisert@pengutronix.de> | 2007-11-08 12:01:52 +0100 |
commit | 8fe25ecf1270ab08e0b3baf5e8bae91e8f55eaa9 (patch) | |
tree | e7688eb0e6b8a5c8aba5c810719d41888c7de926 /commands | |
parent | 0a13be8de25ea2ba37f156fbfac0555125f651f3 (diff) | |
download | barebox-8fe25ecf1270ab08e0b3baf5e8bae91e8f55eaa9.tar.gz barebox-8fe25ecf1270ab08e0b3baf5e8bae91e8f55eaa9.tar.xz |
adding various doku
Diffstat (limited to 'commands')
-rw-r--r-- | commands/cat.c | 2 | ||||
-rw-r--r-- | commands/cd.c | 5 | ||||
-rw-r--r-- | commands/cp.c | 2 | ||||
-rw-r--r-- | commands/edit.c | 23 | ||||
-rw-r--r-- | commands/environment.c | 18 | ||||
-rw-r--r-- | commands/mount.c | 10 | ||||
-rw-r--r-- | commands/net.c | 27 |
7 files changed, 65 insertions, 22 deletions
diff --git a/commands/cat.c b/commands/cat.c index af33eca80c..6596612e95 100644 --- a/commands/cat.c +++ b/commands/cat.c @@ -97,7 +97,7 @@ U_BOOT_CMD_END /** * @page cat_command cat (concatenate) * - * Usage is: cat <file> [<file> ...] + * Usage is: cat \<file\> [\<file\> ...] * * Concatenate files to stdout. Currently only printable characters * and \\n and \\t are printed, but this should be optional diff --git a/commands/cd.c b/commands/cd.c index 08c3a2d268..5d5cacbf87 100644 --- a/commands/cd.c +++ b/commands/cd.c @@ -61,7 +61,8 @@ U_BOOT_CMD_END /** * @page cd_command cd (change working directory) * - * Usage is: cd [<directory name>] + * Usage is: cd [\<directory name>] * - * Change to <directory name>. If called without argument, change to / (root) + * Change to \<directory name>. If called without argument, change to \b / + * (root) */ diff --git a/commands/cp.c b/commands/cp.c index e26ff1fa00..a89bb97d76 100644 --- a/commands/cp.c +++ b/commands/cp.c @@ -151,7 +151,7 @@ U_BOOT_CMD_END /** * @page cp_command cp (copy) * - * Usage: cp <source> [<source>] <destination> + * Usage: cp \<source> [\<source>] \<destination> * * FIXME */ diff --git a/commands/edit.c b/commands/edit.c index 0795d88abc..3a685ebeef 100644 --- a/commands/edit.c +++ b/commands/edit.c @@ -1,6 +1,4 @@ /* - * edit.c - A tiny editor implementation - * * 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 A tiny editor implementation + */ + #include <common.h> #include <command.h> #include <malloc.h> @@ -398,6 +401,7 @@ static int do_edit(cmd_tbl_t * cmdtp, int argc, char *argv[]) return 1; } + /* check if we are called as "sedit" insted of "edit" */ if (*argv[0] == 's') smartscroll = 1; @@ -564,3 +568,18 @@ U_BOOT_CMD_START(edit) .usage = "edit a file", U_BOOT_CMD_HELP(cmd_edit_help) U_BOOT_CMD_END + + +/** + * @page edit_command edit (editor) + * + * Usage is: [s]edit \<file\> + * + * This is a very small editor. It's only features are moving the cursor with + * the usual keys and typing characters. + * + * \b \<ctrl-c\> quits the editor without saving,\n + * \b \<ctrl-d\> quits the editor with saving the current file. + * + * If called as \c sedit the editor uses ansi codes to scroll the screen. + */ diff --git a/commands/environment.c b/commands/environment.c index b5517aa977..01e7cfed98 100644 --- a/commands/environment.c +++ b/commands/environment.c @@ -227,13 +227,13 @@ U_BOOT_CMD_END /** * @page saveenv_command saveenv * - * Usage: saveenv [<envfs>] [<directory>] + * Usage: saveenv [\<envfs>] [\<directory>] * - * Save the files in <directory> to the persistent storage device <envfs>. - * <envfs> is normally a block in flash, but could be any other file. + * Save the files in \<directory> to the persistent storage device \<envfs>. + * \<envfs> is normally a block in flash, but could be any other file. * - * If ommitted <directory> defaults to /env and <envfs> defaults to - * /dev/env0. + * If ommitted \<directory> defaults to \b /env and \<envfs> defaults to + * \b /dev/env0. * * @note envfs can only handle files. Directories are skipped silently. */ @@ -372,12 +372,12 @@ U_BOOT_CMD_END /** * @page loadenv_command loadenv * - * Usage: loadenv [<directory>] [<envfs>] + * Usage: loadenv [\<directory>] [\<envfs>] * - * Load the persistent storage contained in <envfs> to the directory <directory>. + * Load the persistent storage contained in \<envfs> to the directory \<directory>. * - * If ommitted <directory> defaults to /env and <envfs> defaults to - * /dev/env0. + * If ommitted \<directory> defaults to /env and \<envfs> defaults to + * \b /dev/env0. * * @note envfs can only handle files. Directories are skipped silently. */ diff --git a/commands/mount.c b/commands/mount.c index dd04bdeeb7..03b63f04d1 100644 --- a/commands/mount.c +++ b/commands/mount.c @@ -80,16 +80,16 @@ U_BOOT_CMD_START(mount) U_BOOT_CMD_END /** @page mount_command mount - * Usage: mount [<device> <fstype> <mountpoint>] + * Usage: mount [\<device> \<fstype> \<mountpoint>] * - * Mounts a filesystem of a given <fstype> on a <device> to a <mountpoint>. - * <device> can be one of /dev/ * or some arbitrary string if no + * Mounts a filesystem of a given \<fstype> on a \<device> to a \<mountpoint>. + * \<device> can be one of /dev/ * or some arbitrary string if no * device is needed for this driver (for example ramfs). * - * <fstype> is the filesystem driver to use. Try the 'devinfo' command + * \<fstype> is the filesystem driver to use. Try the 'devinfo' command * for a list of available drivers. * - * <mountpoint> must be an empty directory descending directly from the + * \<mountpoint> must be an empty directory descending directly from the * root directory. */ diff --git a/commands/net.c b/commands/net.c index d12559e13f..b9c372a712 100644 --- a/commands/net.c +++ b/commands/net.c @@ -1,6 +1,4 @@ /* - * tftp, rarpboot, dhcp, nfs, cdp - Boot support - * * (C) Copyright 2000 * Wolfgang Denk, DENX Software Engineering, wd@denx.de. * @@ -23,6 +21,11 @@ * MA 02111-1307 USA */ +/** + * @file + * @brief tftp, rarpboot, dhcp, nfs, cdp - Boot support + */ + #include <common.h> #include <command.h> #include <environment.h> @@ -102,6 +105,16 @@ U_BOOT_CMD_START(tftp) U_BOOT_CMD_HELP(cmd_tftp_help) U_BOOT_CMD_END +/** + * @page tftp_command tftp + * + * Usage is: tftp \<filename\> [\<localfilename\>] + * + * Load a file via network using BootP/TFTP protocol. FIXME: Where to find it + * after loading? + * @note This command is available only, if enabled in the menuconfig. + */ + #ifdef CONFIG_NET_RARP static int do_rarpb (cmd_tbl_t *cmdtp, int argc, char *argv[]) { @@ -116,6 +129,16 @@ U_BOOT_CMD_START(rarpboot) U_BOOT_CMD_END #endif /* CONFIG_NET_RARP */ +/** + * @page rarp_command rarp + * + * Usage is: FIXME + * + * Load a file via network using rarp/tftp protocol. FIXME: Where to find it + * after loading? + * @note This command is available only, if enabled in the menuconfig. + */ + #ifdef CONFIG_NET_DHCP static int do_dhcp (cmd_tbl_t *cmdtp, int argc, char *argv[]) { |