RTEMS 4.9.1 On-Line Library

General Commands logoff - logoff from the system

RTEMS Shell User's Guide

2.2.8: logoff - logoff from the system

SYNOPSYS:

logoff

DESCRIPTION:

This command logs the user out of the shell.

EXIT STATUS:

This command does not return.

NOTES:

The system behavior when the shell is exited depends upon how the shell was initiated. The typical behavior is that a login prompt will be displayed for the next login attempt or that the connection will be dropped by the RTEMS system.

EXAMPLES:

The following is an example of how to use logoff:

SHLL [/] $ logoff
logoff from the system...

CONFIGURATION:

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

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

PROGRAMMING INFORMATION:

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

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

The configuration structure for the logoff has the following prototype:

extern rtems_shell_cmd_t rtems_shell_LOGOFF_Command;

RTEMS Shell User's Guide