Changeset 35bcd00 in rtems-docs


Ignore:
Timestamp:
Jan 23, 2016, 3:24:10 AM (4 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, master
Children:
e5afcaa
Parents:
bcfdcef
git-author:
Chris Johns <chrisj@…> (01/23/16 03:24:10)
git-committer:
Amar Takhar <verm@…> (05/03/16 00:51:25)
Message:

Clean up.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • shell/rtems_specific_commands.rst

    rbcfdcef r35bcd00  
     1.. COMMENT: COPYRIGHT (c) 1988-2008.
     2.. COMMENT: On-Line Applications Research Corporation (OAR).
     3.. COMMENT: All rights reserved.
     4
    15RTEMS Specific Commands
    26#######################
     
    711The RTEMS shell has the following rtems commands:
    812
    9 - ``shutdown`` - Shutdown the system
    10 
    11 - ``cpuuse`` - print or reset per thread cpu usage
    12 
    13 - ``stackuse`` - print per thread stack usage
    14 
    15 - ``perioduse`` - print or reset per period usage
    16 
    17 - ``profreport`` - print a profiling report
    18 
    19 - ``wkspace`` - Display information on Executive Workspace
    20 
    21 - ``config`` - Show the system configuration.
    22 
    23 - ``itask`` - List init tasks for the system
    24 
    25 - ``extension`` - Display information about extensions
    26 
    27 - ``task`` - Display information about tasks
    28 
    29 - ``queue`` - Display information about message queues
    30 
    31 - ``sema`` - display information about semaphores
    32 
    33 - ``region`` - display information about regions
    34 
    35 - ``part`` - display information about partitions
    36 
    37 - ``object`` - Display information about RTEMS objects
    38 
    39 - ``driver`` - Display the RTEMS device driver table
    40 
    41 - ``dname`` - Displays information about named drivers
    42 
    43 - ``pthread`` - Displays information about POSIX threads
     13- shutdown_ - Shutdown the system
     14
     15- cpuuse_ - print or reset per thread cpu usage
     16
     17- stackuse_ - print per thread stack usage
     18
     19- perioduse_ - print or reset per period usage
     20
     21- profreport_ - print a profiling report
     22
     23- wkspace_ - Display information on Executive Workspace
     24
     25- config_ - Show the system configuration.
     26
     27- itask_ - List init tasks for the system
     28
     29- extension_ - Display information about extensions
     30
     31- task_ - Display information about tasks
     32
     33- queue_ - Display information about message queues
     34
     35- sema_ - display information about semaphores
     36
     37- region_ - display information about regions
     38
     39- part_ - display information about partitions
     40
     41- object_ - Display information about RTEMS objects
     42
     43- driver_ - Display the RTEMS device driver table
     44
     45- dname_ - Displays information about named drivers
     46
     47- pthread_ - Displays information about POSIX threads
    4448
    4549Commands
     
    5155command as well as providing an example usage.
    5256
     57.. _shutdown:
     58
    5359shutdown - Shutdown the system
    5460------------------------------
     
    5763**SYNOPSYS:**
    5864
    59 .. code:: c
     65.. code:: shell
    6066
    6167    shutdown
     
    7480
    7581The following is an example of how to use ``shutdown``:
    76 .. code:: c
    77 
    78     SHLL \[/] $ shutdown
     82
     83.. code:: shell
     84
     85    SHLL [/] $ shutdown
    7986    System shutting down at user request
    8087
    81 The user will not see another prompt and the system will
    82 shutdown.
     88The user will not see another prompt and the system will shutdown.
    8389
    8490**CONFIGURATION:**
     
    8793.. index:: CONFIGURE_SHELL_COMMAND_SHUTDOWN
    8894
    89 This command is included in the default shell command set.
    90 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_SHUTDOWN`` to have this
    91 command included.
    92 
    93 This command can be excluded from the shell command set by
    94 defining ``CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN`` when all
    95 shell commands have been configured.
    96 
    97 **PROGRAMMING INFORMATION:**
    98 
    99 The configuration structure for the ``shutdown`` has the
    100 following prototype:
     95This command is included in the default shell command set.  When building a
     96custom command set, define ``CONFIGURE_SHELL_COMMAND_SHUTDOWN`` to have this
     97command included.
     98
     99This command can be excluded from the shell command set by defining
     100``CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN`` when all shell commands have been
     101configured.
     102
     103**PROGRAMMING INFORMATION:**
     104
     105The configuration structure for the ``shutdown`` has the following prototype:
     106
    101107.. code:: c
    102108
    103109    extern rtems_shell_cmd_t rtems_shell_SHUTDOWN_Command;
     110
     111.. _cpuuse:
    104112
    105113cpuuse - print or reset per thread cpu usage
     
    109117**SYNOPSYS:**
    110118
    111 .. code:: c
    112 
    113     cpuuse \[-r]
    114 
    115 **DESCRIPTION:**
    116 
    117 This command may be used to print a report on the per thread
    118 cpu usage or to reset the per thread CPU usage statistics. When
    119 invoked with the ``-r`` option, the CPU usage statistics
    120 are reset.
     119.. code:: shell
     120
     121    cpuuse [-r]
     122
     123**DESCRIPTION:**
     124
     125This command may be used to print a report on the per thread cpu usage or to
     126reset the per thread CPU usage statistics. When invoked with the ``-r`` option,
     127the CPU usage statistics are reset.
    121128
    122129**EXIT STATUS:**
     
    126133**NOTES:**
    127134
    128 The granularity of the timing information reported is dependent
    129 upon the BSP and the manner in which RTEMS was built.  In the
    130 default RTEMS configuration, if the BSP supports nanosecond
    131 granularity timestamps, then the information reported will be
    132 highly accurate. Otherwise, the accuracy of the information
     135The granularity of the timing information reported is dependent upon the BSP
     136and the manner in which RTEMS was built.  In the default RTEMS configuration,
     137if the BSP supports nanosecond granularity timestamps, then the information
     138reported will be highly accurate. Otherwise, the accuracy of the information
    133139reported is limited by the clock tick quantum.
    134140
     
    136142
    137143The following is an example of how to use ``cpuuse``:
    138 .. code:: c
    139 
    140     SHLL \[/] $ cpuuse
     144
     145.. code:: shell
     146
     147    SHLL [/] $ cpuuse
    141148    CPU Usage by thread
    142149    ID            NAME         SECONDS   PERCENT
     
    145152    0x0a010002   SHLL             0.525928    1.046
    146153    Time since last CPU Usage reset 50.271321 seconds
    147     SHLL \[/] $ cpuuse -r
     154    SHLL [/] $ cpuuse -r
    148155    Resetting CPU Usage information
    149     SHLL \[/] $ cpuuse
     156    SHLL [/] $ cpuuse
    150157    CPU Usage by thread
    151158    ID            NAME         SECONDS   PERCENT
     
    155162    Time since last CPU Usage reset 0.003092 seconds
    156163
    157 In the above example, the system had set idle for nearly
    158 a minute when the first report was generated.  The``cpuuse -r`` and ``cpuuse`` commands were pasted
    159 from another window so were executed with no gap between.
    160 In the second report, only the ``shell`` thread has
    161 run since the CPU Usage was reset.  It has consumed
    162 approximately 3.092 milliseconds of CPU time processing
    163 the two commands and generating the output.
     164In the above example, the system had set idle for nearly a minute when the
     165first report was generated.  The``cpuuse -r`` and ``cpuuse`` commands were
     166pasted from another window so were executed with no gap between.  In the second
     167report, only the ``shell`` thread has run since the CPU Usage was reset.  It
     168has consumed approximately 3.092 milliseconds of CPU time processing the two
     169commands and generating the output.
    164170
    165171**CONFIGURATION:**
     
    168174.. index:: CONFIGURE_SHELL_COMMAND_CPUUSE
    169175
    170 This command is included in the default shell command set.
    171 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CPUUSE`` to have this
    172 command included.
    173 
    174 This command can be excluded from the shell command set by
    175 defining ``CONFIGURE_SHELL_NO_COMMAND_CPUUSE`` when all
    176 shell commands have been configured.
     176This command is included in the default shell command set.  When building a
     177custom command set, define ``CONFIGURE_SHELL_COMMAND_CPUUSE`` to have this
     178command included.
     179
     180This command can be excluded from the shell command set by defining
     181``CONFIGURE_SHELL_NO_COMMAND_CPUUSE`` when all shell commands have been
     182configured.
    177183
    178184**PROGRAMMING INFORMATION:**
     
    180186.. index:: rtems_shell_rtems_main_cpuuse
    181187
    182 The ``cpuuse`` is implemented by a C language function
    183 which has the following prototype:
     188The ``cpuuse`` is implemented by a C language function which has the following
     189prototype:
     190
    184191.. code:: c
    185192
    186193    int rtems_shell_rtems_main_cpuuse(
    187     int    argc,
    188     char \**argv
     194       int    argc,
     195       char **argv
    189196    );
    190197
    191 The configuration structure for the ``cpuuse`` has the
    192 following prototype:
     198The configuration structure for the ``cpuuse`` has the following prototype:
     199
    193200.. code:: c
    194201
    195202    extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command;
     203
     204.. _stackuse:
    196205
    197206stackuse - print per thread stack usage
     
    201210**SYNOPSYS:**
    202211
    203 .. code:: c
     212.. code:: shell
    204213
    205214    stackuse
     
    207216**DESCRIPTION:**
    208217
    209 This command prints a Stack Usage Report for all of the tasks
    210 and threads in the system.  On systems which support it, the
    211 usage of the interrupt stack is also included in the report.
     218This command prints a Stack Usage Report for all of the tasks and threads in
     219the system.  On systems which support it, the usage of the interrupt stack is
     220also included in the report.
    212221
    213222**EXIT STATUS:**
     
    217226**NOTES:**
    218227
    219 The ``CONFIGURE_STACK_CHECKER_ENABLED`` ``confdefs.h`` constant
    220 must be defined when the application is configured for this
    221 command to have any information to report.
     228The ``CONFIGURE_STACK_CHECKER_ENABLED`` ``confdefs.h`` constant must be defined
     229when the application is configured for this command to have any information to
     230report.
    222231
    223232**EXAMPLES:**
    224233
    225234The following is an example of how to use ``stackuse``:
    226 .. code:: c
    227 
    228     SHLL \[/] $ stackuse
     235
     236.. code:: shell
     237
     238    SHLL [/] $ stackuse
    229239    Stack usage by thread
    230240    ID      NAME    LOW          HIGH     CURRENT     AVAILABLE     USED
     
    239249.. index:: CONFIGURE_SHELL_COMMAND_STACKUSE
    240250
    241 This command is included in the default shell command set.
    242 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_STACKUSE`` to have this
    243 command included.
    244 
    245 This command can be excluded from the shell command set by
    246 defining ``CONFIGURE_SHELL_NO_COMMAND_STACKUSE`` when all
    247 shell commands have been configured.
     251This command is included in the default shell command set.  When building a
     252custom command set, define ``CONFIGURE_SHELL_COMMAND_STACKUSE`` to have this
     253command included.
     254
     255This command can be excluded from the shell command set by defining
     256``CONFIGURE_SHELL_NO_COMMAND_STACKUSE`` when all shell commands have been
     257configured.
    248258
    249259**PROGRAMMING INFORMATION:**
     
    251261.. index:: rtems_shell_rtems_main_stackuse
    252262
    253 The ``stackuse`` is implemented by a C language function
    254 which has the following prototype:
     263The ``stackuse`` is implemented by a C language function which has the
     264following prototype:
     265
    255266.. code:: c
    256267
    257268    int rtems_shell_rtems_main_stackuse(
    258     int    argc,
    259     char \**argv
     269        int    argc,
     270        char **argv
    260271    );
    261272
    262 The configuration structure for the ``stackuse`` has the
    263 following prototype:
     273The configuration structure for the ``stackuse`` has the following prototype:
     274
    264275.. code:: c
    265276
    266277    extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command;
     278
     279.. _perioduse:
    267280
    268281perioduse - print or reset per period usage
     
    272285**SYNOPSYS:**
    273286
    274 .. code:: c
    275 
    276     perioduse \[-r]
    277 
    278 **DESCRIPTION:**
    279 
    280 This command may be used to print a statistics report on the rate
    281 monotonic periods in the application or to reset the rate monotonic
    282 period usage statistics. When invoked with the ``-r`` option, the
    283 usage statistics are reset.
     287.. code:: shell
     288
     289    perioduse [-r]
     290
     291**DESCRIPTION:**
     292
     293This command may be used to print a statistics report on the rate monotonic
     294periods in the application or to reset the rate monotonic period usage
     295statistics. When invoked with the ``-r`` option, the usage statistics are
     296reset.
    284297
    285298**EXIT STATUS:**
     
    289302**NOTES:**
    290303
    291 The granularity of the timing information reported is dependent
    292 upon the BSP and the manner in which RTEMS was built.  In the
    293 default RTEMS configuration, if the BSP supports nanosecond
    294 granularity timestamps, then the information reported will be
    295 highly accurate. Otherwise, the accuracy of the information
     304The granularity of the timing information reported is dependent upon the BSP
     305and the manner in which RTEMS was built.  In the default RTEMS configuration,
     306if the BSP supports nanosecond granularity timestamps, then the information
     307reported will be highly accurate. Otherwise, the accuracy of the information
    296308reported is limited by the clock tick quantum.
    297309
     
    299311
    300312The following is an example of how to use ``perioduse``:
    301 .. code:: c
    302 
    303     SHLL \[/] $ perioduse
     313
     314.. code:: shell
     315
     316    SHLL [/] $ perioduse
    304317    Period information by period
    305318    --- CPU times are in seconds ---
     
    313326    0x42010005 TA5     10      0 0:000065/0:005413/0:002739 0:000065/1:000457/0:041058
    314327    MIN/MAX/AVG                MIN/MAX/AVG
    315     SHLL \[/] $ perioduse -r
     328    SHLL [/] $ perioduse -r
    316329    Resetting Period Usage information
    317     SHLL \[/] $ perioduse
     330    SHLL [/] $ perioduse
    318331    --- CPU times are in seconds ---
    319332    --- Wall times are in seconds ---
     
    331344.. index:: CONFIGURE_SHELL_COMMAND_PERIODUSE
    332345
    333 This command is included in the default shell command set.
    334 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_PERIODUSE`` to have this
    335 command included.
    336 
    337 This command can be excluded from the shell command set by
    338 defining ``CONFIGURE_SHELL_NO_COMMAND_PERIODUSE`` when all
    339 shell commands have been configured.
     346This command is included in the default shell command set.  When building a
     347custom command set, define ``CONFIGURE_SHELL_COMMAND_PERIODUSE`` to have this
     348command included.
     349
     350This command can be excluded from the shell command set by defining
     351``CONFIGURE_SHELL_NO_COMMAND_PERIODUSE`` when all shell commands have been
     352configured.
    340353
    341354**PROGRAMMING INFORMATION:**
     
    345358The ``perioduse`` is implemented by a C language function
    346359which has the following prototype:
     360
    347361.. code:: c
    348362
    349363    int rtems_shell_rtems_main_perioduse(
    350     int    argc,
    351     char \**argv
     364        int    argc,
     365        char **argv
    352366    );
    353367
    354 The configuration structure for the ``perioduse`` has the
    355 following prototype:
     368The configuration structure for the ``perioduse`` has the following prototype:
     369
    356370.. code:: c
    357371
    358372    extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command;
     373
     374.. _profreport:
    359375
    360376profreport - print a profiling report
     
    364380**SYNOPSYS:**
    365381
    366 .. code:: c
     382.. code:: shell
    367383
    368384    profreport
     
    370386**DESCRIPTION:**
    371387
    372 This command may be used to print a profiling report.
     388This command may be used to print a profiling report if profiling is built into
     389the RTEMS kernel.
    373390
    374391**EXIT STATUS:**
     
    384401
    385402The following is an example of how to use ``profreport``:
    386 .. code:: c
    387 
    388     SHLL \[/] $ profreport
     403
     404.. code:: shell
     405
     406    SHLL [/] $ profreport
    389407    <ProfilingReport name="Shell">
    390408    <PerCPUProfilingReport processorIndex="0">
     
    443461.. index:: CONFIGURE_SHELL_COMMAND_PROFREPORT
    444462
    445 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_PROFREPORT`` to have this
    446 command included.
    447 
    448 This command can be excluded from the shell command set by
    449 defining ``CONFIGURE_SHELL_NO_COMMAND_PROFREPORT`` when all
    450 shell commands have been configured.
    451 
    452 **PROGRAMMING INFORMATION:**
    453 
    454 The configuration structure for the ``profreport`` has the
    455 following prototype:
     463When building a custom command set, define
     464``CONFIGURE_SHELL_COMMAND_PROFREPORT`` to have this command included.
     465
     466This command can be excluded from the shell command set by defining
     467``CONFIGURE_SHELL_NO_COMMAND_PROFREPORT`` when all shell commands have been
     468configured.
     469
     470**PROGRAMMING INFORMATION:**
     471
     472The configuration structure for the ``profreport`` has the following prototype:
     473
    456474.. code:: c
    457475
    458476    extern rtems_shell_cmd_t rtems_shell_PROFREPORT_Command;
     477
     478.. _wkspace:
    459479
    460480wkspace - display information on executive workspace
     
    464484**SYNOPSYS:**
    465485
    466 .. code:: c
     486.. code:: shell
    467487
    468488    wkspace
     
    470490**DESCRIPTION:**
    471491
    472 This command prints information on the current state of
    473 the RTEMS Executive Workspace reported.  This includes the
    474 following information:
     492This command prints information on the current state of the RTEMS Executive
     493Workspace reported.  This includes the following information:
    475494
    476495- Number of free blocks
     
    497516
    498517The following is an example of how to use ``wkspace``:
    499 .. code:: c
    500 
    501     SHLL \[/] $ wkspace
     518
     519.. code:: shell
     520
     521    SHLL [/] $ wkspace
    502522    Number of free blocks: 1
    503523    Largest free block:    132336
     
    512532.. index:: CONFIGURE_SHELL_COMMAND_WKSPACE
    513533
    514 This command is included in the default shell command set.
    515 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_WKSPACE`` to have this
    516 command included.
    517 
    518 This command can be excluded from the shell command set by
    519 defining ``CONFIGURE_SHELL_NO_COMMAND_WKSPACE`` when all
    520 shell commands have been configured.
     534This command is included in the default shell command set.  When building a
     535custom command set, define ``CONFIGURE_SHELL_COMMAND_WKSPACE`` to have this
     536command included.
     537
     538This command can be excluded from the shell command set by defining
     539``CONFIGURE_SHELL_NO_COMMAND_WKSPACE`` when all shell commands have been
     540configured.
    521541
    522542**PROGRAMMING INFORMATION:**
     
    524544.. index:: rtems_shell_rtems_main_wkspace
    525545
    526 The ``wkspace`` is implemented by a C language function
    527 which has the following prototype:
     546The ``wkspace`` is implemented by a C language function which has the following
     547prototype:
     548
    528549.. code:: c
    529550
    530551    int rtems_shell_rtems_main_wkspace(
    531     int    argc,
    532     char \**argv
     552        int    argc,
     553        char **argv
    533554    );
    534555
    535 The configuration structure for the ``wkspace`` has the
    536 following prototype:
     556The configuration structure for the ``wkspace`` has the following prototype:
     557
    537558.. code:: c
    538559
    539560    extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command;
     561
     562.. _config:
    540563
    541564config - show the system configuration.
     
    545568**SYNOPSYS:**
    546569
    547 .. code:: c
     570.. code:: shell
    548571
    549572    config
     
    559582**NOTES:**
    560583
    561 At this time, it does not report every configuration parameter.
    562 This is an area in which user submissions or sponsorship of
    563 a developer would be appreciated.
     584At this time, it does not report every configuration parameter.  This is an
     585area in which user submissions or sponsorship of a developer would be
     586appreciated.
    564587
    565588**EXAMPLES:**
    566589
    567590The following is an example of how to use ``config``:
    568 .. code:: c
    569 
     591
     592.. code:: shell
     593
     594    SHLL [/] $ config
    570595    INITIAL (startup) Configuration Info
    571596
     
    580605.. index:: CONFIGURE_SHELL_COMMAND_CONFIG
    581606
    582 This command is included in the default shell command set.
    583 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CONFIG`` to have this
    584 command included.
    585 
    586 This command can be excluded from the shell command set by
    587 defining ``CONFIGURE_SHELL_NO_COMMAND_CONFIG`` when all
    588 shell commands have been configured.
     607This command is included in the default shell command set.  When building a
     608custom command set, define ``CONFIGURE_SHELL_COMMAND_CONFIG`` to have this
     609command included.
     610
     611This command can be excluded from the shell command set by defining
     612``CONFIGURE_SHELL_NO_COMMAND_CONFIG`` when all shell commands have been
     613configured.
    589614
    590615**PROGRAMMING INFORMATION:**
     
    592617.. index:: rtems_shell_rtems_main_config
    593618
    594 The ``config`` is implemented by a C language function
    595 which has the following prototype:
     619The ``config`` is implemented by a C language function which has the following
     620prototype:
     621
    596622.. code:: c
    597623
    598624    int rtems_shell_rtems_main_config(
    599     int    argc,
    600     char \**argv
     625        int    argc,
     626        char **argv
    601627    );
    602628
    603 The configuration structure for the ``config`` has the
    604 following prototype:
     629The configuration structure for the ``config`` has the following prototype:
     630
    605631.. code:: c
    606632
    607633    extern rtems_shell_cmd_t rtems_shell_CONFIG_Command;
     634
     635.. _itask:
    608636
    609637itask - list init tasks for the system
     
    613641**SYNOPSYS:**
    614642
    615 .. code:: c
     643.. code:: shell
    616644
    617645    itask
     
    619647**DESCRIPTION:**
    620648
    621 This command prints a report on the set of initialization
    622 tasks and threads in the system.
     649This command prints a report on the set of initialization tasks and threads in
     650the system.
    623651
    624652**EXIT STATUS:**
     
    628656**NOTES:**
    629657
    630 At this time, it includes only Classic API Initialization Tasks.
    631 This is an area in which user submissions or sponsorship of
    632 a developer would be appreciated.
     658At this time, it includes only Classic API Initialization Tasks.  This is an
     659area in which user submissions or sponsorship of a developer would be
     660appreciated.
    633661
    634662**EXAMPLES:**
    635663
    636664The following is an example of how to use ``itask``:
    637 .. code:: c
    638 
    639     SHLL \[/] $ itask
     665
     666.. code:: shell
     667
     668    SHLL [/] $ itask
    640669    #    NAME   ENTRY        ARGUMENT    PRIO   MODES  ATTRIBUTES   STACK SIZE
    641670    ------------------------------------------------------------------------------
    642     0   UI1    \[0x2002258] 0 \[0x0]        1    nP      DEFAULT     4096 \[0x1000]
     671    0   UI1    [0x2002258] 0 [0x0]        1    nP      DEFAULT     4096 [0x1000]
    643672
    644673**CONFIGURATION:**
     
    647676.. index:: CONFIGURE_SHELL_COMMAND_ITASK
    648677
    649 This command is included in the default shell command set.
    650 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_ITASK`` to have this
    651 command included.
    652 
    653 This command can be excluded from the shell command set by
    654 defining ``CONFIGURE_SHELL_NO_COMMAND_ITASK`` when all
    655 shell commands have been configured.
     678This command is included in the default shell command set.  When building a
     679custom command set, define ``CONFIGURE_SHELL_COMMAND_ITASK`` to have this
     680command included.
     681
     682This command can be excluded from the shell command set by defining
     683``CONFIGURE_SHELL_NO_COMMAND_ITASK`` when all shell commands have been
     684configured.
    656685
    657686**PROGRAMMING INFORMATION:**
     
    659688.. index:: rtems_shell_rtems_main_itask
    660689
    661 The ``itask`` is implemented by a C language function
    662 which has the following prototype:
     690The ``itask`` is implemented by a C language function which has the following
     691prototype:
     692
    663693.. code:: c
    664694
    665695    int rtems_shell_rtems_main_itask(
    666     int    argc,
    667     char \**argv
     696        int    argc,
     697        char **argv
    668698    );
    669699
    670 The configuration structure for the ``itask`` has the
    671 following prototype:
     700The configuration structure for the ``itask`` has the following prototype:
     701
    672702.. code:: c
    673703
    674704    extern rtems_shell_cmd_t rtems_shell_ITASK_Command;
     705
     706.. _extension:
    675707
    676708extension - display information about extensions
     
    680712**SYNOPSYS:**
    681713
    682 .. code:: c
    683 
    684     extension \[id \[id ...] ]
    685 
    686 **DESCRIPTION:**
    687 
    688 When invoked with no arguments, this command prints information on
    689 the set of User Extensions currently active in the system.
    690 
    691 If invoked with a set of ids as arguments, then just
    692 those objects are included in the information printed.
     714.. code:: shell
     715
     716    extension [id [id ...]]
     717
     718**DESCRIPTION:**
     719
     720When invoked with no arguments, this command prints information on the set of
     721User Extensions currently active in the system.
     722
     723If invoked with a set of ids as arguments, then just those objects are included
     724in the information printed.
    693725
    694726**EXIT STATUS:**
     
    704736The following is an example of using the ``extension`` command
    705737on a system with no user extensions.
    706 .. code:: c
    707 
    708     SHLL \[/] $ extension
     738
     739.. code:: shell
     740
     741    SHLL [/] $ extension
    709742    ID       NAME
    710743    ------------------------------------------------------------------------------
     
    715748.. index:: CONFIGURE_SHELL_COMMAND_EXTENSION
    716749
    717 This command is included in the default shell command set.
    718 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_EXTENSION`` to have this
    719 command included.
    720 
    721 This command can be excluded from the shell command set by
    722 defining ``CONFIGURE_SHELL_NO_COMMAND_EXTENSION`` when all
    723 shell commands have been configured.
     750This command is included in the default shell command set.  When building a
     751custom command set, define ``CONFIGURE_SHELL_COMMAND_EXTENSION`` to have this
     752command included.
     753
     754This command can be excluded from the shell command set by defining
     755``CONFIGURE_SHELL_NO_COMMAND_EXTENSION`` when all shell commands have been
     756configured.
    724757
    725758**PROGRAMMING INFORMATION:**
     
    727760.. index:: rtems_shell_rtems_main_extension
    728761
    729 The ``extension`` is implemented by a C language function
    730 which has the following prototype:
     762The ``extension`` is implemented by a C language function which has the
     763following prototype:
     764
    731765.. code:: c
    732766
    733767    int rtems_shell_rtems_main_extension(
    734     int    argc,
    735     char \**argv
     768        int    argc,
     769        char **argv
    736770    );
    737771
    738 The configuration structure for the ``extension`` has the
    739 following prototype:
     772The configuration structure for the ``extension`` has the following prototype:
     773
    740774.. code:: c
    741775
    742776    extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command;
     777
     778.. _task:
    743779
    744780task - display information about tasks
     
    748784**SYNOPSYS:**
    749785
    750 .. code:: c
    751 
    752     task \[id \[id ...] ]
    753 
    754 **DESCRIPTION:**
    755 
    756 When invoked with no arguments, this command prints information on
    757 the set of Classic API Tasks currently active in the system.
    758 
    759 If invoked with a set of ids as arguments, then just
    760 those objects are included in the information printed.
     786.. code:: shell
     787
     788    task [id [id ...]]
     789
     790**DESCRIPTION:**
     791
     792When invoked with no arguments, this command prints information on the set of
     793Classic API Tasks currently active in the system.
     794
     795If invoked with a set of ids as arguments, then just those objects are included
     796in the information printed.
    761797
    762798**EXIT STATUS:**
     
    770806**EXAMPLES:**
    771807
    772 The following is an example of how to use the ``task`` on an
    773 application with just two Classic API tasks:
    774 .. code:: c
    775 
    776     SHLL \[/] $ task
     808The following is an example of how to use the ``task`` on an application with
     809just two Classic API tasks:
     810
     811.. code:: shell
     812
     813    SHLL [/] $ task
    777814    ID       NAME   PRIO   STAT   MODES  EVENTS   WAITID  WAITARG  NOTES
    778815    ------------------------------------------------------------------------------
     
    785822.. index:: CONFIGURE_SHELL_COMMAND_TASK
    786823
    787 This command is included in the default shell command set.
    788 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_TASK`` to have this
    789 command included.
    790 
    791 This command can be excluded from the shell command set by
    792 defining ``CONFIGURE_SHELL_NO_COMMAND_TASK`` when all
    793 shell commands have been configured.
     824This command is included in the default shell command set.  When building a
     825custom command set, define ``CONFIGURE_SHELL_COMMAND_TASK`` to have this
     826command included.
     827
     828This command can be excluded from the shell command set by defining
     829``CONFIGURE_SHELL_NO_COMMAND_TASK`` when all shell commands have been
     830configured.
    794831
    795832**PROGRAMMING INFORMATION:**
     
    797834.. index:: rtems_shell_rtems_main_task
    798835
    799 The ``task`` is implemented by a C language function
    800 which has the following prototype:
    801 .. code:: c
     836The ``task`` is implemented by a C language function which has the following
     837prototype:
     838
     839.. code:: shell
    802840
    803841    int rtems_shell_rtems_main_task(
    804     int    argc,
    805     char \**argv
     842        int    argc,
     843        char **argv
    806844    );
    807845
    808 The configuration structure for the ``task`` has the
    809 following prototype:
     846The configuration structure for the ``task`` has the following prototype:
     847
    810848.. code:: c
    811849
    812850    extern rtems_shell_cmd_t rtems_shell_TASK_Command;
     851
     852.. _queue:
    813853
    814854queue - display information about message queues
     
    818858**SYNOPSYS:**
    819859
    820 .. code:: c
    821 
    822     queue \[id \[id ... ] ]
    823 
    824 **DESCRIPTION:**
    825 
    826 When invoked with no arguments, this command prints information on
    827 the set of Classic API Message Queues currently active in the system.
    828 
    829 If invoked with a set of ids as arguments, then just
    830 those objects are included in the information printed.
     860.. code:: shell
     861
     862    queue [id [id ... ]]
     863
     864**DESCRIPTION:**
     865
     866When invoked with no arguments, this command prints information on the set of
     867Classic API Message Queues currently active in the system.
     868
     869If invoked with a set of ids as arguments, then just those objects are included
     870in the information printed.
    831871
    832872**EXIT STATUS:**
     
    840880**EXAMPLES:**
    841881
    842 The following is an example of using the ``queue`` command
    843 on a system with no Classic API Message Queues.
    844 .. code:: c
    845 
    846     SHLL \[/] $ queue
     882The following is an example of using the ``queue`` command on a system with no
     883Classic API Message Queues.
     884
     885.. code:: shell
     886
     887    SHLL [/] $ queue
    847888    ID       NAME   ATTRIBUTES   PEND   MAXPEND  MAXSIZE
    848889    ------------------------------------------------------------------------------
     
    853894.. index:: CONFIGURE_SHELL_COMMAND_QUEUE
    854895
    855 This command is included in the default shell command set.
    856 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_QUEUE`` to have this
    857 command included.
    858 
    859 This command can be excluded from the shell command set by
    860 defining ``CONFIGURE_SHELL_NO_COMMAND_QUEUE`` when all
    861 shell commands have been configured.
     896This command is included in the default shell command set.  When building a
     897custom command set, define ``CONFIGURE_SHELL_COMMAND_QUEUE`` to have this
     898command included.
     899
     900This command can be excluded from the shell command set by defining
     901``CONFIGURE_SHELL_NO_COMMAND_QUEUE`` when all shell commands have been
     902configured.
    862903
    863904**PROGRAMMING INFORMATION:**
     
    865906.. index:: rtems_shell_rtems_main_queue
    866907
    867 The ``queue`` is implemented by a C language function
    868 which has the following prototype:
     908The ``queue`` is implemented by a C language function which has the following
     909prototype:
     910
    869911.. code:: c
    870912
    871913    int rtems_shell_rtems_main_queue(
    872     int    argc,
    873     char \**argv
     914        int    argc,
     915        char **argv
    874916    );
    875917
    876 The configuration structure for the ``queue`` has the
    877 following prototype:
     918The configuration structure for the ``queue`` has the following prototype:
     919
    878920.. code:: c
    879921
    880922    extern rtems_shell_cmd_t rtems_shell_QUEUE_Command;
     923
     924.. _sema:
    881925
    882926sema - display information about semaphores
     
    886930**SYNOPSYS:**
    887931
    888 .. code:: c
    889 
    890     sema \[id \[id ... ] ]
    891 
    892 **DESCRIPTION:**
    893 
    894 When invoked with no arguments, this command prints information on
    895 the set of Classic API Semaphores currently active in the system.
    896 
    897 If invoked with a set of objects ids as arguments, then just
    898 those objects are included in the information printed.
     932.. code:: shell
     933
     934    sema [id [id ... ]]
     935
     936**DESCRIPTION:**
     937
     938When invoked with no arguments, this command prints information on the set of
     939Classic API Semaphores currently active in the system.
     940
     941If invoked with a set of objects ids as arguments, then just those objects are
     942included in the information printed.
    899943
    900944**EXIT STATUS:**
     
    909953
    910954The following is an example of how to use ``sema``:
    911 .. code:: c
    912 
    913     SHLL \[/] $ sema
     955
     956.. code:: shell
     957
     958    SHLL [/] $ sema
    914959    ID       NAME   ATTR        PRICEIL CURR_CNT HOLDID
    915960    ------------------------------------------------------------------------------
     
    928973.. index:: CONFIGURE_SHELL_COMMAND_SEMA
    929974
    930 This command is included in the default shell command set.
    931 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_SEMA`` to have this
    932 command included.
    933 
    934 This command can be excluded from the shell command set by
    935 defining ``CONFIGURE_SHELL_NO_COMMAND_SEMA`` when all
    936 shell commands have been configured.
     975This command is included in the default shell command set.  When building a
     976custom command set, define ``CONFIGURE_SHELL_COMMAND_SEMA`` to have this
     977command included.
     978
     979This command can be excluded from the shell command set by defining
     980``CONFIGURE_SHELL_NO_COMMAND_SEMA`` when all shell commands have been
     981configured.
    937982
    938983**PROGRAMMING INFORMATION:**
     
    940985.. index:: rtems_shell_rtems_main_sema
    941986
    942 The ``sema`` is implemented by a C language function
    943 which has the following prototype:
     987The ``sema`` is implemented by a C language function which has the following
     988prototype:
     989
    944990.. code:: c
    945991
    946992    int rtems_shell_rtems_main_sema(
    947     int    argc,
    948     char \**argv
     993        int    argc,
     994        char **argv
    949995    );
    950996
    951 The configuration structure for the ``sema`` has the
    952 following prototype:
     997The configuration structure for the ``sema`` has the following prototype:
     998
    953999.. code:: c
    9541000
    9551001    extern rtems_shell_cmd_t rtems_shell_SEMA_Command;
     1002
     1003.. _region:
    9561004
    9571005region - display information about regions
     
    9611009**SYNOPSYS:**
    9621010
    963 .. code:: c
    964 
    965     region \[id \[id ... ] ]
    966 
    967 **DESCRIPTION:**
    968 
    969 When invoked with no arguments, this command prints information on
    970 the set of Classic API Regions currently active in the system.
    971 
    972 If invoked with a set of object ids as arguments, then just
    973 those object are included in the information printed.
     1011.. code:: shell
     1012
     1013    region [id [id ... ]]
     1014
     1015**DESCRIPTION:**
     1016
     1017When invoked with no arguments, this command prints information on the set of
     1018Classic API Regions currently active in the system.
     1019
     1020If invoked with a set of object ids as arguments, then just those object are
     1021included in the information printed.
    9741022
    9751023**EXIT STATUS:**
     
    9831031**EXAMPLES:**
    9841032
    985 The following is an example of using the ``region`` command
    986 on a system with no user extensions.
    987 .. code:: c
    988 
    989     SHLL \[/] $ region
     1033The following is an example of using the ``region`` command on a system with no
     1034user extensions.
     1035
     1036.. code:: shell
     1037
     1038    SHLL [/] $ region
    9901039    ID       NAME   ATTR        STARTADDR LENGTH    PAGE_SIZE USED_BLOCKS
    9911040    ------------------------------------------------------------------------------
     
    9961045.. index:: CONFIGURE_SHELL_COMMAND_REGION
    9971046
    998 This command is included in the default shell command set.
    999 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_REGION`` to have this
    1000 command included.
    1001 
    1002 This command can be excluded from the shell command set by
    1003 defining ``CONFIGURE_SHELL_NO_COMMAND_REGION`` when all
    1004 shell commands have been configured.
     1047This command is included in the default shell command set.  When building a
     1048custom command set, define ``CONFIGURE_SHELL_COMMAND_REGION`` to have this
     1049command included.
     1050
     1051This command can be excluded from the shell command set by defining
     1052``CONFIGURE_SHELL_NO_COMMAND_REGION`` when all shell commands have been
     1053configured.
    10051054
    10061055**PROGRAMMING INFORMATION:**
     
    10081057.. index:: rtems_shell_rtems_main_region
    10091058
    1010 The ``region`` is implemented by a C language function
    1011 which has the following prototype:
     1059The ``region`` is implemented by a C language function which has the following
     1060prototype:
     1061
    10121062.. code:: c
    10131063
    10141064    int rtems_shell_rtems_main_region(
    1015     int    argc,
    1016     char \**argv
     1065        int    argc,
     1066        char **argv
    10171067    );
    10181068
    1019 The configuration structure for the ``region`` has the
    1020 following prototype:
     1069The configuration structure for the ``region`` has the following prototype:
     1070
    10211071.. code:: c
    10221072
    10231073    extern rtems_shell_cmd_t rtems_shell_REGION_Command;
     1074
     1075.. _part:
    10241076
    10251077part - display information about partitions
     
    10291081**SYNOPSYS:**
    10301082
    1031 .. code:: c
    1032 
    1033     part \[id \[id ... ] ]
    1034 
    1035 **DESCRIPTION:**
    1036 
    1037 When invoked with no arguments, this command prints information on
    1038 the set of Classic API Partitions currently active in the system.
    1039 
    1040 If invoked with a set of object ids as arguments, then just
    1041 those objects are included in the information printed.
     1083.. code:: shell
     1084
     1085    part [id [id ... ]]
     1086
     1087**DESCRIPTION:**
     1088
     1089When invoked with no arguments, this command prints information on the set of
     1090Classic API Partitions currently active in the system.
     1091
     1092If invoked with a set of object ids as arguments, then just those objects are
     1093included in the information printed.
    10421094
    10431095**EXIT STATUS:**
     
    10511103**EXAMPLES:**
    10521104
    1053 The following is an example of using the ``part`` command
    1054 on a system with no user extensions.
    1055 .. code:: c
    1056 
    1057     SHLL \[/] $ part
     1105The following is an example of using the ``part`` command on a system with no
     1106user extensions.
     1107
     1108.. code:: shell
     1109
     1110    SHLL [/] $ part
    10581111    ID       NAME   ATTR        STARTADDR LENGTH    BUF_SIZE  USED_BLOCKS
    10591112    ------------------------------------------------------------------------------
     
    10641117.. index:: CONFIGURE_SHELL_COMMAND_PART
    10651118
    1066 This command is included in the default shell command set.
    1067 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_PART`` to have this
    1068 command included.
    1069 
    1070 This command can be excluded from the shell command set by
    1071 defining ``CONFIGURE_SHELL_NO_COMMAND_PART`` when all
    1072 shell commands have been configured.
     1119This command is included in the default shell command set.  When building a
     1120custom command set, define ``CONFIGURE_SHELL_COMMAND_PART`` to have this
     1121command included.
     1122
     1123This command can be excluded from the shell command set by defining
     1124``CONFIGURE_SHELL_NO_COMMAND_PART`` when all shell commands have been
     1125configured.
    10731126
    10741127**PROGRAMMING INFORMATION:**
     
    10761129.. index:: rtems_shell_rtems_main_part
    10771130
    1078 The ``part`` is implemented by a C language function
    1079 which has the following prototype:
     1131The ``part`` is implemented by a C language function which has the following
     1132prototype:
     1133
    10801134.. code:: c
    10811135
    10821136    int rtems_shell_rtems_main_part(
    1083     int    argc,
    1084     char \**argv
     1137        int    argc,
     1138        char **argv
    10851139    );
    10861140
    1087 The configuration structure for the ``part`` has the
    1088 following prototype:
     1141The configuration structure for the ``part`` has the following prototype:
     1142
    10891143.. code:: c
    10901144
    10911145    extern rtems_shell_cmd_t rtems_shell_PART_Command;
     1146
     1147.. _object:
    10921148
    10931149object - display information about rtems objects
     
    10971153**SYNOPSYS:**
    10981154
    1099 .. code:: c
    1100 
    1101     object \[id \[id ...] ]
    1102 
    1103 **DESCRIPTION:**
    1104 
    1105 When invoked with a set of object ids as arguments, then
    1106 a report on those objects is printed.
     1155.. code:: shell
     1156
     1157    object [id [id ...]]
     1158
     1159**DESCRIPTION:**
     1160
     1161When invoked with a set of object ids as arguments, then a report on those
     1162objects is printed.
    11071163
    11081164**EXIT STATUS:**
     
    11171173
    11181174The following is an example of how to use ``object``:
    1119 .. code:: c
    1120 
    1121     SHLL \[/] $ object 0a010001 1a010002
     1175
     1176.. code:: shell
     1177
     1178    SHLL [/] $ object 0a010001 1a010002
    11221179    ID       NAME   PRIO   STAT   MODES  EVENTS   WAITID  WAITARG  NOTES
    11231180    ------------------------------------------------------------------------------
     
    11321189.. index:: CONFIGURE_SHELL_COMMAND_OBJECT
    11331190
    1134 This command is included in the default shell command set.
    1135 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_OBJECT`` to have this
    1136 command included.
    1137 
    1138 This command can be excluded from the shell command set by
    1139 defining ``CONFIGURE_SHELL_NO_COMMAND_OBJECT`` when all
    1140 shell commands have been configured.
     1191This command is included in the default shell command set.  When building a
     1192custom command set, define ``CONFIGURE_SHELL_COMMAND_OBJECT`` to have this
     1193command included.
     1194
     1195This command can be excluded from the shell command set by defining
     1196``CONFIGURE_SHELL_NO_COMMAND_OBJECT`` when all shell commands have been
     1197configured.
    11411198
    11421199**PROGRAMMING INFORMATION:**
     
    11441201.. index:: rtems_shell_rtems_main_object
    11451202
    1146 The ``object`` is implemented by a C language function
    1147 which has the following prototype:
     1203The ``object`` is implemented by a C language function which has the following
     1204prototype:
     1205
    11481206.. code:: c
    11491207
    11501208    int rtems_shell_rtems_main_object(
    1151     int    argc,
    1152     char \**argv
     1209        int    argc,
     1210        char **argv
    11531211    );
    11541212
    11551213The configuration structure for the ``object`` has the
    11561214following prototype:
     1215
    11571216.. code:: c
    11581217
    11591218    extern rtems_shell_cmd_t rtems_shell_OBJECT_Command;
     1219
     1220.. _driver:
    11601221
    11611222driver - display the rtems device driver table
     
    11651226**SYNOPSYS:**
    11661227
    1167 .. code:: c
    1168 
    1169     driver [ major [ major ... ] ]
    1170 
    1171 **DESCRIPTION:**
    1172 
    1173 When invoked with no arguments, this command prints information on
    1174 the set of Device Drivers currently active in the system.
    1175 
    1176 If invoked with a set of major numbers as arguments, then just
    1177 those Device Drivers are included in the information printed.
     1228.. code:: shell
     1229
     1230    driver [major [major ...]]
     1231
     1232**DESCRIPTION:**
     1233
     1234When invoked with no arguments, this command prints information on the set of
     1235Device Drivers currently active in the system.
     1236
     1237If invoked with a set of major numbers as arguments, then just those Device
     1238Drivers are included in the information printed.
    11781239
    11791240**EXIT STATUS:**
     
    11881249
    11891250The following is an example of how to use ``driver``:
    1190 .. code:: c
    1191 
    1192     SHLL \[/] $ driver
     1251
     1252.. code:: shell
     1253
     1254    SHLL [/] $ driver
    11931255    Major      Entry points
    11941256    ------------------------------------------------------------------------------
    1195     0          init: \[0x200256c];  control: \[0x20024c8]
    1196     open: \[0x2002518];  close: \[0x2002504]
    1197     read: \[0x20024f0];  write: \[0x20024dc]
    1198     1          init: \[0x20023fc];  control: \[0x2002448]
    1199     open: \[0x0];  close: \[0x0]
    1200     read: \[0x0];  write: \[0x0]
    1201     SHLL \[/] $
     1257    0          init: [0x200256c];  control: [0x20024c8]
     1258    open: [0x2002518];  close: [0x2002504]
     1259    read: [0x20024f0];  write: [0x20024dc]
     1260    1          init: [0x20023fc];  control: [0x2002448]
     1261    open: [0x0];  close: [0x0]
     1262    read: [0x0];  write: [0x0]
     1263    SHLL [/] $
    12021264
    12031265**CONFIGURATION:**
     
    12061268.. index:: CONFIGURE_SHELL_COMMAND_DRIVER
    12071269
    1208 This command is included in the default shell command set.
    1209 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_DRIVER`` to have this
    1210 command included.
    1211 
    1212 This command can be excluded from the shell command set by
    1213 defining ``CONFIGURE_SHELL_NO_COMMAND_DRIVER`` when all
    1214 shell commands have been configured.
     1270This command is included in the default shell command set.  When building a
     1271custom command set, define ``CONFIGURE_SHELL_COMMAND_DRIVER`` to have this
     1272command included.
     1273
     1274This command can be excluded from the shell command set by defining
     1275``CONFIGURE_SHELL_NO_COMMAND_DRIVER`` when all shell commands have been
     1276configured.
    12151277
    12161278**PROGRAMMING INFORMATION:**
     
    12181280.. index:: rtems_shell_rtems_main_driver
    12191281
    1220 The ``driver`` is implemented by a C language function
    1221 which has the following prototype:
     1282The ``driver`` is implemented by a C language function which has the following
     1283prototype:
     1284
    12221285.. code:: c
    12231286
    12241287    int rtems_shell_rtems_main_driver(
    1225     int    argc,
    1226     char \**argv
     1288        int    argc,
     1289        char **argv
    12271290    );
    12281291
    1229 The configuration structure for the ``driver`` has the
    1230 following prototype:
     1292The configuration structure for the ``driver`` has the following prototype:
     1293
    12311294.. code:: c
    12321295
    12331296    extern rtems_shell_cmd_t rtems_shell_DRIVER_Command;
     1297
     1298.. _dname:
    12341299
    12351300dname - displays information about named drivers
     
    12391304**SYNOPSYS:**
    12401305
    1241 .. code:: c
     1306.. code:: shell
    12421307
    12431308    dname
     
    12451310**DESCRIPTION:**
    12461311
    1247 This command XXX
    1248 
    1249 WARNING! XXX This command does not appear to work as of 27 February 2008.
     1312WARNING! This command does not appear to work as of 27 February 2008.
    12501313
    12511314**EXIT STATUS:**
     
    12601323
    12611324The following is an example of how to use ``dname``:
    1262 .. code:: c
     1325
     1326.. code:: shell
    12631327
    12641328    EXAMPLE_TBD
     
    12691333.. index:: CONFIGURE_SHELL_COMMAND_DNAME
    12701334
    1271 This command is included in the default shell command set.
    1272 When building a custom command set, define``CONFIGURE_SHELL_COMMAND_DNAME`` to have this
    1273 command included.
    1274 
    1275 This command can be excluded from the shell command set by
    1276 defining ``CONFIGURE_SHELL_NO_COMMAND_DNAME`` when all
    1277 shell commands have been configured.
     1335This command is included in the default shell command set.  When building a
     1336custom command set, define ``CONFIGURE_SHELL_COMMAND_DNAME`` to have this
     1337command included.
     1338
     1339This command can be excluded from the shell command set by defining
     1340``CONFIGURE_SHELL_NO_COMMAND_DNAME`` when all shell commands have been
     1341configured.
    12781342
    12791343**PROGRAMMING INFORMATION:**
     
    12811345.. index:: rtems_shell_rtems_main_dname
    12821346
    1283 The ``dname`` is implemented by a C language function
    1284 which has the following prototype:
     1347The ``dname`` is implemented by a C language function which has the following
     1348prototype:
     1349
    12851350.. code:: c
    12861351
    12871352    int rtems_shell_rtems_main_dname(
    1288     int    argc,
    1289     char \**argv
     1353        int    argc,
     1354        char **argv
    12901355    );
    12911356
    1292 The configuration structure for the ``dname`` has the
    1293 following prototype:
     1357The configuration structure for the ``dname`` has the following prototype:
     1358
    12941359.. code:: c
    12951360
    12961361    extern rtems_shell_cmd_t rtems_shell_DNAME_Command;
     1362
     1363.. _pthread:
    12971364
    12981365pthread - display information about POSIX threads
     
    13021369**SYNOPSYS:**
    13031370
    1304 .. code:: c
    1305 
    1306     pthread \[id \[id ...] ]
    1307 
    1308 **DESCRIPTION:**
    1309 
    1310 When invoked with no arguments, this command prints information on
    1311 the set of POSIX API threads currently active in the system.
    1312 
    1313 If invoked with a set of ids as arguments, then just
    1314 those objects are included in the information printed.
     1371.. code:: shell
     1372
     1373    pthread [id [id ...]]
     1374
     1375**DESCRIPTION:**
     1376
     1377When invoked with no arguments, this command prints information on the set of
     1378POSIX API threads currently active in the system.
     1379
     1380If invoked with a set of ids as arguments, then just those objects are included
     1381in the information printed.
    13151382
    13161383**EXIT STATUS:**
     
    13241391**EXAMPLES:**
    13251392
    1326 The following is an example of how to use the ``task`` on an
    1327 application with four POSIX threads:
    1328 .. code:: c
    1329 
    1330     SHLL \[/] $ pthread
     1393The following is an example of how to use the ``task`` on an application with
     1394four POSIX threads:
     1395
     1396.. code:: shell
     1397
     1398    SHLL [/] $ pthread
    13311399    ID       NAME           PRI  STATE MODES   EVENTS    WAITID  WAITARG  NOTES
    13321400    ------------------------------------------------------------------------------
     
    13381406**CONFIGURATION:**
    13391407
    1340 This command is part of the monitor commands which are always
    1341 available in the shell.
     1408This command is part of the monitor commands which are always available in the
     1409shell.
    13421410
    13431411**PROGRAMMING INFORMATION:**
    13441412
    13451413This command is not directly available for invocation.
    1346 
    1347 .. COMMENT: COPYRIGHT (c) 1988-2008.
    1348 
    1349 .. COMMENT: On-Line Applications Research Corporation (OAR).
    1350 
    1351 .. COMMENT: All rights reserved.
    1352 
Note: See TracChangeset for help on using the changeset viewer.