diff options
Diffstat (limited to 'shell')
| -rw-r--r-- | shell/rtems_specific_commands.rst | 801 |
1 files changed, 431 insertions, 370 deletions
diff --git a/shell/rtems_specific_commands.rst b/shell/rtems_specific_commands.rst index ccbb99b..d2cacae 100644 --- a/shell/rtems_specific_commands.rst +++ b/shell/rtems_specific_commands.rst @@ -1,3 +1,7 @@ +.. COMMENT: COPYRIGHT (c) 1988-2008. +.. COMMENT: On-Line Applications Research Corporation (OAR). +.. COMMENT: All rights reserved. + RTEMS Specific Commands ####################### @@ -6,41 +10,41 @@ Introduction The RTEMS shell has the following rtems commands: -- ``shutdown`` - Shutdown the system +- shutdown_ - Shutdown the system -- ``cpuuse`` - print or reset per thread cpu usage +- cpuuse_ - print or reset per thread cpu usage -- ``stackuse`` - print per thread stack usage +- stackuse_ - print per thread stack usage -- ``perioduse`` - print or reset per period usage +- perioduse_ - print or reset per period usage -- ``profreport`` - print a profiling report +- profreport_ - print a profiling report -- ``wkspace`` - Display information on Executive Workspace +- wkspace_ - Display information on Executive Workspace -- ``config`` - Show the system configuration. +- config_ - Show the system configuration. -- ``itask`` - List init tasks for the system +- itask_ - List init tasks for the system -- ``extension`` - Display information about extensions +- extension_ - Display information about extensions -- ``task`` - Display information about tasks +- task_ - Display information about tasks -- ``queue`` - Display information about message queues +- queue_ - Display information about message queues -- ``sema`` - display information about semaphores +- sema_ - display information about semaphores -- ``region`` - display information about regions +- region_ - display information about regions -- ``part`` - display information about partitions +- part_ - display information about partitions -- ``object`` - Display information about RTEMS objects +- object_ - Display information about RTEMS objects -- ``driver`` - Display the RTEMS device driver table +- driver_ - Display the RTEMS device driver table -- ``dname`` - Displays information about named drivers +- dname_ - Displays information about named drivers -- ``pthread`` - Displays information about POSIX threads +- pthread_ - Displays information about POSIX threads Commands ======== @@ -50,13 +54,15 @@ subsection is dedicated to each of the commands and describes the behavior and configuration of that command as well as providing an example usage. +.. _shutdown: + shutdown - Shutdown the system ------------------------------ .. index:: shutdown **SYNOPSYS:** -.. code:: c +.. code:: shell shutdown @@ -73,51 +79,52 @@ This command does not return. **EXAMPLES:** The following is an example of how to use ``shutdown``: -.. code:: c - SHLL \[/] $ shutdown +.. code:: shell + + SHLL [/] $ shutdown System shutting down at user request -The user will not see another prompt and the system will -shutdown. +The user will not see another prompt and the system will shutdown. **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN .. index:: CONFIGURE_SHELL_COMMAND_SHUTDOWN -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_SHUTDOWN`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_SHUTDOWN`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** -The configuration structure for the ``shutdown`` has the -following prototype: +The configuration structure for the ``shutdown`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_SHUTDOWN_Command; +.. _cpuuse: + cpuuse - print or reset per thread cpu usage -------------------------------------------- .. index:: cpuuse **SYNOPSYS:** -.. code:: c +.. code:: shell - cpuuse \[-r] + cpuuse [-r] **DESCRIPTION:** -This command may be used to print a report on the per thread -cpu usage or to reset the per thread CPU usage statistics. When -invoked with the ``-r`` option, the CPU usage statistics -are reset. +This command may be used to print a report on the per thread cpu usage or to +reset the per thread CPU usage statistics. When invoked with the ``-r`` option, +the CPU usage statistics are reset. **EXIT STATUS:** @@ -125,28 +132,28 @@ This command returns 0 on success and non-zero if an error is encountered. **NOTES:** -The granularity of the timing information reported is dependent -upon the BSP and the manner in which RTEMS was built. In the -default RTEMS configuration, if the BSP supports nanosecond -granularity timestamps, then the information reported will be -highly accurate. Otherwise, the accuracy of the information +The granularity of the timing information reported is dependent upon the BSP +and the manner in which RTEMS was built. In the default RTEMS configuration, +if the BSP supports nanosecond granularity timestamps, then the information +reported will be highly accurate. Otherwise, the accuracy of the information reported is limited by the clock tick quantum. **EXAMPLES:** The following is an example of how to use ``cpuuse``: -.. code:: c - SHLL \[/] $ cpuuse +.. code:: shell + + SHLL [/] $ cpuuse CPU Usage by thread ID NAME SECONDS PERCENT 0x09010001 IDLE 49.745393 98.953 0x0a010001 UI1 0.000000 0.000 0x0a010002 SHLL 0.525928 1.046 Time since last CPU Usage reset 50.271321 seconds - SHLL \[/] $ cpuuse -r + SHLL [/] $ cpuuse -r Resetting CPU Usage information - SHLL \[/] $ cpuuse + SHLL [/] $ cpuuse CPU Usage by thread ID NAME SECONDS PERCENT 0x09010001 IDLE 0.000000 0.000 @@ -154,61 +161,63 @@ The following is an example of how to use ``cpuuse``: 0x0a010002 SHLL 0.003092 100.000 Time since last CPU Usage reset 0.003092 seconds -In the above example, the system had set idle for nearly -a minute when the first report was generated. The``cpuuse -r`` and ``cpuuse`` commands were pasted -from another window so were executed with no gap between. -In the second report, only the ``shell`` thread has -run since the CPU Usage was reset. It has consumed -approximately 3.092 milliseconds of CPU time processing -the two commands and generating the output. +In the above example, the system had set idle for nearly a minute when the +first report was generated. The``cpuuse -r`` and ``cpuuse`` commands were +pasted from another window so were executed with no gap between. In the second +report, only the ``shell`` thread has run since the CPU Usage was reset. It +has consumed approximately 3.092 milliseconds of CPU time processing the two +commands and generating the output. **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_CPUUSE .. index:: CONFIGURE_SHELL_COMMAND_CPUUSE -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CPUUSE`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_CPUUSE`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_CPUUSE`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_CPUUSE`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_cpuuse -The ``cpuuse`` is implemented by a C language function -which has the following prototype: +The ``cpuuse`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_cpuuse( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``cpuuse`` has the -following prototype: +The configuration structure for the ``cpuuse`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command; +.. _stackuse: + stackuse - print per thread stack usage --------------------------------------- .. index:: stackuse **SYNOPSYS:** -.. code:: c +.. code:: shell stackuse **DESCRIPTION:** -This command prints a Stack Usage Report for all of the tasks -and threads in the system. On systems which support it, the -usage of the interrupt stack is also included in the report. +This command prints a Stack Usage Report for all of the tasks and threads in +the system. On systems which support it, the usage of the interrupt stack is +also included in the report. **EXIT STATUS:** @@ -216,16 +225,17 @@ This command always succeeds and returns 0. **NOTES:** -The ``CONFIGURE_STACK_CHECKER_ENABLED`` ``confdefs.h`` constant -must be defined when the application is configured for this -command to have any information to report. +The ``CONFIGURE_STACK_CHECKER_ENABLED`` ``confdefs.h`` constant must be defined +when the application is configured for this command to have any information to +report. **EXAMPLES:** The following is an example of how to use ``stackuse``: -.. code:: c - SHLL \[/] $ stackuse +.. code:: shell + + SHLL [/] $ stackuse Stack usage by thread ID NAME LOW HIGH CURRENT AVAILABLE USED 0x09010001 IDLE 0x023d89a0 - 0x023d99af 0x023d9760 4096 608 @@ -238,49 +248,52 @@ The following is an example of how to use ``stackuse``: .. index:: CONFIGURE_SHELL_NO_COMMAND_STACKUSE .. index:: CONFIGURE_SHELL_COMMAND_STACKUSE -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_STACKUSE`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_STACKUSE`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_STACKUSE`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_STACKUSE`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_stackuse -The ``stackuse`` is implemented by a C language function -which has the following prototype: +The ``stackuse`` is implemented by a C language function which has the +following prototype: + .. code:: c int rtems_shell_rtems_main_stackuse( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``stackuse`` has the -following prototype: +The configuration structure for the ``stackuse`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command; +.. _perioduse: + perioduse - print or reset per period usage ------------------------------------------- .. index:: perioduse **SYNOPSYS:** -.. code:: c +.. code:: shell - perioduse \[-r] + perioduse [-r] **DESCRIPTION:** -This command may be used to print a statistics report on the rate -monotonic periods in the application or to reset the rate monotonic -period usage statistics. When invoked with the ``-r`` option, the -usage statistics are reset. +This command may be used to print a statistics report on the rate monotonic +periods in the application or to reset the rate monotonic period usage +statistics. When invoked with the ``-r`` option, the usage statistics are +reset. **EXIT STATUS:** @@ -288,19 +301,19 @@ This command returns 0 on success and non-zero if an error is encountered. **NOTES:** -The granularity of the timing information reported is dependent -upon the BSP and the manner in which RTEMS was built. In the -default RTEMS configuration, if the BSP supports nanosecond -granularity timestamps, then the information reported will be -highly accurate. Otherwise, the accuracy of the information +The granularity of the timing information reported is dependent upon the BSP +and the manner in which RTEMS was built. In the default RTEMS configuration, +if the BSP supports nanosecond granularity timestamps, then the information +reported will be highly accurate. Otherwise, the accuracy of the information reported is limited by the clock tick quantum. **EXAMPLES:** The following is an example of how to use ``perioduse``: -.. code:: c - SHLL \[/] $ perioduse +.. code:: shell + + SHLL [/] $ perioduse Period information by period --- CPU times are in seconds --- --- Wall times are in seconds --- @@ -312,9 +325,9 @@ The following is an example of how to use ``perioduse``: 0x42010004 TA4 501 0 0:000043/0:044075/0:004911 0:000043/0:020004/0:002814 0x42010005 TA5 10 0 0:000065/0:005413/0:002739 0:000065/1:000457/0:041058 MIN/MAX/AVG MIN/MAX/AVG - SHLL \[/] $ perioduse -r + SHLL [/] $ perioduse -r Resetting Period Usage information - SHLL \[/] $ perioduse + SHLL [/] $ perioduse --- CPU times are in seconds --- --- Wall times are in seconds --- ID OWNER COUNT MISSED CPU TIME WALL TIME @@ -330,13 +343,13 @@ The following is an example of how to use ``perioduse``: .. index:: CONFIGURE_SHELL_NO_COMMAND_PERIODUSE .. index:: CONFIGURE_SHELL_COMMAND_PERIODUSE -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_PERIODUSE`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_PERIODUSE`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_PERIODUSE`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_PERIODUSE`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** @@ -344,32 +357,36 @@ shell commands have been configured. The ``perioduse`` is implemented by a C language function which has the following prototype: + .. code:: c int rtems_shell_rtems_main_perioduse( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``perioduse`` has the -following prototype: +The configuration structure for the ``perioduse`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command; +.. _profreport: + profreport - print a profiling report ------------------------------------- .. index:: profreport **SYNOPSYS:** -.. code:: c +.. code:: shell profreport **DESCRIPTION:** -This command may be used to print a profiling report. +This command may be used to print a profiling report if profiling is built into +the RTEMS kernel. **EXIT STATUS:** @@ -383,9 +400,10 @@ information. **EXAMPLES:** The following is an example of how to use ``profreport``: -.. code:: c - SHLL \[/] $ profreport +.. code:: shell + + SHLL [/] $ profreport <ProfilingReport name="Shell"> <PerCPUProfilingReport processorIndex="0"> <MaxThreadDispatchDisabledTime unit="ns">10447</MaxThreadDispatchDisabledTime> @@ -442,36 +460,37 @@ The following is an example of how to use ``profreport``: .. index:: CONFIGURE_SHELL_NO_COMMAND_PROFREPORT .. index:: CONFIGURE_SHELL_COMMAND_PROFREPORT -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_PROFREPORT`` to have this -command included. +When building a custom command set, define +``CONFIGURE_SHELL_COMMAND_PROFREPORT`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_PROFREPORT`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_PROFREPORT`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** -The configuration structure for the ``profreport`` has the -following prototype: +The configuration structure for the ``profreport`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_PROFREPORT_Command; +.. _wkspace: + wkspace - display information on executive workspace ---------------------------------------------------- .. index:: wkspace **SYNOPSYS:** -.. code:: c +.. code:: shell wkspace **DESCRIPTION:** -This command prints information on the current state of -the RTEMS Executive Workspace reported. This includes the -following information: +This command prints information on the current state of the RTEMS Executive +Workspace reported. This includes the following information: - Number of free blocks @@ -496,9 +515,10 @@ NONE **EXAMPLES:** The following is an example of how to use ``wkspace``: -.. code:: c - SHLL \[/] $ wkspace +.. code:: shell + + SHLL [/] $ wkspace Number of free blocks: 1 Largest free block: 132336 Total bytes free: 132336 @@ -511,40 +531,43 @@ The following is an example of how to use ``wkspace``: .. index:: CONFIGURE_SHELL_NO_COMMAND_WKSPACE .. index:: CONFIGURE_SHELL_COMMAND_WKSPACE -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_WKSPACE`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_WKSPACE`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_WKSPACE`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_WKSPACE`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_wkspace -The ``wkspace`` is implemented by a C language function -which has the following prototype: +The ``wkspace`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_wkspace( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``wkspace`` has the -following prototype: +The configuration structure for the ``wkspace`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command; +.. _config: + config - show the system configuration. --------------------------------------- .. index:: config **SYNOPSYS:** -.. code:: c +.. code:: shell config @@ -558,15 +581,17 @@ This command always succeeds and returns 0. **NOTES:** -At this time, it does not report every configuration parameter. -This is an area in which user submissions or sponsorship of -a developer would be appreciated. +At this time, it does not report every configuration parameter. This is an +area in which user submissions or sponsorship of a developer would be +appreciated. **EXAMPLES:** The following is an example of how to use ``config``: -.. code:: c +.. code:: shell + + SHLL [/] $ config INITIAL (startup) Configuration Info WORKSPACE start: 0x23d22e0; size: 0x2dd20 @@ -579,47 +604,50 @@ The following is an example of how to use ``config``: .. index:: CONFIGURE_SHELL_NO_COMMAND_CONFIG .. index:: CONFIGURE_SHELL_COMMAND_CONFIG -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_CONFIG`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_CONFIG`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_CONFIG`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_CONFIG`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_config -The ``config`` is implemented by a C language function -which has the following prototype: +The ``config`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_config( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``config`` has the -following prototype: +The configuration structure for the ``config`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_CONFIG_Command; +.. _itask: + itask - list init tasks for the system -------------------------------------- .. index:: itask **SYNOPSYS:** -.. code:: c +.. code:: shell itask **DESCRIPTION:** -This command prints a report on the set of initialization -tasks and threads in the system. +This command prints a report on the set of initialization tasks and threads in +the system. **EXIT STATUS:** @@ -627,69 +655,73 @@ This command always succeeds and returns 0. **NOTES:** -At this time, it includes only Classic API Initialization Tasks. -This is an area in which user submissions or sponsorship of -a developer would be appreciated. +At this time, it includes only Classic API Initialization Tasks. This is an +area in which user submissions or sponsorship of a developer would be +appreciated. **EXAMPLES:** The following is an example of how to use ``itask``: -.. code:: c - SHLL \[/] $ itask +.. code:: shell + + SHLL [/] $ itask # NAME ENTRY ARGUMENT PRIO MODES ATTRIBUTES STACK SIZE ------------------------------------------------------------------------------ - 0 UI1 \[0x2002258] 0 \[0x0] 1 nP DEFAULT 4096 \[0x1000] + 0 UI1 [0x2002258] 0 [0x0] 1 nP DEFAULT 4096 [0x1000] **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_ITASK .. index:: CONFIGURE_SHELL_COMMAND_ITASK -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_ITASK`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_ITASK`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_ITASK`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_ITASK`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_itask -The ``itask`` is implemented by a C language function -which has the following prototype: +The ``itask`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_itask( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``itask`` has the -following prototype: +The configuration structure for the ``itask`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_ITASK_Command; +.. _extension: + extension - display information about extensions ------------------------------------------------ .. index:: extension **SYNOPSYS:** -.. code:: c +.. code:: shell - extension \[id \[id ...] ] + extension [id [id ...]] **DESCRIPTION:** -When invoked with no arguments, this command prints information on -the set of User Extensions currently active in the system. +When invoked with no arguments, this command prints information on the set of +User Extensions currently active in the system. -If invoked with a set of ids as arguments, then just -those objects are included in the information printed. +If invoked with a set of ids as arguments, then just those objects are included +in the information printed. **EXIT STATUS:** @@ -703,9 +735,10 @@ NONE The following is an example of using the ``extension`` command on a system with no user extensions. -.. code:: c - SHLL \[/] $ extension +.. code:: shell + + SHLL [/] $ extension ID NAME ------------------------------------------------------------------------------ @@ -714,50 +747,53 @@ on a system with no user extensions. .. index:: CONFIGURE_SHELL_NO_COMMAND_EXTENSION .. index:: CONFIGURE_SHELL_COMMAND_EXTENSION -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_EXTENSION`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_EXTENSION`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_EXTENSION`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_EXTENSION`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_extension -The ``extension`` is implemented by a C language function -which has the following prototype: +The ``extension`` is implemented by a C language function which has the +following prototype: + .. code:: c int rtems_shell_rtems_main_extension( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``extension`` has the -following prototype: +The configuration structure for the ``extension`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command; +.. _task: + task - display information about tasks -------------------------------------- .. index:: task **SYNOPSYS:** -.. code:: c +.. code:: shell - task \[id \[id ...] ] + task [id [id ...]] **DESCRIPTION:** -When invoked with no arguments, this command prints information on -the set of Classic API Tasks currently active in the system. +When invoked with no arguments, this command prints information on the set of +Classic API Tasks currently active in the system. -If invoked with a set of ids as arguments, then just -those objects are included in the information printed. +If invoked with a set of ids as arguments, then just those objects are included +in the information printed. **EXIT STATUS:** @@ -769,11 +805,12 @@ NONE **EXAMPLES:** -The following is an example of how to use the ``task`` on an -application with just two Classic API tasks: -.. code:: c +The following is an example of how to use the ``task`` on an application with +just two Classic API tasks: + +.. code:: shell - SHLL \[/] $ task + SHLL [/] $ task ID NAME PRIO STAT MODES EVENTS WAITID WAITARG NOTES ------------------------------------------------------------------------------ 0a010001 UI1 1 SUSP P:T:nA NONE @@ -784,50 +821,53 @@ application with just two Classic API tasks: .. index:: CONFIGURE_SHELL_NO_COMMAND_TASK .. index:: CONFIGURE_SHELL_COMMAND_TASK -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_TASK`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_TASK`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_TASK`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_TASK`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_task -The ``task`` is implemented by a C language function -which has the following prototype: -.. code:: c +The ``task`` is implemented by a C language function which has the following +prototype: + +.. code:: shell int rtems_shell_rtems_main_task( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``task`` has the -following prototype: +The configuration structure for the ``task`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_TASK_Command; +.. _queue: + queue - display information about message queues ------------------------------------------------ .. index:: queue **SYNOPSYS:** -.. code:: c +.. code:: shell - queue \[id \[id ... ] ] + queue [id [id ... ]] **DESCRIPTION:** -When invoked with no arguments, this command prints information on -the set of Classic API Message Queues currently active in the system. +When invoked with no arguments, this command prints information on the set of +Classic API Message Queues currently active in the system. -If invoked with a set of ids as arguments, then just -those objects are included in the information printed. +If invoked with a set of ids as arguments, then just those objects are included +in the information printed. **EXIT STATUS:** @@ -839,11 +879,12 @@ NONE **EXAMPLES:** -The following is an example of using the ``queue`` command -on a system with no Classic API Message Queues. -.. code:: c +The following is an example of using the ``queue`` command on a system with no +Classic API Message Queues. - SHLL \[/] $ queue +.. code:: shell + + SHLL [/] $ queue ID NAME ATTRIBUTES PEND MAXPEND MAXSIZE ------------------------------------------------------------------------------ @@ -852,50 +893,53 @@ on a system with no Classic API Message Queues. .. index:: CONFIGURE_SHELL_NO_COMMAND_QUEUE .. index:: CONFIGURE_SHELL_COMMAND_QUEUE -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_QUEUE`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_QUEUE`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_QUEUE`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_QUEUE`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_queue -The ``queue`` is implemented by a C language function -which has the following prototype: +The ``queue`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_queue( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``queue`` has the -following prototype: +The configuration structure for the ``queue`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_QUEUE_Command; +.. _sema: + sema - display information about semaphores ------------------------------------------- .. index:: sema **SYNOPSYS:** -.. code:: c +.. code:: shell - sema \[id \[id ... ] ] + sema [id [id ... ]] **DESCRIPTION:** -When invoked with no arguments, this command prints information on -the set of Classic API Semaphores currently active in the system. +When invoked with no arguments, this command prints information on the set of +Classic API Semaphores currently active in the system. -If invoked with a set of objects ids as arguments, then just -those objects are included in the information printed. +If invoked with a set of objects ids as arguments, then just those objects are +included in the information printed. **EXIT STATUS:** @@ -908,9 +952,10 @@ NONE **EXAMPLES:** The following is an example of how to use ``sema``: -.. code:: c - SHLL \[/] $ sema +.. code:: shell + + SHLL [/] $ sema ID NAME ATTR PRICEIL CURR_CNT HOLDID ------------------------------------------------------------------------------ 1a010001 LBIO PR:BI:IN 0 1 00000000 @@ -927,50 +972,53 @@ The following is an example of how to use ``sema``: .. index:: CONFIGURE_SHELL_NO_COMMAND_SEMA .. index:: CONFIGURE_SHELL_COMMAND_SEMA -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_SEMA`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_SEMA`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_SEMA`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_SEMA`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_sema -The ``sema`` is implemented by a C language function -which has the following prototype: +The ``sema`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_sema( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``sema`` has the -following prototype: +The configuration structure for the ``sema`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_SEMA_Command; +.. _region: + region - display information about regions ------------------------------------------ .. index:: region **SYNOPSYS:** -.. code:: c +.. code:: shell - region \[id \[id ... ] ] + region [id [id ... ]] **DESCRIPTION:** -When invoked with no arguments, this command prints information on -the set of Classic API Regions currently active in the system. +When invoked with no arguments, this command prints information on the set of +Classic API Regions currently active in the system. -If invoked with a set of object ids as arguments, then just -those object are included in the information printed. +If invoked with a set of object ids as arguments, then just those object are +included in the information printed. **EXIT STATUS:** @@ -982,11 +1030,12 @@ NONE **EXAMPLES:** -The following is an example of using the ``region`` command -on a system with no user extensions. -.. code:: c +The following is an example of using the ``region`` command on a system with no +user extensions. - SHLL \[/] $ region +.. code:: shell + + SHLL [/] $ region ID NAME ATTR STARTADDR LENGTH PAGE_SIZE USED_BLOCKS ------------------------------------------------------------------------------ @@ -995,50 +1044,53 @@ on a system with no user extensions. .. index:: CONFIGURE_SHELL_NO_COMMAND_REGION .. index:: CONFIGURE_SHELL_COMMAND_REGION -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_REGION`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_REGION`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_REGION`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_REGION`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_region -The ``region`` is implemented by a C language function -which has the following prototype: +The ``region`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_region( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``region`` has the -following prototype: +The configuration structure for the ``region`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_REGION_Command; +.. _part: + part - display information about partitions ------------------------------------------- .. index:: part **SYNOPSYS:** -.. code:: c +.. code:: shell - part \[id \[id ... ] ] + part [id [id ... ]] **DESCRIPTION:** -When invoked with no arguments, this command prints information on -the set of Classic API Partitions currently active in the system. +When invoked with no arguments, this command prints information on the set of +Classic API Partitions currently active in the system. -If invoked with a set of object ids as arguments, then just -those objects are included in the information printed. +If invoked with a set of object ids as arguments, then just those objects are +included in the information printed. **EXIT STATUS:** @@ -1050,11 +1102,12 @@ NONE **EXAMPLES:** -The following is an example of using the ``part`` command -on a system with no user extensions. -.. code:: c +The following is an example of using the ``part`` command on a system with no +user extensions. - SHLL \[/] $ part +.. code:: shell + + SHLL [/] $ part ID NAME ATTR STARTADDR LENGTH BUF_SIZE USED_BLOCKS ------------------------------------------------------------------------------ @@ -1063,47 +1116,50 @@ on a system with no user extensions. .. index:: CONFIGURE_SHELL_NO_COMMAND_PART .. index:: CONFIGURE_SHELL_COMMAND_PART -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_PART`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_PART`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_PART`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_PART`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_part -The ``part`` is implemented by a C language function -which has the following prototype: +The ``part`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_part( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``part`` has the -following prototype: +The configuration structure for the ``part`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_PART_Command; +.. _object: + object - display information about rtems objects ------------------------------------------------ .. index:: object **SYNOPSYS:** -.. code:: c +.. code:: shell - object \[id \[id ...] ] + object [id [id ...]] **DESCRIPTION:** -When invoked with a set of object ids as arguments, then -a report on those objects is printed. +When invoked with a set of object ids as arguments, then a report on those +objects is printed. **EXIT STATUS:** @@ -1116,9 +1172,10 @@ NONE **EXAMPLES:** The following is an example of how to use ``object``: -.. code:: c - SHLL \[/] $ object 0a010001 1a010002 +.. code:: shell + + SHLL [/] $ object 0a010001 1a010002 ID NAME PRIO STAT MODES EVENTS WAITID WAITARG NOTES ------------------------------------------------------------------------------ 0a010001 UI1 1 SUSP P:T:nA NONE @@ -1131,50 +1188,54 @@ The following is an example of how to use ``object``: .. index:: CONFIGURE_SHELL_NO_COMMAND_OBJECT .. index:: CONFIGURE_SHELL_COMMAND_OBJECT -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_OBJECT`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_OBJECT`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_OBJECT`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_OBJECT`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_object -The ``object`` is implemented by a C language function -which has the following prototype: +The ``object`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_object( - int argc, - char \**argv + int argc, + char **argv ); The configuration structure for the ``object`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_OBJECT_Command; +.. _driver: + driver - display the rtems device driver table ---------------------------------------------- .. index:: driver **SYNOPSYS:** -.. code:: c +.. code:: shell - driver [ major [ major ... ] ] + driver [major [major ...]] **DESCRIPTION:** -When invoked with no arguments, this command prints information on -the set of Device Drivers currently active in the system. +When invoked with no arguments, this command prints information on the set of +Device Drivers currently active in the system. -If invoked with a set of major numbers as arguments, then just -those Device Drivers are included in the information printed. +If invoked with a set of major numbers as arguments, then just those Device +Drivers are included in the information printed. **EXIT STATUS:** @@ -1187,66 +1248,68 @@ NONE **EXAMPLES:** The following is an example of how to use ``driver``: -.. code:: c - SHLL \[/] $ driver +.. code:: shell + + SHLL [/] $ driver Major Entry points ------------------------------------------------------------------------------ - 0 init: \[0x200256c]; control: \[0x20024c8] - open: \[0x2002518]; close: \[0x2002504] - read: \[0x20024f0]; write: \[0x20024dc] - 1 init: \[0x20023fc]; control: \[0x2002448] - open: \[0x0]; close: \[0x0] - read: \[0x0]; write: \[0x0] - SHLL \[/] $ + 0 init: [0x200256c]; control: [0x20024c8] + open: [0x2002518]; close: [0x2002504] + read: [0x20024f0]; write: [0x20024dc] + 1 init: [0x20023fc]; control: [0x2002448] + open: [0x0]; close: [0x0] + read: [0x0]; write: [0x0] + SHLL [/] $ **CONFIGURATION:** .. index:: CONFIGURE_SHELL_NO_COMMAND_DRIVER .. index:: CONFIGURE_SHELL_COMMAND_DRIVER -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_DRIVER`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_DRIVER`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_DRIVER`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_DRIVER`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_driver -The ``driver`` is implemented by a C language function -which has the following prototype: +The ``driver`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_driver( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``driver`` has the -following prototype: +The configuration structure for the ``driver`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_DRIVER_Command; +.. _dname: + dname - displays information about named drivers ------------------------------------------------ .. index:: dname **SYNOPSYS:** -.. code:: c +.. code:: shell dname **DESCRIPTION:** -This command XXX - -WARNING! XXX This command does not appear to work as of 27 February 2008. +WARNING! This command does not appear to work as of 27 February 2008. **EXIT STATUS:** @@ -1259,7 +1322,8 @@ NONE **EXAMPLES:** The following is an example of how to use ``dname``: -.. code:: c + +.. code:: shell EXAMPLE_TBD @@ -1268,50 +1332,53 @@ The following is an example of how to use ``dname``: .. index:: CONFIGURE_SHELL_NO_COMMAND_DNAME .. index:: CONFIGURE_SHELL_COMMAND_DNAME -This command is included in the default shell command set. -When building a custom command set, define``CONFIGURE_SHELL_COMMAND_DNAME`` to have this +This command is included in the default shell command set. When building a +custom command set, define ``CONFIGURE_SHELL_COMMAND_DNAME`` to have this command included. -This command can be excluded from the shell command set by -defining ``CONFIGURE_SHELL_NO_COMMAND_DNAME`` when all -shell commands have been configured. +This command can be excluded from the shell command set by defining +``CONFIGURE_SHELL_NO_COMMAND_DNAME`` when all shell commands have been +configured. **PROGRAMMING INFORMATION:** .. index:: rtems_shell_rtems_main_dname -The ``dname`` is implemented by a C language function -which has the following prototype: +The ``dname`` is implemented by a C language function which has the following +prototype: + .. code:: c int rtems_shell_rtems_main_dname( - int argc, - char \**argv + int argc, + char **argv ); -The configuration structure for the ``dname`` has the -following prototype: +The configuration structure for the ``dname`` has the following prototype: + .. code:: c extern rtems_shell_cmd_t rtems_shell_DNAME_Command; +.. _pthread: + pthread - display information about POSIX threads ------------------------------------------------- .. index:: pthread **SYNOPSYS:** -.. code:: c +.. code:: shell - pthread \[id \[id ...] ] + pthread [id [id ...]] **DESCRIPTION:** -When invoked with no arguments, this command prints information on -the set of POSIX API threads currently active in the system. +When invoked with no arguments, this command prints information on the set of +POSIX API threads currently active in the system. -If invoked with a set of ids as arguments, then just -those objects are included in the information printed. +If invoked with a set of ids as arguments, then just those objects are included +in the information printed. **EXIT STATUS:** @@ -1323,11 +1390,12 @@ This command is only available when the POSIX API is configured. **EXAMPLES:** -The following is an example of how to use the ``task`` on an -application with four POSIX threads: -.. code:: c +The following is an example of how to use the ``task`` on an application with +four POSIX threads: + +.. code:: shell - SHLL \[/] $ pthread + SHLL [/] $ pthread ID NAME PRI STATE MODES EVENTS WAITID WAITARG NOTES ------------------------------------------------------------------------------ 0b010002 Main 133 READY P:T:nA NONE 43010001 0x7b1148 @@ -1337,16 +1405,9 @@ application with four POSIX threads: **CONFIGURATION:** -This command is part of the monitor commands which are always -available in the shell. +This command is part of the monitor commands which are always available in the +shell. **PROGRAMMING INFORMATION:** This command is not directly available for invocation. - -.. COMMENT: COPYRIGHT (c) 1988-2008. - -.. COMMENT: On-Line Applications Research Corporation (OAR). - -.. COMMENT: All rights reserved. - |