1 files changed, 462 insertions, 0 deletions
diff --git a/doc/shell/general.t b/doc/shell/general.t
new file mode 100644
index 0000000000..9a3efe6bec
--- /dev/null
+++ b/doc/shell/general.t
@@ -0,0 +1,462 @@
+@c
+@c  COPYRIGHT (c) 1988-2008.
+@c  On-Line Applications Research Corporation (OAR).
+@c  All rights reserved.
+@c
+@c  $
+@c
+
+@chapter General Commands
+
+@section Introduction
+
+The RTEMS shell has the following general commands:
+
+@itemize @bullet
+
+
+@item @code{alias} - Add alias for an existing command
+
+@item @code{date} - Print current date and time
+
+@item @code{id} - show uid gid euid and egid
+
+@item @code{tty} - show ttyname
+
+@item @code{whoami} - show current user
+
+@item @code{logoff} - logoff from the system
+
+@item @code{exit} - alias for logoff command
+
+@end itemize
+
+@section Commands
+
+@c
+@c
+@c
+@page
+@subsection alias - add alias for an existing command
+
+@pgindex alias
+
+@subheading SYNOPSYS:
+
+alias oldCommand newCommand
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use alias:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_ALIAS
+@findex CONFIGURE_SHELL_COMMAND_ALIAS
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_ALIAS}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_ALIAS}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_alias
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_alias(
+  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_ALIAS_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection date - print current date and time
+
+@pgindex date
+
+@subheading SYNOPSYS:
+
+date
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use date:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_DATE
+@findex CONFIGURE_SHELL_COMMAND_DATE
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_DATE}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_DATE}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_date
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_date(
+  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_DATE_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection id - show uid gid euid and egid
+
+@pgindex id
+
+@subheading SYNOPSYS:
+
+id
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use id:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_ID
+@findex CONFIGURE_SHELL_COMMAND_ID
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_ID}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_ID}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_id
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_id(
+  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_ID_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection tty - show ttyname
+
+@pgindex tty
+
+@subheading SYNOPSYS:
+
+tty
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use tty:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_TTY
+@findex CONFIGURE_SHELL_COMMAND_TTY
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_TTY}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_TTY}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_tty
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_tty(
+  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_TTY_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection whoami - show current user
+
+@pgindex whoami
+
+@subheading SYNOPSYS:
+
+whoami
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use whoami:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_WHOAMI
+@findex CONFIGURE_SHELL_COMMAND_WHOAMI
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_WHOAMI}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_WHOAMI}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_whoami
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_whoami(
+  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_WHOAMI_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection logoff - logoff from the system
+
+@pgindex logoff
+
+@subheading SYNOPSYS:
+
+logoff
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use logoff:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_LOGOFF
+@findex CONFIGURE_SHELL_COMMAND_LOGOFF
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_LOGOFF}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_LOGOFF}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_logoff
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_logoff(
+  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_LOGOFF_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection exit - alias for logoff command
+
+@pgindex exit
+
+@subheading SYNOPSYS:
+
+exit
+
+@subheading DESCRIPTION:
+
+This command XXX
+
+@subheading NOTES:
+
+NONE
+
+@subheading EXAMPLES:
+
+The following is an example of how to use exit:
+
+@example
+EXAMPLE_TBD
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_EXIT
+@findex CONFIGURE_SHELL_COMMAND_EXIT
+
+In order to disable this command out if you are configuring all commands,
+define @code{CONFIGURE_SHELL_NO_COMMAND_EXIT}.
+
+In order to enable this command if you are building a custom command set
+define @code{CONFIGURE_SHELL_COMMAND_EXIT}.
+
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_exit
+
+The @code{COMMAND} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_exit(
+  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_EXIT_Command;
+@end example
+