RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

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

Browse Source 
* Makefile.am, configure.ac, index.html.in: Add initial version of
	RTEMS Shell Manual. This is largely a starting point but has most of
	the required structure.
	* shell/.cvsignore, shell/Makefile.am, shell/file.t, shell/general.t,
	shell/memory.t, shell/network.t, shell/preface.texi, shell/rtems.t,
	shell/shell.texi: New files.
This commit is contained in:
Joel Sherrill
2008-02-20 22:55:13 +00:00
parent 6cf00455c4
commit eb03905dfe
13 changed files with 3302 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/ChangeLog
View File

@@ -1,3 +1,12 @@
2008-02-20 Joel Sherrill <joel.sherrill@oarcorp.com>
* Makefile.am, configure.ac, index.html.in: Add initial version of
RTEMS Shell Manual. This is largely a starting point but has most of
the required structure.
* shell/.cvsignore, shell/Makefile.am, shell/file.t, shell/general.t,
shell/memory.t, shell/network.t, shell/preface.texi, shell/rtems.t,
shell/shell.texi: New files.
2008-02-05 Joel Sherrill <joel.sherrill@oarcorp.com>
* networking/networkapp.t: Add configuration parameters for network

2
doc/Makefile.am
View File

@@ -9,7 +9,7 @@ ACLOCAL_AMFLAGS = -I ../aclocal
SUBDIRS = tools started user bsp_howto porting develenv posix_users \
posix1003.1 filesystem itron3.0 networking ada_user started_ada \
new_chapters relnotes cpu_supplement
new_chapters relnotes cpu_supplement shell
if USE_HTML
html_DATA = index.html HELP.html

1
doc/configure.ac
View File

@@ -212,5 +212,6 @@ started_ada/Makefile
relnotes/Makefile
new_chapters/Makefile
cpu_supplement/Makefile
shell/Makefile
])
AC_OUTPUT

10
doc/index.html.in
View File

@@ -59,6 +59,16 @@
<A HREF="networking/index.html">
RTEMS Network Supplement</A>
</LI>
<LI><A HREF="../pdf/shell.pdf">
<IMG SRC="images/pdf1.gif" HEIGHT=18 WIDTH=16></A>
<A HREF="../ps/shell.ps">
<IMG SRC="images/ps.gif" HEIGHT=18 WIDTH=16></A>
<A HREF="../dvi/shell.dvi">
<IMG SRC="images/dvi.gif" HEIGHT=18 WIDTH=16></A>
<A HREF="shell/index.html">
RTEMS Shell</A>
</LI>
</MENU>
<LI>Ada Manuals</LI>
<MENU>

32
doc/shell/.cvsignore Normal file
View File

@@ -0,0 +1,32 @@
file.texi
general.texi
memory.texi
network.texi
rtems.texi
shell
shell-?
shell-??
shell.aux
shell.cp
shell.cps
shell.dvi
shell.fn
shell.fns
shell*.html
shell.info
shell.info-?
shell.info-??
shell.ky
shell.log
shell.pdf
shell.pg
shell.ps
shell.toc
shell.tp
shell.vr
index.html
Makefile
Makefile.in
mdate-sh
rtems_footer.html
rtems_header.html

51
doc/shell/Makefile.am Normal file
View File

@@ -0,0 +1,51 @@
#
# COPYRIGHT (c) 1988-2007
# On-Line Applications Research Corporation (OAR).
# All rights reserved.
#
# $Id$
#
PROJECT = shell
EDITION = 1
include $(top_srcdir)/project.am
include $(top_srcdir)/main.am
FILES = shell.texi preface.texi
GENERATED_FILES = 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
$(BMENU2) -p "Preface" \
-u "Top" \
-n "" < $< > $@
file.texi: file.t
$(BMENU2) -p "" \
-u "Top" \
-n "" < $< > $@
memory.texi: memory.t
$(BMENU2) -p "" \
-u "Top" \
-n "" < $< > $@
rtems.texi: rtems.t
$(BMENU2) -p "" \
-u "Top" \
-n "" < $< > $@
network.texi: network.t
$(BMENU2) -p "" \
-u "Top" \
-n "" < $< > $@
EXTRA_DIST = general.t file.t memory.t rtems.t network.t
CLEANFILES += shell.info shell.info-? shell.info-??

