Changeset 0a90bf2 in rtems
- Timestamp:
- 02/19/09 19:20:51 (15 years ago)
- Branches:
- 4.10, 4.11, 5, master
- Children:
- 66913da2
- Parents:
- 4e54befe
- Location:
- doc
- Files:
-
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/ChangeLog
r4e54befe r0a90bf2 1 2009-02-19 Joel Sherrill <joel.sherrill@oarcorp.com> 2 3 * shell/rtems.t: Add halt command. 4 1 5 2009-02-12 Joel Sherrill <joel.sherrill@oarcorp.com> 2 6 -
doc/shell/rtems.t
r4e54befe r0a90bf2 15 15 @itemize @bullet 16 16 17 @item @code{halt} - Shutdown the system 17 18 @item @code{cpuuse} - print or reset per thread cpu usage 18 19 @item @code{stackuse} - print per thread stack usage … … 40 41 describes the behavior and configuration of that 41 42 command as well as providing an example usage. 43 44 @c 45 @c 46 @c 47 @page 48 @subsection halt - Shutdown the system 49 50 @pgindex halt 51 52 @subheading SYNOPSYS: 53 54 @example 55 halt 56 @end example 57 58 @subheading DESCRIPTION: 59 60 This command is used to shutdown the RTEMS application. 61 62 @subheading EXIT STATUS: 63 64 This command does not return. 65 66 @subheading NOTES: 67 68 69 @subheading EXAMPLES: 70 71 The following is an example of how to use @code{halt}: 72 73 @example 74 SHLL [/] $ halt 75 @end example 76 77 The user will not see another prompt and the system will 78 shutdown. 79 80 @subheading CONFIGURATION: 81 82 @findex CONFIGURE_SHELL_NO_COMMAND_HALT 83 @findex CONFIGURE_SHELL_COMMAND_HALT 84 85 This command is included in the default shell command set. 86 When building a custom command set, define 87 @code{CONFIGURE_SHELL_COMMAND_HALT} to have this 88 command included. 89 90 This command can be excluded from the shell command set by 91 defining @code{CONFIGURE_SHELL_NO_COMMAND_HALT} when all 92 shell commands have been configured. 93 94 @subheading PROGRAMMING INFORMATION: 95 96 @findex rtems_shell_rtems_main_halt 97 98 The @code{halt} is implemented by a C language function 99 which has the following prototype: 100 101 @example 102 int rtems_shell_rtems_main_halt( 103 int argc, 104 char **argv 105 ); 106 @end example 107 108 The configuration structure for the @code{halt} has the 109 following prototype: 110 111 @example 112 extern rtems_shell_cmd_t rtems_shell_HALT_Command; 113 @end example 114 42 115 @c 43 116 @c
Note: See TracChangeset
for help on using the changeset viewer.