change log for rtems (2010-05-12)
rtems-vc at rtems.org
rtems-vc at rtems.org
Thu May 13 04:10:54 UTC 2010
*ccj*:
2010-05-13 Chris Johns <chrisj at rtems.org>
* shell/file.t: Add dd, debugrfs, hexdump, ln, mknod, mkrfs, mv.
* shell/general.t: Add time.
M 1.271 doc/ChangeLog
M 1.11 doc/shell/file.t
M 1.11 doc/shell/general.t
diff -u rtems/doc/ChangeLog:1.270 rtems/doc/ChangeLog:1.271
--- rtems/doc/ChangeLog:1.270 Wed May 12 06:30:51 2010
+++ rtems/doc/ChangeLog Wed May 12 22:45:02 2010
@@ -1,3 +1,8 @@
+2010-05-13 Chris Johns <chrisj at rtems.org>
+
+ * shell/file.t: Add dd, debugrfs, hexdump, ln, mknod, mkrfs, mv.
+ * shell/general.t: Add time.
+
2010-05-12 Sebastian Huber <sebastian.huber at embedded-brains.de>
PR 1512/doc
diff -u rtems/doc/shell/file.t:1.10 rtems/doc/shell/file.t:1.11
--- rtems/doc/shell/file.t:1.10 Wed May 12 06:30:52 2010
+++ rtems/doc/shell/file.t Wed May 12 22:45:02 2010
@@ -16,11 +16,14 @@
@item @code{umask} - Set file mode creation mask
@item @code{cp} - copy files
+ at item @code{mv} - move 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 empty directories
+ at item @code{ln} - make links
+ at item @code{mknod} - make device special file
@item @code{chroot} - change the root directory
@item @code{chmod} - change permissions of a file
@item @code{cat} - display file contents
@@ -29,8 +32,11 @@
@item @code{mount} - mount disk
@item @code{unmount} - unmount disk
@item @code{blksync} - sync the block driver
+ at item @code{dd} - format disks
+ at item @code{hexdump} - format disks
@item @code{fdisk} - format disks
@item @code{dir} - alias for ls
+ at item @code{mkrfs} - format RFS file system
@item @code{cd} - alias for chdir
@end itemize
@@ -129,7 +135,6 @@
@example
cp [-R [-H | -L | -P]] [-f | -i] [-pv] src target
-
cp [-R [-H | -L] ] [-f | -i] [-NpPv] source_file ... target_directory
@end example
@@ -145,37 +150,30 @@
@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.
@@ -191,7 +189,6 @@
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
@@ -199,7 +196,6 @@
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
@@ -294,8 +290,8 @@
@findex rtems_shell_rtems_main_cp
-The @code{cp} is implemented by a C language function
-which has the following prototype:
+The @code{cp} command is implemented by a C language function which
+has the following prototype:
@example
int rtems_shell_rtems_main_cp(
@@ -320,6 +316,127 @@
@c
@c
@page
+ at subsection mv - move files
+
+ at pgindex mv
+
+ at subheading SYNOPSYS:
+
+ at example
+mv [-fiv] source_file target_file
+mv [-fiv] source_file... target_file
+ at end example
+
+ at subheading DESCRIPTION:
+
+In its first form, the mv utility renames the file named by the source
+operand to the destination path named by the target operand. This
+form is assumed when the last operand does not name an already
+existing directory.
+
+In its second form, mv moves each file named by a source operand to a
+destination file in the existing directory named by the directory
+operand. The destination path for each operand is the pathname
+produced by the concatenation of the last operand, a slash, and the
+final pathname component of the named file.
+
+The following options are available:
+
+ at table @b
+ at item -f
+Do not prompt for confirmation before overwriting the destination
+path.
+
+ at item -i
+Causes mv to write a prompt to standard error before moving a file
+that would overwrite an existing file. If the response from the
+standard input begins with the character 'y', the move is attempted.
+
+ at item -v
+Cause mv to be verbose, showing files as they are processed.
+
+ at end table
+
+The last of any -f or -i options is the one which affects mv's
+behavior.
+
+It is an error for any of the source operands to specify a nonexistent
+file or directory.
+
+It is an error for the source operand to specify a directory if the
+target exists and is not a directory.
+
+If the destination path does not have a mode which permits writing, mv
+prompts the user for confirmation as specified for the -i option.
+
+Should the @b{rename} call fail because source and target are on
+different file systems, @code{mv} will remove the destination file,
+copy the source file to the destination, and then remove the source.
+The effect is roughly equivalent to:
+
+ at example
+rm -f destination_path && \
+cp -PRp source_file destination_path && \
+rm -rf source_file
+ at end example
+
+ at subheading EXIT STATUS:
+
+The @code{mv} utility exits 0 on success, and >0 if an error occurs.
+
+ at subheading NOTES:
+
+NONE
+
+ at subheading EXAMPLES:
+
+ at example
+SHLL [/] mv /dev/console /dev/con1
+ at end example
+
+ at subheading CONFIGURATION:
+
+ at findex CONFIGURE_SHELL_NO_COMMAND_MV
+ at findex CONFIGURE_SHELL_COMMAND_MV
+
+This command is included in the default shell command set. When
+building a custom command set, define
+ at code{CONFIGURE_SHELL_COMMAND_MV} to have this command included.
+
+This command can be excluded from the shell command set by
+defining @code{CONFIGURE_SHELL_NO_COMMAND_MV} when all
+shell commands have been configured.
+
+ at subheading PROGRAMMING INFORMATION:
+
+ at findex rtems_shell_rtems_main_mv
+
+The @code{mv} command is implemented by a C language function which
+has the following prototype:
+
+ at example
+int rtems_shell_rtems_main_mv(
+ int argc,
+ char **argv
+);
+ at end example
+
+The configuration structure for the @code{mv} has the
+following prototype:
+
+ at example
+extern rtems_shell_cmd_t rtems_shell_MV_Command;
+ at end example
+
+ at subheading ORIGIN:
+
+The implementation and portions of the documentation for this command
+are from NetBSD 4.0.
+
+ at c
+ at c
+ at c
+ at page
@subsection pwd - print work directory
@pgindex pwd
@@ -714,6 +831,274 @@
@c
@c
@page
+ at subsection ln - make links
+
+ at pgindex ln
+
+ at subheading SYNOPSYS:
+
+ at example
+ln [-fhinsv] source_file [target_file]
+ln [-fhinsv] source_file ... target_dir
+ at end example
+
+ at subheading DESCRIPTION:
+
+The ln utility creates a new directory entry (linked file) which has
+the same modes as the original file. It is useful for maintaining
+multiple copies of a file in many places at once without using up
+storage for the ``copies''; instead, a link ``points'' to the original
+copy. There are two types of links; hard links and symbolic links.
+How a link ``points'' to a file is one of the differences between a
+hard or symbolic link.
+
+The options are as follows:
+ at table @b
+ at item -f
+Unlink any already existing file, permitting the link to occur.
+
+ at item -h
+If the target_file or target_dir is a symbolic link, do not follow it.
+This is most useful with the -f option, to replace a symlink which may
+point to a directory.
+
+ at item -i
+Cause ln to write a prompt to standard error if the target file
+exists. If the response from the standard input begins with the
+character `y' or `Y', then unlink the target file so that the link may
+occur. Otherwise, do not attempt the link. (The -i option overrides
+any previous -f options.)
+
+ at item -n
+Same as -h, for compatibility with other ln implementations.
+
+ at item -s
+Create a symbolic link.
+
+ at item -v
+Cause ln to be verbose, showing files as they are processed.
+ at end table
+
+By default ln makes hard links. A hard link to a file is
+indistinguishable from the original directory entry; any changes to a
+file are effective independent of the name used to reference the file.
+Hard links may not normally refer to directories and may not span file
+systems.
+
+A symbolic link contains the name of the file to which it is linked.
+The referenced file is used when an @i{open} operation is performed on
+the link. A @i{stat} on a symbolic link will return the linked-to
+file; an @i{lstat} must be done to obtain information about the link.
+The @i{readlink} call may be used to read the contents of a symbolic
+link. Symbolic links may span file systems and may refer to
+directories.
+
+Given one or two arguments, ln creates a link to an existing file
+source_file. If target_file is given, the link has that name;
+target_file may also be a directory in which to place the link;
+otherwise it is placed in the current directory. If only the
+directory is specified, the link will be made to the last component of
+source_file.
+
+Given more than two arguments, ln makes links in target_dir to all the
+named source files. The links made will have the same name as the
+files being linked to.
+
+ at subheading EXIT STATUS:
+
+The @code{ln} utility exits 0 on success, and >0 if an error occurs.
+
+ at subheading NOTES:
+
+NONE
+
+ at subheading EXAMPLES:
+
+ at example
+SHLL [/] ln -s /dev/console /dev/con1
+ at end example
+
+ at subheading CONFIGURATION:
+
+ at findex CONFIGURE_SHELL_NO_COMMAND_LN
+ at findex CONFIGURE_SHELL_COMMAND_LN
+
+This command is included in the default shell command set. When
+building a custom command set, define
+ at code{CONFIGURE_SHELL_COMMAND_LN} to have this command included.
+
+This command can be excluded from the shell command set by
+defining @code{CONFIGURE_SHELL_NO_COMMAND_LN} when all
+shell commands have been configured.
+
+ at subheading PROGRAMMING INFORMATION:
+
+ at findex rtems_shell_rtems_main_ln
+
+The @code{ln} command is implemented by a C language function which
+has the following prototype:
+
+ at example
+int rtems_shell_rtems_main_ln(
+ int argc,
+ char **argv
+);
+ at end example
+
+The configuration structure for the @code{ln} has the following
+prototype:
+
+ at example
+extern rtems_shell_cmd_t rtems_shell_LN_Command;
+ at end example
+
+ at subheading ORIGIN:
+
+The implementation and portions of the documentation for this command
+are from NetBSD 4.0.
+
+ at c
+ at c
+ at c
+ at page
+ at subsection mknod - make device special file
+
+ at pgindex mknod
+
+ at subheading SYNOPSYS:
+
+ at example
+mknod [-rR] [-F fmt] [-g gid] [-m mode] [-u uid] name [c | b]
+ [driver | major] minor
+mknod [-rR] [-F fmt] [-g gid] [-m mode] [-u uid] name [c | b]
+ major unit subunit
+mknod [-rR] [-g gid] [-m mode] [-u uid] name [c | b] number
+mknod [-rR] [-g gid] [-m mode] [-u uid] name p
+ at end example
+
+ at subheading DESCRIPTION:
+
+The mknod command creates device special files, or fifos. Normally
+the shell script /dev/MAKEDEV is used to create special files for
+commonly known devices; it executes mknod with the appropriate
+arguments and can make all the files required for the device.
+
+To make nodes manually, the arguments are:
+
+ at table @b
+ at item -r
+Replace an existing file if its type is incorrect.
+
+ at item -R
+Replace an existing file if its type is incorrect. Correct the
+mode, user and group.
+
+ at item -g gid
+Specify the group for the device node. The gid operand may be a
+numeric group ID or a group name. If a group name is also a numeric
+group ID, the operand is used as a group name. Precede a numeric
+group ID with a # to stop it being treated as a name.
+
+ at item -m mode
+Specify the mode for the device node. The mode may be absolute or
+symbolic, see @i{chmod}.
+
+ at item -u uid
+Specify the user for the device node. The uid operand may be a
+numeric user ID or a user name. If a user name is also a numeric user
+ID, the operand is used as a user name. Precede a numeric user ID
+with a # to stop it being treated as a name.
+
+ at item name
+Device name, for example ``tty'' for a termios serial device or ``hd''
+for a disk.
+
+ at item b | c | p
+Type of device. If the device is a block type device such as a tape
+or disk drive which needs both cooked and raw special files, the type
+is b. All other devices are character type devices, such as terminal
+and pseudo devices, and are type c. Specifying p creates fifo files.
+
+ at item driver | major
+The major device number is an integer number which tells the kernel
+which device driver entry point to use. If the device driver is
+configured into the current kernel it may be specified by driver name
+or major number.
+
+ at item minor
+The minor device number tells the kernel which one of several similar
+devices the node corresponds to; for example, it may be a specific
+serial port or pty.
+
+ at item unit and subunit
+The unit and subunit numbers select a subset of a device; for example,
+the unit may specify a particular disk, and the subunit a partition on
+that disk. (Currently this form of specification is only supported
+by the bsdos format, for compatibility with the BSD/OS mknod).
+
+ at item number
+A single opaque device number. Useful for netbooted computers which
+require device numbers packed in a format that isn't supported by
+-F.
+ at end table
+
+ at subheading EXIT STATUS:
+
+The @code{mknod} utility exits 0 on success, and >0 if an error occurs.
+
+ at subheading NOTES:
+
+NONE
+
+ at subheading EXAMPLES:
+
+ at example
+SHLL [/] mknod c 3 0 /dev/ttyS10
+ at end example
+
+ at subheading CONFIGURATION:
+
+ at findex CONFIGURE_SHELL_NO_COMMAND_MKNOD
+ at findex CONFIGURE_SHELL_COMMAND_MKNOD
+
+This command is included in the default shell command set. When
+building a custom command set, define
+ at code{CONFIGURE_SHELL_COMMAND_MKNOD} to have this command included.
+
+This command can be excluded from the shell command set by
+defining @code{CONFIGURE_SHELL_NO_COMMAND_MKNOD} when all
+shell commands have been configured.
+
+ at subheading PROGRAMMING INFORMATION:
+
+ at findex rtems_shell_rtems_main_mknod
+
+The @code{mknod} command is implemented by a C language function which
+has the following prototype:
+
+ at example
+int rtems_shell_rtems_main_mknod(
+ int argc,
+ char **argv
+);
+ at end example
+
+The configuration structure for the @code{mknod} has the following
+prototype:
+
+ at example
+extern rtems_shell_cmd_t rtems_shell_MKNOD_Command;
+ at end example
+
+ at subheading ORIGIN:
+
+The implementation and portions of the documentation for this command
+are from NetBSD 4.0.
+
+ at c
+ at c
+ at c
+ at page
@subsection chroot - change the root directory
@pgindex chroot
@@ -1072,12 +1457,14 @@
@item tftp - TFTP Network File System
@item ftp - FTP Network File System
@item nfs - Network File System
+ at item rfs - RTEMS 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.
+When the file system type is 'msdos' or 'rfs' 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:
@@ -1097,7 +1484,7 @@
Mount the Flash Disk driver to the '/fd' mount point:
@example
-$ mount -t msdos /dev/flashdisk0 /fd
+SHLL [/] $ mount -t msdos /dev/flashdisk0 /fd
@end example
Mount the NFS file system exported path 'bar' by host 'foo':
@@ -1118,7 +1505,6 @@
$ cat /tftp/10.10.10.10/test.txt
@end example
-
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_MOUNT
@@ -1142,6 +1528,7 @@
@item tftp - CONFIGURE_SHELL_MOUNT_TFTP
@item ftp - CONFIGURE_SHELL_MOUNT_FTP
@item nfs - CONFIGURE_SHELL_MOUNT_NFS
+ at item rfs - CONFIGURE_SHELL_MOUNT_RFS
@end itemize
An example configuration is:
@@ -1152,6 +1539,7 @@
#define CONFIGURE_SHELL_MOUNT_TFTP
#define CONFIGURE_SHELL_MOUNT_FTP
#define CONFIGURE_SHELL_MOUNT_NFS
+ #define CONFIGURE_SHELL_MOUNT_RFS
#endif
@end example
@@ -1318,6 +1706,528 @@
@c
@c
@page
+ at subsection dd - convert and copy a file
+
+ at pgindex dd
+
+ at subheading SYNOPSYS:
+
+ at example
+dd [operands ...]
+ at end example
+
+ at subheading DESCRIPTION:
+
+The dd utility copies the standard input to the standard output.
+Input data is read and written in 512-byte blocks. If input reads are
+short, input from multiple reads are aggregated to form the output
+block. When finished, dd displays the number of complete and partial
+input and output blocks and truncated input records to the standard
+error output.
+
+The following operands are available:
+
+ at table @b
+ at item bs=n
+Set both input and output block size, superseding the ibs and obs
+operands. If no conversion values other than noerror, notrunc or sync
+are specified, then each input block is copied to the output as a
+single block without any aggregation of short blocks.
+
+ at item cbs=n
+Set the conversion record size to n bytes. The conversion record size
+is required by the record oriented conversion values.
+
+ at item count=n
+Copy only n input blocks.
+
+ at item files=n
+Copy n input files before terminating. This operand is only
+applicable when the input device is a tape.
+
+ at item ibs=n
+Set the input block size to n bytes instead of the default 512.
+
+ at item if=file
+Read input from file instead of the standard input.
+
+ at item obs=n
+Set the output block size to n bytes instead of the default 512.
+
+ at item of=file
+Write output to file instead of the standard output. Any regular
+output file is truncated unless the notrunc conversion value is
+specified. If an initial portion of the output file is skipped (see
+the seek operand) the output file is truncated at that point.
+
+ at item seek=n
+Seek n blocks from the beginning of the output before copying. On
+non-tape devices, a @i{lseek} operation is used. Otherwise, existing
+blocks are read and the data discarded. If the seek operation is past
+the end of file, space from the current end of file to the specified
+offset is filled with blocks of NUL bytes.
+
+ at item skip=n
+Skip n blocks from the beginning of the input before copying. On
+input which supports seeks, a @i{lseek} operation is used. Otherwise,
+input data is read and discarded. For pipes, the correct number of
+bytes is read. For all other devices, the correct number of blocks is
+read without distinguishing between a partial or complete block being
+read.
+
+ at item progress=n
+Switch on display of progress if n is set to any non-zero value. This
+will cause a ``.'' to be printed (to the standard error output) for
+every n full or partial blocks written to the output file.
+
+ at item conv=value[,value...]
+Where value is one of the symbols from the following list.
+
+ at table @b
+ at item ascii, oldascii
+The same as the unblock value except that characters are translated
+from EBCDIC to ASCII before the records are converted. (These values
+imply unblock if the operand cbs is also specified.) There are two
+conversion maps for ASCII. The value ascii specifies the recom-
+mended one which is compatible with AT&T System V UNIX. The value
+oldascii specifies the one used in historic AT&T and pre 4.3BSD-Reno
+systems.
+
+ at item block
+Treats the input as a sequence of newline or end-of-file terminated
+variable length records independent of input and output block
+boundaries. Any trailing newline character is discarded. Each
+input record is converted to a fixed length output record where the
+length is specified by the cbs operand. Input records shorter than
+the conversion record size are padded with spaces. Input records
+longer than the conversion record size are truncated. The number of
+truncated input records, if any, are reported to the standard error
+output at the completion of the copy.
+
+ at item ebcdic, ibm, oldebcdic, oldibm
+The same as the block value except that characters are translated from
+ASCII to EBCDIC after the records are converted. (These values imply
+block if the operand cbs is also specified.) There are four
+conversion maps for EBCDIC. The value ebcdic specifies the
+recommended one which is compatible with AT&T System V UNIX. The
+value ibm is a slightly different mapping, which is compatible with
+the AT&T System V UNIX ibm value. The values oldebcdic and oldibm are
+maps used in historic AT&T and pre 4.3BSD-Reno systems.
+
+ at item lcase
+Transform uppercase characters into lowercase characters.
+
+ at item noerror
+Do not stop processing on an input error. When an input error occurs,
+a diagnostic message followed by the current input and output block
+counts will be written to the standard error output in the same format
+as the standard completion message. If the sync conversion is also
+specified, any missing input data will be replaced with NUL bytes (or
+with spaces if a block oriented conversion value was specified) and
+processed as a normal input buffer. If the sync conversion is not
+specified, the input block is omitted from the output. On input files
+which are not tapes or pipes, the file offset will be positioned past
+the block in which the error occurred using lseek(2).
+
+ at item notrunc
+Do not truncate the output file. This will preserve any blocks in the
+output file not explicitly written by dd. The notrunc value is not
+supported for tapes.
+
+ at item osync
+Pad the final output block to the full output block size. If the
+input file is not a multiple of the output block size after
+conversion, this conversion forces the final output block to be the
+same size as preceding blocks for use on devices that require
+regularly sized blocks to be written. This option is incompatible
+with use of the bs=n block size specification.
+
+ at item sparse
+If one or more non-final output blocks would consist solely of NUL
+bytes, try to seek the output file by the required space instead of
+filling them with NULs. This results in a sparse file on some file
+systems.
+
+ at item swab
+Swap every pair of input bytes. If an input buffer has an odd number
+of bytes, the last byte will be ignored during swapping.
+
+ at item sync
+Pad every input block to the input buffer size. Spaces are used for
+pad bytes if a block oriented conversion value is specified, otherwise
+NUL bytes are used.
+
+ at item ucase
+Transform lowercase characters into uppercase characters.
+
+ at item unblock
+Treats the input as a sequence of fixed length records independent of
+input and output block boundaries. The length of the input records is
+specified by the cbs operand. Any trailing space characters are
+discarded and a newline character is appended.
+ at end table
+ at end table
+
+Where sizes are specified, a decimal number of bytes is expected. Two
+or more numbers may be separated by an ``x'' to indicate a product.
+Each number may have one of the following optional suffixes:
+ at table @b
+ at item b
+Block; multiply by 512
+ at item k
+Kibi; multiply by 1024 (1 KiB)
+ at item m
+Mebi; multiply by 1048576 (1 MiB)
+ at item g
+Gibi; multiply by 1073741824 (1 GiB)
+ at item t
+Tebi; multiply by 1099511627776 (1 TiB)
+ at item w
+Word; multiply by the number of bytes in an integer
+ at end table
+
+When finished, dd displays the number of complete and partial input
+and output blocks, truncated input records and odd-length
+byte-swapping ritten. Partial output blocks to tape devices are
+considered fatal errors. Otherwise, the rest of the block will be
+written. Partial output blocks to character devices will produce a
+warning message. A truncated input block is one where a variable
+length record oriented conversion value was specified and the input
+line was too long to fit in the conversion record or was not newline
+terminated.
+
+Normally, data resulting from input or conversion or both are
+aggregated into output blocks of the specified size. After the end of
+input is reached, any remaining output is written as a block. This
+means that the final output block may be shorter than the output block
+size.
+
+ at subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
+ at subheading NOTES:
+
+NONE
+
+ at subheading EXAMPLES:
+
+The following is an example of how to use @code{dd}:
+
+ at example
+SHLL [/] $ dd if=/nfs/boot-image of=/dev/hda1
+ at end example
+
+ at subheading CONFIGURATION:
+
+ at findex CONFIGURE_SHELL_NO_COMMAND_DD
+ at findex CONFIGURE_SHELL_COMMAND_DD
+
+This command is included in the default shell command set. When
+building a custom command set, define
+ at code{CONFIGURE_SHELL_COMMAND_DD} to have this command included.
+
+This command can be excluded from the shell command set by defining
+ at code{CONFIGURE_SHELL_NO_COMMAND_DD} when all shell commands have been
+configured.
+
+ at subheading PROGRAMMING INFORMATION:
+
+ at findex rtems_shell_rtems_main_dd
+
+The @code{dd} command is implemented by a C language function which
+has the following prototype:
+
+ at example
+int rtems_shell_rtems_main_dd(
+ int argc,
+ char **argv
+);
+ at end example
+
+The configuration structure for the @code{dd} has the following
+prototype:
+
+ at example
+extern rtems_shell_cmd_t rtems_shell_DD_Command;
+ at end example
+
+ at c
+ at c
+ at c
+ at page
+ at subsection hexdump - ascii/dec/hex/octal dump
+
+ at pgindex hexdump
+
+ at subheading SYNOPSYS:
+
+ at example
+hexdump [-bcCdovx] [-e format_string] [-f format_file] [-n length]
+ [-s skip] file ...
+ at end example
+
+ at subheading DESCRIPTION:
+
+The hexdump utility is a filter which displays the specified files, or
+the standard input, if no files are specified, in a user specified
+format.
+
+The options are as follows:
+
+ at table @b
+ at item -b
+One-byte octal display. Display the input offset in hexadecimal,
+followed by sixteen space-separated, three column, zero-filled, bytes
+of input data, in octal, per line.
+
+ at item -c
+One-byte character display. Display the input offset in hexadecimal,
+followed by sixteen space-separated, three column, space-filled,
+characters of input data per line.
+
+ at item -C
+Canonical hex+ASCII display. Display the input offset in hexadecimal,
+followed by sixteen space-separated, two column, hexadecimal bytes,
+followed by the same sixteen bytes in %_p format enclosed in ``|''
+characters.
+
+ at item -d
+Two-byte decimal display. Display the input offset in hexadecimal,
+followed by eight space-separated, five column, zero-filled, two-byte
+units of input data, in unsigned decimal, per line.
+
+ at item -e format_string
+Specify a format string to be used for displaying data.
+
+ at item -f format_file
+Specify a file that contains one or more newline separated format
+strings. Empty lines and lines whose first non-blank character is a
+hash mark (#) are ignored.
+
+ at item -n length
+Interpret only length bytes of input.
+
+ at item -o
+Two-byte octal display. Display the input offset in hexadecimal,
+followed by eight space-separated, six column, zerofilled, two byte
+quantities of input data, in octal, per line.
+
+ at item -s offset
+Skip offset bytes from the beginning of the input. By default, offset
+is interpreted as a decimal number. With a leading 0x or 0X, offset
+is interpreted as a hexadecimal number, otherwise, with a leading 0,
+offset is interpreted as an octal number. Appending the character b,
+k, or m to offset causes it to be interpreted as a multiple of 512,
+1024, or 1048576, respectively.
+
+ at item -v
+The -v option causes hexdump to display all input data. Without the
+-v option, any number of groups of output lines, which would be
+identical to the immediately preceding group of output lines (except
+for the input offsets), are replaced with a line containing a single
+asterisk.
+
+ at item -x
+Two-byte hexadecimal display. Display the input offset in
+hexadecimal, followed by eight, space separated, four column,
+zero-filled, two-byte quantities of input data, in hexadecimal, per
+line.
+ at end table
+
+For each input file, hexdump sequentially copies the input to standard
+output, transforming the data according to the format strings
+specified by the -e and -f options, in the order that they were
+specified.
+
+ at b{Formats}
+
+A format string contains any number of format units, separated by
+whitespace. A format unit contains up to three items: an iteration
+count, a byte count, and a format.
+
+The iteration count is an optional positive integer, which defaults to
+one. Each format is applied iteration count times.
+
+The byte count is an optional positive integer. If specified it
+defines the number of bytes to be interpreted by each iteration of the
+format.
+
+If an iteration count and/or a byte count is specified, a single slash
+must be placed after the iteration count and/or before the byte count
+to disambiguate them. Any whitespace before or after the slash is
+ignored.
+
+The format is required and must be surrounded by double quote (`` ``)
+marks. It is interpreted as a fprintf-style format string (see
+ at i{fprintf}), with the following exceptions:
+
+ at itemize @bullet
+ at item
+An asterisk (*) may not be used as a field width or precision.
+ at item
+A byte count or field precision is required for each ``s'' con-
+version character (unlike the fprintf(3) default which prints the
+entire string if the precision is unspecified).
+ at item
+The conversion characters ``h'', ``l'', ``n'', ``p'' and ``q'' are not
+supported.
+ at item
+The single character escape sequences described in the C standard
+are supported:
+ at quotation
+NUL \0
+<alert character> \a
+<backspace> \b
+<form-feed> \f
+<newline> \n
+<carriage return> \r
+<tab> \t
+<vertical tab> \v
+ at end quotation
+ at end itemize
+
+Hexdump also supports the following additional conversion strings:
+
+ at table @b
+ at item _a[dox]
+Display the input offset, cumulative across input files, of the next
+byte to be displayed. The appended characters d, o, and x specify the
+display base as decimal, octal or hexadecimal respectively.
+
+ at item _A[dox]
+Identical to the _a conversion string except that it is only performed
+once, when all of the input data has been processed.
+
+ at item _c
+Output characters in the default character set. Nonprinting
+characters are displayed in three character, zero-padded octal, except
+for those representable by standard escape notation (see above), which
+are displayed as two character strings.
+
+ at item _p
+Output characters in the default character set. Nonprinting
+characters are displayed as a single ``.''.
+
+ at item _u
+Output US ASCII characters, with the exception that control characters
+are displayed using the following, lower-case, names. Characters
+greater than 0xff, hexadecimal, are displayed as hexadecimal
+strings.
+
+000 nul 001 soh 002 stx 003 etx 004 eot 005 enq
+006 ack 007 bel 008 bs 009 ht 00A lf 00B vt
+00C ff 00D cr 00E so 00F si 010 dle 011 dc1
+012 dc2 013 dc3 014 dc4 015 nak 016 syn 017 etb
+018 can 019 em 01A sub 01B esc 01C fs 01D gs
+01E rs 01F us 07F del
+ at end table
+
+The default and supported byte counts for the conversion characters
+are as follows:
+
+ at quotation
+%_c, %_p, %_u, %c One byte counts only.
+
+%d, %i, %o, %u, %X, %x Four byte default, one, two, four
+ and eight byte counts supported.
+
+%E, %e, %f, %G, %g Eight byte default, four byte
+ counts supported.
+ at end quotation
+
+The amount of data interpreted by each format string is the sum of the
+data required by each format unit, which is the iteration count times
+the byte count, or the iteration count times the number of bytes
+required by the format if the byte count is not specified.
+
+The input is manipulated in ``blocks'', where a block is defined as
+the largest amount of data specified by any format string. Format
+strings interpreting less than an input block's worth of data, whose
+last format unit both interprets some number of bytes and does not
+have a specified iteration count, have the iteration count incremented
+until the entire input block has been processed or there is not enough
+data remaining in the block to satisfy the format string.
+
+If, either as a result of user specification or hexdump modifying the
+iteration count as described above, an iteration count is greater than
+one, no trailing whitespace characters are output during the last
+iteration.
+
+It is an error to specify a byte count as well as multiple conversion
+characters or strings unless all but one of the conversion characters
+or strings is _a or _A.
+
+If, as a result of the specification of the -n option or end-of-file
+being reached, input data only partially satisfies a format string,
+the input block is zero-padded sufficiently to display all available
+data (i.e. any format units overlapping the end of data will display
+some num- ber of the zero bytes).
+
+Further output by such format strings is replaced by an equivalent
+number of spaces. An equivalent number of spaces is defined as the
+number of spaces output by an s conversion character with the same
+field width and precision as the original conversion character or
+conversion string but with any ``+'', `` '', ``#'' conversion flag
+characters removed, and ref- erencing a NULL string.
+
+If no format strings are specified, the default display is equivalent
+to specifying the -x option.
+
+ at subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
+ at subheading NOTES:
+
+NONE
+
+ at subheading EXAMPLES:
+
+The following is an example of how to use @code{hexdump}:
+
+ at example
+SHLL [/] $ hexdump -C -n 512 /dev/hda1
+ at end example
+
+ at subheading CONFIGURATION:
+
+ at findex CONFIGURE_SHELL_NO_COMMAND_HEXDUMP
+ at findex CONFIGURE_SHELL_COMMAND_HEXDUMP
+
+This command is included in the default shell command set. When
+building a custom command set, define
+ at code{CONFIGURE_SHELL_COMMAND_HEXDUMP} to have this command included.
+
+This command can be excluded from the shell command set by defining
+ at code{CONFIGURE_SHELL_NO_COMMAND_HEXDUMP} when all shell commands have
+been configured.
+
+ at subheading PROGRAMMING INFORMATION:
+
+ at findex rtems_shell_rtems_main_hexdump
+
+The @code{hexdump} command is implemented by a C language function
+which has the following prototype:
+
+ at example
+int rtems_shell_rtems_main_hexdump(
+ int argc,
+ char **argv
+);
+ at end example
+
+The configuration structure for the @code{hexdump} has the following
+prototype:
+
+ at example
+extern rtems_shell_cmd_t rtems_shell_HEXDUMP_Command;
+ at end example
+
+ at c
+ at c
+ at c
+ at page
@subsection fdisk - format disk
@pgindex fdisk
@@ -1426,6 +2336,223 @@
@c
@c
@page
+ at subsection mkrfs - format RFS file system
+
+ at pgindex mkrfs
+
+ at subheading SYNOPSYS:
+
+ at example
+mkrfs [-vsbiIo] device
+ at end example
+
+ at subheading DESCRIPTION:
+
+Format the block device with the RTEMS File System (RFS). The default
+configuration with not parameters selects a suitable block size based
+on the size of the media being formatted.
+
+The media is broken up into groups of blocks. The number of blocks in
+a group is based on the number of bits a block contains. The large a
+block the more blocks a group contains and the fewer groups in the
+file system.
+
+The following options are provided:
+
+ at table @b
+ at item -v
+Display configuration and progress of the format.
+
+ at item -s
+Set the block size in bytes.
+
+ at item -b
+The number of blocks in a group. The block count must be equal or less
+than the number of bits in a block.
+
+ at item -i
+Number of inodes in a group. The inode count must be equal or less
+than the number of bits in a block.
+
+ at item -I
+Initialise the inodes. The default is not to initialise the inodes and
+to rely on the inode being initialised when allocated. Initialising
+the inode table helps recovery if a problem appears.
+
+ at item -o
+Integer percentage of the media used by inodes. The default is 1%.
+
+ at item device
+Path of the device to format.
+ at end table
+
+ at subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
+ at subheading NOTES:
+
+NONE
+
+ at subheading EXAMPLES:
+
+The following is an example of how to use @code{mkrfs}:
+
+ at example
+SHLL [/] $ mkrfs /dev/fdda
+ at end example
+
+ at subheading CONFIGURATION:
+
+ at findex CONFIGURE_SHELL_NO_COMMAND_MKRFS
+ at findex CONFIGURE_SHELL_COMMAND_MKRFS
+
+This command is included in the default shell command set.
+When building a custom command set, define
+ at code{CONFIGURE_SHELL_COMMAND_MKRFS} to have this
+command included.
+
+This command can be excluded from the shell command set by
+defining @code{CONFIGURE_SHELL_NO_COMMAND_MKRFS} when all
+shell commands have been configured.
+
+ at subheading PROGRAMMING INFORMATION:
+
+ at findex rtems_shell_rtems_main_mkrfs
+
+The @code{mkrfs} command is implemented by a C language function which
+has the following prototype:
+
+ at example
+int rtems_shell_rtems_main_mkrfs(
+ int argc,
+ char **argv
+);
+ at end example
+
+The configuration structure for @code{mkrfs} has the following
+prototype:
+
+ at example
+extern rtems_shell_cmd_t rtems_shell_MKRFS_Command;
+ at end example
+
+ at c
+ at c
+ at c
+ at page
+ at subsection debugrfs - debug RFS file system
+
+ at pgindex debugrfs
+
+ at subheading SYNOPSYS:
+
+ at example
+debugrfs [-hl] path command [options]
+ at end example
+
+ at subheading DESCRIPTION:
+
+The command provides debugging information for the RFS file system.
+
+The options are:
+
+ at table @b
+ at item -h
+Print a help message.
+
+ at item -l
+List the commands.
+
+ at item path
+Path to the mounted RFS file system. The file system has to be mounted
+to view to use this command.
+ at end table
+
+The commands are:
+
+ at table @b
+ at item block start [end]
+Display the contents of the blocks from start to end.
+
+ at item data
+Display the file system data and configuration.
+
+ at item dir bno
+Process the block as a directory displaying the entries.
+
+ at item group start [end]
+Display the group data from the start group to the end group.
+
+ at item inode [-aef] [start] [end]
+Display the inodes between start and end. If no start and end is
+provides all inodes are displayed.
+
+ at table @b
+ at item -a
+Display all inodes. That is allocated and unallocated inodes.
+ at item -e
+Search and display on inodes that have an error.
+ at item -f
+Force display of inodes, even when in error.
+ at end table
+ at end table
+
+ at subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
+ at subheading NOTES:
+
+NONE
+
+ at subheading EXAMPLES:
+
+The following is an example of how to use @code{debugrfs}:
+
+ at example
+SHLL [/] $ debugrfs /c data
+ at end example
+
+ at subheading CONFIGURATION:
+
+ at findex CONFIGURE_SHELL_NO_COMMAND_DEBUGRFS
+ at findex CONFIGURE_SHELL_COMMAND_DEBUGRFS
+
+This command is included in the default shell command set.
+When building a custom command set, define
+ at code{CONFIGURE_SHELL_COMMAND_DEBUGRFS} to have this
+command included.
+
+This command can be excluded from the shell command set by
+defining @code{CONFIGURE_SHELL_NO_COMMAND_DEBUGRFS} when all
+shell commands have been configured.
+
+ at subheading PROGRAMMING INFORMATION:
+
+ at findex rtems_shell_rtems_main_debugrfs
+
+The @code{debugrfs} command is implemented by a C language function which
+has the following prototype:
+
+ at example
+int rtems_shell_rtems_main_debugrfs(
+ int argc,
+ char **argv
+);
+ at end example
+
+The configuration structure for @code{debugrfs} has the following
+prototype:
+
+ at example
+extern rtems_shell_cmd_t rtems_shell_DEBUGRFS_Command;
+ at end example
+
+ at c
+ at c
+ at c
+ at page
@subsection cd - alias for chdir
@pgindex cd
diff -u rtems/doc/shell/general.t:1.10 rtems/doc/shell/general.t:1.11
--- rtems/doc/shell/general.t:1.10 Wed May 12 06:30:52 2010
+++ rtems/doc/shell/general.t Wed May 12 22:45:02 2010
@@ -24,9 +24,10 @@
@item @code{getenv} - print environment variable
@item @code{setenv} - set environment variable
@item @code{unsetenv} - unset environment variable
+ at item @code{time} - time command execution
@item @code{logoff} - logoff from the system
- at item @code{exit} - alias for logoff command
@item @code{rtc} - RTC driver configuration
+ at item @code{exit} - alias for logoff command
@end itemize
@@ -843,6 +844,76 @@
@c
@c
@page
+ at subsection time - time command execution
+
+ at pgindex time
+
+ at subheading SYNOPSYS:
+
+ at example
+time command [argument ...]
+ at end example
+
+ at subheading DESCRIPTION:
+
+The time command executes and times a command. After the command
+finishes, time writes the total time elapsed. Times are reported in
+seconds.
+
+ at subheading EXIT STATUS:
+
+This command returns 0 on success and non-zero if an error is encountered.
+
+ at subheading NOTES:
+
+None.
+
+ at subheading EXAMPLES:
+
+The following is an example of how to use @code{time}:
+
+ at example
+SHLL [/] $ time cp -r /nfs/directory /c
+ at end example
+
+ at subheading CONFIGURATION:
+
+ at findex CONFIGURE_SHELL_NO_COMMAND_TIME
+ at findex CONFIGURE_SHELL_COMMAND_TIME
+
+This command is included in the default shell command set. When
+building a custom command set, define
+ at code{CONFIGURE_SHELL_COMMAND_TIME} to have this command included.
+
+This command can be excluded from the shell command set by
+defining @code{CONFIGURE_SHELL_NO_COMMAND_TIME} when all
+shell commands have been configured.
+
+ at subheading PROGRAMMING INFORMATION:
+
+ at findex rtems_shell_rtems_main_time
+
+The @code{time} is implemented by a C language function
+which has the following prototype:
+
+ at example
+int rtems_shell_rtems_main_time(
+ int argc,
+ char **argv
+);
+ at end example
+
+The configuration structure for the @code{time} has the
+following prototype:
+
+ at example
+extern rtems_shell_cmd_t rtems_shell_TIME_Command;
+ at end example
+
+ at c
+ at c
+ at c
+ at page
@subsection logoff - logoff from the system
@pgindex logoff
@@ -916,6 +987,34 @@
@c
@c
@page
+ at subsection rtc - RTC driver configuration
+
+ at pgindex rtc
+
+ at subheading SYNOPSYS:
+
+ at example
+rtc
+ at end example
+
+ at subheading CONFIGURATION:
+
+ at findex CONFIGURE_SHELL_NO_COMMAND_RTC
+ at findex CONFIGURE_SHELL_COMMAND_RTC
+
+This command is included in the default shell command set.
+When building a custom command set, define
+ at code{CONFIGURE_SHELL_COMMAND_RTC} to have this
+command included.
+
+This command can be excluded from the shell command set by
+defining @code{CONFIGURE_SHELL_NO_COMMAND_RTC} when all
+shell commands have been configured.
+
+ at c
+ at c
+ at c
+ at page
@subsection exit - exit the shell
@pgindex exit
@@ -956,31 +1055,3 @@
The @code{exit} is implemented directly in the shell interpreter.
There is no C routine associated with it.
-
- at c
- at c
- at c
- at page
- at subsection rtc - RTC driver configuration
-
- at pgindex rtc
-
- at subheading SYNOPSYS:
-
- at example
-rtc
- at end example
-
- at subheading CONFIGURATION:
-
- at findex CONFIGURE_SHELL_NO_COMMAND_RTC
- at findex CONFIGURE_SHELL_COMMAND_RTC
-
-This command is included in the default shell command set.
-When building a custom command set, define
- at code{CONFIGURE_SHELL_COMMAND_RTC} to have this
-command included.
-
-This command can be excluded from the shell command set by
-defining @code{CONFIGURE_SHELL_NO_COMMAND_RTC} when all
-shell commands have been configured.
--
Generated by Deluxe Loginfo [http://www.codewiz.org/projects/index.html#loginfo] 2.122 by Bernardo Innocenti <bernie at develer.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/vc/attachments/20100512/2b20905d/attachment.html>
More information about the vc
mailing list