1031
doc/shell/file.t Normal file
View File

File diff suppressed because it is too large Load Diff

462
doc/shell/general.t Normal file
View File

@@ -0,0 +1,462 @@
@c
@c COPYRIGHT (c) 1988-2008.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $
@c
@chapter General Commands
@section Introduction
The RTEMS shell has the following general commands:
@itemize @bullet
@item @code{alias} - Add alias for an existing command
@item @code{date} - Print current date and time
@item @code{id} - show uid gid euid and egid
@item @code{tty} - show ttyname
@item @code{whoami} - show current user
@item @code{logoff} - logoff from the system
@item @code{exit} - alias for logoff command
@end itemize
@section Commands
@c
@c
@c
@page
@subsection alias - add alias for an existing command
@pgindex alias
@subheading SYNOPSYS:
alias oldCommand newCommand
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use alias:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_ALIAS
@findex CONFIGURE_SHELL_COMMAND_ALIAS
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_ALIAS}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_ALIAS}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_alias
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_alias(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_ALIAS_Command;
@end example
@c
@c
@c
@page
@subsection date - print current date and time
@pgindex date
@subheading SYNOPSYS:
date
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use date:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_DATE
@findex CONFIGURE_SHELL_COMMAND_DATE
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_DATE}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_DATE}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_date
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_date(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_DATE_Command;
@end example
@c
@c
@c
@page
@subsection id - show uid gid euid and egid
@pgindex id
@subheading SYNOPSYS:
id
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use id:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_ID
@findex CONFIGURE_SHELL_COMMAND_ID
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_ID}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_ID}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_id
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_id(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_ID_Command;
@end example
@c
@c
@c
@page
@subsection tty - show ttyname
@pgindex tty
@subheading SYNOPSYS:
tty
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use tty:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_TTY
@findex CONFIGURE_SHELL_COMMAND_TTY
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_TTY}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_TTY}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_tty
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_tty(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_TTY_Command;
@end example
@c
@c
@c
@page
@subsection whoami - show current user
@pgindex whoami
@subheading SYNOPSYS:
whoami
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use whoami:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_WHOAMI
@findex CONFIGURE_SHELL_COMMAND_WHOAMI
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_WHOAMI}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_WHOAMI}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_whoami
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_whoami(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_WHOAMI_Command;
@end example
@c
@c
@c
@page
@subsection logoff - logoff from the system
@pgindex logoff
@subheading SYNOPSYS:
logoff
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use logoff:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_LOGOFF
@findex CONFIGURE_SHELL_COMMAND_LOGOFF
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_LOGOFF}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_LOGOFF}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_logoff
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_logoff(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_LOGOFF_Command;
@end example
@c
@c
@c
@page
@subsection exit - alias for logoff command
@pgindex exit
@subheading SYNOPSYS:
exit
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use exit:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_EXIT
@findex CONFIGURE_SHELL_COMMAND_EXIT
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_EXIT}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_EXIT}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_exit
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_exit(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_EXIT_Command;
@end example

399
doc/shell/memory.t Normal file
View File

@@ -0,0 +1,399 @@
@c
@c COPYRIGHT (c) 1988-2008.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $
@c
@chapter Memory Commands
@section Introduction
The RTEMS shell has the following memory commands:
@itemize @bullet
@item @code{mdump} - Display contents of memory
@item @code{wdump} - Display contents of memory (word)
@item @code{medit} - Modify contents of memory
@item @code{mfill} - File memory with pattern
@item @code{mmove} - Move contents of memory
@item @code{malloc} - Obtain information on C Program Heap
@end itemize
@section Commands
@c
@c
@c
@page
@subsection mdump - display contents of memory
@pgindex mdump
@subheading SYNOPSYS:
mdump [addr [size]]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use mdump:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_MDUMP
@findex CONFIGURE_SHELL_COMMAND_MDUMP
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_MDUMP}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_MDUMP}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_mdump
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_mdump(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_MDUMP_Command;
@end example
@c
@c
@c
@page
@subsection wdump - display contents of memory (word)
@pgindex wdump
@subheading SYNOPSYS:
wdump [addr [size]]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use wdump:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_WDUMP
@findex CONFIGURE_SHELL_COMMAND_WDUMP
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_WDUMP}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_WDUMP}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_wdump
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_wdump(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_WDUMP_Command;
@end example
@c
@c
@c
@page
@subsection medit - modify contents of memory
@pgindex medit
@subheading SYNOPSYS:
medit addr value [value ...]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use medit:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_MEDIT
@findex CONFIGURE_SHELL_COMMAND_MEDIT
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_MEDIT}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_MEDIT}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_medit
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_medit(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_MEDIT_Command;
@end example
@c
@c
@c
@page
@subsection mfill - file memory with pattern
@pgindex mfill
@subheading SYNOPSYS:
mfill addr size value
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use mfill:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_MFILL
@findex CONFIGURE_SHELL_COMMAND_MFILL
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_MFILL}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_MFILL}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_mfill
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_mfill(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_MFILL_Command;
@end example
@c
@c
@c
@page
@subsection mmove - move contents of memory
@pgindex mmove
@subheading SYNOPSYS:
mmove dst src size
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use mmove:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_MMOVE
@findex CONFIGURE_SHELL_COMMAND_MMOVE
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_MMOVE}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_MMOVE}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_mmove
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_mmove(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_MMOVE_Command;
@end example
@c
@c
@c
@page
@subsection malloc - obtain information on c program heap
@pgindex malloc
@subheading SYNOPSYS:
malloc [info|stats]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use malloc:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_MALLOC
@findex CONFIGURE_SHELL_COMMAND_MALLOC
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_MALLOC}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_MALLOC}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_malloc
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_malloc(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_MALLOC_Command;
@end example

210
doc/shell/network.t Normal file
View File

@@ -0,0 +1,210 @@
@c
@c COPYRIGHT (c) 1988-2008.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $
@c
@chapter Network Commands
@section Introduction
The RTEMS shell has the following network commands:
@itemize @bullet
@item @code{netstats} - obtain network statistics
@item @code{ifconfig} - configure a network interface
@item @code{route} - show or manipulate the IP routing table
@end itemize
@section Commands
@c
@c
@c
@page
@subsection netstats - obtain network statistics
@pgindex netstats
@subheading SYNOPSYS:
netstats [-Aimfpcutv]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use netstats:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_NETSTATS
@findex CONFIGURE_SHELL_COMMAND_NETSTATS
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_NETSTATS}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_NETSTATS}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_netstats
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_netstats(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_NETSTATS_Command;
@end example
@c
@c
@c
@page
@subsection ifconfig - configure a network interface
@pgindex ifconfig
@subheading SYNOPSYS:
ifconfig
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use ifconfig:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_IFCONFIG
@findex CONFIGURE_SHELL_COMMAND_IFCONFIG
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_IFCONFIG}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_IFCONFIG}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_ifconfig
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_ifconfig(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_IFCONFIG_Command;
@end example
@c
@c
@c
@page
@subsection route - show or manipulate the ip routing table
@pgindex route
@subheading SYNOPSYS:
route [subcommand]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use route:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_ROUTE
@findex CONFIGURE_SHELL_COMMAND_ROUTE
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_ROUTE}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_ROUTE}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_route
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_route(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_ROUTE_Command;
@end example

17
doc/shell/preface.texi Normal file
View File

@@ -0,0 +1,17 @@
@c
@c COPYRIGHT (c) 1988-2008.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $Id$
@c
@ifinfo
@node Preface, General Commands, 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

966
doc/shell/rtems.t Normal file
View File

@@ -0,0 +1,966 @@
@c
@c COPYRIGHT (c) 1988-2008.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $
@c
@chapter RTEMS Commands
@section Introduction
The RTEMS shell has the following rtems commands:
@itemize @bullet
@item @code{cpuuse} - print or reset per thread cpu usage
@item @code{stackuse} - print per thread stack usage
@item @code{perioduse} - print or reset per period usage
@item @code{wkspace} - Display information on Executive Workspace
@item @code{config} - Show the system configuration.
@item @code{itask} - List init tasks for the system
@item @code{extension} - Display information about extensions
@item @code{task} - Display information about tasks
@item @code{queue} - Display information about message queues
@item @code{sema} - display information about semaphores
@item @code{region} - display information about regions
@item @code{part} - display information about partitions
@item @code{object} - Display information about RTEMS objects
@item @code{driver} - Display the RTEMS device driver table
@item @code{dname} - Displays information about named drivers
@end itemize
@section Commands
@c
@c
@c
@page
@subsection cpuuse - print or reset per thread cpu usage
@pgindex cpuuse
@subheading SYNOPSYS:
cpuuse [-r]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use cpuuse:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_CPUUSE
@findex CONFIGURE_SHELL_COMMAND_CPUUSE
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_CPUUSE}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_CPUUSE}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_cpuuse
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_cpuuse(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command;
@end example
@c
@c
@c
@page
@subsection stackuse - print per thread stack usage
@pgindex stackuse
@subheading SYNOPSYS:
stackuse
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use stackuse:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_STACKUSE
@findex CONFIGURE_SHELL_COMMAND_STACKUSE
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_STACKUSE}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_STACKUSE}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_stackuse
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_stackuse(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command;
@end example
@c
@c
@c
@page
@subsection perioduse - print or reset per period usage
@pgindex perioduse
@subheading SYNOPSYS:
perioduse [-r]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use perioduse:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_PERIODUSE
@findex CONFIGURE_SHELL_COMMAND_PERIODUSE
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_PERIODUSE}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_PERIODUSE}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_perioduse
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_perioduse(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command;
@end example
@c
@c
@c
@page
@subsection wkspace - display information on executive workspace
@pgindex wkspace
@subheading SYNOPSYS:
wkspace
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use wkspace:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_WKSPACE
@findex CONFIGURE_SHELL_COMMAND_WKSPACE
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_WKSPACE}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_WKSPACE}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_wkspace
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_wkspace(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command;
@end example
@c
@c
@c
@page
@subsection config - show the system configuration.
@pgindex config
@subheading SYNOPSYS:
config
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use config:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_CONFIG
@findex CONFIGURE_SHELL_COMMAND_CONFIG
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_CONFIG}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_CONFIG}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_config
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_config(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_CONFIG_Command;
@end example
@c
@c
@c
@page
@subsection itask - list init tasks for the system
@pgindex itask
@subheading SYNOPSYS:
itask
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use itask:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_ITASK
@findex CONFIGURE_SHELL_COMMAND_ITASK
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_ITASK}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_ITASK}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_itask
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_itask(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_ITASK_Command;
@end example
@c
@c
@c
@page
@subsection extension - display information about extensions
@pgindex extension
@subheading SYNOPSYS:
extension [id [id ...] ]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use extension:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_EXTENSION
@findex CONFIGURE_SHELL_COMMAND_EXTENSION
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_EXTENSION}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_EXTENSION}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_extension
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_extension(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command;
@end example
@c
@c
@c
@page
@subsection task - display information about tasks
@pgindex task
@subheading SYNOPSYS:
task [id [id ...] ]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use task:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_TASK
@findex CONFIGURE_SHELL_COMMAND_TASK
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_TASK}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_TASK}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_task
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_task(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_TASK_Command;
@end example
@c
@c
@c
@page
@subsection queue - display information about message queues
@pgindex queue
@subheading SYNOPSYS:
queue [id [id ... ] ]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use queue:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_QUEUE
@findex CONFIGURE_SHELL_COMMAND_QUEUE
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_QUEUE}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_QUEUE}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_queue
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_queue(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_QUEUE_Command;
@end example
@c
@c
@c
@page
@subsection sema - display information about semaphores
@pgindex sema
@subheading SYNOPSYS:
sema [id [id ... ] ]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use sema:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_SEMA
@findex CONFIGURE_SHELL_COMMAND_SEMA
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_SEMA}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_SEMA}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_sema
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_sema(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_SEMA_Command;
@end example
@c
@c
@c
@page
@subsection region - display information about regions
@pgindex region
@subheading SYNOPSYS:
region [id [id ... ] ]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use region:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_REGION
@findex CONFIGURE_SHELL_COMMAND_REGION
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_REGION}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_REGION}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_region
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_region(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_REGION_Command;
@end example
@c
@c
@c
@page
@subsection part - display information about partitions
@pgindex part
@subheading SYNOPSYS:
part [id [id ... ] ]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use part:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_PART
@findex CONFIGURE_SHELL_COMMAND_PART
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_PART}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_PART}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_part
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_part(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_PART_Command;
@end example
@c
@c
@c
@page
@subsection object - display information about rtems objects
@pgindex object
@subheading SYNOPSYS:
object [id [id ...] ]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use object:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_OBJECT
@findex CONFIGURE_SHELL_COMMAND_OBJECT
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_OBJECT}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_OBJECT}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_object
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_object(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_OBJECT_Command;
@end example
@c
@c
@c
@page
@subsection driver - display the rtems device driver table
@pgindex driver
@subheading SYNOPSYS:
driver [ major [ major ... ] ]
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use driver:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_DRIVER
@findex CONFIGURE_SHELL_COMMAND_DRIVER
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_DRIVER}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_DRIVER}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_driver
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_driver(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_DRIVER_Command;
@end example
@c
@c
@c
@page
@subsection dname - displays information about named drivers
@pgindex dname
@subheading SYNOPSYS:
dname
@subheading DESCRIPTION:
This command XXX
@subheading NOTES:
NONE
@subheading EXAMPLES:
The following is an example of how to use dname:
@example
EXAMPLE_TBD
@end example
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_DNAME
@findex CONFIGURE_SHELL_COMMAND_DNAME
In order to disable this command out if you are configuring all commands,
define @code{CONFIGURE_SHELL_NO_COMMAND_DNAME}.
In order to enable this command if you are building a custom command set
define @code{CONFIGURE_SHELL_COMMAND_DNAME}.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_dname
The @code{COMMAND} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_dname(
int argc,
char **argv
);
@end example
The configuration structure for the @code{COMMAND} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_DNAME_Command;
@end example

113
doc/shell/shell.texi Normal file
View File

@@ -0,0 +1,113 @@
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename shell.info
@syncodeindex vr fn
@synindex ky cp
@paragraphindent 0
@c %**end of header
@c
@c COPYRIGHT (c) 1988-2008.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $Id$
@c
@c
@c Master file for the Shell User's Guide
@c
@c Joel's Questions
@c
@c 1. Why does paragraphindent only impact makeinfo?
@c 2. Why does paragraphindent show up in HTML?
@c
@include version.texi
@include common/setup.texi
@include common/rtems.texi
@ifset use-ascii
@dircategory RTEMS Shell On-Line Manual
@direntry
* RTEMS Shell: (shell). The RTEMS Shell User's Guide.
@end direntry
@end ifset
@c @syncodeindex fn cp
@c
@c Title Page Stuff
@c
@c
@c I don't really like having a short title page. --joel
@c
@c @shorttitlepage RTEMS Shell User's Guide
@setchapternewpage odd
@settitle RTEMS Shell User's Guide
@titlepage
@finalout
@title RTEMS Shell User's Guide
@subtitle Edition @value{EDITION}, for RTEMS @value{VERSION}
@sp 1
@subtitle @value{UPDATED}
@author On-Line Applications Research Corporation
@page
@include common/cpright.texi
@end titlepage
@c This prevents a black box from being printed on "overflow" lines.
@c The alternative is to rework a sentence to avoid this problem.
@contents
@include preface.texi
@include general.texi
@include file.texi
@include memory.texi
@include rtems.texi
@include network.texi
@ifinfo
@node Top, Preface, (dir), (dir)
@top shell
This is the online version of the RTEMS Shell User's Guide.
@menu
* Preface::
* General Commands::
* File and Directory Commands::
* Memory Commands::
* RTEMS Commands::
* Network Commands::
* Function and Variable Index::
* Concept Index::
* Command Index::
@end menu
@end ifinfo
@c
@c
@c Need to copy the emacs stuff and "trailer stuff" (index, toc) into here
@c
@node Function and Variable Index, Concept Index, , Top
@unnumbered Function and Variable Index
@printindex fn
@c There are currently no Command and Variable Index entries.
@node Concept Index, Command Index, Function and Variable Index, Top
@unnumbered Concept Index
@printindex cp
@node Command Index, , Concept Index, Top
@unnumbered Command Index
@printindex pg
@bye