1 files changed, 966 insertions, 0 deletions
diff --git a/doc/shell/rtems.t b/doc/shell/rtems.t
new file mode 100644
index 0000000000..e9d791aa22
--- /dev/null
+++ b/doc/shell/rtems.t
@@ -0,0 +1,966 @@
+@c
+@c  COPYRIGHT (c) 1988-2008.
+@c  On-Line Applications Research Corporation (OAR).
+@c  All rights reserved.
+@c
+@c  $
+@c
+
+@chapter RTEMS Commands
+
+@section Introduction
+
+The RTEMS shell has the following rtems commands:
+
+@itemize @bullet
+
+
+@item @code{cpuuse} - print or reset per thread cpu usage
+
+@item @code{stackuse} - print per thread stack usage
+
+@item @code{perioduse} - print or reset per period usage
+
+@item @code{wkspace} - Display information on Executive Workspace
+
+@item @code{config} - Show the system configuration.
+
+@item @code{itask} - List init tasks for the system
+
+@item @code{extension} - Display information about extensions
+
+@item @code{task} - Display information about tasks
+
+@item @code{queue} - Display information about message queues
+
+@item @code{sema} - display information about semaphores
+
+@item @code{region} - display information about regions
+
+@item @code{part} - display information about partitions
+
+@item @code{object} - Display information about RTEMS objects
+
+@item @code{driver} - Display the RTEMS device driver table
+
+@item @code{dname} - Displays information about named drivers
+
+@end itemize
+
+@section Commands
+
+@c
+@c
+@c
+@page
+@subsection cpuuse - print or reset per thread cpu usage
+
+@pgindex cpuuse
+
+@subheading SYNOPSYS:
+
+cpuuse [-r]
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use cpuuse:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_CPUUSE
+@findex CONFIGURE_SHELL_COMMAND_CPUUSE
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_CPUUSE}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_CPUUSE}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_cpuuse
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_cpuuse(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection stackuse - print per thread stack usage
+
+@pgindex stackuse
+
+@subheading SYNOPSYS:
+
+stackuse
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use stackuse:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_STACKUSE
+@findex CONFIGURE_SHELL_COMMAND_STACKUSE
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_STACKUSE}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_STACKUSE}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_stackuse
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_stackuse(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection perioduse - print or reset per period usage
+
+@pgindex perioduse
+
+@subheading SYNOPSYS:
+
+perioduse [-r]
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use perioduse:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_PERIODUSE
+@findex CONFIGURE_SHELL_COMMAND_PERIODUSE
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_PERIODUSE}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_PERIODUSE}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_perioduse
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_perioduse(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection wkspace - display information on executive workspace
+
+@pgindex wkspace
+
+@subheading SYNOPSYS:
+
+wkspace
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use wkspace:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_WKSPACE
+@findex CONFIGURE_SHELL_COMMAND_WKSPACE
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_WKSPACE}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_WKSPACE}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_wkspace
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_wkspace(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection config - show the system configuration.
+
+@pgindex config
+
+@subheading SYNOPSYS:
+
+config
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use config:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_CONFIG
+@findex CONFIGURE_SHELL_COMMAND_CONFIG
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_CONFIG}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_CONFIG}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_config
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_config(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_CONFIG_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection itask - list init tasks for the system
+
+@pgindex itask
+
+@subheading SYNOPSYS:
+
+itask
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use itask:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_ITASK
+@findex CONFIGURE_SHELL_COMMAND_ITASK
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_ITASK}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_ITASK}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_itask
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_itask(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_ITASK_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection extension - display information about extensions
+
+@pgindex extension
+
+@subheading SYNOPSYS:
+
+extension [id [id ...] ]
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use extension:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_EXTENSION
+@findex CONFIGURE_SHELL_COMMAND_EXTENSION
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_EXTENSION}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_EXTENSION}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_extension
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_extension(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection task - display information about tasks
+
+@pgindex task
+
+@subheading SYNOPSYS:
+
+task [id [id ...] ]
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use task:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_TASK
+@findex CONFIGURE_SHELL_COMMAND_TASK
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_TASK}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_TASK}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_task
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_task(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_TASK_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection queue - display information about message queues
+
+@pgindex queue
+
+@subheading SYNOPSYS:
+
+queue [id [id ... ] ]
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use queue:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_QUEUE
+@findex CONFIGURE_SHELL_COMMAND_QUEUE
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_QUEUE}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_QUEUE}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_queue
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_queue(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_QUEUE_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection sema - display information about semaphores
+
+@pgindex sema
+
+@subheading SYNOPSYS:
+
+sema [id [id ... ] ]
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use sema:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_SEMA
+@findex CONFIGURE_SHELL_COMMAND_SEMA
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_SEMA}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_SEMA}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_sema
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_sema(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_SEMA_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection region - display information about regions
+
+@pgindex region
+
+@subheading SYNOPSYS:
+
+region [id [id ... ] ]
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use region:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_REGION
+@findex CONFIGURE_SHELL_COMMAND_REGION
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_REGION}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_REGION}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_region
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_region(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_REGION_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection part - display information about partitions
+
+@pgindex part
+
+@subheading SYNOPSYS:
+
+part [id [id ... ] ]
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use part:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_PART
+@findex CONFIGURE_SHELL_COMMAND_PART
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_PART}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_PART}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_part
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_part(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_PART_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection object - display information about rtems objects
+
+@pgindex object
+
+@subheading SYNOPSYS:
+
+object [id [id ...] ]
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use object:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_OBJECT
+@findex CONFIGURE_SHELL_COMMAND_OBJECT
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_OBJECT}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_OBJECT}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_object
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_object(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_OBJECT_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection driver - display the rtems device driver table
+
+@pgindex driver
+
+@subheading SYNOPSYS:
+
+driver [ major [ major ... ] ]
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use driver:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_DRIVER
+@findex CONFIGURE_SHELL_COMMAND_DRIVER
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_DRIVER}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_DRIVER}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_driver
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_driver(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_DRIVER_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection dname - displays information about named drivers
+
+@pgindex dname
+
+@subheading SYNOPSYS:
+
+dname
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use dname:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_DNAME
+@findex CONFIGURE_SHELL_COMMAND_DNAME
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_DNAME}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_DNAME}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_dname
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_dname(
+  int    argc,
+  char **argv
+);
+@end example
+
+The configuration structure for the @code{COMMAND} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_DNAME_Command;
+@end example
+