RTEMS Documentation Project
RTEMS Shell Guide
6.87c8ac7-modified
1. Preface
1.1. Acknowledgements
2. Configuration and Initialization
2.1. Introduction
2.2. Configuration
2.2.1. Customizing the Command Set
2.2.2. Adding Custom Commands
2.3. Initialization
2.3.1. Attached to a Serial Port
2.3.2. Attached to a Socket
2.4. Access Control
2.4.1. Login Checks
2.4.2. Configuration Files
2.4.3. Command Visibility and Execution Permission
2.4.4. Add CRYPT(3) Formats
2.5. Functions
2.5.1. rtems_shell_init - Initialize the shell
2.5.2. rtems_shell_login_check - Default login check handler
3. General Commands
3.1. Introduction
3.2. Commands
3.2.1. help - Print command help
3.2.2. alias - add alias for an existing command
3.2.3. cmdls - List commands
3.2.4. cmdchown - Change user or owner of commands
3.2.5. cmdchmod - Change mode of commands
3.2.6. date - print or set current date and time
3.2.7. echo - produce message in a shell script
3.2.8. sleep - delay for a specified amount of time
3.2.9. id - show uid gid euid and egid
3.2.10. tty - show ttyname
3.2.11. whoami - print effective user id
3.2.12. getenv - print environment variable
3.2.13. setenv - set environment variable
3.2.14. unsetenv - unset environment variable
3.2.15. time - time command execution
3.2.16. logoff - logoff from the system
3.2.17. rtc - RTC driver configuration
3.2.18. i2cdetect - detect I2C devices
3.2.19. i2cget - get data from an EEPROM like I2C device
3.2.20. i2cset - write data to an EEPROM like I2C device
3.2.21. spi - read and write simple data to an SPI bus
3.2.22. exit - exit the shell
4. File and Directory Commands
4.1. Introduction
4.2. Commands
4.2.1. blksync - sync the block driver
4.2.2. cat - display file contents
4.2.3. cd - alias for chdir
4.2.4. chdir - change the current directory
4.2.5. chmod - change permissions of a file
4.2.6. chroot - change the root directory
4.2.7. cp - copy files
4.2.8. dd - convert and copy a file
4.2.9. debugrfs - debug RFS file system
4.2.10. df - display file system disk space usage
4.2.11. dir - alias for ls
4.2.12. fdisk - format disk
4.2.13. hexdump - ascii/dec/hex/octal dump
4.2.14. ln - make links
4.2.15. ls - list files in the directory
4.2.16. md5 - compute the Md5 hash of a file or list of files
4.2.17. mkdir - create a directory
4.2.18. mkdos - DOSFS file system format
4.2.19. mknod - make device special file
4.2.20. mkrfs - format RFS file system
4.2.21. mount - mount disk
4.2.22. mv - move files
4.2.23. pwd - print work directory
4.2.24. rmdir - remove empty directories
4.2.25. rm - remove files
4.2.26. umask - set file mode creation mask
4.2.27. unmount - unmount disk
5. Memory Commands
5.1. Introduction
5.2. Commands
5.2.1. mdump - display contents of memory
5.2.2. wdump - display contents of memory (word)
5.2.3. ldump - display contents of memory (longword)
5.2.4. medit - modify contents of memory
5.2.5. mfill - file memory with pattern
5.2.6. mmove - move contents of memory
5.2.7. malloc - obtain information on C program heap
6. RTEMS Specific Commands
6.1. Introduction
6.2. Commands
6.2.1. rtems - RTEMS Details
6.2.2. shutdown - Shutdown the system
6.2.3. cpuinfo - print per-processor information
6.2.4. cpuuse - print or reset per thread cpu usage
6.2.5. stackuse - print per thread stack usage
6.2.6. perioduse - print or reset per period usage
6.2.7. profreport - print a profiling report
6.2.8. wkspace - display information on executive workspace
6.2.9. config - show the system configuration.
6.2.10. itask - list init tasks for the system
6.2.11. extension - display information about extensions
6.2.12. task - display information about tasks
6.2.13. queue - display information about message queues
6.2.14. sema - display information about semaphores
6.2.15. region - display information about regions
6.2.16. part - display information about partitions
6.2.17. object - display information about RTEMS objects
6.2.18. driver - display the RTEMS device driver table
6.2.19. dname - displays information about named drivers
6.2.20. pthread - display information about POSIX threads
7. Dynamic Loader
7.1. Introduction
7.2. Commands
7.2.1. rtl - Manager the RTL
8. Network Commands
8.1. Introduction
8.2. Commands
8.2.1. netstats - obtain network statistics
8.2.2. ifconfig - configure a network interface
8.2.3. route - show or manipulate the ip routing table
8.2.4. ping - ping a host or IP address
9. Function and Variable Index
10. Concept Index
Index
RTEMS Shell Guide
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
A
alias
B
blksync
C
cat
cd
chdir
chmod
chroot
cmdchmod
cmdchown
cmdls
config
CONFIGURE_SHELL_COMMAND_ALIAS
CONFIGURE_SHELL_COMMAND_BLKSYNC
CONFIGURE_SHELL_COMMAND_CAT
CONFIGURE_SHELL_COMMAND_CD
CONFIGURE_SHELL_COMMAND_CHDIR
CONFIGURE_SHELL_COMMAND_CHMOD
CONFIGURE_SHELL_COMMAND_CHROOT
CONFIGURE_SHELL_COMMAND_CMDCHMOD
CONFIGURE_SHELL_COMMAND_CMDCHOWN
CONFIGURE_SHELL_COMMAND_CMDLS
CONFIGURE_SHELL_COMMAND_CONFIG
CONFIGURE_SHELL_COMMAND_CP
CONFIGURE_SHELL_COMMAND_CPUINFO
CONFIGURE_SHELL_COMMAND_CPUUSE
CONFIGURE_SHELL_COMMAND_DATE
CONFIGURE_SHELL_COMMAND_DD
CONFIGURE_SHELL_COMMAND_DEBUGRFS
CONFIGURE_SHELL_COMMAND_DF
CONFIGURE_SHELL_COMMAND_DIR
CONFIGURE_SHELL_COMMAND_DNAME
CONFIGURE_SHELL_COMMAND_DRIVER
CONFIGURE_SHELL_COMMAND_ECHO
CONFIGURE_SHELL_COMMAND_EXTENSION
CONFIGURE_SHELL_COMMAND_FDISK
CONFIGURE_SHELL_COMMAND_GETENV
CONFIGURE_SHELL_COMMAND_HEXDUMP
CONFIGURE_SHELL_COMMAND_I2CDETECT
CONFIGURE_SHELL_COMMAND_I2CGET
CONFIGURE_SHELL_COMMAND_I2CSET
CONFIGURE_SHELL_COMMAND_ID
CONFIGURE_SHELL_COMMAND_IFCONFIG
CONFIGURE_SHELL_COMMAND_ITASK
CONFIGURE_SHELL_COMMAND_LDUMP
CONFIGURE_SHELL_COMMAND_LN
CONFIGURE_SHELL_COMMAND_LOGOFF
CONFIGURE_SHELL_COMMAND_LS
CONFIGURE_SHELL_COMMAND_MALLOC
CONFIGURE_SHELL_COMMAND_MD5
CONFIGURE_SHELL_COMMAND_MDUMP
CONFIGURE_SHELL_COMMAND_MEDIT
CONFIGURE_SHELL_COMMAND_MFILL
CONFIGURE_SHELL_COMMAND_MKDIR
CONFIGURE_SHELL_COMMAND_MKDOS
CONFIGURE_SHELL_COMMAND_MKNOD
CONFIGURE_SHELL_COMMAND_MKRFS
CONFIGURE_SHELL_COMMAND_MMOVE
CONFIGURE_SHELL_COMMAND_MOUNT
CONFIGURE_SHELL_COMMAND_MV
CONFIGURE_SHELL_COMMAND_NETSTATS
CONFIGURE_SHELL_COMMAND_OBJECT
CONFIGURE_SHELL_COMMAND_PART
CONFIGURE_SHELL_COMMAND_PERIODUSE
CONFIGURE_SHELL_COMMAND_PING
CONFIGURE_SHELL_COMMAND_PROFREPORT
CONFIGURE_SHELL_COMMAND_PWD
CONFIGURE_SHELL_COMMAND_QUEUE
CONFIGURE_SHELL_COMMAND_REGION
CONFIGURE_SHELL_COMMAND_RM
CONFIGURE_SHELL_COMMAND_RMDIR
CONFIGURE_SHELL_COMMAND_ROUTE
CONFIGURE_SHELL_COMMAND_RTC
CONFIGURE_SHELL_COMMAND_RTEMS
CONFIGURE_SHELL_COMMAND_SEMA
CONFIGURE_SHELL_COMMAND_SETENV
CONFIGURE_SHELL_COMMAND_SHUTDOWN
CONFIGURE_SHELL_COMMAND_SLEEP
CONFIGURE_SHELL_COMMAND_SPI
CONFIGURE_SHELL_COMMAND_STACKUSE
CONFIGURE_SHELL_COMMAND_TASK
CONFIGURE_SHELL_COMMAND_TIME
CONFIGURE_SHELL_COMMAND_TTY
CONFIGURE_SHELL_COMMAND_UMASK
CONFIGURE_SHELL_COMMAND_UNMOUNT
CONFIGURE_SHELL_COMMAND_UNSETENV
CONFIGURE_SHELL_COMMAND_WDUMP
CONFIGURE_SHELL_COMMAND_WHOAMI
CONFIGURE_SHELL_COMMAND_WKSPACE
CONFIGURE_SHELL_NO_COMMAND_ALIAS
CONFIGURE_SHELL_NO_COMMAND_BLKSYNC
CONFIGURE_SHELL_NO_COMMAND_CAT
CONFIGURE_SHELL_NO_COMMAND_CD
CONFIGURE_SHELL_NO_COMMAND_CHDIR
CONFIGURE_SHELL_NO_COMMAND_CHMOD
CONFIGURE_SHELL_NO_COMMAND_CHROOT
CONFIGURE_SHELL_NO_COMMAND_CMDCHMOD
CONFIGURE_SHELL_NO_COMMAND_CMDCHOWN
CONFIGURE_SHELL_NO_COMMAND_CMDLS
CONFIGURE_SHELL_NO_COMMAND_CONFIG
CONFIGURE_SHELL_NO_COMMAND_CP
CONFIGURE_SHELL_NO_COMMAND_CPUINFO
CONFIGURE_SHELL_NO_COMMAND_CPUUSE
CONFIGURE_SHELL_NO_COMMAND_DATE
CONFIGURE_SHELL_NO_COMMAND_DD
CONFIGURE_SHELL_NO_COMMAND_DEBUGRFS
CONFIGURE_SHELL_NO_COMMAND_DF
CONFIGURE_SHELL_NO_COMMAND_DIR
CONFIGURE_SHELL_NO_COMMAND_DNAME
CONFIGURE_SHELL_NO_COMMAND_DRIVER
CONFIGURE_SHELL_NO_COMMAND_ECHO
CONFIGURE_SHELL_NO_COMMAND_EXTENSION
CONFIGURE_SHELL_NO_COMMAND_FDISK
CONFIGURE_SHELL_NO_COMMAND_GETENV
CONFIGURE_SHELL_NO_COMMAND_HEXDUMP
CONFIGURE_SHELL_NO_COMMAND_I2CDETECT
CONFIGURE_SHELL_NO_COMMAND_I2CGET
CONFIGURE_SHELL_NO_COMMAND_I2CSET
CONFIGURE_SHELL_NO_COMMAND_ID
CONFIGURE_SHELL_NO_COMMAND_IFCONFIG
CONFIGURE_SHELL_NO_COMMAND_ITASK
CONFIGURE_SHELL_NO_COMMAND_LDUMP
CONFIGURE_SHELL_NO_COMMAND_LN
CONFIGURE_SHELL_NO_COMMAND_LOGOFF
CONFIGURE_SHELL_NO_COMMAND_LS
CONFIGURE_SHELL_NO_COMMAND_MALLOC
CONFIGURE_SHELL_NO_COMMAND_MD5
CONFIGURE_SHELL_NO_COMMAND_MDUMP
CONFIGURE_SHELL_NO_COMMAND_MEDIT
CONFIGURE_SHELL_NO_COMMAND_MFILL
CONFIGURE_SHELL_NO_COMMAND_MKDIR
CONFIGURE_SHELL_NO_COMMAND_MKDOS
CONFIGURE_SHELL_NO_COMMAND_MKNOD
CONFIGURE_SHELL_NO_COMMAND_MKRFS
CONFIGURE_SHELL_NO_COMMAND_MMOVE
CONFIGURE_SHELL_NO_COMMAND_MOUNT
CONFIGURE_SHELL_NO_COMMAND_MV
CONFIGURE_SHELL_NO_COMMAND_NETSTATS
CONFIGURE_SHELL_NO_COMMAND_OBJECT
CONFIGURE_SHELL_NO_COMMAND_PART
CONFIGURE_SHELL_NO_COMMAND_PERIODUSE
CONFIGURE_SHELL_NO_COMMAND_PING
CONFIGURE_SHELL_NO_COMMAND_PROFREPORT
CONFIGURE_SHELL_NO_COMMAND_PWD
CONFIGURE_SHELL_NO_COMMAND_QUEUE
CONFIGURE_SHELL_NO_COMMAND_REGION
CONFIGURE_SHELL_NO_COMMAND_RM
CONFIGURE_SHELL_NO_COMMAND_RMDIR
CONFIGURE_SHELL_NO_COMMAND_ROUTE
CONFIGURE_SHELL_NO_COMMAND_RTC
CONFIGURE_SHELL_NO_COMMAND_RTEMS
CONFIGURE_SHELL_NO_COMMAND_SEMA
CONFIGURE_SHELL_NO_COMMAND_SETENV
CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN
CONFIGURE_SHELL_NO_COMMAND_SLEEP
CONFIGURE_SHELL_NO_COMMAND_SPI
CONFIGURE_SHELL_NO_COMMAND_STACKUSE
CONFIGURE_SHELL_NO_COMMAND_TASK
CONFIGURE_SHELL_NO_COMMAND_TIME
CONFIGURE_SHELL_NO_COMMAND_TTY
CONFIGURE_SHELL_NO_COMMAND_UMASK
CONFIGURE_SHELL_NO_COMMAND_UNMOUNT
CONFIGURE_SHELL_NO_COMMAND_UNSETENV
CONFIGURE_SHELL_NO_COMMAND_WDUMP
CONFIGURE_SHELL_NO_COMMAND_WHOAMI
CONFIGURE_SHELL_NO_COMMAND_WKSPACE
cp
cpuinfo
cpuuse
crypt_add_format
D
date
dd
debugrfs
df
dir
dname
driver
duplicate symbols
E
echo
exit
extension
F
fdisk
G
getenv
H
help
hexdump
I
i2cdetect
i2cget
i2cset
id
ifconfig
initialization
,
[1]
itask
L
ldump
list archive symbols
ln
logoff
ls
M
malloc
md5
mdump
medit
mfill
mkdir
mkdos
mknod
mkrfs
mmove
mount
mv
N
netstats
O
object
P
part
perioduse
ping
profreport
pthread
pwd
Q
queue
R
region
rm
rmdir
route
rtc
rtems
rtems_rtl_shell_archive
rtems_rtl_shell_call
rtems_rtl_shell_command
rtems_rtl_shell_list
rtems_rtl_shell_object
,
[1]
rtems_shell_init
rtems_shell_login_check
rtems_shell_main_cp
rtems_shell_main_mv
rtems_shell_main_rm
rtems_shell_rtems_main_alias
rtems_shell_rtems_main_blksync
rtems_shell_rtems_main_cat
rtems_shell_rtems_main_cd
rtems_shell_rtems_main_chdir
rtems_shell_rtems_main_chmod
rtems_shell_rtems_main_chroot
rtems_shell_rtems_main_config
rtems_shell_rtems_main_cpuinfo
rtems_shell_rtems_main_cpuuse
rtems_shell_rtems_main_date
rtems_shell_rtems_main_dd
rtems_shell_rtems_main_debugrfs
rtems_shell_rtems_main_df
rtems_shell_rtems_main_dir
rtems_shell_rtems_main_dname
rtems_shell_rtems_main_driver
rtems_shell_rtems_main_echo
rtems_shell_rtems_main_extension
rtems_shell_rtems_main_getenv
rtems_shell_rtems_main_hexdump
rtems_shell_rtems_main_id
rtems_shell_rtems_main_ifconfig
rtems_shell_rtems_main_itask
rtems_shell_rtems_main_ldump
rtems_shell_rtems_main_ln
rtems_shell_rtems_main_logoff
rtems_shell_rtems_main_ls
rtems_shell_rtems_main_malloc
rtems_shell_rtems_main_md5
rtems_shell_rtems_main_mdump
rtems_shell_rtems_main_medit
rtems_shell_rtems_main_mfill
rtems_shell_rtems_main_mkdir
rtems_shell_rtems_main_mkdos
rtems_shell_rtems_main_mknod
rtems_shell_rtems_main_mkrfs
rtems_shell_rtems_main_mmove
rtems_shell_rtems_main_mount
rtems_shell_rtems_main_netstats
rtems_shell_rtems_main_object
rtems_shell_rtems_main_part
rtems_shell_rtems_main_perioduse
rtems_shell_rtems_main_ping
rtems_shell_rtems_main_pwd
rtems_shell_rtems_main_queue
rtems_shell_rtems_main_region
rtems_shell_rtems_main_rmdir
rtems_shell_rtems_main_route
rtems_shell_rtems_main_sema
rtems_shell_rtems_main_setenv
rtems_shell_rtems_main_sleep
rtems_shell_rtems_main_stackuse
rtems_shell_rtems_main_task
rtems_shell_rtems_main_time
rtems_shell_rtems_main_tty
rtems_shell_rtems_main_umask
rtems_shell_rtems_main_unmount
rtems_shell_rtems_main_unsetenv
rtems_shell_rtems_main_wdump
rtems_shell_rtems_main_whoami
rtems_shell_rtems_main_wkspace
rtl
rtl ar
rtl call
rtl list
rtl obj
rtl sym
rtl trace
S
sema
setenv
shutdown
sleep
spi
stackuse
T
task
time
tty
U
umask
unmount
unsetenv
W
wdump
whoami
wkspace