summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2008-02-21 23:56:30 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2008-02-21 23:56:30 +0000
commitdc1c4308d65835c2ae42b3a3fb593c95b01b485c (patch)
tree5c52d5b85cf950239051099c22cf53c9026ef755 /doc
parent2008-02-21 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-dc1c4308d65835c2ae42b3a3fb593c95b01b485c.tar.bz2
2008-02-21 Joel Sherrill <joel.sherrill@oarcorp.com>
* shell/file.t, shell/general.t, shell/memory.t, shell/network.t, shell/rtems.t: More descriptions and examples added.
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog5
-rw-r--r--doc/shell/file.t168
-rw-r--r--doc/shell/general.t53
-rw-r--r--doc/shell/memory.t36
-rw-r--r--doc/shell/network.t18
-rw-r--r--doc/shell/rtems.t90
6 files changed, 215 insertions, 155 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index a07b3f61b9..bb092b62ee 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,6 +1,11 @@
2008-02-21 Joel Sherrill <joel.sherrill@oarcorp.com>
* shell/file.t, shell/general.t, shell/memory.t, shell/network.t,
+ shell/rtems.t: More descriptions and examples added.
+
+2008-02-21 Joel Sherrill <joel.sherrill@oarcorp.com>
+
+ * shell/file.t, shell/general.t, shell/memory.t, shell/network.t,
shell/rtems.t: Add mount and cp command information from Chris Johns.
Reformat some things.
diff --git a/doc/shell/file.t b/doc/shell/file.t
index c70e57df09..19620f2700 100644
--- a/doc/shell/file.t
+++ b/doc/shell/file.t
@@ -52,7 +52,8 @@ umask [new_umask]
@subheading DESCRIPTION:
-This command XXX
+This command sets the user file creation mask to @code{new_umask}. The
+argument @code{new_umask} may be octal, hexadecimal, or decimal.
@subheading EXIT STATUS:
@@ -60,14 +61,19 @@ This command returns 0 on success and non-zero if an error is encountered.
@subheading NOTES:
-NONE
+This command does not currently support symbolic mode masks.
@subheading EXAMPLES:
-The following is an example of how to use umask:
+The following is an example of how to use @code{umask}:
@example
-EXAMPLE_TBD
+SHLL [/] $ umask
+022
+SHLL [/] $ umask 0666
+0666
+SHLL [/] $ umask
+0666
@end example
@subheading CONFIGURATION:
@@ -88,7 +94,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_umask
-The @code{COMMAND} is implemented by a C language function
+The @code{umask} is implemented by a C language function
which has the following prototype:
@example
@@ -98,7 +104,7 @@ int rtems_shell_rtems_main_umask(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{umask} has the
following prototype:
@example
@@ -226,7 +232,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use cp:
+The following is an example of how to use @code{cp}:
@example
EXAMPLE_TBD
@@ -250,7 +256,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_cp
-The @code{COMMAND} is implemented by a C language function
+The @code{cp} is implemented by a C language function
which has the following prototype:
@example
@@ -260,7 +266,7 @@ int rtems_shell_rtems_main_cp(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{cp} has the
following prototype:
@example
@@ -288,7 +294,8 @@ pwd
@subheading DESCRIPTION:
-This command XXX
+This command prints the fully qualified filename of the current
+working directory.
@subheading EXIT STATUS:
@@ -300,10 +307,14 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use pwd:
+The following is an example of how to use @code{pwd}:
@example
-EXAMPLE_TBD
+SHLL [/] $ pwd
+/
+SHLL [/] $ cd dev
+SHLL [/dev] $ pwd
+/dev
@end example
@subheading CONFIGURATION:
@@ -324,7 +335,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_pwd
-The @code{COMMAND} is implemented by a C language function
+The @code{pwd} is implemented by a C language function
which has the following prototype:
@example
@@ -334,7 +345,7 @@ int rtems_shell_rtems_main_pwd(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{pwd} has the
following prototype:
@example
@@ -357,7 +368,9 @@ ls [dir]
@subheading DESCRIPTION:
-This command XXX
+This command displays the contents of the specified directory. If
+no arguments are given, then it displays the contents of the current
+working directory.
@subheading EXIT STATUS:
@@ -369,10 +382,22 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use ls:
+The following is an example of how to use @code{ls}:
@example
-EXAMPLE_TBD
+SHLL [/] $ ls
+drwxr-xr-x 1 root root 536 Jan 01 00:00 dev/
+drwxr-xr-x 1 root root 1072 Jan 01 00:00 etc/
+2 files 1608 bytes occupied
+SHLL [/] $ ls etc
+-rw-r--r-- 1 root root 102 Jan 01 00:00 passwd
+-rw-r--r-- 1 root root 42 Jan 01 00:00 group
+-rw-r--r-- 1 root root 30 Jan 01 00:00 issue
+-rw-r--r-- 1 root root 28 Jan 01 00:00 issue.net
+4 files 202 bytes occupied
+SHLL [/] $ ls dev etc
+-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
@end example
@subheading CONFIGURATION:
@@ -393,7 +418,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_ls
-The @code{COMMAND} is implemented by a C language function
+The @code{ls} is implemented by a C language function
which has the following prototype:
@example
@@ -403,7 +428,7 @@ int rtems_shell_rtems_main_ls(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{ls} has the
following prototype:
@example
@@ -426,7 +451,9 @@ chdir [dir]
@subheading DESCRIPTION:
-This command XXX
+This command is used to change the current working directory to
+the specified directory. If no arguments are given, the current
+working directory will be changed to @code{/}.
@subheading EXIT STATUS:
@@ -438,10 +465,14 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use chdir:
+The following is an example of how to use @code{chdir}:
@example
-EXAMPLE_TBD
+SHLL [/] $ pwd
+/
+SHLL [/] $ chdir etc
+SHLL [/etc] $ pwd
+/etc
@end example
@subheading CONFIGURATION:
@@ -462,7 +493,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_chdir
-The @code{COMMAND} is implemented by a C language function
+The @code{chdir} is implemented by a C language function
which has the following prototype:
@example
@@ -472,7 +503,7 @@ int rtems_shell_rtems_main_chdir(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{chdir} has the
following prototype:
@example
@@ -490,12 +521,15 @@ extern rtems_shell_cmd_t rtems_shell_CHDIR_Command;
@subheading SYNOPSYS:
@example
-mkdir dir
+mkdir dir [dir1 .. dirN]
@end example
@subheading DESCRIPTION:
-This command XXX
+This command creates the set of directories in the order they
+are specified on the command line. If an error is encountered
+making one of the directories, the command will continue to
+attempt to create the remaining directories on the command line.
@subheading EXIT STATUS:
@@ -503,14 +537,28 @@ This command returns 0 on success and non-zero if an error is encountered.
@subheading NOTES:
-NONE
+If this command is invoked with no arguments, nothing occurs.
+
+The user must have sufficient permissions to create the directory.
+For the @code{fileio} test provided with RTEMS, this means the user
+must login as @code{root} not @code{rtems}.
@subheading EXAMPLES:
-The following is an example of how to use mkdir:
+The following is an example of how to use @code{mkdir}:
@example
-EXAMPLE_TBD
+SHLL [/] # ls
+drwxr-xr-x 1 root root 536 Jan 01 00:00 dev/
+drwxr-xr-x 1 root root 1072 Jan 01 00:00 etc/
+2 files 1608 bytes occupied
+SHLL [/] # mkdir joel
+SHLL [/] # ls joel
+0 files 0 bytes occupied
+SHLL [/] # cp etc/passwd joel
+SHLL [/] # ls joel
+-rw-r--r-- 1 root root 102 Jan 01 00:02 passwd
+1 files 102 bytes occupied
@end example
@subheading CONFIGURATION:
@@ -531,7 +579,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_mkdir
-The @code{COMMAND} is implemented by a C language function
+The @code{mkdir} is implemented by a C language function
which has the following prototype:
@example
@@ -541,7 +589,7 @@ int rtems_shell_rtems_main_mkdir(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{mkdir} has the
following prototype:
@example
@@ -576,7 +624,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use rmdir:
+The following is an example of how to use @code{rmdir}:
@example
EXAMPLE_TBD
@@ -600,7 +648,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_rmdir
-The @code{COMMAND} is implemented by a C language function
+The @code{rmdir} is implemented by a C language function
which has the following prototype:
@example
@@ -610,7 +658,7 @@ int rtems_shell_rtems_main_rmdir(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{rmdir} has the
following prototype:
@example
@@ -645,7 +693,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use chroot:
+The following is an example of how to use @code{chroot}:
@example
EXAMPLE_TBD
@@ -669,7 +717,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_chroot
-The @code{COMMAND} is implemented by a C language function
+The @code{chroot} is implemented by a C language function
which has the following prototype:
@example
@@ -679,7 +727,7 @@ int rtems_shell_rtems_main_chroot(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{chroot} has the
following prototype:
@example
@@ -714,7 +762,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use chmod:
+The following is an example of how to use @code{chmod}:
@example
EXAMPLE_TBD
@@ -738,7 +786,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_chmod
-The @code{COMMAND} is implemented by a C language function
+The @code{chmod} is implemented by a C language function
which has the following prototype:
@example
@@ -748,7 +796,7 @@ int rtems_shell_rtems_main_chmod(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{chmod} has the
following prototype:
@example
@@ -783,7 +831,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use cat:
+The following is an example of how to use @code{cat}:
@example
EXAMPLE_TBD
@@ -807,7 +855,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_cat
-The @code{COMMAND} is implemented by a C language function
+The @code{cat} is implemented by a C language function
which has the following prototype:
@example
@@ -817,7 +865,7 @@ int rtems_shell_rtems_main_cat(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{cat} has the
following prototype:
@example
@@ -852,7 +900,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use rm:
+The following is an example of how to use @code{rm}:
@example
EXAMPLE_TBD
@@ -876,7 +924,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_rm
-The @code{COMMAND} is implemented by a C language function
+The @code{rm} is implemented by a C language function
which has the following prototype:
@example
@@ -886,7 +934,7 @@ int rtems_shell_rtems_main_rm(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{rm} has the
following prototype:
@example
@@ -1004,7 +1052,7 @@ An example configuration is:
@findex rtems_shell_rtems_main_mount
-The @code{COMMAND} is implemented by a C language function
+The @code{mount} is implemented by a C language function
which has the following prototype:
@example
@@ -1014,7 +1062,7 @@ int rtems_shell_rtems_main_mount(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{mount} has the
following prototype:
@example
@@ -1049,7 +1097,7 @@ TBD
@subheading EXAMPLES:
-The following is an example of how to use mount:
+The following is an example of how to use @code{mount}:
@example
EXAMPLE_TBD
@@ -1073,7 +1121,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_unmount
-The @code{COMMAND} is implemented by a C language function
+The @code{unmount} is implemented by a C language function
which has the following prototype:
@example
@@ -1083,7 +1131,7 @@ int rtems_shell_rtems_main_unmount(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{unmount} has the
following prototype:
@example
@@ -1118,7 +1166,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use blksync:
+The following is an example of how to use @code{blksync}:
@example
EXAMPLE_TBD
@@ -1142,7 +1190,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_blksync
-The @code{COMMAND} is implemented by a C language function
+The @code{blksync} is implemented by a C language function
which has the following prototype:
@example
@@ -1152,7 +1200,7 @@ int rtems_shell_rtems_main_blksync(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{blksync} has the
following prototype:
@example
@@ -1187,7 +1235,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use dir:
+The following is an example of how to use @code{dir}:
@example
EXAMPLE_TBD
@@ -1211,7 +1259,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_dir
-The @code{COMMAND} is implemented by a C language function
+The @code{dir} is implemented by a C language function
which has the following prototype:
@example
@@ -1221,7 +1269,7 @@ int rtems_shell_rtems_main_dir(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{dir} has the
following prototype:
@example
@@ -1256,7 +1304,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use cd:
+The following is an example of how to use @code{cd}:
@example
EXAMPLE_TBD
@@ -1280,7 +1328,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_cd
-The @code{COMMAND} is implemented by a C language function
+The @code{cd} is implemented by a C language function
which has the following prototype:
@example
@@ -1290,7 +1338,7 @@ int rtems_shell_rtems_main_cd(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{cd} has the
following prototype:
@example
diff --git a/doc/shell/general.t b/doc/shell/general.t
index 845d53fca0..13fbef9e3b 100644
--- a/doc/shell/general.t
+++ b/doc/shell/general.t
@@ -42,7 +42,8 @@ alias oldCommand newCommand
@subheading DESCRIPTION:
-This command XXX
+This command adds an alternate name for an existing command to
+the command set.
@subheading EXIT STATUS:
@@ -54,10 +55,16 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use alias:
+The following is an example of how to use @code{alias}:
@example
-EXAMPLE_TBD
+SHLL [/] $ me
+shell:me command not found
+SHLL [/] $ alias whoami me
+SHLL [/] $ me
+rtems
+SHLL [/] $ whoami
+rtems
@end example
@subheading CONFIGURATION:
@@ -78,7 +85,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_alias
-The @code{COMMAND} is implemented by a C language function
+The @code{alias} is implemented by a C language function
which has the following prototype:
@example
@@ -88,7 +95,7 @@ int rtems_shell_rtems_main_alias(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{alias} has the
following prototype:
@example
@@ -123,7 +130,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use date:
+The following is an example of how to use @code{date}:
@example
EXAMPLE_TBD
@@ -147,7 +154,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_date
-The @code{COMMAND} is implemented by a C language function
+The @code{date} is implemented by a C language function
which has the following prototype:
@example
@@ -157,7 +164,7 @@ int rtems_shell_rtems_main_date(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{date} has the
following prototype:
@example
@@ -192,7 +199,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use id:
+The following is an example of how to use @code{id}:
@example
EXAMPLE_TBD
@@ -216,7 +223,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_id
-The @code{COMMAND} is implemented by a C language function
+The @code{id} is implemented by a C language function
which has the following prototype:
@example
@@ -226,7 +233,7 @@ int rtems_shell_rtems_main_id(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{id} has the
following prototype:
@example
@@ -261,7 +268,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use tty:
+The following is an example of how to use @code{tty}:
@example
EXAMPLE_TBD
@@ -285,7 +292,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_tty
-The @code{COMMAND} is implemented by a C language function
+The @code{tty} is implemented by a C language function
which has the following prototype:
@example
@@ -295,7 +302,7 @@ int rtems_shell_rtems_main_tty(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{tty} has the
following prototype:
@example
@@ -330,7 +337,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use whoami:
+The following is an example of how to use @code{whoami}:
@example
EXAMPLE_TBD
@@ -354,7 +361,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_whoami
-The @code{COMMAND} is implemented by a C language function
+The @code{whoami} is implemented by a C language function
which has the following prototype:
@example
@@ -364,7 +371,7 @@ int rtems_shell_rtems_main_whoami(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{whoami} has the
following prototype:
@example
@@ -399,7 +406,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use logoff:
+The following is an example of how to use @code{logoff}:
@example
EXAMPLE_TBD
@@ -423,7 +430,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_logoff
-The @code{COMMAND} is implemented by a C language function
+The @code{logoff} is implemented by a C language function
which has the following prototype:
@example
@@ -433,7 +440,7 @@ int rtems_shell_rtems_main_logoff(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{logoff} has the
following prototype:
@example
@@ -468,7 +475,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use exit:
+The following is an example of how to use @code{exit}:
@example
EXAMPLE_TBD
@@ -492,7 +499,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_exit
-The @code{COMMAND} is implemented by a C language function
+The @code{exit} is implemented by a C language function
which has the following prototype:
@example
@@ -502,7 +509,7 @@ int rtems_shell_rtems_main_exit(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{exit} has the
following prototype:
@example
diff --git a/doc/shell/memory.t b/doc/shell/memory.t
index 69b18bdedf..05e630de0a 100644
--- a/doc/shell/memory.t
+++ b/doc/shell/memory.t
@@ -53,7 +53,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use mdump:
+The following is an example of how to use @code{mdump}:
@example
EXAMPLE_TBD
@@ -77,7 +77,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_mdump
-The @code{COMMAND} is implemented by a C language function
+The @code{mdump} is implemented by a C language function
which has the following prototype:
@example
@@ -87,7 +87,7 @@ int rtems_shell_rtems_main_mdump(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{mdump} has the
following prototype:
@example
@@ -122,7 +122,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use wdump:
+The following is an example of how to use @code{wdump}:
@example
EXAMPLE_TBD
@@ -146,7 +146,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_wdump
-The @code{COMMAND} is implemented by a C language function
+The @code{wdump} is implemented by a C language function
which has the following prototype:
@example
@@ -156,7 +156,7 @@ int rtems_shell_rtems_main_wdump(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{wdump} has the
following prototype:
@example
@@ -191,7 +191,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use medit:
+The following is an example of how to use @code{medit}:
@example
EXAMPLE_TBD
@@ -215,7 +215,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_medit
-The @code{COMMAND} is implemented by a C language function
+The @code{medit} is implemented by a C language function
which has the following prototype:
@example
@@ -225,7 +225,7 @@ int rtems_shell_rtems_main_medit(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{medit} has the
following prototype:
@example
@@ -260,7 +260,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use mfill:
+The following is an example of how to use @code{mfill}:
@example
EXAMPLE_TBD
@@ -284,7 +284,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_mfill
-The @code{COMMAND} is implemented by a C language function
+The @code{mfill} is implemented by a C language function
which has the following prototype:
@example
@@ -294,7 +294,7 @@ int rtems_shell_rtems_main_mfill(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{mfill} has the
following prototype:
@example
@@ -329,7 +329,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use mmove:
+The following is an example of how to use @code{mmove}:
@example
EXAMPLE_TBD
@@ -353,7 +353,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_mmove
-The @code{COMMAND} is implemented by a C language function
+The @code{mmove} is implemented by a C language function
which has the following prototype:
@example
@@ -363,7 +363,7 @@ int rtems_shell_rtems_main_mmove(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{mmove} has the
following prototype:
@example
@@ -398,7 +398,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use malloc:
+The following is an example of how to use @code{malloc}:
@example
EXAMPLE_TBD
@@ -422,7 +422,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_malloc
-The @code{COMMAND} is implemented by a C language function
+The @code{malloc} is implemented by a C language function
which has the following prototype:
@example
@@ -432,7 +432,7 @@ int rtems_shell_rtems_main_malloc(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{malloc} has the
following prototype:
@example
diff --git a/doc/shell/network.t b/doc/shell/network.t
index 2091bb0366..c839c0c978 100644
--- a/doc/shell/network.t
+++ b/doc/shell/network.t
@@ -50,7 +50,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use netstats:
+The following is an example of how to use @code{netstats}:
@example
EXAMPLE_TBD
@@ -74,7 +74,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_netstats
-The @code{COMMAND} is implemented by a C language function
+The @code{netstats} is implemented by a C language function
which has the following prototype:
@example
@@ -84,7 +84,7 @@ int rtems_shell_rtems_main_netstats(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{netstats} has the
following prototype:
@example
@@ -119,7 +119,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use ifconfig:
+The following is an example of how to use @code{ifconfig}:
@example
EXAMPLE_TBD
@@ -143,7 +143,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_ifconfig
-The @code{COMMAND} is implemented by a C language function
+The @code{ifconfig} is implemented by a C language function
which has the following prototype:
@example
@@ -153,7 +153,7 @@ int rtems_shell_rtems_main_ifconfig(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{ifconfig} has the
following prototype:
@example
@@ -188,7 +188,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use route:
+The following is an example of how to use @code{route}:
@example
EXAMPLE_TBD
@@ -212,7 +212,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_route
-The @code{COMMAND} is implemented by a C language function
+The @code{route} is implemented by a C language function
which has the following prototype:
@example
@@ -222,7 +222,7 @@ int rtems_shell_rtems_main_route(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{route} has the
following prototype:
@example
diff --git a/doc/shell/rtems.t b/doc/shell/rtems.t
index bdf3f4b71e..b502ce43c3 100644
--- a/doc/shell/rtems.t
+++ b/doc/shell/rtems.t
@@ -62,7 +62,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use cpuuse:
+The following is an example of how to use @code{cpuuse}:
@example
EXAMPLE_TBD
@@ -86,7 +86,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_cpuuse
-The @code{COMMAND} is implemented by a C language function
+The @code{cpuuse} is implemented by a C language function
which has the following prototype:
@example
@@ -96,7 +96,7 @@ int rtems_shell_rtems_main_cpuuse(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{cpuuse} has the
following prototype:
@example
@@ -131,7 +131,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use stackuse:
+The following is an example of how to use @code{stackuse}:
@example
EXAMPLE_TBD
@@ -155,7 +155,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_stackuse
-The @code{COMMAND} is implemented by a C language function
+The @code{stackuse} is implemented by a C language function
which has the following prototype:
@example
@@ -165,7 +165,7 @@ int rtems_shell_rtems_main_stackuse(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{stackuse} has the
following prototype:
@example
@@ -200,7 +200,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use perioduse:
+The following is an example of how to use @code{perioduse}:
@example
EXAMPLE_TBD
@@ -224,7 +224,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_perioduse
-The @code{COMMAND} is implemented by a C language function
+The @code{perioduse} is implemented by a C language function
which has the following prototype:
@example
@@ -234,7 +234,7 @@ int rtems_shell_rtems_main_perioduse(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{perioduse} has the
following prototype:
@example
@@ -269,7 +269,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use wkspace:
+The following is an example of how to use @code{wkspace}:
@example
EXAMPLE_TBD
@@ -293,7 +293,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_wkspace
-The @code{COMMAND} is implemented by a C language function
+The @code{wkspace} is implemented by a C language function
which has the following prototype:
@example
@@ -303,7 +303,7 @@ int rtems_shell_rtems_main_wkspace(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{wkspace} has the
following prototype:
@example
@@ -338,7 +338,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use config:
+The following is an example of how to use @code{config}:
@example
EXAMPLE_TBD
@@ -362,7 +362,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_config
-The @code{COMMAND} is implemented by a C language function
+The @code{config} is implemented by a C language function
which has the following prototype:
@example
@@ -372,7 +372,7 @@ int rtems_shell_rtems_main_config(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{config} has the
following prototype:
@example
@@ -407,7 +407,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use itask:
+The following is an example of how to use @code{itask}:
@example
EXAMPLE_TBD
@@ -431,7 +431,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_itask
-The @code{COMMAND} is implemented by a C language function
+The @code{itask} is implemented by a C language function
which has the following prototype:
@example
@@ -441,7 +441,7 @@ int rtems_shell_rtems_main_itask(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{itask} has the
following prototype:
@example
@@ -476,7 +476,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use extension:
+The following is an example of how to use @code{extension}:
@example
EXAMPLE_TBD
@@ -500,7 +500,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_extension
-The @code{COMMAND} is implemented by a C language function
+The @code{extension} is implemented by a C language function
which has the following prototype:
@example
@@ -510,7 +510,7 @@ int rtems_shell_rtems_main_extension(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{extension} has the
following prototype:
@example
@@ -545,7 +545,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use task:
+The following is an example of how to use @code{task}:
@example
EXAMPLE_TBD
@@ -569,7 +569,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_task
-The @code{COMMAND} is implemented by a C language function
+The @code{task} is implemented by a C language function
which has the following prototype:
@example
@@ -579,7 +579,7 @@ int rtems_shell_rtems_main_task(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{task} has the
following prototype:
@example
@@ -614,7 +614,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use queue:
+The following is an example of how to use @code{queue}:
@example
EXAMPLE_TBD
@@ -638,7 +638,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_queue
-The @code{COMMAND} is implemented by a C language function
+The @code{queue} is implemented by a C language function
which has the following prototype:
@example
@@ -648,7 +648,7 @@ int rtems_shell_rtems_main_queue(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{queue} has the
following prototype:
@example
@@ -683,7 +683,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use sema:
+The following is an example of how to use @code{sema}:
@example
EXAMPLE_TBD
@@ -707,7 +707,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_sema
-The @code{COMMAND} is implemented by a C language function
+The @code{sema} is implemented by a C language function
which has the following prototype:
@example
@@ -717,7 +717,7 @@ int rtems_shell_rtems_main_sema(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{sema} has the
following prototype:
@example
@@ -752,7 +752,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use region:
+The following is an example of how to use @code{region}:
@example
EXAMPLE_TBD
@@ -776,7 +776,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_region
-The @code{COMMAND} is implemented by a C language function
+The @code{region} is implemented by a C language function
which has the following prototype:
@example
@@ -786,7 +786,7 @@ int rtems_shell_rtems_main_region(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{region} has the
following prototype:
@example
@@ -821,7 +821,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use part:
+The following is an example of how to use @code{part}:
@example
EXAMPLE_TBD
@@ -845,7 +845,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_part
-The @code{COMMAND} is implemented by a C language function
+The @code{part} is implemented by a C language function
which has the following prototype:
@example
@@ -855,7 +855,7 @@ int rtems_shell_rtems_main_part(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{part} has the
following prototype:
@example
@@ -890,7 +890,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use object:
+The following is an example of how to use @code{object}:
@example
EXAMPLE_TBD
@@ -914,7 +914,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_object
-The @code{COMMAND} is implemented by a C language function
+The @code{object} is implemented by a C language function
which has the following prototype:
@example
@@ -924,7 +924,7 @@ int rtems_shell_rtems_main_object(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{object} has the
following prototype:
@example
@@ -959,7 +959,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use driver:
+The following is an example of how to use @code{driver}:
@example
EXAMPLE_TBD
@@ -983,7 +983,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_driver
-The @code{COMMAND} is implemented by a C language function
+The @code{driver} is implemented by a C language function
which has the following prototype:
@example
@@ -993,7 +993,7 @@ int rtems_shell_rtems_main_driver(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{driver} has the
following prototype:
@example
@@ -1028,7 +1028,7 @@ NONE
@subheading EXAMPLES:
-The following is an example of how to use dname:
+The following is an example of how to use @code{dname}:
@example
EXAMPLE_TBD
@@ -1052,7 +1052,7 @@ shell commands have been configured.
@findex rtems_shell_rtems_main_dname
-The @code{COMMAND} is implemented by a C language function
+The @code{dname} is implemented by a C language function
which has the following prototype:
@example
@@ -1062,7 +1062,7 @@ int rtems_shell_rtems_main_dname(
);
@end example
-The configuration structure for the @code{COMMAND} has the
+The configuration structure for the @code{dname} has the
following prototype:
@example