RTEMS 4.10.1 On-Line Library

RTEMS Specific Commands halt - Shutdown the system

RTEMS Shell User's Guide

5.2.1: halt - Shutdown the system

SYNOPSYS:

halt

DESCRIPTION:

This command is used to shutdown the RTEMS application.

EXIT STATUS:

This command does not return.

NOTES:

EXAMPLES:

The following is an example of how to use halt:

SHLL [/] $ halt

The user will not see another prompt and the system will shutdown.

CONFIGURATION:

This command is included in the default shell command set. When building a custom command set, define CONFIGURE_SHELL_COMMAND_HALT to have this command included.

This command can be excluded from the shell command set by defining CONFIGURE_SHELL_NO_COMMAND_HALT when all shell commands have been configured.

PROGRAMMING INFORMATION:

The halt is implemented by a C language function which has the following prototype:

int rtems_shell_rtems_main_halt(
  int    argc,
  char **argv
);

The configuration structure for the halt has the following prototype:

extern rtems_shell_cmd_t rtems_shell_HALT_Command;

RTEMS Shell User's Guide