summaryrefslogtreecommitdiffstats
path: root/doc/shell/general.t
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2008-02-21 17:46:03 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2008-02-21 17:46:03 +0000
commitea0804303b47260d2f7652e41fb585d56d7e00ab (patch)
treea3e429449c2c8c75a193611979024214926d1da3 /doc/shell/general.t
parent2008-02-21 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-ea0804303b47260d2f7652e41fb585d56d7e00ab.tar.bz2
2008-02-21 Joel Sherrill <joel.sherrill@oarcorp.com>
* shell/file.t, shell/general.t, shell/memory.t, shell/network.t, shell/rtems.t: Add mount and cp command information from Chris Johns. Reformat some things.
Diffstat (limited to 'doc/shell/general.t')
-rw-r--r--doc/shell/general.t42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/shell/general.t b/doc/shell/general.t
index 5c108d00ac..845d53fca0 100644
--- a/doc/shell/general.t
+++ b/doc/shell/general.t
@@ -36,12 +36,18 @@ The RTEMS shell has the following general commands:
@subheading SYNOPSYS:
+@example
alias oldCommand newCommand
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -99,12 +105,18 @@ extern rtems_shell_cmd_t rtems_shell_ALIAS_Command;
@subheading SYNOPSYS:
+@example
date
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -162,12 +174,18 @@ extern rtems_shell_cmd_t rtems_shell_DATE_Command;
@subheading SYNOPSYS:
+@example
id
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -225,12 +243,18 @@ extern rtems_shell_cmd_t rtems_shell_ID_Command;
@subheading SYNOPSYS:
+@example
tty
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -288,12 +312,18 @@ extern rtems_shell_cmd_t rtems_shell_TTY_Command;
@subheading SYNOPSYS:
+@example
whoami
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -351,12 +381,18 @@ extern rtems_shell_cmd_t rtems_shell_WHOAMI_Command;
@subheading SYNOPSYS:
+@example
logoff
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -414,12 +450,18 @@ extern rtems_shell_cmd_t rtems_shell_LOGOFF_Command;
@subheading SYNOPSYS:
+@example
exit
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE