summaryrefslogtreecommitdiffstats
path: root/doc/shell/rtems.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/rtems.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/rtems.t')
-rw-r--r--doc/shell/rtems.t90
1 files changed, 90 insertions, 0 deletions
diff --git a/doc/shell/rtems.t b/doc/shell/rtems.t
index 9b10411de1..bdf3f4b71e 100644
--- a/doc/shell/rtems.t
+++ b/doc/shell/rtems.t
@@ -44,12 +44,18 @@ The RTEMS shell has the following rtems commands:
@subheading SYNOPSYS:
+@example
cpuuse [-r]
+@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
@@ -107,12 +113,18 @@ extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command;
@subheading SYNOPSYS:
+@example
stackuse
+@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
@@ -170,12 +182,18 @@ extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command;
@subheading SYNOPSYS:
+@example
perioduse [-r]
+@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
@@ -233,12 +251,18 @@ extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command;
@subheading SYNOPSYS:
+@example
wkspace
+@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
@@ -296,12 +320,18 @@ extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command;
@subheading SYNOPSYS:
+@example
config
+@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
@@ -359,12 +389,18 @@ extern rtems_shell_cmd_t rtems_shell_CONFIG_Command;
@subheading SYNOPSYS:
+@example
itask
+@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
@@ -422,12 +458,18 @@ extern rtems_shell_cmd_t rtems_shell_ITASK_Command;
@subheading SYNOPSYS:
+@example
extension [id [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
@@ -485,12 +527,18 @@ extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command;
@subheading SYNOPSYS:
+@example
task [id [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
@@ -548,12 +596,18 @@ extern rtems_shell_cmd_t rtems_shell_TASK_Command;
@subheading SYNOPSYS:
+@example
queue [id [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
@@ -611,12 +665,18 @@ extern rtems_shell_cmd_t rtems_shell_QUEUE_Command;
@subheading SYNOPSYS:
+@example
sema [id [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
@@ -674,12 +734,18 @@ extern rtems_shell_cmd_t rtems_shell_SEMA_Command;
@subheading SYNOPSYS:
+@example
region [id [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
@@ -737,12 +803,18 @@ extern rtems_shell_cmd_t rtems_shell_REGION_Command;
@subheading SYNOPSYS:
+@example
part [id [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
@@ -800,12 +872,18 @@ extern rtems_shell_cmd_t rtems_shell_PART_Command;
@subheading SYNOPSYS:
+@example
object [id [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
@@ -863,12 +941,18 @@ extern rtems_shell_cmd_t rtems_shell_OBJECT_Command;
@subheading SYNOPSYS:
+@example
driver [ major [ major ... ] ]
+@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
@@ -926,12 +1010,18 @@ extern rtems_shell_cmd_t rtems_shell_DRIVER_Command;
@subheading SYNOPSYS:
+@example
dname
+@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