diff options
Diffstat (limited to 'doc/shell/general.t')
-rw-r--r-- | doc/shell/general.t | 42 |
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 |