summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2008-02-21 17:46:03 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2008-02-21 17:46:03 +0000
commitea0804303b47260d2f7652e41fb585d56d7e00ab (patch)
treea3e429449c2c8c75a193611979024214926d1da3 /doc
parent2008-02-21 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-ea0804303b47260d2f7652e41fb585d56d7e00ab.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: Add mount and cp command information from Chris Johns. Reformat some things.
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog6
-rw-r--r--doc/shell/file.t271
-rw-r--r--doc/shell/general.t42
-rw-r--r--doc/shell/memory.t36
-rw-r--r--doc/shell/network.t18
-rw-r--r--doc/shell/rtems.t90
6 files changed, 454 insertions, 9 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 3cbd5c5e45..a07b3f61b9 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,6 +1,12 @@
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.
+
+2008-02-21 Joel Sherrill <joel.sherrill@oarcorp.com>
+
+ * 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 <joel.sherrill@oarcorp.com>
diff --git a/doc/shell/file.t b/doc/shell/file.t
index 94be2617d4..c70e57df09 100644
--- a/doc/shell/file.t
+++ b/doc/shell/file.t
@@ -46,12 +46,18 @@ The RTEMS shell has the following file and directory commands:
@subheading SYNOPSYS:
+@example
umask [new_umask]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -109,11 +115,110 @@ extern rtems_shell_cmd_t rtems_shell_UMASK_Command;
@subheading SYNOPSYS:
+@example
cp [-R [-H | -L | -P]] [-f | -i] [-pv] src target
+cp [-R [-H | -L] ] [-f | -i] [-NpPv] source_file ... target_directory
+@end example
+
@subheading DESCRIPTION:
-This command XXX
+In the first synopsis form, the cp utility copies the contents of the
+source_file to the target_file. In the second synopsis form, the contents of
+each named source_file is copied to the destination target_directory. The names
+of the files themselves are not changed. If cp detects an attempt to copy a
+file to itself, the copy will fail.
+
+The following options are available:
+
+@table @b
+@item -f
+
+For each existing destination pathname, attempt to overwrite it. If permissions
+do not allow copy to succeed, remove it and create a new file, without
+prompting for confirmation. (The -i option is ignored if the -f option is
+specified.)
+
+@item -H
+
+If the -R option is specified, symbolic links on the command line are followed.
+(Symbolic links encountered in the tree traversal are not followed.)
+
+@item -i
+
+Causes cp to write a prompt to the standard error output before copying a file
+that would overwrite an existing file. If the response from the standard input
+begins with the character 'y', the file copy is attempted.
+
+@item -L
+
+If the -R option is specified, all symbolic links are followed.
+
+@item -N
+
+When used with -p, do not copy file flags.
+
+@item -P
+
+No symbolic links are followed.
+
+@item -p
+
+Causes cp to preserve in the copy as many of the modification time, access
+time, file flags, file mode, user ID, and group ID as allowed by permissions.
+
+If the user ID and group ID cannot be preserved, no error message is displayed
+and the exit value is not altered.
+
+If the source file has its set user ID bit on and the user ID cannot be
+preserved, the set user ID bit is not preserved in the copy's permissions. If
+the source file has its set group ID bit on and the group ID cannot be
+preserved, the set group ID bit is not preserved in the copy's permissions. If
+the source file has both its set user ID and set group ID bits on, and either
+the user ID or group ID cannot be preserved, neither the set user ID or set
+group ID bits are preserved in the copy's permissions.
+
+@item -R
+
+If source_file designates a directory, cp copies the directory and the entire
+subtree connected at that point. This option also causes symbolic links to be
+copied, rather than indirected through, and for cp to create special files
+rather than copying them as normal files. Created directories have the same
+mode as the corresponding source directory, unmodified by the process's umask.
+
+@item -v
+
+Cause cp to be verbose, showing files as they are copied.
+
+@end table
+
+For each destination file that already exists, its contents are overwritten if
+permissions allow, but its mode, user ID, and group ID are unchanged.
+
+In the second synopsis form, target_directory must exist unless there is only
+one named source_file which is a directory and the -R flag is specified.
+
+If the destination file does not exist, the mode of the source file is used as
+modified by the file mode creation mask (umask, see csh(1)). If the source file
+has its set user ID bit on, that bit is removed unless both the source file and
+the destination file are owned by the same user. If the source file has its set
+group ID bit on, that bit is removed unless both the source file and the
+destination file are in the same group and the user is a member of that group.
+If both the set user ID and set group ID bits are set, all of the above
+conditions must be fulfilled or both bits are removed.
+
+Appropriate permissions are required for file creation or overwriting.
+
+Symbolic links are always followed unless the -R flag is set, in which case
+symbolic links are not followed, by default. The -H or -L flags (in conjunction
+with the -R flag), as well as the -P flag cause symbolic links to be followed
+as described above. The -H and -L options are ignored unless the -R option is
+specified. In addition, these options override eachsubhedading other and the
+command's actions are determined by the last one specified.
+
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
@subheading NOTES:
@@ -162,6 +267,11 @@ following prototype:
extern rtems_shell_cmd_t rtems_shell_CP_Command;
@end example
+@subheading ORIGIN:
+
+The implementation and documentation for this command are from
+NetBSD 4.0.
+
@c
@c
@c
@@ -172,12 +282,18 @@ extern rtems_shell_cmd_t rtems_shell_CP_Command;
@subheading SYNOPSYS:
+@example
pwd
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -235,12 +351,18 @@ extern rtems_shell_cmd_t rtems_shell_PWD_Command;
@subheading SYNOPSYS:
+@example
ls [dir]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -298,12 +420,18 @@ extern rtems_shell_cmd_t rtems_shell_LS_Command;
@subheading SYNOPSYS:
+@example
chdir [dir]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -361,12 +489,18 @@ extern rtems_shell_cmd_t rtems_shell_CHDIR_Command;
@subheading SYNOPSYS:
+@example
mkdir dir
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -424,12 +558,18 @@ extern rtems_shell_cmd_t rtems_shell_MKDIR_Command;
@subheading SYNOPSYS:
+@example
rmdir dir
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -487,12 +627,18 @@ extern rtems_shell_cmd_t rtems_shell_RMDIR_Command;
@subheading SYNOPSYS:
+@example
chroot [dir]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -550,12 +696,18 @@ extern rtems_shell_cmd_t rtems_shell_CHROOT_Command;
@subheading SYNOPSYS:
+@example
chmod 0777 n1 n2...
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -613,12 +765,18 @@ extern rtems_shell_cmd_t rtems_shell_CHMOD_Command;
@subheading SYNOPSYS:
+@example
cat n1 [n2 [n3...]]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -676,12 +834,18 @@ extern rtems_shell_cmd_t rtems_shell_CAT_Command;
@subheading SYNOPSYS:
+@example
rm n1 [n2 [n3...]]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -739,24 +903,67 @@ extern rtems_shell_cmd_t rtems_shell_RM_Command;
@subheading SYNOPSYS:
+@example
mount [-t fstype] [-r] [-L] device path
+@end example
@subheading DESCRIPTION:
-This command XXX
+The @code{mount} command will mount a block device to a mount point
+using the specified file system. The files systems are:
+
+@itemize @bullet
+@item msdos - MSDOS File System
+@item tftp - TFTP Network File System
+@item ftp - FTP Network File System
+@item nfs - Network File System
+@end itemize
+
+When the file system type is 'msdos' the driver is a "block device driver"
+node present in the file system. The driver is ignored with the 'tftp' and
+'ftp' file systems. For the 'nfs' file system the driver is the 'host:/path'
+string that described NFS host and the exported file system path.
+
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
@subheading NOTES:
-NONE
+The mount point must exist.
+
+The services offered by each file-system vary. For example you cannot list the
+directory of a TFTP file-system as this server is not provided in the TFTP
+protocol. You need to check each file-system's documentation for the services
+provided.
@subheading EXAMPLES:
-The following is an example of how to use mount:
+Mount the Flash Disk driver to the '/fd' mount point:
@example
-EXAMPLE_TBD
+$ mount -t msdos /dev/flashdisk0 /fd
+@end example
+
+Mount the NFS file system exported path 'bar' by host 'foo':
+
+@example
+$ mount -t nfs foo:/bar /nfs
+@end example
+
+Mount the TFTP file system on '/tftp':
+
+@example
+$ mount -t tftp /tftp
@end example
+To access the TFTP files on server '10.10.10.10':
+
+@example
+$ cat /tftp/10.10.10.10/test.txt
+@end example
+
+
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_MOUNT
@@ -771,6 +978,28 @@ 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.
+The mount command includes references to file-system code. If you do not wish
+to include file-system that you do not use do not define the mount command
+support for that file-system. The file-system mount command defines are:
+
+@itemize @bullet
+@item msdos - CONFIGURE_SHELL_MOUNT_MSDOS
+@item tftp - CONFIGURE_SHELL_MOUNT_TFTP
+@item ftp - CONFIGURE_SHELL_MOUNT_FTP
+@item nfs - CONFIGURE_SHELL_MOUNT_NFS
+@end itemize
+
+An example configuration is:
+
+@example
+#define CONFIGURE_SHELL_MOUNT_MSDOS
+#ifdef RTEMS_NETWORKING
+ #define CONFIGURE_SHELL_MOUNT_TFTP
+ #define CONFIGURE_SHELL_MOUNT_FTP
+ #define CONFIGURE_SHELL_MOUNT_NFS
+#endif
+@end example
+
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_mount
@@ -802,19 +1031,25 @@ extern rtems_shell_cmd_t rtems_shell_MOUNT_Command;
@subheading SYNOPSYS:
+@example
unmount path
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
-NONE
+TBD
@subheading EXAMPLES:
-The following is an example of how to use unmount:
+The following is an example of how to use mount:
@example
EXAMPLE_TBD
@@ -865,12 +1100,18 @@ extern rtems_shell_cmd_t rtems_shell_UNMOUNT_Command;
@subheading SYNOPSYS:
+@example
blksync driver
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -928,12 +1169,18 @@ extern rtems_shell_cmd_t rtems_shell_BLKSYNC_Command;
@subheading SYNOPSYS:
-display directory contents
+@example
+dir [dir]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -991,12 +1238,18 @@ extern rtems_shell_cmd_t rtems_shell_DIR_Command;
@subheading SYNOPSYS:
-change the current directory
+@example
+cd DIRECTORY
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
diff --git a/doc/shell/general.t b/doc/shell/general.t
index 5c108d00ac..845d53fca0 100644
--- a/doc/shell/general.t
+++ b/doc/shell/general.t
@@ -36,12 +36,18 @@ The RTEMS shell has the following general commands:
@subheading SYNOPSYS:
+@example
alias oldCommand newCommand
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -99,12 +105,18 @@ extern rtems_shell_cmd_t rtems_shell_ALIAS_Command;
@subheading SYNOPSYS:
+@example
date
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -162,12 +174,18 @@ extern rtems_shell_cmd_t rtems_shell_DATE_Command;
@subheading SYNOPSYS:
+@example
id
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -225,12 +243,18 @@ extern rtems_shell_cmd_t rtems_shell_ID_Command;
@subheading SYNOPSYS:
+@example
tty
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -288,12 +312,18 @@ extern rtems_shell_cmd_t rtems_shell_TTY_Command;
@subheading SYNOPSYS:
+@example
whoami
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -351,12 +381,18 @@ extern rtems_shell_cmd_t rtems_shell_WHOAMI_Command;
@subheading SYNOPSYS:
+@example
logoff
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -414,12 +450,18 @@ extern rtems_shell_cmd_t rtems_shell_LOGOFF_Command;
@subheading SYNOPSYS:
+@example
exit
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
diff --git a/doc/shell/memory.t b/doc/shell/memory.t
index dea1d5fc48..69b18bdedf 100644
--- a/doc/shell/memory.t
+++ b/doc/shell/memory.t
@@ -35,12 +35,18 @@ The RTEMS shell has the following memory commands:
@subheading SYNOPSYS:
+@example
mdump [addr [size]]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -98,12 +104,18 @@ extern rtems_shell_cmd_t rtems_shell_MDUMP_Command;
@subheading SYNOPSYS:
+@example
wdump [addr [size]]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -161,12 +173,18 @@ extern rtems_shell_cmd_t rtems_shell_WDUMP_Command;
@subheading SYNOPSYS:
+@example
medit addr value [value ...]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -224,12 +242,18 @@ extern rtems_shell_cmd_t rtems_shell_MEDIT_Command;
@subheading SYNOPSYS:
+@example
mfill addr size value
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -287,12 +311,18 @@ extern rtems_shell_cmd_t rtems_shell_MFILL_Command;
@subheading SYNOPSYS:
+@example
mmove dst src size
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -350,12 +380,18 @@ extern rtems_shell_cmd_t rtems_shell_MMOVE_Command;
@subheading SYNOPSYS:
+@example
malloc [info|stats]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
diff --git a/doc/shell/network.t b/doc/shell/network.t
index ca7ceb24d6..2091bb0366 100644
--- a/doc/shell/network.t
+++ b/doc/shell/network.t
@@ -32,12 +32,18 @@ The RTEMS shell has the following network commands:
@subheading SYNOPSYS:
+@example
netstats [-Aimfpcutv]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -95,12 +101,18 @@ extern rtems_shell_cmd_t rtems_shell_NETSTATS_Command;
@subheading SYNOPSYS:
+@example
ifconfig
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -158,12 +170,18 @@ extern rtems_shell_cmd_t rtems_shell_IFCONFIG_Command;
@subheading SYNOPSYS:
+@example
route [subcommand]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
diff --git a/doc/shell/rtems.t b/doc/shell/rtems.t
index 9b10411de1..bdf3f4b71e 100644
--- a/doc/shell/rtems.t
+++ b/doc/shell/rtems.t
@@ -44,12 +44,18 @@ The RTEMS shell has the following rtems commands:
@subheading SYNOPSYS:
+@example
cpuuse [-r]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -107,12 +113,18 @@ extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command;
@subheading SYNOPSYS:
+@example
stackuse
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -170,12 +182,18 @@ extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command;
@subheading SYNOPSYS:
+@example
perioduse [-r]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -233,12 +251,18 @@ extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command;
@subheading SYNOPSYS:
+@example
wkspace
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -296,12 +320,18 @@ extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command;
@subheading SYNOPSYS:
+@example
config
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -359,12 +389,18 @@ extern rtems_shell_cmd_t rtems_shell_CONFIG_Command;
@subheading SYNOPSYS:
+@example
itask
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -422,12 +458,18 @@ extern rtems_shell_cmd_t rtems_shell_ITASK_Command;
@subheading SYNOPSYS:
+@example
extension [id [id ...] ]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -485,12 +527,18 @@ extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command;
@subheading SYNOPSYS:
+@example
task [id [id ...] ]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -548,12 +596,18 @@ extern rtems_shell_cmd_t rtems_shell_TASK_Command;
@subheading SYNOPSYS:
+@example
queue [id [id ... ] ]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -611,12 +665,18 @@ extern rtems_shell_cmd_t rtems_shell_QUEUE_Command;
@subheading SYNOPSYS:
+@example
sema [id [id ... ] ]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -674,12 +734,18 @@ extern rtems_shell_cmd_t rtems_shell_SEMA_Command;
@subheading SYNOPSYS:
+@example
region [id [id ... ] ]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -737,12 +803,18 @@ extern rtems_shell_cmd_t rtems_shell_REGION_Command;
@subheading SYNOPSYS:
+@example
part [id [id ... ] ]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -800,12 +872,18 @@ extern rtems_shell_cmd_t rtems_shell_PART_Command;
@subheading SYNOPSYS:
+@example
object [id [id ...] ]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -863,12 +941,18 @@ extern rtems_shell_cmd_t rtems_shell_OBJECT_Command;
@subheading SYNOPSYS:
+@example
driver [ major [ major ... ] ]
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE
@@ -926,12 +1010,18 @@ extern rtems_shell_cmd_t rtems_shell_DRIVER_Command;
@subheading SYNOPSYS:
+@example
dname
+@end example
@subheading DESCRIPTION:
This command XXX
+@subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
@subheading NOTES:
NONE