From b88d9ccf1d89ba10dca3aa0548b027d70e5f97fc Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Thu, 21 Feb 2008 17:20:13 +0000 Subject: 2008-02-21 Joel Sherrill * shell/file.t, shell/general.t, shell/memory.t, shell/network.t, shell/rtems.t: A bit of clean up on the script. --- doc/ChangeLog | 5 ++ doc/shell/file.t | 195 ++++++++++++++++++++++++++-------------------------- doc/shell/general.t | 86 +++++++++++------------ doc/shell/memory.t | 74 ++++++++++---------- doc/shell/network.t | 38 +++++----- doc/shell/rtems.t | 182 ++++++++++++++++++++++++------------------------ 6 files changed, 292 insertions(+), 288 deletions(-) (limited to 'doc') diff --git a/doc/ChangeLog b/doc/ChangeLog index d32aa3d45b..3cbd5c5e45 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2008-02-21 Joel Sherrill + + * shell/file.t, shell/general.t, shell/memory.t, shell/network.t, + shell/rtems.t: A bit of clean up on the script. + 2008-02-21 Joel Sherrill * shell/file.t, shell/general.t, shell/memory.t, shell/network.t, diff --git a/doc/shell/file.t b/doc/shell/file.t index ee2795e88f..94be2617d4 100644 --- a/doc/shell/file.t +++ b/doc/shell/file.t @@ -3,7 +3,7 @@ @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c -@c $ +@c $Id$ @c @chapter File and Directory Commands @@ -14,39 +14,22 @@ The RTEMS shell has the following file and directory commands: @itemize @bullet - @item @code{umask} - Set file mode creation mask - @item @code{cp} - copy files - @item @code{pwd} - print work directory - @item @code{ls} - list files in the directory - @item @code{chdir} - change the current directory - @item @code{mkdir} - create a directory - @item @code{rmdir} - remove directory - @item @code{chroot} - change the root directory - @item @code{chmod} - change permissions of a file - @item @code{cat} - display file contents - @item @code{msdosfmt} - format disk - @item @code{rm} - remove files - @item @code{mount} - mount disk - @item @code{unmount} - unmount disk - @item @code{blksync} - sync the block driver - @item @code{dir} - alias for ls - @item @code{cd} - alias for chdir @end itemize @@ -86,12 +69,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_UMASK @findex CONFIGURE_SHELL_COMMAND_UMASK -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_UMASK} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_UMASK} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_UMASK} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_UMASK} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -148,12 +132,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_CP @findex CONFIGURE_SHELL_COMMAND_CP -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_CP} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_CP} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_CP} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_CP} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -210,12 +195,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_PWD @findex CONFIGURE_SHELL_COMMAND_PWD -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_PWD} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_PWD} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_PWD} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_PWD} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -272,12 +258,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_LS @findex CONFIGURE_SHELL_COMMAND_LS -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_LS} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_LS} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_LS} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_LS} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -334,12 +321,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_CHDIR @findex CONFIGURE_SHELL_COMMAND_CHDIR -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_CHDIR} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_CHDIR} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_CHDIR} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_CHDIR} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -396,12 +384,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_MKDIR @findex CONFIGURE_SHELL_COMMAND_MKDIR -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_MKDIR} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_MKDIR} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_MKDIR} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_MKDIR} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -458,12 +447,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_RMDIR @findex CONFIGURE_SHELL_COMMAND_RMDIR -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_RMDIR} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_RMDIR} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_RMDIR} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_RMDIR} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -520,12 +510,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_CHROOT @findex CONFIGURE_SHELL_COMMAND_CHROOT -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_CHROOT} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_CHROOT} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_CHROOT} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_CHROOT} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -582,12 +573,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_CHMOD @findex CONFIGURE_SHELL_COMMAND_CHMOD -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_CHMOD} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_CHMOD} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_CHMOD} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_CHMOD} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -644,12 +636,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_CAT @findex CONFIGURE_SHELL_COMMAND_CAT -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_CAT} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_CAT} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_CAT} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_CAT} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -706,12 +699,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_RM @findex CONFIGURE_SHELL_COMMAND_RM -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_RM} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_RM} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_RM} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_RM} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -768,12 +762,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_MOUNT @findex CONFIGURE_SHELL_COMMAND_MOUNT -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_MOUNT} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_MOUNT} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_MOUNT} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_MOUNT} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -830,12 +825,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_UNMOUNT @findex CONFIGURE_SHELL_COMMAND_UNMOUNT -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_UNMOUNT} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_UNMOUNT} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_UNMOUNT} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_UNMOUNT} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -892,12 +888,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_BLKSYNC @findex CONFIGURE_SHELL_COMMAND_BLKSYNC -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_BLKSYNC} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_BLKSYNC} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_BLKSYNC} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_BLKSYNC} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -954,12 +951,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_DIR @findex CONFIGURE_SHELL_COMMAND_DIR -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_DIR} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_DIR} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_DIR} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_DIR} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -1016,12 +1014,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_CD @findex CONFIGURE_SHELL_COMMAND_CD -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_CD} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_CD} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_CD} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_CD} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: diff --git a/doc/shell/general.t b/doc/shell/general.t index ed918f94f6..5c108d00ac 100644 --- a/doc/shell/general.t +++ b/doc/shell/general.t @@ -3,7 +3,7 @@ @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c -@c $ +@c $Id$ @c @chapter General Commands @@ -14,19 +14,12 @@ 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 @@ -66,12 +59,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_ALIAS @findex CONFIGURE_SHELL_COMMAND_ALIAS -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_ALIAS} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_ALIAS} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_ALIAS} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_ALIAS} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -128,12 +122,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_DATE @findex CONFIGURE_SHELL_COMMAND_DATE -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_DATE} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_DATE} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_DATE} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_DATE} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -190,12 +185,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_ID @findex CONFIGURE_SHELL_COMMAND_ID -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_ID} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_ID} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_ID} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_ID} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -252,12 +248,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_TTY @findex CONFIGURE_SHELL_COMMAND_TTY -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_TTY} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_TTY} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_TTY} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_TTY} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -314,12 +311,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_WHOAMI @findex CONFIGURE_SHELL_COMMAND_WHOAMI -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_WHOAMI} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_WHOAMI} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_WHOAMI} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_WHOAMI} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -376,12 +374,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_LOGOFF @findex CONFIGURE_SHELL_COMMAND_LOGOFF -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_LOGOFF} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_LOGOFF} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_LOGOFF} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_LOGOFF} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -438,12 +437,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_EXIT @findex CONFIGURE_SHELL_COMMAND_EXIT -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_EXIT} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_EXIT} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_EXIT} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_EXIT} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: diff --git a/doc/shell/memory.t b/doc/shell/memory.t index 82521d7f81..dea1d5fc48 100644 --- a/doc/shell/memory.t +++ b/doc/shell/memory.t @@ -3,7 +3,7 @@ @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c -@c $ +@c $Id$ @c @chapter Memory Commands @@ -14,17 +14,11 @@ 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 @@ -64,12 +58,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_MDUMP @findex CONFIGURE_SHELL_COMMAND_MDUMP -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_MDUMP} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_MDUMP} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_MDUMP} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_MDUMP} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -126,12 +121,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_WDUMP @findex CONFIGURE_SHELL_COMMAND_WDUMP -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_WDUMP} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_WDUMP} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_WDUMP} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_WDUMP} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -188,12 +184,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_MEDIT @findex CONFIGURE_SHELL_COMMAND_MEDIT -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_MEDIT} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_MEDIT} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_MEDIT} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_MEDIT} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -250,12 +247,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_MFILL @findex CONFIGURE_SHELL_COMMAND_MFILL -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_MFILL} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_MFILL} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_MFILL} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_MFILL} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -312,12 +310,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_MMOVE @findex CONFIGURE_SHELL_COMMAND_MMOVE -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_MMOVE} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_MMOVE} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_MMOVE} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_MMOVE} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -374,12 +373,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_MALLOC @findex CONFIGURE_SHELL_COMMAND_MALLOC -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_MALLOC} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_MALLOC} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_MALLOC} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_MALLOC} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: diff --git a/doc/shell/network.t b/doc/shell/network.t index 200c52ceb4..ca7ceb24d6 100644 --- a/doc/shell/network.t +++ b/doc/shell/network.t @@ -3,7 +3,7 @@ @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c -@c $ +@c $Id$ @c @chapter Network Commands @@ -14,11 +14,8 @@ 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 @@ -58,12 +55,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_NETSTATS @findex CONFIGURE_SHELL_COMMAND_NETSTATS -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_NETSTATS} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_NETSTATS} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_NETSTATS} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_NETSTATS} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -120,12 +118,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_IFCONFIG @findex CONFIGURE_SHELL_COMMAND_IFCONFIG -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_IFCONFIG} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_IFCONFIG} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_IFCONFIG} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_IFCONFIG} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -182,12 +181,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_ROUTE @findex CONFIGURE_SHELL_COMMAND_ROUTE -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_ROUTE} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_ROUTE} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_ROUTE} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_ROUTE} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: diff --git a/doc/shell/rtems.t b/doc/shell/rtems.t index 66ff9b071d..9b10411de1 100644 --- a/doc/shell/rtems.t +++ b/doc/shell/rtems.t @@ -3,7 +3,7 @@ @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c -@c $ +@c $Id$ @c @chapter RTEMS Commands @@ -14,35 +14,20 @@ 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 @@ -82,12 +67,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_CPUUSE @findex CONFIGURE_SHELL_COMMAND_CPUUSE -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_CPUUSE} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_CPUUSE} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_CPUUSE} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_CPUUSE} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -144,12 +130,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_STACKUSE @findex CONFIGURE_SHELL_COMMAND_STACKUSE -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_STACKUSE} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_STACKUSE} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_STACKUSE} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_STACKUSE} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -206,12 +193,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_PERIODUSE @findex CONFIGURE_SHELL_COMMAND_PERIODUSE -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_PERIODUSE} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_PERIODUSE} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_PERIODUSE} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_PERIODUSE} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -268,12 +256,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_WKSPACE @findex CONFIGURE_SHELL_COMMAND_WKSPACE -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_WKSPACE} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_WKSPACE} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_WKSPACE} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_WKSPACE} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -330,12 +319,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_CONFIG @findex CONFIGURE_SHELL_COMMAND_CONFIG -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_CONFIG} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_CONFIG} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_CONFIG} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_CONFIG} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -392,12 +382,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_ITASK @findex CONFIGURE_SHELL_COMMAND_ITASK -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_ITASK} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_ITASK} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_ITASK} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_ITASK} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -454,12 +445,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_EXTENSION @findex CONFIGURE_SHELL_COMMAND_EXTENSION -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_EXTENSION} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_EXTENSION} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_EXTENSION} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_EXTENSION} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -516,12 +508,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_TASK @findex CONFIGURE_SHELL_COMMAND_TASK -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_TASK} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_TASK} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_TASK} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_TASK} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -578,12 +571,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_QUEUE @findex CONFIGURE_SHELL_COMMAND_QUEUE -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_QUEUE} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_QUEUE} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_QUEUE} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_QUEUE} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -640,12 +634,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_SEMA @findex CONFIGURE_SHELL_COMMAND_SEMA -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_SEMA} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_SEMA} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_SEMA} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_SEMA} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -702,12 +697,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_REGION @findex CONFIGURE_SHELL_COMMAND_REGION -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_REGION} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_REGION} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_REGION} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_REGION} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -764,12 +760,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_PART @findex CONFIGURE_SHELL_COMMAND_PART -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_PART} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_PART} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_PART} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_PART} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -826,12 +823,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_OBJECT @findex CONFIGURE_SHELL_COMMAND_OBJECT -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_OBJECT} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_OBJECT} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_OBJECT} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_OBJECT} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -888,12 +886,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_DRIVER @findex CONFIGURE_SHELL_COMMAND_DRIVER -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_DRIVER} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_DRIVER} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_DRIVER} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_DRIVER} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: @@ -950,12 +949,13 @@ EXAMPLE_TBD @findex CONFIGURE_SHELL_NO_COMMAND_DNAME @findex CONFIGURE_SHELL_COMMAND_DNAME -This command is included as part of the all commands the shell command -set. Define @code{CONFIGURE_SHELL_COMMAND_DNAME} when building -a custom command set. +This command is included in the default shell command set. +When building a custom command set, define +@code{CONFIGURE_SHELL_COMMAND_DNAME} to have this +command included. -This command can be excluded from the shell command set with the -define @code{CONFIGURE_SHELL_NO_COMMAND_DNAME} when all +This command can be excluded from the shell command set by +defining @code{CONFIGURE_SHELL_NO_COMMAND_DNAME} when all shell commands have been configured. @subheading PROGRAMMING INFORMATION: -- cgit v1.2.3