diff options
Diffstat (limited to 'shell')
| -rw-r--r-- | shell/file_and_directory.rst | 1716 |
1 files changed, 866 insertions, 850 deletions
diff --git a/shell/file_and_directory.rst b/shell/file_and_directory.rst index 152f678..05e2952 100644 --- a/shell/file_and_directory.rst +++ b/shell/file_and_directory.rst @@ -63,10 +63,9 @@ The RTEMS shell has the following file and directory commands: Commands ======== -This section details the File and Directory Commands available. A -subsection is dedicated to each of the commands and -describes the behavior and configuration of that -command as well as providing an example usage. +This section details the File and Directory Commands available. A subsection +is dedicated to each of the commands and describes the behavior and +configuration of that command as well as providing an example usage. blksync - sync the block driver ------------------------------- @@ -74,13 +73,15 @@ blksync - sync the block driver **SYNOPSYS:** -.. code:: c +.. code:: shell blksync driver **DESCRIPTION:** -This command XXX +This command issues a block driver sync call to the driver. The driver is a +path to a device node. The sync call will flush all pending writes in the cache +to the media and block until the writes have completed. **EXIT STATUS:** @@ -88,27 +89,28 @@ This command returns 0 on success and non-zero if an error is encountered. **NOTES:** -NONE +None. **EXAMPLES:** The following is an example of how to use ``blksync``: + .. code:: c - EXAMPLE_TBD + blksync /dev/hda1 **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_BLKSYNC .. index:: CONFIGURE_SHELL_COMMAND_BLKSYNC -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_BLKSYNC`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_BLKSYNC`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_BLKSYNC`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_BLKSYNC`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** @@ -116,15 +118,16 @@ shell commands have been configured. The ``blksync`` is implemented by a C language function which has the following prototype: + .. code:: c int rtems_shell_rtems_main_blksync( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``blksync`` has the -following prototype: +The configuration structure for the ``blksync`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_BLKSYNC_Command; @@ -135,9 +138,9 @@ cat - display file contents **SYNOPSYS:** -.. code:: c +.. code:: shell - cat file1 \[file2 .. fileN] + cat file1 [file2 .. fileN] **DESCRIPTION:** @@ -154,11 +157,12 @@ It is possible to read the input from a device file using ``cat``. **EXAMPLES:** The following is an example of how to use ``cat``: -.. code:: c - SHLL \[/] # cat /etc/passwd - root:\*:0:0:root::/:/bin/sh - rtems:\*:1:1:RTEMS Application::/:/bin/sh +.. code:: shell + + SHLL [/] # cat /etc/passwd + root:*:0:0:root::/:/bin/sh + rtems:*:1:1:RTEMS Application::/:/bin/sh tty:!:2:2:tty owner::/:/bin/false **CONFIGURATION:** @@ -166,29 +170,30 @@ The following is an example of how to use ``cat``: .. index:: CONFIGURE_SHELL_NO_COMMAND_CAT .. index:: CONFIGURE_SHELL_COMMAND_CAT -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CAT`` to have this -command included. +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_CAT`` to have this command +included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_CAT`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_CAT`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_cat -The ``cat`` is implemented by a C language function -which has the following prototype: +The ``cat`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_cat( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``cat`` has the -following prototype: +The configuration structure for the ``cat`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_CAT_Command; @@ -199,14 +204,14 @@ cd - alias for chdir **SYNOPSYS:** -.. code:: c +.. code:: shell cd directory **DESCRIPTION:** -This command is an alias or alternate name for the ``chdir``. -See `ls - list files in the directory`_ for more information. +This command is an alias or alternate name for the ``chdir``. See `ls - list +files in the directory` for more information. **EXIT STATUS:** @@ -214,24 +219,25 @@ This command returns 0 on success and non-zero if an error is encountered. **NOTES:** -NONE +None. **EXAMPLES:** The following is an example of how to use ``cd``: -.. code:: c - SHLL \[/] $ cd etc - SHLL \[/etc] $ cd / - SHLL \[/] $ cd /etc - SHLL \[/etc] $ pwd +.. code:: shell + + SHLL [/] $ cd etc + SHLL [/etc] $ cd / + SHLL [/] $ cd /etc + SHLL [/etc] $ pwd /etc - SHLL \[/etc] $ cd / - SHLL \[/] $ pwd + SHLL [/etc] $ cd / + SHLL [/] $ pwd / - SHLL \[/] $ cd etc - SHLL \[/etc] $ cd .. - SHLL \[/] $ pwd + SHLL [/] $ cd etc + SHLL [/etc] $ cd .. + SHLL [/] $ pwd / **CONFIGURATION:** @@ -239,29 +245,29 @@ The following is an example of how to use ``cd``: .. index:: CONFIGURE_SHELL_NO_COMMAND_CD .. index:: CONFIGURE_SHELL_COMMAND_CD -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CD`` to have this -command included. +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_CD`` to have this command +included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_CD`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_CD`` when all shell commands have been configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_cd -The ``cd`` is implemented by a C language function -which has the following prototype: +The ``cd`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_cd( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``cd`` has the -following prototype: +The configuration structure for the ``cd`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_CD_Command; @@ -273,15 +279,15 @@ chdir - change the current directory **SYNOPSYS:** -.. code:: c +.. code:: shell - chdir \[dir] + chdir [dir] **DESCRIPTION:** -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 ``/``. +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 ``/``. **EXIT STATUS:** @@ -289,17 +295,18 @@ This command returns 0 on success and non-zero if an error is encountered. **NOTES:** -NONE +None. **EXAMPLES:** The following is an example of how to use ``chdir``: -.. code:: c - SHLL \[/] $ pwd +.. code:: shell + + SHLL [/] $ pwd / - SHLL \[/] $ chdir etc - SHLL \[/etc] $ pwd + SHLL [/] $ chdir etc + SHLL [/etc] $ pwd /etc **CONFIGURATION:** @@ -307,29 +314,30 @@ The following is an example of how to use ``chdir``: .. index:: CONFIGURE_SHELL_NO_COMMAND_CHDIR .. index:: CONFIGURE_SHELL_COMMAND_CHDIR -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CHDIR`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_CHDIR`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_CHDIR`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_CHDIR`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_chdir -The ``chdir`` is implemented by a C language function -which has the following prototype: +The ``chdir`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_chdir( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``chdir`` has the -following prototype: +The configuration structure for the ``chdir`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_CHDIR_Command; @@ -340,16 +348,15 @@ chmod - change permissions of a file **SYNOPSYS:** -.. code:: c +.. code:: shell - chmod permissions file1 \[file2...] + chmod permissions file1 [file2...] **DESCRIPTION:** -This command changes the permissions on the files specified to the -indicated ``permissions``. The permission values are POSIX based -with owner, group, and world having individual read, write, and -executive permission bits. +This command changes the permissions on the files specified to the indicated +``permissions``. The permission values are POSIX based with owner, group, and +world having individual read, write, and executive permission bits. **EXIT STATUS:** @@ -363,31 +370,32 @@ the permissions. **EXAMPLES:** The following is an example of how to use ``chmod``: -.. code:: c - SHLL \[/] # cd etc - SHLL \[/etc] # ls +.. code:: shell + + SHLL [/] # cd etc + SHLL [/etc] # ls -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 \[/etc] # chmod 0777 passwd - SHLL \[/etc] # ls + SHLL [/etc] # chmod 0777 passwd + SHLL [/etc] # ls -rwxrwxrwx 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 \[/etc] # chmod 0322 passwd - SHLL \[/etc] # ls + SHLL [/etc] # chmod 0322 passwd + SHLL [/etc] # ls --wx-w--w- 1 nouser root 102 Jan 01 00:00 passwd -rw-r--r-- 1 nouser root 42 Jan 01 00:00 group -rw-r--r-- 1 nouser root 30 Jan 01 00:00 issue -rw-r--r-- 1 nouser root 28 Jan 01 00:00 issue.net 4 files 202 bytes occupied - SHLL \[/etc] # chmod 0644 passwd - SHLL \[/etc] # ls + SHLL [/etc] # chmod 0644 passwd + SHLL [/etc] # ls -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 @@ -399,29 +407,30 @@ The following is an example of how to use ``chmod``: .. index:: CONFIGURE_SHELL_NO_COMMAND_CHMOD .. index:: CONFIGURE_SHELL_COMMAND_CHMOD -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CHMOD`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_CHMOD`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_CHMOD`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_CHMOD`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_chmod -The ``chmod`` is implemented by a C language function -which has the following prototype: +The ``chmod`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_chmod( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``chmod`` has the -following prototype: +The configuration structure for the ``chmod`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_CHMOD_Command; @@ -432,14 +441,13 @@ chroot - change the root directory **SYNOPSYS:** -.. code:: c +.. code:: shell - chroot \[dir] + chroot [dir] **DESCRIPTION:** -This command changes the root directory to ``dir`` for subsequent -commands. +This command changes the root directory to ``dir`` for subsequent commands. **EXIT STATUS:** @@ -449,23 +457,23 @@ The destination directory ``dir`` must exist. **NOTES:** -NONE +None. **EXAMPLES:** -The following is an example of how to use ``chroot`` -and the impact it has on the environment for subsequent -command invocations: +The following is an example of how to use ``chroot`` and the impact it has on +the environment for subsequent command invocations: + .. code:: c - SHLL \[/] $ cat passwd + SHLL [/] $ cat passwd cat: passwd: No such file or directory - SHLL \[/] $ chroot etc - SHLL \[/] $ cat passwd - root:\*:0:0:root::/:/bin/sh - rtems:\*:1:1:RTEMS Application::/:/bin/sh + SHLL [/] $ chroot etc + SHLL [/] $ cat passwd + root:*:0:0:root::/:/bin/sh + rtems:*:1:1:RTEMS Application::/:/bin/sh tty:!:2:2:tty owner::/:/bin/false - SHLL \[/] $ cat /etc/passwd + SHLL [/] $ cat /etc/passwd cat: /etc/passwd: No such file or directory **CONFIGURATION:** @@ -473,31 +481,31 @@ command invocations: .. index:: CONFIGURE_SHELL_NO_COMMAND_CHROOT .. index:: CONFIGURE_SHELL_COMMAND_CHROOT -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CHROOT`` to have this -command included. Additional to that you have to add one -POSIX key value pair for each thread where you want to use -the command. +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_CHROOT`` to have this +command included. Additional to that you have to add one POSIX key value pair +for each thread where you want to use the command. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_CHROOT`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_CHROOT`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_chroot -The ``chroot`` is implemented by a C language function -which has the following prototype: +The ``chroot`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_chroot( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``chroot`` has the -following prototype: +The configuration structure for the ``chroot`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_CHROOT_Command; @@ -508,10 +516,10 @@ cp - copy files **SYNOPSYS:** -.. code:: c +.. code:: shell - cp \[-R \[-H | -L | -P]] \[-f | -i] \[-pv] src target - cp \[-R \[-H | -L] ] \[-f | -i] \[-NpPv] source_file ... target_directory + cp [-R [-H | -L | -P]] [-f | -i] [-pv] src target + cp [-R [-H | -L] ] [-f | -i] [-NpPv] source_file ... target_directory **DESCRIPTION:** @@ -604,18 +612,19 @@ NONE **EXAMPLES:** -The following is an example of how to use ``cp`` to -copy a file to a new name in the current directory: -.. code:: c +The following is an example of how to use ``cp`` to copy a file to a new name +in the current directory: + +.. code:: shell - SHLL \[/] # cat joel + SHLL [/] # cat joel cat: joel: No such file or directory - SHLL \[/] # cp etc/passwd joel - SHLL \[/] # cat joel - root:\*:0:0:root::/:/bin/sh - rtems:\*:1:1:RTEMS Application::/:/bin/sh + SHLL [/] # cp etc/passwd joel + SHLL [/] # cat joel + root:*:0:0:root::/:/bin/sh + rtems:*:1:1:RTEMS Application::/:/bin/sh tty:!:2:2:tty owner::/:/bin/false - SHLL \[/] # ls + 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/ -rw-r--r-- 1 root root 102 Jan 01 00:00 joel @@ -624,34 +633,34 @@ copy a file to a new name in the current directory: The following is an example of how to use ``cp`` to copy one or more files to a destination directory and use the same ``basename`` in the destination directory: -.. code:: c - SHLL \[/] # mkdir tmp - SHLL \[/] # ls tmp +.. code:: shell + + SHLL [/] # mkdir tmp + SHLL [/] # ls tmp 0 files 0 bytes occupied - SHLL \[/] # cp /etc/passwd tmp - SHLL \[/] # ls /tmp + SHLL [/] # cp /etc/passwd tmp + SHLL [/] # ls /tmp -rw-r--r-- 1 root root 102 Jan 01 00:01 passwd 1 files 102 bytes occupied - SHLL \[/] # cp /etc/passwd /etc/group /tmp - SHLL \[/] # ls /tmp + SHLL [/] # cp /etc/passwd /etc/group /tmp + SHLL [/] # ls /tmp -rw-r--r-- 1 root root 102 Jan 01 00:01 passwd -rw-r--r-- 1 root root 42 Jan 01 00:01 group 2 files 144 bytes occupied - SHLL \[/] # + SHLL [/] # **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_CP .. index:: CONFIGURE_SHELL_COMMAND_CP -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CP`` to have this -command included. +This command is included in the default shell command set. When building a +custom command set, define``CONFIGURE_SHELL_COMMAND_CP`` to have this command +included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_CP`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_CP`` when all shell commands have been configured. **PROGRAMMING INFORMATION:** @@ -659,23 +668,24 @@ shell commands have been configured. The ``cp`` command is implemented by a C language function which has the following prototype: + .. code:: c int rtems_shell_main_cp( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``cp`` has the -following prototype: +The configuration structure for the ``cp`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_CP_Command; **ORIGIN:** -The implementation and portions of the documentation for this -command are from NetBSD 4.0. +The implementation and portions of the documentation for this command are from +NetBSD 4.0. dd - convert and copy a file ---------------------------- @@ -683,37 +693,36 @@ dd - convert and copy a file **SYNOPSYS:** -.. code:: c +.. code:: shell - dd \[operands ...] + dd [operands ...] **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 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: *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. + 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. *cbs=n* - Set the conversion record size to n bytes. The conversion record size - is required by the record oriented conversion values. + Set the conversion record size to n bytes. The conversion record size is + required by the record oriented conversion values. *count=n* Copy only n input blocks. *files=n* - Copy n input files before terminating. This operand is only - applicable when the input device is a tape. + Copy n input files before terminating. This operand is only applicable + when the input device is a tape. *ibs=n* Set the input block size to n bytes instead of the default 512. @@ -725,30 +734,29 @@ The following operands are available: Set the output block size to n bytes instead of the default 512. *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. + 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. *seek=n* - Seek n blocks from the beginning of the output before copying. On - non-tape devices, a *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. + Seek n blocks from the beginning of the output before copying. On non-tape + devices, a *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. *skip=n* - Skip n blocks from the beginning of the input before copying. On - input which supports seeks, a *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. + Skip n blocks from the beginning of the input before copying. On input + which supports seeks, a *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. *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. + 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. *conv=value[,value...]* Where value is one of the symbols from the following list. @@ -758,33 +766,32 @@ The following operands are available: 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. + 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. *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. + 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. *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. + 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. *lcase* @@ -811,12 +818,12 @@ The following operands are available: *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. + 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. *sparse* @@ -847,9 +854,9 @@ The following operands are available: specified by the cbs operand. Any trailing space characters are discarded and a newline character is appended. -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: +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: *b* Block; multiply by 512 @@ -869,21 +876,18 @@ Each number may have one of the following optional suffixes: *w* Word; multiply by the number of bytes in an integer -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. +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. **EXIT STATUS:** @@ -896,36 +900,40 @@ NONE **EXAMPLES:** The following is an example of how to use ``dd``: -.. code:: c - SHLL \[/] $ dd if=/nfs/boot-image of=/dev/hda1 +.. code:: shell + + SHLL [/] $ dd if=/nfs/boot-image of=/dev/hda1 **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_DD .. index:: CONFIGURE_SHELL_COMMAND_DD -This command is included in the default shell command set. When -building a custom command set, define``CONFIGURE_SHELL_COMMAND_DD`` to have this command included. +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_DD`` to have this command +included. -This command can be excluded from the shell command set by defining``CONFIGURE_SHELL_NO_COMMAND_DD`` when all shell commands have been +This command can be excluded from the shell command set by +defining``CONFIGURE_SHELL_NO_COMMAND_DD`` when all shell commands have been configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_dd -The ``dd`` command is implemented by a C language function which -has the following prototype: +The ``dd`` command is implemented by a C language function which has the +following prototype: + .. code:: c int rtems_shell_rtems_main_dd( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``dd`` has the following -prototype: +The configuration structure for the ``dd`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_DD_Command; @@ -936,9 +944,9 @@ debugrfs - debug RFS file system **SYNOPSYS:** -.. code:: c +.. code:: shell - debugrfs \[-hl] path command \[options] + debugrfs [-hl] path command [options] **DESCRIPTION:** @@ -953,12 +961,12 @@ The options are: List the commands. *path* - Path to the mounted RFS file system. The file system has to be mounted - to view to use this command. + Path to the mounted RFS file system. The file system has to be mounted to + view to use this command. The commands are: -*block start \[end]* +*block start [end]* Display the contents of the blocks from start to end. *data* @@ -967,24 +975,20 @@ The commands are: *dir bno* Process the block as a directory displaying the entries. -*group start \[end]* +*group start [end]* Display the group data from the start group to the end group. -*inode \[-aef] \[start] \[end]* - - Display the inodes between start and end. If no start and end is - provides all inodes are displayed. +*inode [-aef] [start] [end]* + Display the inodes between start and end. If no start and end is provides + all inodes are displayed. *-a* - Display all inodes. That is allocated and unallocated inodes. *-e* - Search and display on inodes that have an error. *-f* - Force display of inodes, even when in error. **EXIT STATUS:** @@ -998,22 +1002,23 @@ NONE **EXAMPLES:** The following is an example of how to use ``debugrfs``: -.. code:: c - SHLL \[/] $ debugrfs /c data +.. code:: shell + + SHLL [/] $ debugrfs /c data **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_DEBUGRFS .. index:: CONFIGURE_SHELL_COMMAND_DEBUGRFS -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_DEBUGRFS`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_DEBUGRFS`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_DEBUGRFS`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_DEBUGRFS`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** @@ -1021,15 +1026,16 @@ shell commands have been configured. The ``debugrfs`` command is implemented by a C language function which has the following prototype: + .. code:: c int rtems_shell_rtems_main_debugrfs( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for ``debugrfs`` has the following -prototype: +The configuration structure for ``debugrfs`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_DEBUGRFS_Command; @@ -1040,9 +1046,9 @@ df - display file system disk space usage **SYNOPSYS:** -.. code:: c +.. code:: shell - df \[-h] \[-B block_size] + df [-h] [-B block_size] **DESCRIPTION:** @@ -1061,13 +1067,13 @@ NONE The following is an example of how to use ``df``: .. code:: c - SHLL \[/] $ df -B 4K + SHLL [/] $ df -B 4K Filesystem 4K-blocks Used Available Use% Mounted on /dev/rda 124 1 124 0% /mnt/ramdisk - SHLL \[/] $ df + SHLL [/] $ df Filesystem 1K-blocks Used Available Use% Mounted on /dev/rda 495 1 494 0% /mnt/ramdisk - SHLL \[/] $ df -h + SHLL [/] $ df -h Filesystem Size Used Available Use% Mounted on /dev/rda 495K 1K 494K 0% /mnt/ramdisk @@ -1076,29 +1082,29 @@ The following is an example of how to use ``df``: .. index:: CONFIGURE_SHELL_NO_COMMAND_DF .. index:: CONFIGURE_SHELL_COMMAND_DF -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_DF`` to have this -command included. +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_DF`` to have this command +included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_DF`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_DF`` when all shell commands have been configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_df -The ``df`` is implemented by a C language function -which has the following prototype: +The ``df`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_main_df( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``df`` has the -following prototype: +The configuration structure for the ``df`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_DF_Command; @@ -1109,15 +1115,14 @@ dir - alias for ls **SYNOPSYS:** -.. code:: c +.. code:: shell - dir \[dir] + dir [dir] **DESCRIPTION:** -This command is an alias or alternate name for the ``ls``. -See `ls - list files in the directory`_ -for more information. +This command is an alias or alternate name for the ``ls``. See `ls - list +files in the directory` for more information. **EXIT STATUS:** @@ -1130,13 +1135,14 @@ NONE **EXAMPLES:** The following is an example of how to use ``dir``: -.. code:: c - SHLL \[/] $ dir +.. code:: shell + + SHLL [/] $ dir 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 \[/] $ dir etc + SHLL [/] $ dir 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 @@ -1152,9 +1158,9 @@ This command is included in the default shell command set. When building a custom command set, define``CONFIGURE_SHELL_COMMAND_DIR`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_DIR`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_DIR`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** @@ -1162,15 +1168,16 @@ shell commands have been configured. The ``dir`` is implemented by a C language function which has the following prototype: + .. code:: c int rtems_shell_rtems_main_dir( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``dir`` has the -following prototype: +The configuration structure for the ``dir`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_DIR_Command; @@ -1181,7 +1188,7 @@ fdisk - format disk **SYNOPSYS:** -.. code:: c +.. code:: shell fdisk @@ -1190,13 +1197,13 @@ fdisk - format disk .. index:: CONFIGURE_SHELL_NO_COMMAND_FDISK .. index:: CONFIGURE_SHELL_COMMAND_FDISK -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_FDISK`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_FDISK`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_FDISK`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_FDISK`` when all shell commands have been +configured. hexdump - ascii/dec/hex/octal dump ---------------------------------- @@ -1204,28 +1211,26 @@ hexdump - ascii/dec/hex/octal dump **SYNOPSYS:** -.. code:: c +.. code:: shell - hexdump \[-bcCdovx] \[-e format_string] \[-f format_file] \[-n length] - \[-s skip] file ... + hexdump [-bcCdovx] [-e format_string] [-f format_file] [-n length] [-s skip] file ... **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 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: *-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. + 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. *-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. + followed by sixteen space-separated, three column, space-filled, characters + of input data per line. *-C* Canonical hex+ASCII display. Display the input offset in hexadecimal, @@ -1235,172 +1240,176 @@ The options are as follows: *-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. + followed by eight space-separated, five column, zero-filled, two-byte units + of input data, in unsigned decimal, per line. *-e format_string* Specify a format string to be used for displaying data. *-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. + 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. *-n length* Interpret only length bytes of input. *-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. + 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. *-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. + 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. *-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. + 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. *-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. + 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. -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. +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. *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. +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 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. +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. +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*fprintf*), with the following exceptions: +The format is required and must be surrounded by double quote (" ") marks. It +is interpreted as a fprintf-style format string (see*fprintf*), with the +following exceptions: - An asterisk (\*) may not be used as a field width or precision. -- 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). +- 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). -- The conversion characters "h", "l", "n", "p" and "q" are not - supported. +- The conversion characters "h", "l", "n", "p" and "q" are not supported. -- The single character escape sequences described in the C standard - are supported: +- The single character escape sequences described in the C standard are + supported: - NUL \\0 - <alert character> \\a - <backspace> \\b - <form-feed> \\f - <newline> \\n - <carriage return> \\r - <tab> \\t - <vertical tab> \\v + NUL \0 + <alert character> \a + <backspace> \b + <form-feed> \f + <newline> \n + <carriage return> \r + <tab> \t + <vertical tab> \v Hexdump also supports the following additional conversion strings: *_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. + 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. *_A[dox]* Identical to the _a conversion string except that it is only performed once, when all of the input data has been processed. *_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. + 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. *_p* - Output characters in the default character set. Nonprinting - characters are displayed as a single ".". + Output characters in the default character set. Nonprinting characters are + displayed as a single ".". *_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 + 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| | | | + +-----------+-----------+-----------+-----------+-----------+-----------+ The default and supported byte counts for the conversion characters are as follows: - %_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. - -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. + +----------------------+---------------------------------+ + |%_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. | + +----------------------+---------------------------------+ + +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. +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). +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. +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. +If no format strings are specified, the default display is equivalent to +specifying the -x option. **EXIT STATUS:** @@ -1413,36 +1422,40 @@ NONE **EXAMPLES:** The following is an example of how to use ``hexdump``: -.. code:: c - SHLL \[/] $ hexdump -C -n 512 /dev/hda1 +.. code:: shell + + SHLL [/] $ hexdump -C -n 512 /dev/hda1 **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_HEXDUMP .. index:: CONFIGURE_SHELL_COMMAND_HEXDUMP -This command is included in the default shell command set. When -building a custom command set, define``CONFIGURE_SHELL_COMMAND_HEXDUMP`` to have this command included. +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_HEXDUMP`` to have this +command included. -This command can be excluded from the shell command set by defining``CONFIGURE_SHELL_NO_COMMAND_HEXDUMP`` when all shell commands have +This command can be excluded from the shell command set by +defining``CONFIGURE_SHELL_NO_COMMAND_HEXDUMP`` when all shell commands have been configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_hexdump -The ``hexdump`` command is implemented by a C language function -which has the following prototype: +The ``hexdump`` command is implemented by a C language function which has the +following prototype: + .. code:: c int rtems_shell_rtems_main_hexdump( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``hexdump`` has the following -prototype: +The configuration structure for the ``hexdump`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_HEXDUMP_Command; @@ -1455,18 +1468,17 @@ ln - make links .. code:: c - ln \[-fhinsv] source_file \[target_file] - ln \[-fhinsv] source_file ... target_dir + ln [-fhinsv] source_file [target_file] + ln [-fhinsv] source_file ... target_dir **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 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: @@ -1479,11 +1491,10 @@ The options are as follows: point to a directory. *-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.) + 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.) *-n* Same as -h, for compatibility with other ln implementations. @@ -1494,30 +1505,27 @@ The options are as follows: *-v* Cause ln to be verbose, showing files as they are processed. -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 *open* operation is performed on -the link. A *stat* on a symbolic link will return the linked-to -file; an *lstat* must be done to obtain information about the link. -The *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. +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 *open* operation is performed on the link. A +*stat* on a symbolic link will return the linked-to file; an *lstat* must be +done to obtain information about the link. The *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. **EXIT STATUS:** @@ -1525,49 +1533,50 @@ The ``ln`` utility exits 0 on success, and >0 if an error occurs. **NOTES:** -NONE +None. **EXAMPLES:** -.. code:: c +.. code:: shell - SHLL \[/] ln -s /dev/console /dev/con1 + SHLL [/] ln -s /dev/console /dev/con1 **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_LN .. index:: CONFIGURE_SHELL_COMMAND_LN -This command is included in the default shell command set. When -building a custom command set, define``CONFIGURE_SHELL_COMMAND_LN`` to have this command included. +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_LN`` to have this command +included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_LN`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_LN`` when all shell commands have been configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_ln -The ``ln`` command is implemented by a C language function which -has the following prototype: +The ``ln`` command is implemented by a C language function which has the +following prototype: + .. code:: c int rtems_shell_rtems_main_ln( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``ln`` has the following -prototype: +The configuration structure for the ``ln`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_LN_Command; **ORIGIN:** -The implementation and portions of the documentation for this command -are from NetBSD 4.0. +The implementation and portions of the documentation for this command are from +NetBSD 4.0. ls - list files in the directory -------------------------------- @@ -1575,15 +1584,14 @@ ls - list files in the directory **SYNOPSYS:** -.. code:: c +.. code:: shell - ls \[dir] + ls [dir] **DESCRIPTION:** -This command displays the contents of the specified directory. If -no arguments are given, then it displays the contents of the current -working directory. +This command displays the contents of the specified directory. If no arguments +are given, then it displays the contents of the current working directory. **EXIT STATUS:** @@ -1591,26 +1599,26 @@ This command returns 0 on success and non-zero if an error is encountered. **NOTES:** -This command currently does not display information on a set of -files like the POSIX ls(1). It only displays the contents of -entire directories. +This command currently does not display information on a set of files like the +POSIX ls(1). It only displays the contents of entire directories. **EXAMPLES:** The following is an example of how to use ``ls``: -.. code:: c - SHLL \[/] $ ls +.. code:: shell + + 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 + 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 + 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 @@ -1619,29 +1627,29 @@ The following is an example of how to use ``ls``: .. index:: CONFIGURE_SHELL_NO_COMMAND_LS .. index:: CONFIGURE_SHELL_COMMAND_LS -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_LS`` to have this -command included. +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_LS`` to have this command +included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_LS`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_LS`` when all shell commands have been configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_ls -The ``ls`` is implemented by a C language function -which has the following prototype: +The ``ls`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_ls( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``ls`` has the -following prototype: +The configuration structure for the ``ls`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_LS_Command; @@ -1652,15 +1660,14 @@ md5 - compute the Md5 hash of a file or list of files **SYNOPSYS:** -.. code:: c +.. code:: shell md5 <files> **DESCRIPTION:** -This command prints the MD5 of a file. You can provide one or more -files on the command line and a hash for each file is printed in a -single line of output. +This command prints the MD5 of a file. You can provide one or more files on the +command line and a hash for each file is printed in a single line of output. **EXIT STATUS:** @@ -1668,14 +1675,15 @@ This command returns 0 on success and non-zero if an error is encountered. **NOTES:** -NONE +None. **EXAMPLES:** The following is an example of how to use ``md5``: -.. code:: c - SHLL \[/] $ md5 shell-init +.. code:: shell + + SHLL [/] $ md5 shell-init MD5 (shell-init) = 43b4d2e71b47db79eae679a2efeacf31 **CONFIGURATION:** @@ -1683,29 +1691,30 @@ The following is an example of how to use ``md5``: .. index:: CONFIGURE_SHELL_NO_COMMAND_MD5 .. index:: CONFIGURE_SHELL_COMMAND_MD5 -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_MD5`` to have this -command included. +This command is included in the default shell command set. When building a +custom command set, define``CONFIGURE_SHELL_COMMAND_MD5`` to have this command +included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_MD5`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_MD5`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_md5 -The ``df`` is implemented by a C language function -which has the following prototype: +The ``md5`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_main_md5( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``md5`` has the -following prototype: +The configuration structure for the ``md5`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_MD5_Command; @@ -1718,14 +1727,14 @@ mkdir - create a directory .. code:: c - mkdir dir \[dir1 .. dirN] + mkdir dir [dir1 .. dirN] **DESCRIPTION:** -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. +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. **EXIT STATUS:** @@ -1735,24 +1744,25 @@ This command returns 0 on success and non-zero if an error is encountered. If this command is invoked with no arguments, nothing occurs. -The user must have sufficient permissions to create the directory. -For the ``fileio`` test provided with RTEMS, this means the user -must login as ``root`` not ``rtems``. +The user must have sufficient permissions to create the directory. For the +``fileio`` test provided with RTEMS, this means the user must login as ``root`` +not ``rtems``. **EXAMPLES:** The following is an example of how to use ``mkdir``: -.. code:: c - SHLL \[/] # ls +.. code:: shell + + 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 + SHLL [/] # mkdir joel + SHLL [/] # ls joel 0 files 0 bytes occupied - SHLL \[/] # cp etc/passwd joel - SHLL \[/] # ls joel + 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 @@ -1761,29 +1771,30 @@ The following is an example of how to use ``mkdir``: .. index:: CONFIGURE_SHELL_NO_COMMAND_MKDIR .. index:: CONFIGURE_SHELL_COMMAND_MKDIR -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_MKDIR`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_MKDIR`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_MKDIR`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_MKDIR`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_mkdir -The ``mkdir`` is implemented by a C language function -which has the following prototype: +The ``mkdir`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_mkdir( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``mkdir`` has the -following prototype: +The configuration structure for the ``mkdir`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_MKDIR_Command; @@ -1794,9 +1805,9 @@ mldos - DOSFS file system format **SYNOPSYS:** -.. code:: c +.. code:: shell - mkdir \[-V label] \[-s sectors/cluster] \[-r size] \[-v] path + mkdir [-V label] [-s sectors/cluster] [-r size] [-v] path **DESCRIPTION:** @@ -1814,43 +1825,45 @@ This command returns 0 on success and non-zero if an error is encountered. **NOTES:** -NONE +None. **EXAMPLES:** The following is an example of how to use ``mkdos``: -.. code:: c - SHLL \[/] $ mkdos /dev/rda1 +.. code:: shell + + SHLL [/] $ mkdos /dev/rda1 **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_MKDOS .. index:: CONFIGURE_SHELL_COMMAND_MKDOS -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_MKDOS`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_MKDOS`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_MKDOS`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_MKDOS`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_mkdos -The ``mkdos`` is implemented by a C language function -which has the following prototype: +The ``mkdos`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_mkdos( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``mkdos`` has the -following prototype: +The configuration structure for the ``mkdos`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_MKDOS_Command; @@ -1861,21 +1874,19 @@ mknod - make device special file **SYNOPSYS:** -.. code:: c +.. code:: shell - 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 + 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 **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. +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: @@ -1883,56 +1894,55 @@ To make nodes manually, the arguments are: Replace an existing file if its type is incorrect. *-R* - Replace an existing file if its type is incorrect. Correct the - mode, user and group. + Replace an existing file if its type is incorrect. Correct the mode, user + and group. *-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. + 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. *-m mode* Specify the mode for the device node. The mode may be absolute or symbolic, see *chmod*. *-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. + 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. *name* - Device name, for example "tty" for a termios serial device or "hd" - for a disk. + Device name, for example "tty" for a termios serial device or "hd" for a + disk. *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. + 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. *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. + 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. *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. + devices the node corresponds to; for example, it may be a specific serial + port or pty. *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). + 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). *number* + A single opaque device number. Useful for netbooted computers which - require device numbers packed in a format that isn't supported by - -F. + require device numbers packed in a format that isn't supported by -F. **EXIT STATUS:** @@ -1940,49 +1950,51 @@ The ``mknod`` utility exits 0 on success, and >0 if an error occurs. **NOTES:** -NONE +None. **EXAMPLES:** -.. code:: c +.. code:: shell - SHLL \[/] mknod c 3 0 /dev/ttyS10 + SHLL [/] mknod c 3 0 /dev/ttyS10 **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_MKNOD .. index:: CONFIGURE_SHELL_COMMAND_MKNOD -This command is included in the default shell command set. When -building a custom command set, define``CONFIGURE_SHELL_COMMAND_MKNOD`` to have this command included. +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_MKNOD`` to have this +command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_MKNOD`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_MKNOD`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_mknod -The ``mknod`` command is implemented by a C language function which -has the following prototype: +The ``mknod`` command is implemented by a C language function which has the +following prototype: + .. code:: c int rtems_shell_rtems_main_mknod( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``mknod`` has the following -prototype: +The configuration structure for the ``mknod`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_MKNOD_Command; **ORIGIN:** -The implementation and portions of the documentation for this command -are from NetBSD 4.0. +The implementation and portions of the documentation for this command are from +NetBSD 4.0. mkrfs - format RFS file system ------------------------------ @@ -1990,20 +2002,19 @@ mkrfs - format RFS file system **SYNOPSYS:** -.. code:: c +.. code:: shell - mkrfs \[-vsbiIo] device + mkrfs [-vsbiIo] device **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. +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 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: @@ -2014,17 +2025,17 @@ The following options are provided: Set the block size in bytes. *-b* - The number of blocks in a group. The block count must be equal or less - than the number of bits in a block. + The number of blocks in a group. The block count must be equal or less than + the number of bits in a block. *-i* - Number of inodes in a group. The inode count must be equal or less - than the number of bits in a block. + Number of inodes in a group. The inode count must be equal or less than the + number of bits in a block. *-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. + 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. *-o* Integer percentage of the media used by inodes. The default is 1%. @@ -2038,43 +2049,45 @@ This command returns 0 on success and non-zero if an error is encountered. **NOTES:** -NONE +None. **EXAMPLES:** The following is an example of how to use ``mkrfs``: -.. code:: c - SHLL \[/] $ mkrfs /dev/fdda +.. code:: shell + + SHLL [/] $ mkrfs /dev/fdda **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_MKRFS .. index:: CONFIGURE_SHELL_COMMAND_MKRFS -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_MKRFS`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_MKRFS`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_MKRFS`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_MKRFS`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_mkrfs -The ``mkrfs`` command is implemented by a C language function which -has the following prototype: +The ``mkrfs`` command is implemented by a C language function which has the +following prototype: + .. code:: c int rtems_shell_rtems_main_mkrfs( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for ``mkrfs`` has the following -prototype: +The configuration structure for ``mkrfs`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_MKRFS_Command; @@ -2085,14 +2098,14 @@ mount - mount disk **SYNOPSYS:** -.. code:: c +.. code:: shell - mount \[-t fstype] \[-r] \[-L] device path + mount [-t fstype] [-r] [-L] device path **DESCRIPTION:** -The ``mount`` command will mount a block device to a mount point -using the specified file system. The files systems are: +The ``mount`` command will mount a block device to a mount point using the +specified file system. The files systems are: - msdos - MSDOS File System @@ -2104,11 +2117,10 @@ using the specified file system. The files systems are: - rfs - RTEMS File System -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. +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. **EXIT STATUS:** @@ -2126,22 +2138,25 @@ provided. **EXAMPLES:** Mount the Flash Disk driver to the '/fd' mount point: -.. code:: c - SHLL \[/] $ mount -t msdos /dev/flashdisk0 /fd +.. code:: shell + + SHLL [/] $ mount -t msdos /dev/flashdisk0 /fd Mount the NFS file system exported path 'bar' by host 'foo': -.. code:: c + +.. code:: shell $ mount -t nfs foo:/bar /nfs Mount the TFTP file system on '/tftp': -.. code:: c + +.. code:: shell $ mount -t tftp /tftp To access the TFTP files on server '10.10.10.10': -.. code:: c +.. code:: shell $ cat /tftp/10.10.10.10/test.txt @@ -2150,13 +2165,13 @@ To access the TFTP files on server '10.10.10.10': .. index:: CONFIGURE_SHELL_NO_COMMAND_MOUNT .. index:: CONFIGURE_SHELL_COMMAND_MOUNT -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_MOUNT`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_MOUNT`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_MOUNT`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``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 @@ -2173,6 +2188,7 @@ support for that file-system. The file-system mount command defines are: - rfs - CONFIGURE_SHELL_MOUNT_RFS An example configuration is: + .. code:: c #define CONFIGURE_SHELL_MOUNT_MSDOS @@ -2187,17 +2203,18 @@ An example configuration is: .. index:: rtems_shell_rtems_main_mount -The ``mount`` is implemented by a C language function -which has the following prototype: +The ``mount`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_mount( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``mount`` has the -following prototype: +The configuration structure for the ``mount`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_MOUNT_Command; @@ -2208,58 +2225,55 @@ mv - move files **SYNOPSYS:** -.. code:: c +.. code:: shell - mv \[-fiv] source_file target_file - mv \[-fiv] source_file... target_file + mv [-fiv] source_file target_file + mv [-fiv] source_file... target_file **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 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. +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: *-f* - Do not prompt for confirmation before overwriting the destination - path. + Do not prompt for confirmation before overwriting the destination path. *-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. + 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. *-v* Cause mv to be verbose, showing files as they are processed. -The last of any -f or -i options is the one which affects mv's -behavior. +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 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. +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. +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 *rename* call fail because source and target are on -different file systems, ``mv`` will remove the destination file, -copy the source file to the destination, and then remove the source. -The effect is roughly equivalent to: -.. code:: c +Should the *rename* call fail because source and target are on different file +systems, ``mv`` will remove the destination file, copy the source file to the +destination, and then remove the source. The effect is roughly equivalent to: + +.. code:: shell - rm -f destination_path && \\ - cp -PRp source_file destination_path && \\ + rm -f destination_path && \ + cp -PRp source_file destination_path && \ rm -rf source_file **EXIT STATUS:** @@ -2268,49 +2282,50 @@ The ``mv`` utility exits 0 on success, and >0 if an error occurs. **NOTES:** -NONE +None. **EXAMPLES:** -.. code:: c +.. code:: shell - SHLL \[/] mv /dev/console /dev/con1 + SHLL [/] mv /dev/console /dev/con1 **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_MV .. index:: CONFIGURE_SHELL_COMMAND_MV -This command is included in the default shell command set. When -building a custom command set, define``CONFIGURE_SHELL_COMMAND_MV`` to have this command included. +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_MV`` to have this command +included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_MV`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_MV`` when all shell commands have been configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_main_mv -The ``mv`` command is implemented by a C language function which -has the following prototype: +The ``mv`` command is implemented by a C language function which has the +following prototype: + .. code:: c int rtems_shell_main_mv( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``mv`` has the -following prototype: +The configuration structure for the ``mv`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_MV_Command; **ORIGIN:** -The implementation and portions of the documentation for this command -are from NetBSD 4.0. +The implementation and portions of the documentation for this command are from +NetBSD 4.0. pwd - print work directory -------------------------- @@ -2318,14 +2333,14 @@ pwd - print work directory **SYNOPSYS:** -.. code:: c +.. code:: shell pwd **DESCRIPTION:** -This command prints the fully qualified filename of the current -working directory. +This command prints the fully qualified filename of the current working +directory. **EXIT STATUS:** @@ -2333,17 +2348,18 @@ This command returns 0 on success and non-zero if an error is encountered. **NOTES:** -NONE +None. **EXAMPLES:** The following is an example of how to use ``pwd``: -.. code:: c - SHLL \[/] $ pwd +.. code:: shell + + SHLL [/] $ pwd / - SHLL \[/] $ cd dev - SHLL \[/dev] $ pwd + SHLL [/] $ cd dev + SHLL [/dev] $ pwd /dev **CONFIGURATION:** @@ -2351,29 +2367,30 @@ The following is an example of how to use ``pwd``: .. index:: CONFIGURE_SHELL_NO_COMMAND_PWD .. index:: CONFIGURE_SHELL_COMMAND_PWD -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_PWD`` to have this -command included. +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_PWD`` to have this command +included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_PWD`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_PWD`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_pwd -The ``pwd`` is implemented by a C language function -which has the following prototype: +The ``pwd`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_pwd( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``pwd`` has the -following prototype: +The configuration structure for the ``pwd`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_PWD_Command; @@ -2384,14 +2401,14 @@ rmdir - remove empty directories **SYNOPSYS:** -.. code:: c +.. code:: shell - rmdir \[dir1 .. dirN] + rmdir [dir1 .. dirN] **DESCRIPTION:** -This command removes the specified set of directories. If no -directories are provided on the command line, no actions are taken. +This command removes the specified set of directories. If no directories are +provided on the command line, no actions are taken. **EXIT STATUS:** @@ -2399,17 +2416,18 @@ This command returns 0 on success and non-zero if an error is encountered. **NOTES:** -This command is a implemented using the ``rmdir(2)`` system -call and all reasons that call may fail apply to this command. +This command is a implemented using the ``rmdir(2)`` system call and all +reasons that call may fail apply to this command. **EXAMPLES:** The following is an example of how to use ``rmdir``: -.. code:: c - SHLL \[/] # mkdir joeldir - SHLL \[/] # rmdir joeldir - SHLL \[/] # ls joeldir +.. code:: shell + + SHLL [/] # mkdir joeldir + SHLL [/] # rmdir joeldir + SHLL [/] # ls joeldir joeldir: No such file or directory. **CONFIGURATION:** @@ -2417,29 +2435,30 @@ The following is an example of how to use ``rmdir``: .. index:: CONFIGURE_SHELL_NO_COMMAND_RMDIR .. index:: CONFIGURE_SHELL_COMMAND_RMDIR -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_RMDIR`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_RMDIR`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_RMDIR`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_RMDIR`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_rmdir -The ``rmdir`` is implemented by a C language function -which has the following prototype: +The ``rmdir`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_rmdir( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``rmdir`` has the -following prototype: +The configuration structure for the ``rmdir`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_RMDIR_Command; @@ -2450,21 +2469,20 @@ rm - remove files **SYNOPSYS:** -.. code:: c +.. code:: shell - rm file1 \[file2 ... fileN] + rm file1 [file2 ... fileN] **DESCRIPTION:** This command deletes a name from the filesystem. If the specified file name was the last link to a file and there are no ``open`` file descriptor -references to that file, then it is deleted and the associated space in -the file system is made available for subsequent use. +references to that file, then it is deleted and the associated space in the +file system is made available for subsequent use. -If the filename specified was the last link to a file but there -are open file descriptor references to it, then the file will -remain in existence until the last file descriptor referencing -it is closed. +If the filename specified was the last link to a file but there are open file +descriptor references to it, then the file will remain in existence until the +last file descriptor referencing it is closed. **EXIT STATUS:** @@ -2472,20 +2490,21 @@ This command returns 0 on success and non-zero if an error is encountered. **NOTES:** -NONE +None. **EXAMPLES:** The following is an example of how to use ``rm``: + .. code:: c - SHLL \[/] # cp /etc/passwd tmpfile - SHLL \[/] # cat tmpfile - root:\*:0:0:root::/:/bin/sh - rtems:\*:1:1:RTEMS Application::/:/bin/sh + SHLL [/] # cp /etc/passwd tmpfile + SHLL [/] # cat tmpfile + root:*:0:0:root::/:/bin/sh + rtems:*:1:1:RTEMS Application::/:/bin/sh tty:!:2:2:tty owner::/:/bin/false - SHLL \[/] # rm tmpfile - SHLL \[/] # cat tmpfile + SHLL [/] # rm tmpfile + SHLL [/] # cat tmpfile cat: tmpfile: No such file or directory **CONFIGURATION:** @@ -2493,25 +2512,25 @@ The following is an example of how to use ``rm``: .. index:: CONFIGURE_SHELL_NO_COMMAND_RM .. index:: CONFIGURE_SHELL_COMMAND_RM -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_RM`` to have this -command included. +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_RM`` to have this command +included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_RM`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_RM`` when all shell commands have been configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_main_rm -The ``rm`` is implemented by a C language function -which has the following prototype: +The ``rm`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_main_rm( - int argc, - char \**argv + int argc, + char **argv ); The configuration structure for the ``rm`` has the @@ -2526,14 +2545,14 @@ umask - set file mode creation mask **SYNOPSYS:** -.. code:: c +.. code:: shell - umask \[new_umask] + umask [new_umask] **DESCRIPTION:** -This command sets the user file creation mask to ``new_umask``. The -argument ``new_umask`` may be octal, hexadecimal, or decimal. +This command sets the user file creation mask to ``new_umask``. The argument +``new_umask`` may be octal, hexadecimal, or decimal. **EXIT STATUS:** @@ -2546,13 +2565,14 @@ This command does not currently support symbolic mode masks. **EXAMPLES:** The following is an example of how to use ``umask``: -.. code:: c - SHLL \[/] $ umask +.. code:: shell + + SHLL [/] $ umask 022 - SHLL \[/] $ umask 0666 + SHLL [/] $ umask 0666 0666 - SHLL \[/] $ umask + SHLL [/] $ umask 0666 **CONFIGURATION:** @@ -2560,29 +2580,30 @@ The following is an example of how to use ``umask``: .. index:: CONFIGURE_SHELL_NO_COMMAND_UMASK .. index:: CONFIGURE_SHELL_COMMAND_UMASK -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_UMASK`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_UMASK`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_UMASK`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_UMASK`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_umask -The ``umask`` is implemented by a C language function -which has the following prototype: +The ``umask`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_umask( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``umask`` has the -following prototype: +The configuration structure for the ``umask`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_UMASK_Command; @@ -2593,7 +2614,7 @@ unmount - unmount disk **SYNOPSYS:** -.. code:: c +.. code:: shell unmount path @@ -2612,7 +2633,8 @@ TBD - Surely there must be some warnings to go here. **EXAMPLES:** The following is an example of how to use ``unmount``: -.. code:: c + +.. code:: shell EXAMPLE_TBD @@ -2621,36 +2643,30 @@ The following is an example of how to use ``unmount``: .. index:: CONFIGURE_SHELL_NO_COMMAND_UNMOUNT .. index:: CONFIGURE_SHELL_COMMAND_UNMOUNT -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_UNMOUNT`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_UNMOUNT`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_UNMOUNT`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_UNMOUNT`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_unmount -The ``unmount`` is implemented by a C language function -which has the following prototype: +The ``unmount`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_unmount( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``unmount`` has the -following prototype: +The configuration structure for the ``unmount`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_UNMOUNT_Command; - -.. COMMENT: COPYRIGHT (c) 1988-2012. - -.. COMMENT: On-Line Applications Research Corporation (OAR). - -.. COMMENT: All rights reserved. - |