Mirrors_Framework/rtems
1
0 Fork 0
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2026-11-05 14:38:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

2008-02-28 Joel Sherrill <joel.sherrill@oarcorp.com>

Browse Source 
* shell/.cvsignore, shell/Makefile.am, shell/memory.t,
	shell/preface.texi, shell/shell.texi: Added much information the
	Preface. Created initial version of Configuration and Intialization
	chapter. Links are now complete from start to end of manual.
	* shell/confinit.t: New file.
This commit is contained in:
Joel Sherrill committed 2008-02-29 00:23:04 +00:00
1 parent fbd6c0f11b
commit c2153cfd29
7 files changed
+382 -17
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

doc/ChangeLog
+8
View File
@@ -1,3 +1,11 @@
2008-02-28 Joel Sherrill <joel.sherrill@oarcorp.com>
* shell/.cvsignore, shell/Makefile.am, shell/memory.t,
shell/preface.texi, shell/shell.texi: Added much information the
Preface. Created initial version of Configuration and Intialization
chapter. Links are now complete from start to end of manual.
* shell/confinit.t: New file.
2008-02-28 Joel Sherrill <joel.sherrill@oarcorp.com>
* shell/file.t, shell/network.t: Document more commands and provide
doc/shell/.cvsignore
+1
View File
@@ -1,3 +1,4 @@
confinit.texi
file.texi
general.texi
index.html
doc/shell/Makefile.am
+17 -11
View File
@@ -14,37 +14,43 @@ include $(top_srcdir)/main.am
FILES = shell.texi preface.texi
GENERATED_FILES = general.texi file.texi memory.texi rtems.texi network.texi
GENERATED_FILES = confinit.texi general.texi file.texi memory.texi \
rtems.texi network.texi
COMMON_FILES += $(top_srcdir)/common/cpright.texi
info_TEXINFOS = shell.texi
shell_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES)
general.texi: general.t
confinit.texi: confinit.t
$(BMENU2) -p "Preface" \
-u "Top" \
-n "" < $< > $@
-n "General Commands" < $< > $@
general.texi: general.t
$(BMENU2) -p "Configuration and Initialization rtems_shell_init - initialize the shell" \
-u "Top" \
-n "File and Directory Commands" < $< > $@
file.texi: file.t
$(BMENU2) -p "" \
$(BMENU2) -p "General Commands exit - exit the shell" \
-u "Top" \
-n "" < $< > $@
-n "Memory Commands" < $< > $@
memory.texi: memory.t
$(BMENU2) -p "" \
$(BMENU2) -p "File and Directory Commands cd - alias for chdir" \
-u "Top" \
-n "" < $< > $@
-n "RTEMS Specific Commands" < $< > $@
rtems.texi: rtems.t
$(BMENU2) -p "" \
$(BMENU2) -p "Memory Commands malloc - obtain information on C program heap" \
-u "Top" \
-n "" < $< > $@
-n "Network Commands" < $< > $@
network.texi: network.t
$(BMENU2) -p "" \
$(BMENU2) -p "RTEMS Specific Commands dname - displays information about named drivers" \
-u "Top" \
-n "" < $< > $@
-n "Function and Variable Index" < $< > $@
EXTRA_DIST = general.t file.t memory.t rtems.t network.t
doc/shell/confinit.t
+253
View File
File diff suppressed because it is too large. Load diff
doc/shell/memory.t
+1 -1
View File
@@ -438,7 +438,7 @@ extern rtems_shell_cmd_t rtems_shell_MMOVE_Command;
@c
@c
@page
@subsection malloc - obtain information on c program heap
@subsection malloc - obtain information on C program heap
@pgindex malloc
doc/shell/preface.texi
+99 -4
View File
@@ -7,11 +7,106 @@
@c
@ifinfo
@node Preface, General Commands, Top, Top
@node Preface, Configuration and Initialization, Top, Top
@end ifinfo
@unnumbered Preface
Real-time embedded systems vary widely based upon their
operational and maintenance requirements. Many of these
systems now include a command line interface which can
be used to diagnostic
operational and maintenance requirements. Some of these
systems provide ways for the user or developer to interact
with them. This interaction could be used for operational,
diagnostic, or configuration purposes. The capabilities
described in this manual are those provided with RTEMS to
provide a command line interface for user access. Some
of these commands will be familiar as standard POSIX utilities
while others are RTEMS specific or helpful in debugging
and analyzing an embedded system. As a simple example of
the powerful and very familiar capabilities that the RTEMS
Shell provides to an application, consider the following
example which hints at some of the capabilities available:
@smallexample
Welcome to rtems-4.8.99.0(SPARC/w/FPU/sis)
COPYRIGHT (c) 1989-2008.
On-Line Applications Research Corporation (OAR).
Login into RTEMS
login: rtems
Password:
RTEMS SHELL (Ver.1.0-FRC):/dev/console. Feb 28 2008. 'help' to list commands.
SHLL [/] $ cat /etc/passwd
root:*:0:0:root::/:/bin/sh
rtems:*:1:1:RTEMS Application::/:/bin/sh
tty:!:2:2:tty owner::/:/bin/false
SHLL [/] $ ls /dev
-rwxr-xr-x 1 rtems root 0 Jan 01 00:00 console
-rwxr-xr-x 1 root root 0 Jan 01 00:00 console_b
2 files 0 bytes occupied
SHLL [/] $ stackuse
Stack usage by thread
ID NAME LOW HIGH CURRENT AVAILABLE USED
0x09010001 IDLE 0x023d89a0 - 0x023d99af 0x023d9760 4096 608
0x0a010001 UI1 0x023d9f30 - 0x023daf3f 0x023dad18 4096 1804
0x0a010002 SHLL 0x023db4c0 - 0x023df4cf 0x023de9d0 16384 6204
0xffffffff INTR 0x023d2760 - 0x023d375f 0x00000000 4080 316
SHLL [/] $ mount -L
File systems: msdos
SHLL [/] $
@end smallexample
In the above example, the user @i{rtems} logs into a
SPARC based RTEMS system. The first command is
@code{cat /etc/passwd}. This simple command lets us
know that this application is running the In Memory
File System (IMFS) and that the infrastructure has
provided dummy entries for @i{/etc/passwd} and a few
other files. The contents of @i{/etc/passwd} let
us know that the user could have logged in as @code{root}.
In fact, the @code{root} user has more permissions
than @code{rtems} who is not allowed to write into the
filesystem.
The second command is @code{ls /dev} which lets us
know that RTEMS has POSIX-style device nodes which
can be accesses through standard I/O function calls.
The third command executed is the RTEMS specific
@code{stackuse} which gives a report on the stack
usage of each thread in the system. Since stack
overflows are a common error in deeply embedded systems,
this is a surprising simple, yet powerful debugging aid.
Finally, the last command, @code{mount -L} hints that
RTEMS supports a variety of mountable filesystems. With
support for MS-DOS FAT on IDE/ATA and Flash devices as
well as network-based filesystens such as NFS and TFTP,
the standard free RTEMS provides a robuse infrastructure
for embedded applications.
This manual describes the RTEMS Shell and its command set.
In our terminology, the Shell is just a loop reading user
input and turning that input into commands with argument.
The Shell provided with RTEMS is a simple command reading
loop with limited scripting capabilities. It can be connected
to via a standard serial port or connected to the RTEMS
@code{telnetd} server for use across a network.
Each command in the command set is implemented as a single
subroutine which has a @i{main-style} prototype. The commands
interpret their arguments and operate upon stdin, stdout, and
stderr by default. This allows each command to be invoked
independent of the shell.
The described separation of shell from commands from communications
mechanism was an important design goal. At one level, the RTEMS
Shell is a complete shell environment providing access to multiple
POSIX compliant filesystems and TCP/IP stack. The subset of
capabilities available is easy to configure and the standard
Shell can be logged into from either a serial port or via telnet.
But at another level, the Shell is a large set of components which
can be integrated into the user's developed command interpreter.
In either case, it is trivial to add custom commands to the command
set available.
doc/shell/shell.texi
+3 -1
View File
@@ -66,6 +66,7 @@
@contents
@include preface.texi
@include confinit.texi
@include general.texi
@include file.texi
@include memory.texi
@@ -79,6 +80,7 @@ This is the online version of the RTEMS Shell User's Guide.
@menu
* Preface::
* Configuration and Initialization::
* General Commands::
* File and Directory Commands::
* Memory Commands::
@@ -95,7 +97,7 @@ This is the online version of the RTEMS Shell User's Guide.
@c Need to copy the emacs stuff and "trailer stuff" (index, toc) into here
@c
@node Function and Variable Index, Concept Index, , Top
@node Function and Variable Index, Concept Index, Network Commands route - show or manipulate the ip routing table, Top
@unnumbered Function and Variable Index
@printindex fn