RTEMS 4.9.3 On-Line Library

General Commands alias - add alias for an existing command

RTEMS Shell User's Guide

2.2.1: alias - add alias for an existing command

SYNOPSYS:

alias oldCommand newCommand

DESCRIPTION:

This command adds an alternate name for an existing command to the command set.

EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

NOTES:

NONE

EXAMPLES:

The following is an example of how to use alias:

SHLL [/] $ me
shell:me command not found
SHLL [/] $ alias whoami me
SHLL [/] $ me
rtems
SHLL [/] $ whoami
rtems

CONFIGURATION:

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

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

PROGRAMMING INFORMATION:

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

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

The configuration structure for the alias has the following prototype:

extern rtems_shell_cmd_t rtems_shell_ALIAS_Command;

RTEMS Shell User's Guide