Changeset 4f81ff1 in rtems-docs


Ignore:
Timestamp:
01/19/16 00:29:54 (7 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, 5, am, master
Children:
b990440
Parents:
f916fca
git-author:
Chris Johns <chrisj@…> (01/19/16 00:29:54)
git-committer:
Amar Takhar <verm@…> (05/03/16 00:51:24)
Message:

Clean up of file and directory commands.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • shell/file_and_directory.rst

    rf916fca r4f81ff1  
    6464========
    6565
    66 This section details the File and Directory Commands available.  A
    67 subsection is dedicated to each of the commands and
    68 describes the behavior and configuration of that
    69 command as well as providing an example usage.
     66This section details the File and Directory Commands available.  A subsection
     67is dedicated to each of the commands and describes the behavior and
     68configuration of that command as well as providing an example usage.
    7069
    7170blksync - sync the block driver
     
    7574**SYNOPSYS:**
    7675
    77 .. code:: c
     76.. code:: shell
    7877
    7978    blksync driver
     
    8180**DESCRIPTION:**
    8281
    83 This command XXX
     82This command issues a block driver sync call to the driver. The driver is a
     83path to a device node. The sync call will flush all pending writes in the cache
     84to the media and block until the writes have completed.
    8485
    8586**EXIT STATUS:**
     
    8990**NOTES:**
    9091
    91 NONE
     92None.
    9293
    9394**EXAMPLES:**
    9495
    9596The following is an example of how to use ``blksync``:
    96 .. code:: c
    97 
    98     EXAMPLE_TBD
     97
     98.. code:: c
     99
     100    blksync /dev/hda1
    99101
    100102**CONFIGURATION:**
     
    103105.. index:: CONFIGURE_SHELL_COMMAND_BLKSYNC
    104106
    105 This command is included in the default shell command set.
    106 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_BLKSYNC`` to have this
     107This command is included in the default shell command set.  When building a
     108custom command set, define ``CONFIGURE_SHELL_COMMAND_BLKSYNC`` to have this
    107109command included.
    108110
    109 This command can be excluded from the shell command set by
    110 defining ``CONFIGURE_SHELL_NO_COMMAND_BLKSYNC`` when all
    111 shell commands have been configured.
     111This command can be excluded from the shell command set by defining
     112``CONFIGURE_SHELL_NO_COMMAND_BLKSYNC`` when all shell commands have been
     113configured.
    112114
    113115**PROGRAMMING INFORMATION:**
     
    117119The ``blksync`` is implemented by a C language function
    118120which has the following prototype:
     121
    119122.. code:: c
    120123
    121124    int rtems_shell_rtems_main_blksync(
    122     int    argc,
    123     char \**argv
     125        int    argc,
     126        char **argv
    124127    );
    125128
    126 The configuration structure for the ``blksync`` has the
    127 following prototype:
     129The configuration structure for the ``blksync`` has the following prototype:
     130
    128131.. code:: c
    129132
     
    136139**SYNOPSYS:**
    137140
    138 .. code:: c
    139 
    140     cat file1 \[file2 .. fileN]
     141.. code:: shell
     142
     143    cat file1 [file2 .. fileN]
    141144
    142145**DESCRIPTION:**
     
    155158
    156159The following is an example of how to use ``cat``:
    157 .. code:: c
    158 
    159     SHLL \[/] # cat /etc/passwd
    160     root:\*:0:0:root::/:/bin/sh
    161     rtems:\*:1:1:RTEMS Application::/:/bin/sh
     160
     161.. code:: shell
     162
     163    SHLL [/] # cat /etc/passwd
     164    root:*:0:0:root::/:/bin/sh
     165    rtems:*:1:1:RTEMS Application::/:/bin/sh
    162166    tty:!:2:2:tty owner::/:/bin/false
    163167
     
    167171.. index:: CONFIGURE_SHELL_COMMAND_CAT
    168172
    169 This command is included in the default shell command set.
    170 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CAT`` to have this
    171 command included.
    172 
    173 This command can be excluded from the shell command set by
    174 defining ``CONFIGURE_SHELL_NO_COMMAND_CAT`` when all
    175 shell commands have been configured.
     173This command is included in the default shell command set.  When building a
     174custom command set, define ``CONFIGURE_SHELL_COMMAND_CAT`` to have this command
     175included.
     176
     177This command can be excluded from the shell command set by defining
     178``CONFIGURE_SHELL_NO_COMMAND_CAT`` when all shell commands have been
     179configured.
    176180
    177181**PROGRAMMING INFORMATION:**
     
    179183.. index:: rtems_shell_rtems_main_cat
    180184
    181 The ``cat`` is implemented by a C language function
    182 which has the following prototype:
     185The ``cat`` is implemented by a C language function which has the following
     186prototype:
     187
    183188.. code:: c
    184189
    185190    int rtems_shell_rtems_main_cat(
    186     int    argc,
    187     char \**argv
     191        int    argc,
     192        char **argv
    188193    );
    189194
    190 The configuration structure for the ``cat`` has the
    191 following prototype:
     195The configuration structure for the ``cat`` has the following prototype:
     196
    192197.. code:: c
    193198
     
    200205**SYNOPSYS:**
    201206
    202 .. code:: c
     207.. code:: shell
    203208
    204209    cd directory
     
    206211**DESCRIPTION:**
    207212
    208 This command is an alias or alternate name for the ``chdir``.
    209 See `ls - list files in the directory`_ for more information.
     213This command is an alias or alternate name for the ``chdir``.  See `ls - list
     214files in the directory` for more information.
    210215
    211216**EXIT STATUS:**
     
    215220**NOTES:**
    216221
    217 NONE
     222None.
    218223
    219224**EXAMPLES:**
    220225
    221226The following is an example of how to use ``cd``:
    222 .. code:: c
    223 
    224     SHLL \[/] $ cd etc
    225     SHLL \[/etc] $ cd /
    226     SHLL \[/] $ cd /etc
    227     SHLL \[/etc] $ pwd
     227
     228.. code:: shell
     229
     230    SHLL [/] $ cd etc
     231    SHLL [/etc] $ cd /
     232    SHLL [/] $ cd /etc
     233    SHLL [/etc] $ pwd
    228234    /etc
    229     SHLL \[/etc] $ cd /
    230     SHLL \[/] $ pwd
     235    SHLL [/etc] $ cd /
     236    SHLL [/] $ pwd
    231237    /
    232     SHLL \[/] $ cd etc
    233     SHLL \[/etc] $ cd ..
    234     SHLL \[/] $ pwd
     238    SHLL [/] $ cd etc
     239    SHLL [/etc] $ cd ..
     240    SHLL [/] $ pwd
    235241    /
    236242
     
    240246.. index:: CONFIGURE_SHELL_COMMAND_CD
    241247
    242 This command is included in the default shell command set.
    243 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CD`` to have this
    244 command included.
    245 
    246 This command can be excluded from the shell command set by
    247 defining ``CONFIGURE_SHELL_NO_COMMAND_CD`` when all
    248 shell commands have been configured.
     248This command is included in the default shell command set.  When building a
     249custom command set, define ``CONFIGURE_SHELL_COMMAND_CD`` to have this command
     250included.
     251
     252This command can be excluded from the shell command set by defining
     253``CONFIGURE_SHELL_NO_COMMAND_CD`` when all shell commands have been configured.
    249254
    250255**PROGRAMMING INFORMATION:**
     
    252257.. index:: rtems_shell_rtems_main_cd
    253258
    254 The ``cd`` is implemented by a C language function
    255 which has the following prototype:
     259The ``cd`` is implemented by a C language function which has the following
     260prototype:
     261
    256262.. code:: c
    257263
    258264    int rtems_shell_rtems_main_cd(
    259     int    argc,
    260     char \**argv
     265        int    argc,
     266        char **argv
    261267    );
    262268
    263 The configuration structure for the ``cd`` has the
    264 following prototype:
     269The configuration structure for the ``cd`` has the following prototype:
     270
    265271.. code:: c
    266272
     
    274280**SYNOPSYS:**
    275281
    276 .. code:: c
    277 
    278     chdir \[dir]
     282.. code:: shell
     283
     284    chdir [dir]
    279285
    280286**DESCRIPTION:**
    281287
    282 This command is used to change the current working directory to
    283 the specified directory.  If no arguments are given, the current
    284 working directory will be changed to ``/``.
     288This command is used to change the current working directory to the specified
     289directory.  If no arguments are given, the current working directory will be
     290changed to ``/``.
    285291
    286292**EXIT STATUS:**
     
    290296**NOTES:**
    291297
    292 NONE
     298None.
    293299
    294300**EXAMPLES:**
    295301
    296302The following is an example of how to use ``chdir``:
    297 .. code:: c
    298 
    299     SHLL \[/] $ pwd
     303
     304.. code:: shell
     305
     306    SHLL [/] $ pwd
    300307    /
    301     SHLL \[/] $ chdir etc
    302     SHLL \[/etc] $ pwd
     308    SHLL [/] $ chdir etc
     309    SHLL [/etc] $ pwd
    303310    /etc
    304311
     
    308315.. index:: CONFIGURE_SHELL_COMMAND_CHDIR
    309316
    310 This command is included in the default shell command set.
    311 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CHDIR`` to have this
     317This command is included in the default shell command set.  When building a
     318custom command set, define ``CONFIGURE_SHELL_COMMAND_CHDIR`` to have this
    312319command included.
    313320
    314 This command can be excluded from the shell command set by
    315 defining ``CONFIGURE_SHELL_NO_COMMAND_CHDIR`` when all
    316 shell commands have been configured.
     321This command can be excluded from the shell command set by defining
     322``CONFIGURE_SHELL_NO_COMMAND_CHDIR`` when all shell commands have been
     323configured.
    317324
    318325**PROGRAMMING INFORMATION:**
     
    320327.. index:: rtems_shell_rtems_main_chdir
    321328
    322 The ``chdir`` is implemented by a C language function
    323 which has the following prototype:
     329The ``chdir`` is implemented by a C language function which has the following
     330prototype:
     331
    324332.. code:: c
    325333
    326334    int rtems_shell_rtems_main_chdir(
    327     int    argc,
    328     char \**argv
     335        int    argc,
     336        char **argv
    329337    );
    330338
    331 The configuration structure for the ``chdir`` has the
    332 following prototype:
     339The configuration structure for the ``chdir`` has the following prototype:
     340
    333341.. code:: c
    334342
     
    341349**SYNOPSYS:**
    342350
    343 .. code:: c
    344 
    345     chmod permissions file1 \[file2...]
     351.. code:: shell
     352
     353    chmod permissions file1 [file2...]
    346354
    347355**DESCRIPTION:**
    348356
    349 This command changes the permissions on the files specified to the
    350 indicated ``permissions``.  The permission values are POSIX based
    351 with owner, group, and world having individual read, write, and
    352 executive permission bits.
     357This command changes the permissions on the files specified to the indicated
     358``permissions``.  The permission values are POSIX based with owner, group, and
     359world having individual read, write, and executive permission bits.
    353360
    354361**EXIT STATUS:**
     
    364371
    365372The following is an example of how to use ``chmod``:
    366 .. code:: c
    367 
    368     SHLL \[/] # cd etc
    369     SHLL \[/etc] # ls
     373
     374.. code:: shell
     375
     376    SHLL [/] # cd etc
     377    SHLL [/etc] # ls
    370378    -rw-r--r--   1   root   root         102 Jan 01 00:00 passwd
    371379    -rw-r--r--   1   root   root          42 Jan 01 00:00 group
     
    373381    -rw-r--r--   1   root   root          28 Jan 01 00:00 issue.net
    374382    4 files 202 bytes occupied
    375     SHLL \[/etc] # chmod 0777 passwd
    376     SHLL \[/etc] # ls
     383    SHLL [/etc] # chmod 0777 passwd
     384    SHLL [/etc] # ls
    377385    -rwxrwxrwx   1   root   root         102 Jan 01 00:00 passwd
    378386    -rw-r--r--   1   root   root          42 Jan 01 00:00 group
     
    380388    -rw-r--r--   1   root   root          28 Jan 01 00:00 issue.net
    381389    4 files 202 bytes occupied
    382     SHLL \[/etc] # chmod 0322 passwd
    383     SHLL \[/etc] # ls
     390    SHLL [/etc] # chmod 0322 passwd
     391    SHLL [/etc] # ls
    384392    --wx-w--w-   1 nouser   root         102 Jan 01 00:00 passwd
    385393    -rw-r--r--   1 nouser   root          42 Jan 01 00:00 group
     
    387395    -rw-r--r--   1 nouser   root          28 Jan 01 00:00 issue.net
    388396    4 files 202 bytes occupied
    389     SHLL \[/etc] # chmod 0644 passwd
    390     SHLL \[/etc] # ls
     397    SHLL [/etc] # chmod 0644 passwd
     398    SHLL [/etc] # ls
    391399    -rw-r--r--   1   root   root         102 Jan 01 00:00 passwd
    392400    -rw-r--r--   1   root   root          42 Jan 01 00:00 group
     
    400408.. index:: CONFIGURE_SHELL_COMMAND_CHMOD
    401409
    402 This command is included in the default shell command set.
    403 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CHMOD`` to have this
     410This command is included in the default shell command set.  When building a
     411custom command set, define ``CONFIGURE_SHELL_COMMAND_CHMOD`` to have this
    404412command included.
    405413
    406 This command can be excluded from the shell command set by
    407 defining ``CONFIGURE_SHELL_NO_COMMAND_CHMOD`` when all
    408 shell commands have been configured.
     414This command can be excluded from the shell command set by defining
     415``CONFIGURE_SHELL_NO_COMMAND_CHMOD`` when all shell commands have been
     416configured.
    409417
    410418**PROGRAMMING INFORMATION:**
     
    412420.. index:: rtems_shell_rtems_main_chmod
    413421
    414 The ``chmod`` is implemented by a C language function
    415 which has the following prototype:
     422The ``chmod`` is implemented by a C language function which has the following
     423prototype:
     424
    416425.. code:: c
    417426
    418427    int rtems_shell_rtems_main_chmod(
    419     int    argc,
    420     char \**argv
     428        int    argc,
     429        char **argv
    421430    );
    422431
    423 The configuration structure for the ``chmod`` has the
    424 following prototype:
     432The configuration structure for the ``chmod`` has the following prototype:
     433
    425434.. code:: c
    426435
     
    433442**SYNOPSYS:**
    434443
    435 .. code:: c
    436 
    437     chroot \[dir]
     444.. code:: shell
     445
     446    chroot [dir]
    438447
    439448**DESCRIPTION:**
    440449
    441 This command changes the root directory to ``dir`` for subsequent
    442 commands.
     450This command changes the root directory to ``dir`` for subsequent commands.
    443451
    444452**EXIT STATUS:**
     
    450458**NOTES:**
    451459
    452 NONE
     460None.
    453461
    454462**EXAMPLES:**
    455463
    456 The following is an example of how to use ``chroot``
    457 and the impact it has on the environment for subsequent
    458 command invocations:
    459 .. code:: c
    460 
    461     SHLL \[/] $ cat passwd
     464The following is an example of how to use ``chroot`` and the impact it has on
     465the environment for subsequent command invocations:
     466
     467.. code:: c
     468
     469    SHLL [/] $ cat passwd
    462470    cat: passwd: No such file or directory
    463     SHLL \[/] $ chroot etc
    464     SHLL \[/] $ cat passwd
    465     root:\*:0:0:root::/:/bin/sh
    466     rtems:\*:1:1:RTEMS Application::/:/bin/sh
     471    SHLL [/] $ chroot etc
     472    SHLL [/] $ cat passwd
     473    root:*:0:0:root::/:/bin/sh
     474    rtems:*:1:1:RTEMS Application::/:/bin/sh
    467475    tty:!:2:2:tty owner::/:/bin/false
    468     SHLL \[/] $ cat /etc/passwd
     476    SHLL [/] $ cat /etc/passwd
    469477    cat: /etc/passwd: No such file or directory
    470478
     
    474482.. index:: CONFIGURE_SHELL_COMMAND_CHROOT
    475483
    476 This command is included in the default shell command set.
    477 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CHROOT`` to have this
    478 command included. Additional to that you have to add one
    479 POSIX key value pair for each thread where you want to use
    480 the command.
    481 
    482 This command can be excluded from the shell command set by
    483 defining ``CONFIGURE_SHELL_NO_COMMAND_CHROOT`` when all
    484 shell commands have been configured.
     484This command is included in the default shell command set.  When building a
     485custom command set, define ``CONFIGURE_SHELL_COMMAND_CHROOT`` to have this
     486command included. Additional to that you have to add one POSIX key value pair
     487for each thread where you want to use the command.
     488
     489This command can be excluded from the shell command set by defining
     490``CONFIGURE_SHELL_NO_COMMAND_CHROOT`` when all shell commands have been
     491configured.
    485492
    486493**PROGRAMMING INFORMATION:**
     
    488495.. index:: rtems_shell_rtems_main_chroot
    489496
    490 The ``chroot`` is implemented by a C language function
    491 which has the following prototype:
     497The ``chroot`` is implemented by a C language function which has the following
     498prototype:
     499
    492500.. code:: c
    493501
    494502    int rtems_shell_rtems_main_chroot(
    495     int    argc,
    496     char \**argv
     503        int    argc,
     504        char **argv
    497505    );
    498506
    499 The configuration structure for the ``chroot`` has the
    500 following prototype:
     507The configuration structure for the ``chroot`` has the following prototype:
     508
    501509.. code:: c
    502510
     
    509517**SYNOPSYS:**
    510518
    511 .. code:: c
    512 
    513     cp \[-R \[-H | -L | -P]] \[-f | -i] \[-pv] src target
    514     cp \[-R \[-H | -L] ] \[-f | -i] \[-NpPv] source_file ... target_directory
     519.. code:: shell
     520
     521    cp [-R [-H | -L | -P]] [-f | -i] [-pv] src target
     522    cp [-R [-H | -L] ] [-f | -i] [-NpPv] source_file ... target_directory
    515523
    516524**DESCRIPTION:**
     
    605613**EXAMPLES:**
    606614
    607 The following is an example of how to use ``cp`` to
    608 copy a file to a new name in the current directory:
    609 .. code:: c
    610 
    611     SHLL \[/] # cat joel
     615The following is an example of how to use ``cp`` to copy a file to a new name
     616in the current directory:
     617
     618.. code:: shell
     619
     620    SHLL [/] # cat joel
    612621    cat: joel: No such file or directory
    613     SHLL \[/] # cp etc/passwd joel
    614     SHLL \[/] # cat joel
    615     root:\*:0:0:root::/:/bin/sh
    616     rtems:\*:1:1:RTEMS Application::/:/bin/sh
     622    SHLL [/] # cp etc/passwd joel
     623    SHLL [/] # cat joel
     624    root:*:0:0:root::/:/bin/sh
     625    rtems:*:1:1:RTEMS Application::/:/bin/sh
    617626    tty:!:2:2:tty owner::/:/bin/false
    618     SHLL \[/] # ls
     627    SHLL [/] # ls
    619628    drwxr-xr-x   1   root   root         536 Jan 01 00:00 dev/
    620629    drwxr-xr-x   1   root   root        1072 Jan 01 00:00 etc/
     
    625634copy one or more files to a destination directory and
    626635use the same ``basename`` in the destination directory:
    627 .. code:: c
    628 
    629     SHLL \[/] # mkdir tmp
    630     SHLL \[/] # ls tmp
     636
     637.. code:: shell
     638
     639    SHLL [/] # mkdir tmp
     640    SHLL [/] # ls tmp
    631641    0 files 0 bytes occupied
    632     SHLL \[/] # cp /etc/passwd tmp
    633     SHLL \[/] # ls /tmp
     642    SHLL [/] # cp /etc/passwd tmp
     643    SHLL [/] # ls /tmp
    634644    -rw-r--r--   1   root   root         102 Jan 01 00:01 passwd
    635645    1 files 102 bytes occupied
    636     SHLL \[/] # cp /etc/passwd /etc/group /tmp
    637     SHLL \[/] # ls /tmp
     646    SHLL [/] # cp /etc/passwd /etc/group /tmp
     647    SHLL [/] # ls /tmp
    638648    -rw-r--r--   1   root   root         102 Jan 01 00:01 passwd
    639649    -rw-r--r--   1   root   root          42 Jan 01 00:01 group
    640650    2 files 144 bytes occupied
    641     SHLL \[/] #
     651    SHLL [/] #
    642652
    643653**CONFIGURATION:**
     
    646656.. index:: CONFIGURE_SHELL_COMMAND_CP
    647657
    648 This command is included in the default shell command set.
    649 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CP`` to have this
    650 command included.
    651 
    652 This command can be excluded from the shell command set by
    653 defining ``CONFIGURE_SHELL_NO_COMMAND_CP`` when all
    654 shell commands have been configured.
     658This command is included in the default shell command set.  When building a
     659custom command set, define``CONFIGURE_SHELL_COMMAND_CP`` to have this command
     660included.
     661
     662This command can be excluded from the shell command set by defining
     663``CONFIGURE_SHELL_NO_COMMAND_CP`` when all shell commands have been configured.
    655664
    656665**PROGRAMMING INFORMATION:**
     
    660669The ``cp`` command is implemented by a C language function which
    661670has the following prototype:
     671
    662672.. code:: c
    663673
    664674    int rtems_shell_main_cp(
    665     int    argc,
    666     char \**argv
     675        int    argc,
     676        char **argv
    667677    );
    668678
    669 The configuration structure for the ``cp`` has the
    670 following prototype:
     679The configuration structure for the ``cp`` has the following prototype:
     680
    671681.. code:: c
    672682
     
    675685**ORIGIN:**
    676686
    677 The implementation and portions of the documentation for this
    678 command are from NetBSD 4.0.
     687The implementation and portions of the documentation for this command are from
     688NetBSD 4.0.
    679689
    680690dd - convert and copy a file
     
    684694**SYNOPSYS:**
    685695
    686 .. code:: c
    687 
    688     dd \[operands ...]
     696.. code:: shell
     697
     698    dd [operands ...]
    689699
    690700**DESCRIPTION:**
    691701
    692 The dd utility copies the standard input to the standard output.
    693 Input data is read and written in 512-byte blocks.  If input reads are
    694 short, input from multiple reads are aggregated to form the output
    695 block.  When finished, dd displays the number of complete and partial
    696 input and output blocks and truncated input records to the standard
    697 error output.
     702The dd utility copies the standard input to the standard output.  Input data is
     703read and written in 512-byte blocks.  If input reads are short, input from
     704multiple reads are aggregated to form the output block.  When finished, dd
     705displays the number of complete and partial input and output blocks and
     706truncated input records to the standard error output.
    698707
    699708The following operands are available:
    700709
    701710*bs=n*
    702     Set both input and output block size, superseding the ibs and obs
    703     operands.  If no conversion values other than noerror, notrunc or sync
    704     are specified, then each input block is copied to the output as a
    705     single block without any aggregation of short blocks.
     711    Set both input and output block size, superseding the ibs and obs operands.
     712    If no conversion values other than noerror, notrunc or sync are specified,
     713    then each input block is copied to the output as a single block without any
     714    aggregation of short blocks.
    706715
    707716*cbs=n*
    708     Set the conversion record size to n bytes.  The conversion record size
    709     is required by the record oriented conversion values.
     717    Set the conversion record size to n bytes.  The conversion record size is
     718    required by the record oriented conversion values.
    710719
    711720*count=n*
     
    713722
    714723*files=n*
    715     Copy n input files before terminating.  This operand is only
    716     applicable when the input device is a tape.
     724    Copy n input files before terminating.  This operand is only applicable
     725    when the input device is a tape.
    717726
    718727*ibs=n*
     
    726735
    727736*of=file*
    728     Write output to file instead of the standard output.  Any regular
    729     output file is truncated unless the notrunc conversion value is
    730     specified.  If an initial portion of the output file is skipped (see
    731     the seek operand) the output file is truncated at that point.
     737    Write output to file instead of the standard output.  Any regular output
     738    file is truncated unless the notrunc conversion value is specified.  If an
     739    initial portion of the output file is skipped (see the seek operand) the
     740    output file is truncated at that point.
    732741
    733742*seek=n*
    734     Seek n blocks from the beginning of the output before copying.  On
    735     non-tape devices, a *lseek* operation is used.  Otherwise, existing
    736     blocks are read and the data discarded.  If the seek operation is past
    737     the end of file, space from the current end of file to the specified
    738     offset is filled with blocks of NUL bytes.
     743    Seek n blocks from the beginning of the output before copying.  On non-tape
     744    devices, a *lseek* operation is used.  Otherwise, existing blocks are read
     745    and the data discarded.  If the seek operation is past the end of file,
     746    space from the current end of file to the specified offset is filled with
     747    blocks of NUL bytes.
    739748
    740749*skip=n*
    741     Skip n blocks from the beginning of the input before copying.  On
    742     input which supports seeks, a *lseek* operation is used.  Otherwise,
    743     input data is read and discarded.  For pipes, the correct number of
    744     bytes is read.  For all other devices, the correct number of blocks is
    745     read without distinguishing between a partial or complete block being
    746     read.
     750    Skip n blocks from the beginning of the input before copying.  On input
     751    which supports seeks, a *lseek* operation is used.  Otherwise, input data
     752    is read and discarded.  For pipes, the correct number of bytes is read.
     753    For all other devices, the correct number of blocks is read without
     754    distinguishing between a partial or complete block being read.
    747755
    748756*progress=n*
    749     Switch on display of progress if n is set to any non-zero value.  This
    750     will cause a "." to be printed (to the standard error output) for
    751     every n full or partial blocks written to the output file.
     757    Switch on display of progress if n is set to any non-zero value.  This will
     758    cause a "." to be printed (to the standard error output) for every n full
     759    or partial blocks written to the output file.
    752760
    753761*conv=value[,value...]*
     
    759767        from EBCDIC to ASCII before the records are converted.  (These values
    760768        imply unblock if the operand cbs is also specified.)  There are two
    761         conversion maps for ASCII.  The value ascii specifies the recom-
    762         mended one which is compatible with AT&T System V UNIX.  The value
    763         oldascii specifies the one used in historic AT&T and pre 4.3BSD-Reno
    764         systems.
     769        conversion maps for ASCII.  The value ascii specifies the recom- mended
     770        one which is compatible with AT&T System V UNIX.  The value oldascii
     771        specifies the one used in historic AT&T and pre 4.3BSD-Reno systems.
    765772
    766773    *block*
     
    768775        Treats the input as a sequence of newline or end-of-file terminated
    769776        variable length records independent of input and output block
    770         boundaries.  Any trailing newline character is discarded.  Each
    771         input record is converted to a fixed length output record where the
    772         length is specified by the cbs operand.  Input records shorter than
    773         the conversion record size are padded with spaces.  Input records
    774         longer than the conversion record size are truncated.  The number of
    775         truncated input records, if any, are reported to the standard error
    776         output at the completion of the copy.
     777        boundaries.  Any trailing newline character is discarded.  Each input
     778        record is converted to a fixed length output record where the length is
     779        specified by the cbs operand.  Input records shorter than the
     780        conversion record size are padded with spaces.  Input records longer
     781        than the conversion record size are truncated.  The number of truncated
     782        input records, if any, are reported to the standard error output at the
     783        completion of the copy.
    777784
    778785    *ebcdic, ibm, oldebcdic, oldibm*
     
    780787        The same as the block value except that characters are translated from
    781788        ASCII to EBCDIC after the records are converted.  (These values imply
    782         block if the operand cbs is also specified.)  There are four
    783         conversion maps for EBCDIC.  The value ebcdic specifies the
    784         recommended one which is compatible with AT&T System V UNIX.  The
    785         value ibm is a slightly different mapping, which is compatible with
    786         the AT&T System V UNIX ibm value.  The values oldebcdic and oldibm are
    787         maps used in historic AT&T and pre 4.3BSD-Reno systems.
     789        block if the operand cbs is also specified.)  There are four conversion
     790        maps for EBCDIC.  The value ebcdic specifies the recommended one which
     791        is compatible with AT&T System V UNIX.  The value ibm is a slightly
     792        different mapping, which is compatible with the AT&T System V UNIX ibm
     793        value.  The values oldebcdic and oldibm are maps used in historic AT&T
     794        and pre 4.3BSD-Reno systems.
    788795
    789796    *lcase*
     
    812819    *osync*
    813820
    814         Pad the final output block to the full output block size.  If the
    815         input file is not a multiple of the output block size after
    816         conversion, this conversion forces the final output block to be the
    817         same size as preceding blocks for use on devices that require
    818         regularly sized blocks to be written.  This option is incompatible
    819         with use of the bs=n block size specification.
     821        Pad the final output block to the full output block size.  If the input
     822        file is not a multiple of the output block size after conversion, this
     823        conversion forces the final output block to be the same size as
     824        preceding blocks for use on devices that require regularly sized blocks
     825        to be written.  This option is incompatible with use of the bs=n block
     826        size specification.
    820827
    821828    *sparse*
     
    848855        discarded and a newline character is appended.
    849856
    850 Where sizes are specified, a decimal number of bytes is expected.  Two
    851 or more numbers may be separated by an "x" to indicate a product.
    852 Each number may have one of the following optional suffixes:
     857Where sizes are specified, a decimal number of bytes is expected.  Two or more
     858numbers may be separated by an "x" to indicate a product.  Each number may have
     859one of the following optional suffixes:
    853860
    854861*b*
     
    870877    Word; multiply by the number of bytes in an integer
    871878
    872 When finished, dd displays the number of complete and partial input
    873 and output blocks, truncated input records and odd-length
    874 byte-swapping ritten.  Partial output blocks to tape devices are
    875 considered fatal errors.  Otherwise, the rest of the block will be
    876 written.  Partial output blocks to character devices will produce a
    877 warning message.  A truncated input block is one where a variable
    878 length record oriented conversion value was specified and the input
    879 line was too long to fit in the conversion record or was not newline
    880 terminated.
    881 
    882 Normally, data resulting from input or conversion or both are
    883 aggregated into output blocks of the specified size.  After the end of
    884 input is reached, any remaining output is written as a block.  This
    885 means that the final output block may be shorter than the output block
    886 size.
     879When finished, dd displays the number of complete and partial input and output
     880blocks, truncated input records and odd-length byte-swapping ritten.  Partial
     881output blocks to tape devices are considered fatal errors.  Otherwise, the rest
     882of the block will be written.  Partial output blocks to character devices will
     883produce a warning message.  A truncated input block is one where a variable
     884length record oriented conversion value was specified and the input line was
     885too long to fit in the conversion record or was not newline terminated.
     886
     887Normally, data resulting from input or conversion or both are aggregated into
     888output blocks of the specified size.  After the end of input is reached, any
     889remaining output is written as a block.  This means that the final output block
     890may be shorter than the output block size.
    887891
    888892**EXIT STATUS:**
     
    897901
    898902The following is an example of how to use ``dd``:
    899 .. code:: c
    900 
    901     SHLL \[/] $ dd if=/nfs/boot-image of=/dev/hda1
     903
     904.. code:: shell
     905
     906    SHLL [/] $ dd if=/nfs/boot-image of=/dev/hda1
    902907
    903908**CONFIGURATION:**
     
    906911.. index:: CONFIGURE_SHELL_COMMAND_DD
    907912
    908 This command is included in the default shell command set.  When
    909 building a custom command set, define``CONFIGURE_SHELL_COMMAND_DD`` to have this command included.
    910 
    911 This command can be excluded from the shell command set by defining``CONFIGURE_SHELL_NO_COMMAND_DD`` when all shell commands have been
     913This command is included in the default shell command set.  When building a
     914custom command set, define ``CONFIGURE_SHELL_COMMAND_DD`` to have this command
     915included.
     916
     917This command can be excluded from the shell command set by
     918defining``CONFIGURE_SHELL_NO_COMMAND_DD`` when all shell commands have been
    912919configured.
    913920
     
    916923.. index:: rtems_shell_rtems_main_dd
    917924
    918 The ``dd`` command is implemented by a C language function which
    919 has the following prototype:
     925The ``dd`` command is implemented by a C language function which has the
     926following prototype:
     927
    920928.. code:: c
    921929
    922930    int rtems_shell_rtems_main_dd(
    923     int    argc,
    924     char \**argv
     931        int    argc,
     932        char **argv
    925933    );
    926934
    927 The configuration structure for the ``dd`` has the following
    928 prototype:
     935The configuration structure for the ``dd`` has the following prototype:
     936
    929937.. code:: c
    930938
     
    937945**SYNOPSYS:**
    938946
    939 .. code:: c
    940 
    941     debugrfs \[-hl] path command \[options]
     947.. code:: shell
     948
     949    debugrfs [-hl] path command [options]
    942950
    943951**DESCRIPTION:**
     
    954962
    955963*path*
    956     Path to the mounted RFS file system. The file system has to be mounted
    957     to view to use this command.
     964    Path to the mounted RFS file system. The file system has to be mounted to
     965    view to use this command.
    958966
    959967The commands are:
    960968
    961 *block start \[end]*
     969*block start [end]*
    962970    Display the contents of the blocks from start to end.
    963971
     
    968976    Process the block as a directory displaying the entries.
    969977
    970 *group start \[end]*
     978*group start [end]*
    971979    Display the group data from the start group to the end group.
    972980
    973 *inode \[-aef] \[start] \[end]*
    974 
    975     Display the inodes between start and end. If no start and end is
    976     provides all inodes are displayed.
     981*inode [-aef] [start] [end]*
     982    Display the inodes between start and end. If no start and end is provides
     983    all inodes are displayed.
    977984
    978985    *-a*
    979 
    980986        Display all inodes. That is allocated and unallocated inodes.
    981987
    982988    *-e*
    983 
    984989        Search and display on inodes that have an error.
    985990
    986991    *-f*
    987 
    988992        Force display of inodes, even when in error.
    989993
     
    9991003
    10001004The following is an example of how to use ``debugrfs``:
    1001 .. code:: c
    1002 
    1003     SHLL \[/] $ debugrfs /c data
     1005
     1006.. code:: shell
     1007
     1008    SHLL [/] $ debugrfs /c data
    10041009
    10051010**CONFIGURATION:**
     
    10081013.. index:: CONFIGURE_SHELL_COMMAND_DEBUGRFS
    10091014
    1010 This command is included in the default shell command set.
    1011 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_DEBUGRFS`` to have this
     1015This command is included in the default shell command set.  When building a
     1016custom command set, define ``CONFIGURE_SHELL_COMMAND_DEBUGRFS`` to have this
    10121017command included.
    10131018
    1014 This command can be excluded from the shell command set by
    1015 defining ``CONFIGURE_SHELL_NO_COMMAND_DEBUGRFS`` when all
    1016 shell commands have been configured.
     1019This command can be excluded from the shell command set by defining
     1020``CONFIGURE_SHELL_NO_COMMAND_DEBUGRFS`` when all shell commands have been
     1021configured.
    10171022
    10181023**PROGRAMMING INFORMATION:**
     
    10221027The ``debugrfs`` command is implemented by a C language function which
    10231028has the following prototype:
     1029
    10241030.. code:: c
    10251031
    10261032    int rtems_shell_rtems_main_debugrfs(
    1027     int    argc,
    1028     char \**argv
     1033        int    argc,
     1034        char **argv
    10291035    );
    10301036
    1031 The configuration structure for ``debugrfs`` has the following
    1032 prototype:
     1037The configuration structure for ``debugrfs`` has the following prototype:
     1038
    10331039.. code:: c
    10341040
     
    10411047**SYNOPSYS:**
    10421048
    1043 .. code:: c
    1044 
    1045     df \[-h] \[-B block_size]
     1049.. code:: shell
     1050
     1051    df [-h] [-B block_size]
    10461052
    10471053**DESCRIPTION:**
     
    10621068.. code:: c
    10631069
    1064     SHLL \[/] $ df -B 4K
     1070    SHLL [/] $ df -B 4K
    10651071    Filesystem     4K-blocks        Used   Available       Use%     Mounted on
    10661072    /dev/rda               124         1         124         0%   /mnt/ramdisk
    1067     SHLL \[/] $ df
     1073    SHLL [/] $ df
    10681074    Filesystem     1K-blocks        Used   Available       Use%     Mounted on
    10691075    /dev/rda               495         1         494         0%   /mnt/ramdisk
    1070     SHLL \[/] $ df -h
     1076    SHLL [/] $ df -h
    10711077    Filesystem     Size             Used   Available       Use%     Mounted on
    10721078    /dev/rda              495K        1K        494K         0%   /mnt/ramdisk
     
    10771083.. index:: CONFIGURE_SHELL_COMMAND_DF
    10781084
    1079 This command is included in the default shell command set.
    1080 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_DF`` to have this
    1081 command included.
    1082 
    1083 This command can be excluded from the shell command set by
    1084 defining ``CONFIGURE_SHELL_NO_COMMAND_DF`` when all
    1085 shell commands have been configured.
     1085This command is included in the default shell command set.  When building a
     1086custom command set, define ``CONFIGURE_SHELL_COMMAND_DF`` to have this command
     1087included.
     1088
     1089This command can be excluded from the shell command set by defining
     1090``CONFIGURE_SHELL_NO_COMMAND_DF`` when all shell commands have been configured.
    10861091
    10871092**PROGRAMMING INFORMATION:**
     
    10891094.. index:: rtems_shell_rtems_main_df
    10901095
    1091 The ``df`` is implemented by a C language function
    1092 which has the following prototype:
     1096The ``df`` is implemented by a C language function which has the following
     1097prototype:
     1098
    10931099.. code:: c
    10941100
    10951101    int rtems_shell_main_df(
    1096     int argc,
    1097     char \**argv
     1102        int    argc,
     1103        char **argv
    10981104    );
    10991105
    1100 The configuration structure for the ``df`` has the
    1101 following prototype:
     1106The configuration structure for the ``df`` has the following prototype:
     1107
    11021108.. code:: c
    11031109
     
    11101116**SYNOPSYS:**
    11111117
    1112 .. code:: c
    1113 
    1114     dir \[dir]
     1118.. code:: shell
     1119
     1120    dir [dir]
    11151121
    11161122**DESCRIPTION:**
    11171123
    1118 This command is an alias or alternate name for the ``ls``.
    1119 See `ls - list files in the directory`_
    1120 for more information.
     1124This command is an alias or alternate name for the ``ls``.  See `ls - list
     1125files in the directory` for more information.
    11211126
    11221127**EXIT STATUS:**
     
    11311136
    11321137The following is an example of how to use ``dir``:
    1133 .. code:: c
    1134 
    1135     SHLL \[/] $ dir
     1138
     1139.. code:: shell
     1140
     1141    SHLL [/] $ dir
    11361142    drwxr-xr-x   1   root   root         536 Jan 01 00:00 dev/
    11371143    drwxr-xr-x   1   root   root        1072 Jan 01 00:00 etc/
    11381144    2 files 1608 bytes occupied
    1139     SHLL \[/] $ dir etc
     1145    SHLL [/] $ dir etc
    11401146    -rw-r--r--   1   root   root         102 Jan 01 00:00 passwd
    11411147    -rw-r--r--   1   root   root          42 Jan 01 00:00 group
     
    11531159command included.
    11541160
    1155 This command can be excluded from the shell command set by
    1156 defining ``CONFIGURE_SHELL_NO_COMMAND_DIR`` when all
    1157 shell commands have been configured.
     1161This command can be excluded from the shell command set by defining
     1162``CONFIGURE_SHELL_NO_COMMAND_DIR`` when all shell commands have been
     1163configured.
    11581164
    11591165**PROGRAMMING INFORMATION:**
     
    11631169The ``dir`` is implemented by a C language function
    11641170which has the following prototype:
     1171
    11651172.. code:: c
    11661173
    11671174    int rtems_shell_rtems_main_dir(
    1168     int    argc,
    1169     char \**argv
     1175        int    argc,
     1176        char **argv
    11701177    );
    11711178
    1172 The configuration structure for the ``dir`` has the
    1173 following prototype:
     1179The configuration structure for the ``dir`` has the following prototype:
     1180
    11741181.. code:: c
    11751182
     
    11821189**SYNOPSYS:**
    11831190
    1184 .. code:: c
     1191.. code:: shell
    11851192
    11861193    fdisk
     
    11911198.. index:: CONFIGURE_SHELL_COMMAND_FDISK
    11921199
    1193 This command is included in the default shell command set.
    1194 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_FDISK`` to have this
     1200This command is included in the default shell command set.  When building a
     1201custom command set, define ``CONFIGURE_SHELL_COMMAND_FDISK`` to have this
    11951202command included.
    11961203
    1197 This command can be excluded from the shell command set by
    1198 defining ``CONFIGURE_SHELL_NO_COMMAND_FDISK`` when all
    1199 shell commands have been configured.
     1204This command can be excluded from the shell command set by defining
     1205``CONFIGURE_SHELL_NO_COMMAND_FDISK`` when all shell commands have been
     1206configured.
    12001207
    12011208hexdump - ascii/dec/hex/octal dump
     
    12051212**SYNOPSYS:**
    12061213
    1207 .. code:: c
    1208 
    1209     hexdump \[-bcCdovx] \[-e format_string] \[-f format_file] \[-n length]
    1210     \[-s skip] file ...
     1214.. code:: shell
     1215
     1216    hexdump [-bcCdovx] [-e format_string] [-f format_file] [-n length] [-s skip] file ...
    12111217
    12121218**DESCRIPTION:**
    12131219
    1214 The hexdump utility is a filter which displays the specified files, or
    1215 the standard input, if no files are specified, in a user specified
    1216 format.
     1220The hexdump utility is a filter which displays the specified files, or the
     1221standard input, if no files are specified, in a user specified format.
    12171222
    12181223The options are as follows:
    12191224
    12201225*-b*
    1221     One-byte octal display.  Display the input offset in hexadecimal,
    1222     followed by sixteen space-separated, three column, zero-filled, bytes
    1223     of input data, in octal, per line.
     1226    One-byte octal display.  Display the input offset in hexadecimal, followed
     1227    by sixteen space-separated, three column, zero-filled, bytes of input data,
     1228    in octal, per line.
    12241229
    12251230*-c*
    12261231    One-byte character display.  Display the input offset in hexadecimal,
    1227     followed by sixteen space-separated, three column, space-filled,
    1228     characters of input data per line.
     1232    followed by sixteen space-separated, three column, space-filled, characters
     1233    of input data per line.
    12291234
    12301235*-C*
     
    12361241*-d*
    12371242    Two-byte decimal display.  Display the input offset in hexadecimal,
    1238     followed by eight space-separated, five column, zero-filled, two-byte
    1239     units of input data, in unsigned decimal, per line.
     1243    followed by eight space-separated, five column, zero-filled, two-byte units
     1244    of input data, in unsigned decimal, per line.
    12401245
    12411246*-e format_string*
     
    12431248
    12441249*-f format_file*
    1245     Specify a file that contains one or more newline separated format
    1246     strings.  Empty lines and lines whose first non-blank character is a
    1247     hash mark (#) are ignored.
     1250    Specify a file that contains one or more newline separated format strings.
     1251    Empty lines and lines whose first non-blank character is a hash mark (#)
     1252    are ignored.
    12481253
    12491254*-n length*
     
    12511256
    12521257*-o*
    1253     Two-byte octal display.  Display the input offset in hexadecimal,
    1254     followed by eight space-separated, six column, zerofilled, two byte
    1255     quantities of input data, in octal, per line.
     1258    Two-byte octal display.  Display the input offset in hexadecimal, followed
     1259    by eight space-separated, six column, zerofilled, two byte quantities of
     1260    input data, in octal, per line.
    12561261
    12571262*-s offset*
    1258     Skip offset bytes from the beginning of the input.  By default, offset
    1259     is interpreted as a decimal number.  With a leading 0x or 0X, offset
    1260     is interpreted as a hexadecimal number, otherwise, with a leading 0,
    1261     offset is interpreted as an octal number.  Appending the character b,
    1262     k, or m to offset causes it to be interpreted as a multiple of 512,
    1263     1024, or 1048576, respectively.
     1263    Skip offset bytes from the beginning of the input.  By default, offset is
     1264    interpreted as a decimal number.  With a leading 0x or 0X, offset is
     1265    interpreted as a hexadecimal number, otherwise, with a leading 0, offset is
     1266    interpreted as an octal number.  Appending the character b, k, or m to
     1267    offset causes it to be interpreted as a multiple of 512, 1024, or 1048576,
     1268    respectively.
    12641269
    12651270*-v*
    1266     The -v option causes hexdump to display all input data.  Without the
    1267     -v option, any number of groups of output lines, which would be
    1268     identical to the immediately preceding group of output lines (except
    1269     for the input offsets), are replaced with a line containing a single
    1270     asterisk.
     1271    The -v option causes hexdump to display all input data.  Without the -v
     1272    option, any number of groups of output lines, which would be identical to
     1273    the immediately preceding group of output lines (except for the input
     1274    offsets), are replaced with a line containing a single asterisk.
    12711275
    12721276*-x*
    1273     Two-byte hexadecimal display.  Display the input offset in
    1274     hexadecimal, followed by eight, space separated, four column,
    1275     zero-filled, two-byte quantities of input data, in hexadecimal, per
    1276     line.
    1277 
    1278 For each input file, hexdump sequentially copies the input to standard
    1279 output, transforming the data according to the format strings
    1280 specified by the -e and -f options, in the order that they were
    1281 specified.
     1277    Two-byte hexadecimal display.  Display the input offset in hexadecimal,
     1278    followed by eight, space separated, four column, zero-filled, two-byte
     1279    quantities of input data, in hexadecimal, per line.
     1280
     1281For each input file, hexdump sequentially copies the input to standard output,
     1282transforming the data according to the format strings specified by the -e and
     1283-f options, in the order that they were specified.
    12821284
    12831285*Formats*
    12841286
    1285 A format string contains any number of format units, separated by
    1286 whitespace.  A format unit contains up to three items: an iteration
    1287 count, a byte count, and a format.
    1288 
    1289 The iteration count is an optional positive integer, which defaults to
    1290 one.  Each format is applied iteration count times.
    1291 
    1292 The byte count is an optional positive integer.  If specified it
    1293 defines the number of bytes to be interpreted by each iteration of the
    1294 format.
    1295 
    1296 If an iteration count and/or a byte count is specified, a single slash
    1297 must be placed after the iteration count and/or before the byte count
    1298 to disambiguate them.  Any whitespace before or after the slash is
    1299 ignored.
    1300 
    1301 The format is required and must be surrounded by double quote (" ")
    1302 marks.  It is interpreted as a fprintf-style format string (see*fprintf*), with the following exceptions:
     1287A format string contains any number of format units, separated by whitespace.
     1288A format unit contains up to three items: an iteration count, a byte count, and
     1289a format.
     1290
     1291The iteration count is an optional positive integer, which defaults to one.
     1292Each format is applied iteration count times.
     1293
     1294The byte count is an optional positive integer.  If specified it defines the
     1295number of bytes to be interpreted by each iteration of the format.
     1296
     1297If an iteration count and/or a byte count is specified, a single slash must be
     1298placed after the iteration count and/or before the byte count to disambiguate
     1299them.  Any whitespace before or after the slash is ignored.
     1300
     1301The format is required and must be surrounded by double quote (" ") marks.  It
     1302is interpreted as a fprintf-style format string (see*fprintf*), with the
     1303following exceptions:
    13031304
    13041305- An asterisk (\*) may not be used as a field width or precision.
    13051306
    1306 - A byte count or field precision is required for each "s" con-
    1307   version character (unlike the fprintf(3) default which prints the
    1308   entire string if the precision is unspecified).
    1309 
    1310 - The conversion characters "h", "l", "n", "p" and "q" are not
    1311   supported.
    1312 
    1313 - The single character escape sequences described in the C standard
    1314   are supported:
    1315 
    1316       NUL                  \\0
    1317       <alert character>    \\a
    1318       <backspace>          \\b
    1319       <form-feed>          \\f
    1320       <newline>            \\n
    1321       <carriage return>    \\r
    1322       <tab>                \\t
    1323       <vertical tab>       \\v
     1307- A byte count or field precision is required for each "s" con- version
     1308  character (unlike the fprintf(3) default which prints the entire string if
     1309  the precision is unspecified).
     1310
     1311- The conversion characters "h", "l", "n", "p" and "q" are not supported.
     1312
     1313- The single character escape sequences described in the C standard are
     1314  supported:
     1315
     1316      NUL                  \0
     1317      <alert character>    \a
     1318      <backspace>          \b
     1319      <form-feed>          \f
     1320      <newline>            \n
     1321      <carriage return>    \r
     1322      <tab>                \t
     1323      <vertical tab>       \v
    13241324
    13251325Hexdump also supports the following additional conversion strings:
    13261326
    13271327*_a[dox]*
    1328     Display the input offset, cumulative across input files, of the next
    1329     byte to be displayed.  The appended characters d, o, and x specify the
    1330     display base as decimal, octal or hexadecimal respectively.
     1328    Display the input offset, cumulative across input files, of the next byte
     1329    to be displayed.  The appended characters d, o, and x specify the display
     1330    base as decimal, octal or hexadecimal respectively.
    13311331
    13321332*_A[dox]*
     
    13351335
    13361336*_c*
    1337     Output characters in the default character set.  Nonprinting
    1338     characters are displayed in three character, zero-padded octal, except
    1339     for those representable by standard escape notation (see above), which
    1340     are displayed as two character strings.
     1337    Output characters in the default character set.  Nonprinting characters are
     1338    displayed in three character, zero-padded octal, except for those
     1339    representable by standard escape notation (see above), which are displayed
     1340    as two character strings.
    13411341
    13421342*_p*
    1343     Output characters in the default character set.  Nonprinting
    1344     characters are displayed as a single ".".
     1343    Output characters in the default character set.  Nonprinting characters are
     1344    displayed as a single ".".
    13451345
    13461346*_u*
    1347     Output US ASCII characters, with the exception that control characters
    1348     are displayed using the following, lower-case, names.  Characters
    1349     greater than 0xff, hexadecimal, are displayed as hexadecimal
    1350     strings.
    1351     000 nul  001 soh  002 stx  003 etx  004 eot  005 enq
    1352     006 ack  007 bel  008 bs   009 ht   00A lf   00B vt
    1353     00C ff   00D cr   00E so   00F si   010 dle  011 dc1
    1354     012 dc2  013 dc3  014 dc4  015 nak  016 syn  017 etb
    1355     018 can  019 em   01A sub  01B esc  01C fs   01D gs
    1356     01E rs   01F us   07F del
     1347    Output US ASCII characters, with the exception that control characters are
     1348    displayed using the following, lower-case, names.  Characters greater than
     1349    0xff, hexadecimal, are displayed as hexadecimal strings.
     1350
     1351    +-----------+-----------+-----------+-----------+-----------+-----------+
     1352    |``000`` nul|``001`` soh|``002`` stx|``003`` etx|``004`` eot|``005`` enq|
     1353    +-----------+-----------+-----------+-----------+-----------+-----------+
     1354    |``006`` ack|``007`` bel|``008`` bs |``009`` ht |``00A`` lf |``00B`` vt |
     1355    +-----------+-----------+-----------+-----------+-----------+-----------+
     1356    |``00C`` ff |``00D`` cr |``00E`` so |``00F`` si |``010`` dle|``011`` dc1|
     1357    +-----------+-----------+-----------+-----------+-----------+-----------+
     1358    |``012`` dc2|``013`` dc3|``014`` dc4|``015`` nak|``016`` syn|``017`` etb|
     1359    +-----------+-----------+-----------+-----------+-----------+-----------+
     1360    |``018`` can|``019`` em |``01A`` sub|``01B`` esc|``01C`` fs |``01D`` gs |
     1361    +-----------+-----------+-----------+-----------+-----------+-----------+
     1362    |``01E`` rs |``01F`` us |``07F`` del|           |           |           |
     1363    +-----------+-----------+-----------+-----------+-----------+-----------+
    13571364
    13581365The default and supported byte counts for the conversion characters
    13591366are as follows:
    13601367
    1361     %_c, %_p, %_u, %c       One byte counts only.
    1362     %d, %i, %o, %u, %X, %x  Four byte default, one, two, four
    1363     and eight byte counts supported.
    1364     %E, %e, %f, %G, %g      Eight byte default, four byte
    1365     counts supported.
    1366 
    1367 The amount of data interpreted by each format string is the sum of the
    1368 data required by each format unit, which is the iteration count times
    1369 the byte count, or the iteration count times the number of bytes
    1370 required by the format if the byte count is not specified.
    1371 
    1372 The input is manipulated in "blocks", where a block is defined as
    1373 the largest amount of data specified by any format string.  Format
    1374 strings interpreting less than an input block's worth of data, whose
    1375 last format unit both interprets some number of bytes and does not
    1376 have a specified iteration count, have the iteration count incremented
    1377 until the entire input block has been processed or there is not enough
    1378 data remaining in the block to satisfy the format string.
    1379 
    1380 If, either as a result of user specification or hexdump modifying the
    1381 iteration count as described above, an iteration count is greater than
    1382 one, no trailing whitespace characters are output during the last
    1383 iteration.
     1368    +----------------------+---------------------------------+
     1369    |%_c, %_p, %_u, %c     |One byte counts only.            |
     1370    +----------------------+---------------------------------+
     1371    |%d, %i, %o, %u, %X, %x|Four byte default, one, two, four|
     1372    |                      |and eight byte counts supported. |
     1373    +----------------------+---------------------------------+
     1374    |%E, %e, %f, %G, %g    |Eight byte default, four byte    |
     1375    |                      |counts supported.                |
     1376    +----------------------+---------------------------------+
     1377
     1378The amount of data interpreted by each format string is the sum of the data
     1379required by each format unit, which is the iteration count times the byte
     1380count, or the iteration count times the number of bytes required by the format
     1381if the byte count is not specified.
     1382
     1383The input is manipulated in "blocks", where a block is defined as the largest
     1384amount of data specified by any format string.  Format strings interpreting
     1385less than an input block's worth of data, whose last format unit both
     1386interprets some number of bytes and does not have a specified iteration count,
     1387have the iteration count incremented until the entire input block has been
     1388processed or there is not enough data remaining in the block to satisfy the
     1389format string.
     1390
     1391If, either as a result of user specification or hexdump modifying the iteration
     1392count as described above, an iteration count is greater than one, no trailing
     1393whitespace characters are output during the last iteration.
    13841394
    13851395It is an error to specify a byte count as well as multiple conversion
    1386 characters or strings unless all but one of the conversion characters
    1387 or strings is _a or _A.
    1388 
    1389 If, as a result of the specification of the -n option or end-of-file
    1390 being reached, input data only partially satisfies a format string,
    1391 the input block is zero-padded sufficiently to display all available
    1392 data (i.e. any format units overlapping the end of data will display
    1393 some num- ber of the zero bytes).
    1394 
    1395 Further output by such format strings is replaced by an equivalent
    1396 number of spaces.  An equivalent number of spaces is defined as the
    1397 number of spaces output by an s conversion character with the same
    1398 field width and precision as the original conversion character or
    1399 conversion string but with any "+", " ", "#" conversion flag
    1400 characters removed, and ref- erencing a NULL string.
    1401 
    1402 If no format strings are specified, the default display is equivalent
    1403 to specifying the -x option.
     1396characters or strings unless all but one of the conversion characters or
     1397strings is _a or _A.
     1398
     1399If, as a result of the specification of the -n option or end-of-file being
     1400reached, input data only partially satisfies a format string, the input block
     1401is zero-padded sufficiently to display all available data (i.e. any format
     1402units overlapping the end of data will display some num- ber of the zero
     1403bytes).
     1404
     1405Further output by such format strings is replaced by an equivalent number of
     1406spaces.  An equivalent number of spaces is defined as the number of spaces
     1407output by an s conversion character with the same field width and precision as
     1408the original conversion character or conversion string but with any "+", " ",
     1409"#" conversion flag characters removed, and ref- erencing a NULL string.
     1410
     1411If no format strings are specified, the default display is equivalent to
     1412specifying the -x option.
    14041413
    14051414**EXIT STATUS:**
     
    14141423
    14151424The following is an example of how to use ``hexdump``:
    1416 .. code:: c
    1417 
    1418     SHLL \[/] $ hexdump -C -n 512 /dev/hda1
     1425
     1426.. code:: shell
     1427
     1428    SHLL [/] $ hexdump -C -n 512 /dev/hda1
    14191429
    14201430**CONFIGURATION:**
     
    14231433.. index:: CONFIGURE_SHELL_COMMAND_HEXDUMP
    14241434
    1425 This command is included in the default shell command set.  When
    1426 building a custom command set, define``CONFIGURE_SHELL_COMMAND_HEXDUMP`` to have this command included.
    1427 
    1428 This command can be excluded from the shell command set by defining``CONFIGURE_SHELL_NO_COMMAND_HEXDUMP`` when all shell commands have
     1435This command is included in the default shell command set.  When building a
     1436custom command set, define ``CONFIGURE_SHELL_COMMAND_HEXDUMP`` to have this
     1437command included.
     1438
     1439This command can be excluded from the shell command set by
     1440defining``CONFIGURE_SHELL_NO_COMMAND_HEXDUMP`` when all shell commands have
    14291441been configured.
    14301442
     
    14331445.. index:: rtems_shell_rtems_main_hexdump
    14341446
    1435 The ``hexdump`` command is implemented by a C language function
    1436 which has the following prototype:
     1447The ``hexdump`` command is implemented by a C language function which has the
     1448following prototype:
     1449
    14371450.. code:: c
    14381451
    14391452    int rtems_shell_rtems_main_hexdump(
    1440     int    argc,
    1441     char \**argv
     1453        int    argc,
     1454        char **argv
    14421455    );
    14431456
    1444 The configuration structure for the ``hexdump`` has the following
    1445 prototype:
     1457The configuration structure for the ``hexdump`` has the following prototype:
     1458
    14461459.. code:: c
    14471460
     
    14561469.. code:: c
    14571470
    1458     ln \[-fhinsv] source_file \[target_file]
    1459     ln \[-fhinsv] source_file ... target_dir
     1471    ln [-fhinsv] source_file [target_file]
     1472    ln [-fhinsv] source_file ... target_dir
    14601473
    14611474**DESCRIPTION:**
    14621475
    1463 The ln utility creates a new directory entry (linked file) which has
    1464 the same modes as the original file.  It is useful for maintaining
    1465 multiple copies of a file in many places at once without using up
    1466 storage for the "copies"; instead, a link "points" to the original
    1467 copy.  There are two types of links; hard links and symbolic links.
    1468 How a link "points" to a file is one of the differences between a
    1469 hard or symbolic link.
     1476The ln utility creates a new directory entry (linked file) which has the same
     1477modes as the original file.  It is useful for maintaining multiple copies of a
     1478file in many places at once without using up storage for the "copies"; instead,
     1479a link "points" to the original copy.  There are two types of links; hard links
     1480and symbolic links.  How a link "points" to a file is one of the differences
     1481between a hard or symbolic link.
    14701482
    14711483The options are as follows:
     
    14801492
    14811493*-i*
    1482     Cause ln to write a prompt to standard error if the target file
    1483     exists.  If the response from the standard input begins with the
    1484     character 'y' or 'Y', then unlink the target file so that the link may
    1485     occur.  Otherwise, do not attempt the link.  (The -i option overrides
    1486     any previous -f options.)
     1494    Cause ln to write a prompt to standard error if the target file exists.  If
     1495    the response from the standard input begins with the character 'y' or 'Y',
     1496    then unlink the target file so that the link may occur.  Otherwise, do not
     1497    attempt the link.  (The -i option overrides any previous -f options.)
    14871498
    14881499*-n*
     
    14951506    Cause ln to be verbose, showing files as they are processed.
    14961507
    1497 By default ln makes hard links.  A hard link to a file is
    1498 indistinguishable from the original directory entry; any changes to a
    1499 file are effective independent of the name used to reference the file.
    1500 Hard links may not normally refer to directories and may not span file
    1501 systems.
    1502 
    1503 A symbolic link contains the name of the file to which it is linked.
    1504 The referenced file is used when an *open* operation is performed on
    1505 the link.  A *stat* on a symbolic link will return the linked-to
    1506 file; an *lstat* must be done to obtain information about the link.
    1507 The *readlink* call may be used to read the contents of a symbolic
    1508 link.  Symbolic links may span file systems and may refer to
    1509 directories.
    1510 
    1511 Given one or two arguments, ln creates a link to an existing file
    1512 source_file.  If target_file is given, the link has that name;
    1513 target_file may also be a directory in which to place the link;
    1514 otherwise it is placed in the current directory.  If only the
    1515 directory is specified, the link will be made to the last component of
    1516 source_file.
    1517 
    1518 Given more than two arguments, ln makes links in target_dir to all the
    1519 named source files.  The links made will have the same name as the
    1520 files being linked to.
     1508By default ln makes hard links.  A hard link to a file is indistinguishable
     1509from the original directory entry; any changes to a file are effective
     1510independent of the name used to reference the file.  Hard links may not
     1511normally refer to directories and may not span file systems.
     1512
     1513A symbolic link contains the name of the file to which it is linked.  The
     1514referenced file is used when an *open* operation is performed on the link.  A
     1515*stat* on a symbolic link will return the linked-to file; an *lstat* must be
     1516done to obtain information about the link.  The *readlink* call may be used to
     1517read the contents of a symbolic link.  Symbolic links may span file systems and
     1518may refer to directories.
     1519
     1520Given one or two arguments, ln creates a link to an existing file source_file.
     1521If target_file is given, the link has that name; target_file may also be a
     1522directory in which to place the link; otherwise it is placed in the current
     1523directory.  If only the directory is specified, the link will be made to the
     1524last component of source_file.
     1525
     1526Given more than two arguments, ln makes links in target_dir to all the named
     1527source files.  The links made will have the same name as the files being linked
     1528to.
    15211529
    15221530**EXIT STATUS:**
     
    15261534**NOTES:**
    15271535
    1528 NONE
     1536None.
    15291537
    15301538**EXAMPLES:**
    15311539
    1532 .. code:: c
    1533 
    1534     SHLL \[/] ln -s /dev/console /dev/con1
     1540.. code:: shell
     1541
     1542    SHLL [/] ln -s /dev/console /dev/con1
    15351543
    15361544**CONFIGURATION:**
     
    15391547.. index:: CONFIGURE_SHELL_COMMAND_LN
    15401548
    1541 This command is included in the default shell command set.  When
    1542 building a custom command set, define``CONFIGURE_SHELL_COMMAND_LN`` to have this command included.
    1543 
    1544 This command can be excluded from the shell command set by
    1545 defining ``CONFIGURE_SHELL_NO_COMMAND_LN`` when all
    1546 shell commands have been configured.
     1549This command is included in the default shell command set.  When building a
     1550custom command set, define ``CONFIGURE_SHELL_COMMAND_LN`` to have this command
     1551included.
     1552
     1553This command can be excluded from the shell command set by defining
     1554``CONFIGURE_SHELL_NO_COMMAND_LN`` when all shell commands have been configured.
    15471555
    15481556**PROGRAMMING INFORMATION:**
     
    15501558.. index:: rtems_shell_rtems_main_ln
    15511559
    1552 The ``ln`` command is implemented by a C language function which
    1553 has the following prototype:
     1560The ``ln`` command is implemented by a C language function which has the
     1561following prototype:
     1562
    15541563.. code:: c
    15551564
    15561565    int rtems_shell_rtems_main_ln(
    1557     int    argc,
    1558     char \**argv
     1566        int    argc,
     1567        char **argv
    15591568    );
    15601569
    1561 The configuration structure for the ``ln`` has the following
    1562 prototype:
     1570The configuration structure for the ``ln`` has the following prototype:
     1571
    15631572.. code:: c
    15641573
     
    15671576**ORIGIN:**
    15681577
    1569 The implementation and portions of the documentation for this command
    1570 are from NetBSD 4.0.
     1578The implementation and portions of the documentation for this command are from
     1579NetBSD 4.0.
    15711580
    15721581ls - list files in the directory
     
    15761585**SYNOPSYS:**
    15771586
    1578 .. code:: c
    1579 
    1580     ls \[dir]
     1587.. code:: shell
     1588
     1589    ls [dir]
    15811590
    15821591**DESCRIPTION:**
    15831592
    1584 This command displays the contents of the specified directory.  If
    1585 no arguments are given, then it displays the contents of the current
    1586 working directory.
     1593This command displays the contents of the specified directory.  If no arguments
     1594are given, then it displays the contents of the current working directory.
    15871595
    15881596**EXIT STATUS:**
     
    15921600**NOTES:**
    15931601
    1594 This command currently does not display information on a set of
    1595 files like the POSIX ls(1).  It only displays the contents of
    1596 entire directories.
     1602This command currently does not display information on a set of files like the
     1603POSIX ls(1).  It only displays the contents of entire directories.
    15971604
    15981605**EXAMPLES:**
    15991606
    16001607The following is an example of how to use ``ls``:
    1601 .. code:: c
    1602 
    1603     SHLL \[/] $ ls
     1608
     1609.. code:: shell
     1610
     1611    SHLL [/] $ ls
    16041612    drwxr-xr-x   1   root   root         536 Jan 01 00:00 dev/
    16051613    drwxr-xr-x   1   root   root        1072 Jan 01 00:00 etc/
    16061614    2 files 1608 bytes occupied
    1607     SHLL \[/] $ ls etc
     1615    SHLL [/] $ ls etc
    16081616    -rw-r--r--   1   root   root         102 Jan 01 00:00 passwd
    16091617    -rw-r--r--   1   root   root          42 Jan 01 00:00 group
     
    16111619    -rw-r--r--   1   root   root          28 Jan 01 00:00 issue.net
    16121620    4 files 202 bytes occupied
    1613     SHLL \[/] $ ls dev etc
     1621    SHLL [/] $ ls dev etc
    16141622    -rwxr-xr-x   1  rtems   root           0 Jan 01 00:00 console
    16151623    -rwxr-xr-x   1   root   root           0 Jan 01 00:00 console_b
     
    16201628.. index:: CONFIGURE_SHELL_COMMAND_LS
    16211629
    1622 This command is included in the default shell command set.
    1623 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_LS`` to have this
    1624 command included.
    1625 
    1626 This command can be excluded from the shell command set by
    1627 defining ``CONFIGURE_SHELL_NO_COMMAND_LS`` when all
    1628 shell commands have been configured.
     1630This command is included in the default shell command set.  When building a
     1631custom command set, define ``CONFIGURE_SHELL_COMMAND_LS`` to have this command
     1632included.
     1633
     1634This command can be excluded from the shell command set by defining
     1635``CONFIGURE_SHELL_NO_COMMAND_LS`` when all shell commands have been configured.
    16291636
    16301637**PROGRAMMING INFORMATION:**
     
    16321639.. index:: rtems_shell_rtems_main_ls
    16331640
    1634 The ``ls`` is implemented by a C language function
    1635 which has the following prototype:
     1641The ``ls`` is implemented by a C language function which has the following
     1642prototype:
     1643
    16361644.. code:: c
    16371645
    16381646    int rtems_shell_rtems_main_ls(
    1639     int    argc,
    1640     char \**argv
     1647        int    argc,
     1648        char **argv
    16411649    );
    16421650
    1643 The configuration structure for the ``ls`` has the
    1644 following prototype:
     1651The configuration structure for the ``ls`` has the following prototype:
     1652
    16451653.. code:: c
    16461654
     
    16531661**SYNOPSYS:**
    16541662
    1655 .. code:: c
     1663.. code:: shell
    16561664
    16571665    md5 <files>
     
    16591667**DESCRIPTION:**
    16601668
    1661 This command prints the MD5 of a file. You can provide one or more
    1662 files on the command line and a hash for each file is printed in a
    1663 single line of output.
     1669This command prints the MD5 of a file. You can provide one or more files on the
     1670command line and a hash for each file is printed in a single line of output.
    16641671
    16651672**EXIT STATUS:**
     
    16691676**NOTES:**
    16701677
    1671 NONE
     1678None.
    16721679
    16731680**EXAMPLES:**
    16741681
    16751682The following is an example of how to use ``md5``:
    1676 .. code:: c
    1677 
    1678     SHLL \[/] $ md5 shell-init
     1683
     1684.. code:: shell
     1685
     1686    SHLL [/] $ md5 shell-init
    16791687    MD5 (shell-init) = 43b4d2e71b47db79eae679a2efeacf31
    16801688
     
    16841692.. index:: CONFIGURE_SHELL_COMMAND_MD5
    16851693
    1686 This command is included in the default shell command set.
    1687 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_MD5`` to have this
    1688 command included.
    1689 
    1690 This command can be excluded from the shell command set by
    1691 defining ``CONFIGURE_SHELL_NO_COMMAND_MD5`` when all
    1692 shell commands have been configured.
     1694This command is included in the default shell command set.  When building a
     1695custom command set, define``CONFIGURE_SHELL_COMMAND_MD5`` to have this command
     1696included.
     1697
     1698This command can be excluded from the shell command set by defining
     1699``CONFIGURE_SHELL_NO_COMMAND_MD5`` when all shell commands have been
     1700configured.
    16931701
    16941702**PROGRAMMING INFORMATION:**
     
    16961704.. index:: rtems_shell_rtems_main_md5
    16971705
    1698 The ``df`` is implemented by a C language function
    1699 which has the following prototype:
     1706The ``md5`` is implemented by a C language function which has the following
     1707prototype:
     1708
    17001709.. code:: c
    17011710
    17021711    int rtems_shell_main_md5(
    1703     int argc,
    1704     char \**argv
     1712        int    argc,
     1713        char **argv
    17051714    );
    17061715
    1707 The configuration structure for the ``md5`` has the
    1708 following prototype:
     1716The configuration structure for the ``md5`` has the following prototype:
     1717
    17091718.. code:: c
    17101719
     
    17191728.. code:: c
    17201729
    1721     mkdir  dir \[dir1 .. dirN]
     1730    mkdir  dir [dir1 .. dirN]
    17221731
    17231732**DESCRIPTION:**
    17241733
    1725 This command creates the set of directories in the order they
    1726 are specified on the command line.  If an error is encountered
    1727 making one of the directories, the command will continue to
    1728 attempt to create the remaining directories on the command line.
     1734This command creates the set of directories in the order they are specified on
     1735the command line.  If an error is encountered making one of the directories,
     1736the command will continue to attempt to create the remaining directories on the
     1737command line.
    17291738
    17301739**EXIT STATUS:**
     
    17361745If this command is invoked with no arguments, nothing occurs.
    17371746
    1738 The user must have sufficient permissions to create the directory.
    1739 For the ``fileio`` test provided with RTEMS, this means the user
    1740 must login as ``root`` not ``rtems``.
     1747The user must have sufficient permissions to create the directory.  For the
     1748``fileio`` test provided with RTEMS, this means the user must login as ``root``
     1749not ``rtems``.
    17411750
    17421751**EXAMPLES:**
    17431752
    17441753The following is an example of how to use ``mkdir``:
    1745 .. code:: c
    1746 
    1747     SHLL \[/] # ls
     1754
     1755.. code:: shell
     1756
     1757    SHLL [/] # ls
    17481758    drwxr-xr-x   1   root   root         536 Jan 01 00:00 dev/
    17491759    drwxr-xr-x   1   root   root        1072 Jan 01 00:00 etc/
    17501760    2 files 1608 bytes occupied
    1751     SHLL \[/] # mkdir joel
    1752     SHLL \[/] # ls joel
     1761    SHLL [/] # mkdir joel
     1762    SHLL [/] # ls joel
    17531763    0 files 0 bytes occupied
    1754     SHLL \[/] # cp etc/passwd joel
    1755     SHLL \[/] # ls joel
     1764    SHLL [/] # cp etc/passwd joel
     1765    SHLL [/] # ls joel
    17561766    -rw-r--r--   1   root   root         102 Jan 01 00:02 passwd
    17571767    1 files 102 bytes occupied
     
    17621772.. index:: CONFIGURE_SHELL_COMMAND_MKDIR
    17631773
    1764 This command is included in the default shell command set.
    1765 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_MKDIR`` to have this
     1774This command is included in the default shell command set.  When building a
     1775custom command set, define ``CONFIGURE_SHELL_COMMAND_MKDIR`` to have this
    17661776command included.
    17671777
    1768 This command can be excluded from the shell command set by
    1769 defining ``CONFIGURE_SHELL_NO_COMMAND_MKDIR`` when all
    1770 shell commands have been configured.
     1778This command can be excluded from the shell command set by defining
     1779``CONFIGURE_SHELL_NO_COMMAND_MKDIR`` when all shell commands have been
     1780configured.
    17711781
    17721782**PROGRAMMING INFORMATION:**
     
    17741784.. index:: rtems_shell_rtems_main_mkdir
    17751785
    1776 The ``mkdir`` is implemented by a C language function
    1777 which has the following prototype:
     1786The ``mkdir`` is implemented by a C language function which has the following
     1787prototype:
     1788
    17781789.. code:: c
    17791790
    17801791    int rtems_shell_rtems_main_mkdir(
    1781     int    argc,
    1782     char \**argv
     1792        int    argc,
     1793        char **argv
    17831794    );
    17841795
    1785 The configuration structure for the ``mkdir`` has the
    1786 following prototype:
     1796The configuration structure for the ``mkdir`` has the following prototype:
     1797
    17871798.. code:: c
    17881799
     
    17951806**SYNOPSYS:**
    17961807
    1797 .. code:: c
    1798 
    1799     mkdir \[-V label] \[-s sectors/cluster] \[-r size] \[-v] path
     1808.. code:: shell
     1809
     1810    mkdir [-V label] [-s sectors/cluster] [-r size] [-v] path
    18001811
    18011812**DESCRIPTION:**
     
    18151826**NOTES:**
    18161827
    1817 NONE
     1828None.
    18181829
    18191830**EXAMPLES:**
    18201831
    18211832The following is an example of how to use ``mkdos``:
    1822 .. code:: c
    1823 
    1824     SHLL \[/] $ mkdos /dev/rda1
     1833
     1834.. code:: shell
     1835
     1836    SHLL [/] $ mkdos /dev/rda1
    18251837
    18261838**CONFIGURATION:**
     
    18291841.. index:: CONFIGURE_SHELL_COMMAND_MKDOS
    18301842
    1831 This command is included in the default shell command set.
    1832 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_MKDOS`` to have this
     1843This command is included in the default shell command set.  When building a
     1844custom command set, define ``CONFIGURE_SHELL_COMMAND_MKDOS`` to have this
    18331845command included.
    18341846
    1835 This command can be excluded from the shell command set by
    1836 defining ``CONFIGURE_SHELL_NO_COMMAND_MKDOS`` when all
    1837 shell commands have been configured.
     1847This command can be excluded from the shell command set by defining
     1848``CONFIGURE_SHELL_NO_COMMAND_MKDOS`` when all shell commands have been
     1849configured.
    18381850
    18391851**PROGRAMMING INFORMATION:**
     
    18411853.. index:: rtems_shell_rtems_main_mkdos
    18421854
    1843 The ``mkdos`` is implemented by a C language function
    1844 which has the following prototype:
     1855The ``mkdos`` is implemented by a C language function which has the following
     1856prototype:
     1857
    18451858.. code:: c
    18461859
    18471860    int rtems_shell_rtems_main_mkdos(
    1848     int    argc,
    1849     char \**argv
     1861        int    argc,
     1862        char **argv
    18501863    );
    18511864
    1852 The configuration structure for the ``mkdos`` has the
    1853 following prototype:
     1865The configuration structure for the ``mkdos`` has the following prototype:
     1866
    18541867.. code:: c
    18551868
     
    18621875**SYNOPSYS:**
    18631876
    1864 .. code:: c
    1865 
    1866     mknod \[-rR] \[-F fmt] \[-g gid] \[-m mode] \[-u uid] name \[c | b]
    1867     \[driver | major] minor
    1868     mknod \[-rR] \[-F fmt] \[-g gid] \[-m mode] \[-u uid] name \[c | b]
    1869     major unit subunit
    1870     mknod \[-rR] \[-g gid] \[-m mode] \[-u uid] name \[c | b] number
    1871     mknod \[-rR] \[-g gid] \[-m mode] \[-u uid] name p
     1877.. code:: shell
     1878
     1879    mknod [-rR] [-F fmt] [-g gid] [-m mode] [-u uid] name [c | b] [driver | major] minor
     1880    mknod [-rR] [-F fmt] [-g gid] [-m mode] [-u uid] name [c | b] major unit subunit
     1881    mknod [-rR] [-g gid] [-m mode] [-u uid] name [c | b] number
     1882    mknod [-rR] [-g gid] [-m mode] [-u uid] name p
    18721883
    18731884**DESCRIPTION:**
    18741885
    1875 The mknod command creates device special files, or fifos.  Normally
    1876 the shell script /dev/MAKEDEV is used to create special files for
    1877 commonly known devices; it executes mknod with the appropriate
    1878 arguments and can make all the files required for the device.
     1886The mknod command creates device special files, or fifos.  Normally the shell
     1887script /dev/MAKEDEV is used to create special files for commonly known devices;
     1888it executes mknod with the appropriate arguments and can make all the files
     1889required for the device.
    18791890
    18801891To make nodes manually, the arguments are:
     
    18841895
    18851896*-R*
    1886     Replace an existing file if its type is incorrect.  Correct the
    1887     mode, user and group.
     1897    Replace an existing file if its type is incorrect.  Correct the mode, user
     1898    and group.
    18881899
    18891900*-g gid*
    1890     Specify the group for the device node.  The gid operand may be a
    1891     numeric group ID or a group name.  If a group name is also a numeric
    1892     group ID, the operand is used as a group name.  Precede a numeric
    1893     group ID with a # to stop it being treated as a name.
     1901    Specify the group for the device node.  The gid operand may be a numeric
     1902    group ID or a group name.  If a group name is also a numeric group ID, the
     1903    operand is used as a group name.  Precede a numeric group ID with a # to
     1904    stop it being treated as a name.
    18941905
    18951906*-m mode*
     
    18981909
    18991910*-u uid*
    1900     Specify the user for the device node.  The uid operand may be a
    1901     numeric user ID or a user name.  If a user name is also a numeric user
    1902     ID, the operand is used as a user name.  Precede a numeric user ID
    1903     with a # to stop it being treated as a name.
     1911    Specify the user for the device node.  The uid operand may be a numeric
     1912    user ID or a user name.  If a user name is also a numeric user ID, the
     1913    operand is used as a user name.  Precede a numeric user ID with a # to stop
     1914    it being treated as a name.
    19041915
    19051916*name*
    1906     Device name, for example "tty" for a termios serial device or "hd"
    1907     for a disk.
     1917    Device name, for example "tty" for a termios serial device or "hd" for a
     1918    disk.
    19081919
    19091920*b | c | p*
    1910     Type of device.  If the device is a block type device such as a tape
    1911     or disk drive which needs both cooked and raw special files, the type
    1912     is b.  All other devices are character type devices, such as terminal
    1913     and pseudo devices, and are type c.  Specifying p creates fifo files.
     1921    Type of device.  If the device is a block type device such as a tape or
     1922    disk drive which needs both cooked and raw special files, the type is b.
     1923    All other devices are character type devices, such as terminal and pseudo
     1924    devices, and are type c.  Specifying p creates fifo files.
    19141925
    19151926*driver | major*
    1916     The major device number is an integer number which tells the kernel
    1917     which device driver entry point to use.  If the device driver is
    1918     configured into the current kernel it may be specified by driver name
    1919     or major number.
     1927    The major device number is an integer number which tells the kernel which
     1928    device driver entry point to use.  If the device driver is configured into
     1929    the current kernel it may be specified by driver name or major number.
    19201930
    19211931*minor*
    19221932    The minor device number tells the kernel which one of several similar
    1923     devices the node corresponds to; for example, it may be a specific
    1924     serial port or pty.
     1933    devices the node corresponds to; for example, it may be a specific serial
     1934    port or pty.
    19251935
    19261936*unit and subunit*
    1927     The unit and subunit numbers select a subset of a device; for example,
    1928     the unit may specify a particular disk, and the subunit a partition on
    1929     that disk.  (Currently this form of specification is only supported
    1930     by the bsdos format, for compatibility with the BSD/OS mknod).
     1937    The unit and subunit numbers select a subset of a device; for example, the
     1938    unit may specify a particular disk, and the subunit a partition on that
     1939    disk.  (Currently this form of specification is only supported by the bsdos
     1940    format, for compatibility with the BSD/OS mknod).
    19311941
    19321942*number*
     1943
    19331944    A single opaque device number.  Useful for netbooted computers which
    1934     require device numbers packed in a format that isn't supported by
    1935     -F.
     1945    require device numbers packed in a format that isn't supported by -F.
    19361946
    19371947**EXIT STATUS:**
     
    19411951**NOTES:**
    19421952
    1943 NONE
     1953None.
    19441954
    19451955**EXAMPLES:**
    19461956
    1947 .. code:: c
    1948 
    1949     SHLL \[/] mknod c 3 0 /dev/ttyS10
     1957.. code:: shell
     1958
     1959    SHLL [/] mknod c 3 0 /dev/ttyS10
    19501960
    19511961**CONFIGURATION:**
     
    19541964.. index:: CONFIGURE_SHELL_COMMAND_MKNOD
    19551965
    1956 This command is included in the default shell command set.  When
    1957 building a custom command set, define``CONFIGURE_SHELL_COMMAND_MKNOD`` to have this command included.
    1958 
    1959 This command can be excluded from the shell command set by
    1960 defining ``CONFIGURE_SHELL_NO_COMMAND_MKNOD`` when all
    1961 shell commands have been configured.
     1966This command is included in the default shell command set.  When building a
     1967custom command set, define ``CONFIGURE_SHELL_COMMAND_MKNOD`` to have this
     1968command included.
     1969
     1970This command can be excluded from the shell command set by defining
     1971``CONFIGURE_SHELL_NO_COMMAND_MKNOD`` when all shell commands have been
     1972configured.
    19621973
    19631974**PROGRAMMING INFORMATION:**
     
    19651976.. index:: rtems_shell_rtems_main_mknod
    19661977
    1967 The ``mknod`` command is implemented by a C language function which
    1968 has the following prototype:
     1978The ``mknod`` command is implemented by a C language function which has the
     1979following prototype:
     1980
    19691981.. code:: c
    19701982
    19711983    int rtems_shell_rtems_main_mknod(
    1972     int    argc,
    1973     char \**argv
     1984        int    argc,
     1985        char **argv
    19741986    );
    19751987
    1976 The configuration structure for the ``mknod`` has the following
    1977 prototype:
     1988The configuration structure for the ``mknod`` has the following prototype:
     1989
    19781990.. code:: c
    19791991
     
    19821994**ORIGIN:**
    19831995
    1984 The implementation and portions of the documentation for this command
    1985 are from NetBSD 4.0.
     1996The implementation and portions of the documentation for this command are from
     1997NetBSD 4.0.
    19861998
    19871999mkrfs - format RFS file system
     
    19912003**SYNOPSYS:**
    19922004
    1993 .. code:: c
    1994 
    1995     mkrfs \[-vsbiIo] device
     2005.. code:: shell
     2006
     2007    mkrfs [-vsbiIo] device
    19962008
    19972009**DESCRIPTION:**
    19982010
    19992011Format the block device with the RTEMS File System (RFS). The default
    2000 configuration with not parameters selects a suitable block size based
    2001 on the size of the media being formatted.
    2002 
    2003 The media is broken up into groups of blocks. The number of blocks in
    2004 a group is based on the number of bits a block contains. The large a
    2005 block the more blocks a group contains and the fewer groups in the
    2006 file system.
     2012configuration with not parameters selects a suitable block size based on the
     2013size of the media being formatted.
     2014
     2015The media is broken up into groups of blocks. The number of blocks in a group
     2016is based on the number of bits a block contains. The large a block the more
     2017blocks a group contains and the fewer groups in the file system.
    20072018
    20082019The following options are provided:
     
    20152026
    20162027*-b*
    2017     The number of blocks in a group. The block count must be equal or less
    2018     than the number of bits in a block.
     2028    The number of blocks in a group. The block count must be equal or less than
     2029    the number of bits in a block.
    20192030
    20202031*-i*
    2021     Number of inodes in a group. The inode count must be equal or less
    2022     than the number of bits in a block.
     2032    Number of inodes in a group. The inode count must be equal or less than the
     2033    number of bits in a block.
    20232034
    20242035*-I*
    2025     Initialise the inodes. The default is not to initialise the inodes and
    2026     to rely on the inode being initialised when allocated. Initialising
    2027     the inode table helps recovery if a problem appears.
     2036    Initialise the inodes. The default is not to initialise the inodes and to
     2037    rely on the inode being initialised when allocated. Initialising the inode
     2038    table helps recovery if a problem appears.
    20282039
    20292040*-o*
     
    20392050**NOTES:**
    20402051
    2041 NONE
     2052None.
    20422053
    20432054**EXAMPLES:**
    20442055
    20452056The following is an example of how to use ``mkrfs``:
    2046 .. code:: c
    2047 
    2048     SHLL \[/] $ mkrfs /dev/fdda
     2057
     2058.. code:: shell
     2059
     2060    SHLL [/] $ mkrfs /dev/fdda
    20492061
    20502062**CONFIGURATION:**
     
    20532065.. index:: CONFIGURE_SHELL_COMMAND_MKRFS
    20542066
    2055 This command is included in the default shell command set.
    2056 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_MKRFS`` to have this
     2067This command is included in the default shell command set.  When building a
     2068custom command set, define ``CONFIGURE_SHELL_COMMAND_MKRFS`` to have this
    20572069command included.
    20582070
    2059 This command can be excluded from the shell command set by
    2060 defining ``CONFIGURE_SHELL_NO_COMMAND_MKRFS`` when all
    2061 shell commands have been configured.
     2071This command can be excluded from the shell command set by defining
     2072``CONFIGURE_SHELL_NO_COMMAND_MKRFS`` when all shell commands have been
     2073configured.
    20622074
    20632075**PROGRAMMING INFORMATION:**
     
    20652077.. index:: rtems_shell_rtems_main_mkrfs
    20662078
    2067 The ``mkrfs`` command is implemented by a C language function which
    2068 has the following prototype:
     2079The ``mkrfs`` command is implemented by a C language function which has the
     2080following prototype:
     2081
    20692082.. code:: c
    20702083
    20712084    int rtems_shell_rtems_main_mkrfs(
    2072     int    argc,
    2073     char \**argv
     2085        int    argc,
     2086        char **argv
    20742087    );
    20752088
    2076 The configuration structure for ``mkrfs`` has the following
    2077 prototype:
     2089The configuration structure for ``mkrfs`` has the following prototype:
     2090
    20782091.. code:: c
    20792092
     
    20862099**SYNOPSYS:**
    20872100
    2088 .. code:: c
    2089 
    2090     mount \[-t fstype] \[-r] \[-L] device path
     2101.. code:: shell
     2102
     2103    mount [-t fstype] [-r] [-L] device path
    20912104
    20922105**DESCRIPTION:**
    20932106
    2094 The ``mount`` command will mount a block device to a mount point
    2095 using the specified file system. The files systems are:
     2107The ``mount`` command will mount a block device to a mount point using the
     2108specified file system. The files systems are:
    20962109
    20972110- msdos - MSDOS File System
     
    21052118- rfs   - RTEMS File System
    21062119
    2107 When the file system type is 'msdos' or 'rfs' the driver is a "block
    2108 device driver" node present in the file system. The driver is ignored
    2109 with the 'tftp' and 'ftp' file systems. For the 'nfs' file system the
    2110 driver is the 'host:/path' string that described NFS host and the
    2111 exported file system path.
     2120When the file system type is 'msdos' or 'rfs' the driver is a "block device
     2121driver" node present in the file system. The driver is ignored with the 'tftp'
     2122and 'ftp' file systems. For the 'nfs' file system the driver is the
     2123'host:/path' string that described NFS host and the exported file system path.
    21122124
    21132125**EXIT STATUS:**
     
    21272139
    21282140Mount the Flash Disk driver to the '/fd' mount point:
    2129 .. code:: c
    2130 
    2131     SHLL \[/] $ mount -t msdos /dev/flashdisk0 /fd
     2141
     2142.. code:: shell
     2143
     2144    SHLL [/] $ mount -t msdos /dev/flashdisk0 /fd
    21322145
    21332146Mount the NFS file system exported path 'bar' by host 'foo':
    2134 .. code:: c
     2147
     2148.. code:: shell
    21352149
    21362150    $ mount -t nfs foo:/bar /nfs
    21372151
    21382152Mount the TFTP file system on '/tftp':
    2139 .. code:: c
     2153
     2154.. code:: shell
    21402155
    21412156    $ mount -t tftp /tftp
    21422157
    21432158To access the TFTP files on server '10.10.10.10':
    2144 .. code:: c
     2159.. code:: shell
    21452160
    21462161    $ cat /tftp/10.10.10.10/test.txt
     
    21512166.. index:: CONFIGURE_SHELL_COMMAND_MOUNT
    21522167
    2153 This command is included in the default shell command set.
    2154 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_MOUNT`` to have this
     2168This command is included in the default shell command set.  When building a
     2169custom command set, define ``CONFIGURE_SHELL_COMMAND_MOUNT`` to have this
    21552170command included.
    21562171
    2157 This command can be excluded from the shell command set by
    2158 defining ``CONFIGURE_SHELL_NO_COMMAND_MOUNT`` when all
    2159 shell commands have been configured.
     2172This command can be excluded from the shell command set by defining
     2173``CONFIGURE_SHELL_NO_COMMAND_MOUNT`` when all shell commands have been
     2174configured.
    21602175
    21612176The mount command includes references to file-system code. If you do not wish
     
    21742189
    21752190An example configuration is:
     2191
    21762192.. code:: c
    21772193
     
    21882204.. index:: rtems_shell_rtems_main_mount
    21892205
    2190 The ``mount`` is implemented by a C language function
    2191 which has the following prototype:
     2206The ``mount`` is implemented by a C language function which has the following
     2207prototype:
     2208
    21922209.. code:: c
    21932210
    21942211    int rtems_shell_rtems_main_mount(
    2195     int    argc,
    2196     char \**argv
     2212        int    argc,
     2213        char **argv
    21972214    );
    21982215
    2199 The configuration structure for the ``mount`` has the
    2200 following prototype:
     2216The configuration structure for the ``mount`` has the following prototype:
     2217
    22012218.. code:: c
    22022219
     
    22092226**SYNOPSYS:**
    22102227
    2211 .. code:: c
    2212 
    2213     mv \[-fiv] source_file target_file
    2214     mv \[-fiv] source_file... target_file
     2228.. code:: shell
     2229
     2230    mv [-fiv] source_file target_file
     2231    mv [-fiv] source_file... target_file
    22152232
    22162233**DESCRIPTION:**
    22172234
    2218 In its first form, the mv utility renames the file named by the source
    2219 operand to the destination path named by the target operand.  This
    2220 form is assumed when the last operand does not name an already
    2221 existing directory.
     2235In its first form, the mv utility renames the file named by the source operand
     2236to the destination path named by the target operand.  This form is assumed when
     2237the last operand does not name an already existing directory.
    22222238
    22232239In its second form, mv moves each file named by a source operand to a
    2224 destination file in the existing directory named by the directory
    2225 operand.  The destination path for each operand is the pathname
    2226 produced by the concatenation of the last operand, a slash, and the
    2227 final pathname component of the named file.
     2240destination file in the existing directory named by the directory operand.  The
     2241destination path for each operand is the pathname produced by the concatenation
     2242of the last operand, a slash, and the final pathname component of the named
     2243file.
    22282244
    22292245The following options are available:
    22302246
    22312247*-f*
    2232     Do not prompt for confirmation before overwriting the destination
    2233     path.
     2248    Do not prompt for confirmation before overwriting the destination path.
    22342249
    22352250*-i*
    2236     Causes mv to write a prompt to standard error before moving a file
    2237     that would overwrite an existing file.  If the response from the
    2238     standard input begins with the character 'y', the move is attempted.
     2251    Causes mv to write a prompt to standard error before moving a file that
     2252    would overwrite an existing file.  If the response from the standard input
     2253    begins with the character 'y', the move is attempted.
    22392254
    22402255*-v*
    22412256    Cause mv to be verbose, showing files as they are processed.
    22422257
    2243 The last of any -f or -i options is the one which affects mv's
    2244 behavior.
    2245 
    2246 It is an error for any of the source operands to specify a nonexistent
    2247 file or directory.
    2248 
    2249 It is an error for the source operand to specify a directory if the
    2250 target exists and is not a directory.
    2251 
    2252 If the destination path does not have a mode which permits writing, mv
    2253 prompts the user for confirmation as specified for the -i option.
    2254 
    2255 Should the *rename* call fail because source and target are on
    2256 different file systems, ``mv`` will remove the destination file,
    2257 copy the source file to the destination, and then remove the source.
    2258 The effect is roughly equivalent to:
    2259 .. code:: c
    2260 
    2261     rm -f destination_path && \\
    2262     cp -PRp source_file destination_path && \\
     2258The last of any -f or -i options is the one which affects mv's behavior.
     2259
     2260It is an error for any of the source operands to specify a nonexistent file or
     2261directory.
     2262
     2263It is an error for the source operand to specify a directory if the target
     2264exists and is not a directory.
     2265
     2266If the destination path does not have a mode which permits writing, mv prompts
     2267the user for confirmation as specified for the -i option.
     2268
     2269Should the *rename* call fail because source and target are on different file
     2270systems, ``mv`` will remove the destination file, copy the source file to the
     2271destination, and then remove the source.  The effect is roughly equivalent to:
     2272
     2273.. code:: shell
     2274
     2275    rm -f destination_path && \
     2276    cp -PRp source_file destination_path && \
    22632277    rm -rf source_file
    22642278
     
    22692283**NOTES:**
    22702284
    2271 NONE
     2285None.
    22722286
    22732287**EXAMPLES:**
    22742288
    2275 .. code:: c
    2276 
    2277     SHLL \[/] mv /dev/console /dev/con1
     2289.. code:: shell
     2290
     2291    SHLL [/] mv /dev/console /dev/con1
    22782292
    22792293**CONFIGURATION:**
     
    22822296.. index:: CONFIGURE_SHELL_COMMAND_MV
    22832297
    2284 This command is included in the default shell command set.  When
    2285 building a custom command set, define``CONFIGURE_SHELL_COMMAND_MV`` to have this command included.
    2286 
    2287 This command can be excluded from the shell command set by
    2288 defining ``CONFIGURE_SHELL_NO_COMMAND_MV`` when all
    2289 shell commands have been configured.
     2298This command is included in the default shell command set.  When building a
     2299custom command set, define ``CONFIGURE_SHELL_COMMAND_MV`` to have this command
     2300included.
     2301
     2302This command can be excluded from the shell command set by defining
     2303``CONFIGURE_SHELL_NO_COMMAND_MV`` when all shell commands have been configured.
    22902304
    22912305**PROGRAMMING INFORMATION:**
     
    22932307.. index:: rtems_shell_main_mv
    22942308
    2295 The ``mv`` command is implemented by a C language function which
    2296 has the following prototype:
     2309The ``mv`` command is implemented by a C language function which has the
     2310following prototype:
     2311
    22972312.. code:: c
    22982313
    22992314    int rtems_shell_main_mv(
    2300     int    argc,
    2301     char \**argv
     2315        int    argc,
     2316        char **argv
    23022317    );
    23032318
    2304 The configuration structure for the ``mv`` has the
    2305 following prototype:
     2319The configuration structure for the ``mv`` has the following prototype:
     2320
    23062321.. code:: c
    23072322
     
    23102325**ORIGIN:**
    23112326
    2312 The implementation and portions of the documentation for this command
    2313 are from NetBSD 4.0.
     2327The implementation and portions of the documentation for this command are from
     2328NetBSD 4.0.
    23142329
    23152330pwd - print work directory
     
    23192334**SYNOPSYS:**
    23202335
    2321 .. code:: c
     2336.. code:: shell
    23222337
    23232338    pwd
     
    23252340**DESCRIPTION:**
    23262341
    2327 This command prints the fully qualified filename of the current
    2328 working directory.
     2342This command prints the fully qualified filename of the current working
     2343directory.
    23292344
    23302345**EXIT STATUS:**
     
    23342349**NOTES:**
    23352350
    2336 NONE
     2351None.
    23372352
    23382353**EXAMPLES:**
    23392354
    23402355The following is an example of how to use ``pwd``:
    2341 .. code:: c
    2342 
    2343     SHLL \[/] $ pwd
     2356
     2357.. code:: shell
     2358
     2359    SHLL [/] $ pwd
    23442360    /
    2345     SHLL \[/] $ cd dev
    2346     SHLL \[/dev] $ pwd
     2361    SHLL [/] $ cd dev
     2362    SHLL [/dev] $ pwd
    23472363    /dev
    23482364
     
    23522368.. index:: CONFIGURE_SHELL_COMMAND_PWD
    23532369
    2354 This command is included in the default shell command set.
    2355 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_PWD`` to have this
    2356 command included.
    2357 
    2358 This command can be excluded from the shell command set by
    2359 defining ``CONFIGURE_SHELL_NO_COMMAND_PWD`` when all
    2360 shell commands have been configured.
     2370This command is included in the default shell command set.  When building a
     2371custom command set, define ``CONFIGURE_SHELL_COMMAND_PWD`` to have this command
     2372included.
     2373
     2374This command can be excluded from the shell command set by defining
     2375``CONFIGURE_SHELL_NO_COMMAND_PWD`` when all shell commands have been
     2376configured.
    23612377
    23622378**PROGRAMMING INFORMATION:**
     
    23642380.. index:: rtems_shell_rtems_main_pwd
    23652381
    2366 The ``pwd`` is implemented by a C language function
    2367 which has the following prototype:
     2382The ``pwd`` is implemented by a C language function which has the following
     2383prototype:
     2384
    23682385.. code:: c
    23692386
    23702387    int rtems_shell_rtems_main_pwd(
    2371     int    argc,
    2372     char \**argv
     2388        int    argc,
     2389        char **argv
    23732390    );
    23742391
    2375 The configuration structure for the ``pwd`` has the
    2376 following prototype:
     2392The configuration structure for the ``pwd`` has the following prototype:
     2393
    23772394.. code:: c
    23782395
     
    23852402**SYNOPSYS:**
    23862403
    2387 .. code:: c
    2388 
    2389     rmdir  \[dir1 .. dirN]
     2404.. code:: shell
     2405
     2406    rmdir  [dir1 .. dirN]
    23902407
    23912408**DESCRIPTION:**
    23922409
    2393 This command removes the specified set of directories.  If no
    2394 directories are provided on the command line, no actions are taken.
     2410This command removes the specified set of directories.  If no directories are
     2411provided on the command line, no actions are taken.
    23952412
    23962413**EXIT STATUS:**
     
    24002417**NOTES:**
    24012418
    2402 This command is a implemented using the ``rmdir(2)`` system
    2403 call and all reasons that call may fail apply to this command.
     2419This command is a implemented using the ``rmdir(2)`` system call and all
     2420reasons that call may fail apply to this command.
    24042421
    24052422**EXAMPLES:**
    24062423
    24072424The following is an example of how to use ``rmdir``:
    2408 .. code:: c
    2409 
    2410     SHLL \[/] # mkdir joeldir
    2411     SHLL \[/] # rmdir joeldir
    2412     SHLL \[/] # ls joeldir
     2425
     2426.. code:: shell
     2427
     2428    SHLL [/] # mkdir joeldir
     2429    SHLL [/] # rmdir joeldir
     2430    SHLL [/] # ls joeldir
    24132431    joeldir: No such file or directory.
    24142432
     
    24182436.. index:: CONFIGURE_SHELL_COMMAND_RMDIR
    24192437
    2420 This command is included in the default shell command set.
    2421 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_RMDIR`` to have this
     2438This command is included in the default shell command set.  When building a
     2439custom command set, define ``CONFIGURE_SHELL_COMMAND_RMDIR`` to have this
    24222440command included.
    24232441
    2424 This command can be excluded from the shell command set by
    2425 defining ``CONFIGURE_SHELL_NO_COMMAND_RMDIR`` when all
    2426 shell commands have been configured.
     2442This command can be excluded from the shell command set by defining
     2443``CONFIGURE_SHELL_NO_COMMAND_RMDIR`` when all shell commands have been
     2444configured.
    24272445
    24282446**PROGRAMMING INFORMATION:**
     
    24302448.. index:: rtems_shell_rtems_main_rmdir
    24312449
    2432 The ``rmdir`` is implemented by a C language function
    2433 which has the following prototype:
     2450The ``rmdir`` is implemented by a C language function which has the following
     2451prototype:
     2452
    24342453.. code:: c
    24352454
    24362455    int rtems_shell_rtems_main_rmdir(
    2437     int    argc,
    2438     char \**argv
     2456        int    argc,
     2457        char **argv
    24392458    );
    24402459
    2441 The configuration structure for the ``rmdir`` has the
    2442 following prototype:
     2460The configuration structure for the ``rmdir`` has the following prototype:
     2461
    24432462.. code:: c
    24442463
     
    24512470**SYNOPSYS:**
    24522471
    2453 .. code:: c
    2454 
    2455     rm file1 \[file2 ... fileN]
     2472.. code:: shell
     2473
     2474    rm file1 [file2 ... fileN]
    24562475
    24572476**DESCRIPTION:**
     
    24592478This command deletes a name from the filesystem.  If the specified file name
    24602479was the last link to a file and there are no ``open`` file descriptor
    2461 references to that file, then it is deleted and the associated space in
    2462 the file system is made available for subsequent use.
    2463 
    2464 If the filename specified was the last link to a file but there
    2465 are open file descriptor references to it, then the file will
    2466 remain in existence until the last file descriptor referencing
    2467 it is closed.
     2480references to that file, then it is deleted and the associated space in the
     2481file system is made available for subsequent use.
     2482
     2483If the filename specified was the last link to a file but there are open file
     2484descriptor references to it, then the file will remain in existence until the
     2485last file descriptor referencing it is closed.
    24682486
    24692487**EXIT STATUS:**
     
    24732491**NOTES:**
    24742492
    2475 NONE
     2493None.
    24762494
    24772495**EXAMPLES:**
    24782496
    24792497The following is an example of how to use ``rm``:
    2480 .. code:: c
    2481 
    2482     SHLL \[/] # cp /etc/passwd tmpfile
    2483     SHLL \[/] # cat tmpfile
    2484     root:\*:0:0:root::/:/bin/sh
    2485     rtems:\*:1:1:RTEMS Application::/:/bin/sh
     2498
     2499.. code:: c
     2500
     2501    SHLL [/] # cp /etc/passwd tmpfile
     2502    SHLL [/] # cat tmpfile
     2503    root:*:0:0:root::/:/bin/sh
     2504    rtems:*:1:1:RTEMS Application::/:/bin/sh
    24862505    tty:!:2:2:tty owner::/:/bin/false
    2487     SHLL \[/] # rm tmpfile
    2488     SHLL \[/] # cat tmpfile
     2506    SHLL [/] # rm tmpfile
     2507    SHLL [/] # cat tmpfile
    24892508    cat: tmpfile: No such file or directory
    24902509
     
    24942513.. index:: CONFIGURE_SHELL_COMMAND_RM
    24952514
    2496 This command is included in the default shell command set.
    2497 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_RM`` to have this
    2498 command included.
    2499 
    2500 This command can be excluded from the shell command set by
    2501 defining ``CONFIGURE_SHELL_NO_COMMAND_RM`` when all
    2502 shell commands have been configured.
     2515This command is included in the default shell command set.  When building a
     2516custom command set, define ``CONFIGURE_SHELL_COMMAND_RM`` to have this command
     2517included.
     2518
     2519This command can be excluded from the shell command set by defining
     2520``CONFIGURE_SHELL_NO_COMMAND_RM`` when all shell commands have been configured.
    25032521
    25042522**PROGRAMMING INFORMATION:**
     
    25062524.. index:: rtems_shell_main_rm
    25072525
    2508 The ``rm`` is implemented by a C language function
    2509 which has the following prototype:
     2526The ``rm`` is implemented by a C language function which has the following
     2527prototype:
     2528
    25102529.. code:: c
    25112530
    25122531    int rtems_shell_main_rm(
    2513     int    argc,
    2514     char \**argv
     2532        int    argc,
     2533        char **argv
    25152534    );
    25162535
     
    25272546**SYNOPSYS:**
    25282547
    2529 .. code:: c
    2530 
    2531     umask \[new_umask]
     2548.. code:: shell
     2549
     2550    umask [new_umask]
    25322551
    25332552**DESCRIPTION:**
    25342553
    2535 This command sets the user file creation mask to ``new_umask``.  The
    2536 argument ``new_umask`` may be octal, hexadecimal, or decimal.
     2554This command sets the user file creation mask to ``new_umask``.  The argument
     2555``new_umask`` may be octal, hexadecimal, or decimal.
    25372556
    25382557**EXIT STATUS:**
     
    25472566
    25482567The following is an example of how to use ``umask``:
    2549 .. code:: c
    2550 
    2551     SHLL \[/] $ umask
     2568
     2569.. code:: shell
     2570
     2571    SHLL [/] $ umask
    25522572    022
    2553     SHLL \[/] $ umask 0666
     2573    SHLL [/] $ umask 0666
    25542574    0666
    2555     SHLL \[/] $ umask
     2575    SHLL [/] $ umask
    25562576    0666
    25572577
     
    25612581.. index:: CONFIGURE_SHELL_COMMAND_UMASK
    25622582
    2563 This command is included in the default shell command set.
    2564 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_UMASK`` to have this
     2583This command is included in the default shell command set.  When building a
     2584custom command set, define ``CONFIGURE_SHELL_COMMAND_UMASK`` to have this
    25652585command included.
    25662586
    2567 This command can be excluded from the shell command set by
    2568 defining ``CONFIGURE_SHELL_NO_COMMAND_UMASK`` when all
    2569 shell commands have been configured.
     2587This command can be excluded from the shell command set by defining
     2588``CONFIGURE_SHELL_NO_COMMAND_UMASK`` when all shell commands have been
     2589configured.
    25702590
    25712591**PROGRAMMING INFORMATION:**
     
    25732593.. index:: rtems_shell_rtems_main_umask
    25742594
    2575 The ``umask`` is implemented by a C language function
    2576 which has the following prototype:
     2595The ``umask`` is implemented by a C language function which has the following
     2596prototype:
     2597
    25772598.. code:: c
    25782599
    25792600    int rtems_shell_rtems_main_umask(
    2580     int    argc,
    2581     char \**argv
     2601        int    argc,
     2602        char **argv
    25822603    );
    25832604
    2584 The configuration structure for the ``umask`` has the
    2585 following prototype:
     2605The configuration structure for the ``umask`` has the following prototype:
     2606
    25862607.. code:: c
    25872608
     
    25942615**SYNOPSYS:**
    25952616
    2596 .. code:: c
     2617.. code:: shell
    25972618
    25982619    unmount path
     
    26132634
    26142635The following is an example of how to use ``unmount``:
    2615 .. code:: c
     2636
     2637.. code:: shell
    26162638
    26172639    EXAMPLE_TBD
     
    26222644.. index:: CONFIGURE_SHELL_COMMAND_UNMOUNT
    26232645
    2624 This command is included in the default shell command set.
    2625 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_UNMOUNT`` to have this
     2646This command is included in the default shell command set.  When building a
     2647custom command set, define ``CONFIGURE_SHELL_COMMAND_UNMOUNT`` to have this
    26262648command included.
    26272649
    2628 This command can be excluded from the shell command set by
    2629 defining ``CONFIGURE_SHELL_NO_COMMAND_UNMOUNT`` when all
    2630 shell commands have been configured.
     2650This command can be excluded from the shell command set by defining
     2651``CONFIGURE_SHELL_NO_COMMAND_UNMOUNT`` when all shell commands have been
     2652configured.
    26312653
    26322654**PROGRAMMING INFORMATION:**
     
    26342656.. index:: rtems_shell_rtems_main_unmount
    26352657
    2636 The ``unmount`` is implemented by a C language function
    2637 which has the following prototype:
     2658The ``unmount`` is implemented by a C language function which has the following
     2659prototype:
     2660
    26382661.. code:: c
    26392662
    26402663    int rtems_shell_rtems_main_unmount(
    2641     int    argc,
    2642     char \**argv
     2664        int    argc,
     2665        char **argv
    26432666    );
    26442667
    2645 The configuration structure for the ``unmount`` has the
    2646 following prototype:
     2668The configuration structure for the ``unmount`` has the following prototype:
     2669
    26472670.. code:: c
    26482671
    26492672    extern rtems_shell_cmd_t rtems_shell_UNMOUNT_Command;
    2650 
    2651 .. COMMENT: COPYRIGHT (c) 1988-2012.
    2652 
    2653 .. COMMENT: On-Line Applications Research Corporation (OAR).
    2654 
    2655 .. COMMENT: All rights reserved.
    2656 
Note: See TracChangeset for help on using the changeset viewer.