source: rtems-docs/shell/rtems_specific_commands.rst @ e52906b

5am
Last change on this file since e52906b was e52906b, checked in by Sebastian Huber <sebastian.huber@…>, on 01/09/19 at 15:14:06

Simplify SPDX-License-Identifier comment

  • Property mode set to 100644
File size: 46.0 KB
Line 
1.. SPDX-License-Identifier: CC-BY-SA-4.0
2
3.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
4
5RTEMS Specific Commands
6***********************
7
8Introduction
9============
10
11The RTEMS shell has the following RTEMS specific commands:
12
13- shutdown_ - Shutdown the system
14
15- cpuinfo_ - print per-processor information
16
17- cpuuse_ - print or reset per thread cpu usage
18
19- stackuse_ - print per thread stack usage
20
21- perioduse_ - print or reset per period usage
22
23- profreport_ - print a profiling report
24
25- wkspace_ - Display information on Executive Workspace
26
27- config_ - Show the system configuration.
28
29- itask_ - List init tasks for the system
30
31- extension_ - Display information about extensions
32
33- task_ - Display information about tasks
34
35- queue_ - Display information about message queues
36
37- sema_ - display information about semaphores
38
39- region_ - display information about regions
40
41- part_ - display information about partitions
42
43- object_ - Display information about RTEMS objects
44
45- driver_ - Display the RTEMS device driver table
46
47- dname_ - Displays information about named drivers
48
49- pthread_ - Displays information about POSIX threads
50
51Commands
52========
53
54This section details the RTEMS Specific Commands available.  A subsection is
55dedicated to each of the commands and describes the behavior and configuration
56of that command as well as providing an example usage.
57
58.. raw:: latex
59
60   \clearpage
61
62.. _shutdown:
63
64shutdown - Shutdown the system
65------------------------------
66.. index:: shutdown
67
68SYNOPSYS:
69    .. code-block:: shell
70
71        shutdown
72
73DESCRIPTION:
74    This command is used to shutdown the RTEMS application.
75
76EXIT STATUS:
77    This command does not return.
78
79NOTES:
80    NONE
81
82EXAMPLES:
83    The following is an example of how to use ``shutdown``:
84
85    .. code-block:: shell
86
87        SHLL [/] $ shutdown
88        System shutting down at user request
89
90    The user will not see another prompt and the system will shutdown.
91
92.. index:: CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN
93.. index:: CONFIGURE_SHELL_COMMAND_SHUTDOWN
94
95CONFIGURATION:
96    This command is included in the default shell command set.  When building a
97    custom command set, define ``CONFIGURE_SHELL_COMMAND_SHUTDOWN`` to have
98    this command included.
99
100    This command can be excluded from the shell command set by defining
101    ``CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN`` when all shell commands have been
102    configured.
103
104PROGRAMMING INFORMATION:
105    The configuration structure for the ``shutdown`` has the following
106    prototype:
107
108    .. code-block:: c
109
110        extern rtems_shell_cmd_t rtems_shell_SHUTDOWN_Command;
111
112.. raw:: latex
113
114   \clearpage
115
116.. _cpuinfo:
117
118cpuinfo - print per-processor information
119--------------------------------------------
120.. index:: cpuinfo
121
122SYNOPSYS:
123    .. code-block:: shell
124
125        cpuinfo
126
127DESCRIPTION:
128    This command may be used to print per-processor information.
129
130EXIT STATUS:
131    This command returns 0 on success and non-zero if an error is encountered.
132
133EXAMPLES:
134    The following is an example of how to use ``cpuinfo``:
135
136    .. code-block:: shell
137
138        SHLL [/] $ cpuinfo
139        -------------------------------------------------------------------------------
140                                    PER PROCESSOR INFORMATION
141        -------+--------+--------------+-----------------------------------------------
142         INDEX | ONLINE | SCHEDULER ID | SCHEDULER NAME
143        -------+--------+--------------+-----------------------------------------------
144             0 |      1 |   0x0f010001 | UPD
145
146    In the above example, the system has only one processor.  This processor
147    has the index zero and is online.  It is owned by the scheduler with the
148    identifier ``0x0f010001`` and name ``UPD``.
149
150.. index:: CONFIGURE_SHELL_NO_COMMAND_CPUINFO
151.. index:: CONFIGURE_SHELL_COMMAND_CPUINFO
152
153CONFIGURATION:
154    This command is included in the default shell command set.  When building a
155    custom command set, define ``CONFIGURE_SHELL_COMMAND_CPUINFO`` to have this
156    command included.
157
158    This command can be excluded from the shell command set by defining
159    ``CONFIGURE_SHELL_NO_COMMAND_CPUINFO`` when all shell commands have been
160    configured.
161
162.. index:: rtems_shell_rtems_main_cpuinfo
163
164PROGRAMMING INFORMATION:
165    The ``cpuinfo`` is implemented by a C language function which has the following
166    prototype:
167
168    .. code-block:: c
169
170        int rtems_cpu_info_report(
171            const rtems_printer *printer
172        );
173
174    The configuration structure for the ``cpuinfo`` has the following prototype:
175
176    .. code-block:: c
177
178        extern rtems_shell_cmd_t rtems_shell_CPUINFO_Command;
179
180.. raw:: latex
181
182   \clearpage
183
184.. _cpuuse:
185
186cpuuse - print or reset per thread cpu usage
187--------------------------------------------
188.. index:: cpuuse
189
190SYNOPSYS:
191    .. code-block:: shell
192
193        cpuuse [-r]
194
195DESCRIPTION:
196    This command may be used to print a report on the per thread cpu usage or
197    to reset the per thread CPU usage statistics. When invoked with the ``-r``
198    option, the CPU usage statistics are reset.
199
200EXIT STATUS:
201    This command returns 0 on success and non-zero if an error is encountered.
202
203NOTES:
204    The granularity of the timing information reported is dependent upon the
205    BSP and the manner in which RTEMS was built.  In the default RTEMS
206    configuration, if the BSP supports nanosecond granularity timestamps, then
207    the information reported will be highly accurate. Otherwise, the accuracy
208    of the information reported is limited by the clock tick quantum.
209
210EXAMPLES:
211    The following is an example of how to use ``cpuuse``:
212
213    .. code-block:: shell
214
215        [/] cpuuse
216        -------------------------------------------------------------------------------
217                                      CPU USAGE BY THREAD
218        ------------+----------------------------------------+---------------+---------
219         ID         | NAME                                   | SECONDS       | PERCENT
220        ------------+----------------------------------------+---------------+---------
221         0x09010001 | IDLE                                   |     11.444381 |  73.938
222         0x0a010001 | UI1                                    |      0.206754 |   1.335
223         0x0a010002 | BSWP                                   |      0.008277 |   0.053
224         0x0a010003 | BRDA                                   |      0.000952 |   0.006
225         0x0a010004 | MDIA                                   |      0.000334 |   0.002
226         0x0a010005 | TIME                                   |      0.912809 |   5.895
227         0x0a010006 | IRQS                                   |      0.004810 |   0.031
228         0x0a010007 | swi1: netisr 0                         |      0.002593 |   0.016
229         0x0a010008 | kqueue_ctx task                        |      0.000663 |   0.004
230         0x0a010009 | swi5: fast task                        |      0.000059 |   0.000
231         0x0a01000a | thread taskq                           |      0.000057 |   0.000
232         0x0a01000b | swi6: task queu                        |      0.003063 |   0.019
233         0x0a01000c | DHCP                                   |      1.391745 |   8.986
234         0x0a01000d | FTPa                                   |      0.002203 |   0.014
235         0x0a01000e | FTPb                                   |      0.000233 |   0.001
236         0x0a01000f | FTPc                                   |      0.000226 |   0.001
237         0x0a010010 | FTPd                                   |      0.000228 |   0.001
238         0x0a010011 | FTPD                                   |      0.002959 |   0.019
239         0x0a010012 | TNTD                                   |      0.001111 |   0.007
240         0x0a010013 | SHLL                                   |      1.508445 |   9.736
241        ------------+----------------------------------------+---------------+---------
242         TIME SINCE LAST CPU USAGE RESET IN SECONDS:                         15.492171
243        -------------------------------------------------------------------------------
244        [/] # cpuuse -r
245        Resetting CPU Usage information
246        [/] # cpuuse
247        -------------------------------------------------------------------------------
248                                      CPU USAGE BY THREAD
249        ------------+----------------------------------------+---------------+---------
250         ID         | NAME                                   | SECONDS       | PERCENT
251        ------------+----------------------------------------+---------------+---------
252         0x09010001 | IDLE                                   |      0.000000 |   0.000
253         0x0a010001 | UI1                                    |      0.000000 |   0.000
254         0x0a010002 | BSWP                                   |      0.000000 |   0.000
255         0x0a010003 | BRDA                                   |      0.000000 |   0.000
256         0x0a010004 | MDIA                                   |      0.000000 |   0.000
257         0x0a010005 | TIME                                   |      0.000000 |   0.000
258         0x0a010006 | IRQS                                   |      0.000000 |   0.000
259         0x0a010007 | swi1: netisr 0                         |      0.000000 |   0.000
260         0x0a010008 | kqueue_ctx task                        |      0.000000 |   0.000
261         0x0a010009 | swi5: fast task                        |      0.000000 |   0.000
262         0x0a01000a | thread taskq                           |      0.000000 |   0.000
263         0x0a01000b | swi6: task queu                        |      0.000000 |   0.000
264         0x0a01000c | DHCP                                   |      0.000000 |   0.000
265         0x0a01000d | FTPa                                   |      0.000000 |   0.000
266         0x0a01000e | FTPb                                   |      0.000000 |   0.000
267         0x0a01000f | FTPc                                   |      0.000000 |   0.000
268         0x0a010010 | FTPd                                   |      0.000000 |   0.000
269         0x0a010011 | FTPD                                   |      0.000000 |   0.000
270         0x0a010012 | TNTD                                   |      0.000000 |   0.000
271         0x0a010013 | SHLL                                   |      0.016503 |  99.962
272        ------------+----------------------------------------+---------------+---------
273         TIME SINCE LAST CPU USAGE RESET IN SECONDS:                          0.016509
274        -------------------------------------------------------------------------------
275
276    In the above example, the system did something for roughly 15 seconds when the
277    first report was generated.  The ``cpuuse -r`` and ``cpuuse`` commands were
278    pasted from another window so were executed with no gap between.  In the
279    second report, only the ``SHLL`` thread has run since the CPU Usage was
280    reset.  It has consumed approximately 16.509 milliseconds of CPU time
281    processing the two commands and generating the output.
282
283.. index:: CONFIGURE_SHELL_NO_COMMAND_CPUUSE
284.. index:: CONFIGURE_SHELL_COMMAND_CPUUSE
285
286CONFIGURATION:
287    This command is included in the default shell command set.  When building a
288    custom command set, define ``CONFIGURE_SHELL_COMMAND_CPUUSE`` to have this
289    command included.
290
291    This command can be excluded from the shell command set by defining
292    ``CONFIGURE_SHELL_NO_COMMAND_CPUUSE`` when all shell commands have been
293    configured.
294
295.. index:: rtems_shell_rtems_main_cpuuse
296
297PROGRAMMING INFORMATION:
298    The ``cpuuse`` is implemented by a C language function which has the following
299    prototype:
300
301    .. code-block:: c
302
303        int rtems_shell_rtems_main_cpuuse(
304           int    argc,
305           char **argv
306        );
307
308    The configuration structure for the ``cpuuse`` has the following prototype:
309
310    .. code-block:: c
311
312        extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command;
313
314.. raw:: latex
315
316   \clearpage
317
318.. _stackuse:
319
320stackuse - print per thread stack usage
321---------------------------------------
322.. index:: stackuse
323
324SYNOPSYS:
325    .. code-block:: shell
326
327        stackuse
328
329DESCRIPTION:
330    This command prints a Stack Usage Report for all of the tasks and threads
331    in the system.  On systems which support it, the usage of the interrupt
332    stack is also included in the report.
333
334EXIT STATUS:
335    This command always succeeds and returns 0.
336
337NOTES:
338    The ``CONFIGURE_STACK_CHECKER_ENABLED`` ``confdefs.h`` constant must be
339    defined when the application is configured for this command to have any
340    information to report.
341
342EXAMPLES:
343    The following is an example of how to use ``stackuse``:
344
345    .. code-block:: shell
346
347        [/] # stackuse
348                                     STACK USAGE BY THREAD
349        ID         NAME                  LOW        HIGH       CURRENT    AVAIL  USED
350        0x09010001 IDLE                  0x03559960 0x03564055 0x03563728   4080    584
351        0x0a010001 UI1                   0x03564664 0x03597431 0x03596976  32752   4168
352        0x0a010002 BSWP                  0x03714576 0x03718671 0x03718408   4080    564
353        0x0a010003 BRDA                  0x03718680 0x03722775 0x03722480   4080    596
354        0x0a010004 MDIA                  0x03722808 0x03755575 0x03755288  32752    588
355        0x0a010005 TIME                  0x03755664 0x03788431 0x03788168  32752   1448
356        0x0a010006 IRQS                  0x03788440 0x03821207 0x03820952  32752    608
357        0x0a010007 swi1: netisr 0        0x03896880 0x03929647 0x03929376  32752    820
358        0x0a010008 kqueue_ctx task       0x03929872 0x03962639 0x03962392  32752    580
359        0x0a010009 swi5: fast task       0x03963088 0x03995855 0x03995584  32752    572
360        0x0a01000a thread taskq          0x03996080 0x04028847 0x04028600  32752    548
361        0x0a01000b swi6: task queu       0x04029296 0x04062063 0x04061792  32752   1364
362        0x0a01000c DHCP                  0x04250192 0x04258383 0x04257288   8176   2764
363        0x0a01000d FTPa                  0x04258792 0x04266983 0x04265792   8176   1548
364        0x0a01000e FTPb                  0x04267120 0x04275311 0x04274120   8176   1496
365        0x0a01000f FTPc                  0x04275448 0x04283639 0x04282448   8176   1496
366        0x0a010010 FTPd                  0x04283776 0x04291967 0x04290776   8176   1496
367        0x0a010011 FTPD                  0x04292104 0x04296199 0x04295784   4080    772
368        0x0a010012 TNTD                  0x04297088 0x04329855 0x04329368  32752    804
369        0x0a010013 SHLL                  0x04329976 0x04346359 0x04344576  16368   3616
370
371.. index:: CONFIGURE_SHELL_NO_COMMAND_STACKUSE
372.. index:: CONFIGURE_SHELL_COMMAND_STACKUSE
373
374CONFIGURATION:
375    This command is included in the default shell command set.  When building a
376    custom command set, define ``CONFIGURE_SHELL_COMMAND_STACKUSE`` to have
377    this command included.
378
379    This command can be excluded from the shell command set by defining
380    ``CONFIGURE_SHELL_NO_COMMAND_STACKUSE`` when all shell commands have been
381    configured.
382
383.. index:: rtems_shell_rtems_main_stackuse
384
385PROGRAMMING INFORMATION:
386    The ``stackuse`` is implemented by a C language function which has the
387    following prototype:
388
389    .. code-block:: c
390
391        int rtems_shell_rtems_main_stackuse(
392            int    argc,
393            char **argv
394        );
395
396    The configuration structure for the ``stackuse`` has the following prototype:
397
398    .. code-block:: c
399
400        extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command;
401
402.. raw:: latex
403
404   \clearpage
405
406.. _perioduse:
407
408perioduse - print or reset per period usage
409-------------------------------------------
410.. index:: perioduse
411
412SYNOPSYS:
413    .. code-block:: shell
414
415        perioduse [-r]
416
417DESCRIPTION:
418    This command may be used to print a statistics report on the rate monotonic
419    periods in the application or to reset the rate monotonic period usage
420    statistics. When invoked with the ``-r`` option, the usage statistics are
421    reset.
422
423EXIT STATUS:
424    This command returns 0 on success and non-zero if an error is encountered.
425
426NOTES:
427    The granularity of the timing information reported is dependent upon the
428    BSP and the manner in which RTEMS was built.  In the default RTEMS
429    configuration, if the BSP supports nanosecond granularity timestamps, then
430    the information reported will be highly accurate. Otherwise, the accuracy
431    of the information reported is limited by the clock tick quantum.
432
433EXAMPLES:
434    The following is an example of how to use ``perioduse``:
435
436    .. code-block:: shell
437
438        SHLL [/] $ perioduse
439        Period information by period
440        --- CPU times are in seconds ---
441        --- Wall times are in seconds ---
442        ID     OWNER COUNT MISSED          CPU TIME                  WALL TIME
443        MIN/MAX/AVG                MIN/MAX/AVG
444        0x42010001 TA1    502      0 0:000039/0:042650/0:004158 0:000039/0:020118/0:002848
445        0x42010002 TA2    502      0 0:000041/0:042657/0:004309 0:000041/0:020116/0:002848
446        0x42010003 TA3    501      0 0:000041/0:041564/0:003653 0:000041/0:020003/0:002814
447        0x42010004 TA4    501      0 0:000043/0:044075/0:004911 0:000043/0:020004/0:002814
448        0x42010005 TA5     10      0 0:000065/0:005413/0:002739 0:000065/1:000457/0:041058
449        MIN/MAX/AVG                MIN/MAX/AVG
450        SHLL [/] $ perioduse -r
451        Resetting Period Usage information
452        SHLL [/] $ perioduse
453        --- CPU times are in seconds ---
454        --- Wall times are in seconds ---
455        ID     OWNER COUNT MISSED          CPU TIME                  WALL TIME
456        MIN/MAX/AVG                MIN/MAX/AVG
457        0x42010001 TA1      0      0
458        0x42010002 TA2      0      0
459        0x42010003 TA3      0      0
460        0x42010004 TA4      0      0
461        0x42010005 TA5      0      0
462
463.. index:: CONFIGURE_SHELL_NO_COMMAND_PERIODUSE
464.. index:: CONFIGURE_SHELL_COMMAND_PERIODUSE
465
466CONFIGURATION:
467    This command is included in the default shell command set.  When building a
468    custom command set, define ``CONFIGURE_SHELL_COMMAND_PERIODUSE`` to have
469    this command included.
470
471    This command can be excluded from the shell command set by defining
472    ``CONFIGURE_SHELL_NO_COMMAND_PERIODUSE`` when all shell commands have been
473    configured.
474
475.. index:: rtems_shell_rtems_main_perioduse
476
477PROGRAMMING INFORMATION:
478    The ``perioduse`` is implemented by a C language function which has the
479    following prototype:
480
481    .. code-block:: c
482
483        int rtems_shell_rtems_main_perioduse(
484            int    argc,
485            char **argv
486        );
487
488    The configuration structure for the ``perioduse`` has the following prototype:
489
490    .. code-block:: c
491
492        extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command;
493
494.. raw:: latex
495
496   \clearpage
497
498.. _profreport:
499
500profreport - print a profiling report
501-------------------------------------
502.. index:: profreport
503
504SYNOPSYS:
505    .. code-block:: shell
506
507        profreport
508
509DESCRIPTION:
510    This command may be used to print a profiling report if profiling is built
511    into the RTEMS kernel.
512
513EXIT STATUS:
514    This command returns 0.
515
516NOTES:
517    Profiling must be enabled at build configuration time to get profiling
518    information.
519
520EXAMPLES:
521    The following is an example of how to use ``profreport``:
522
523    .. code-block:: shell
524
525        SHLL [/] $ profreport
526        <ProfilingReport name="Shell">
527        <PerCPUProfilingReport processorIndex="0">
528        <MaxThreadDispatchDisabledTime unit="ns">10447</MaxThreadDispatchDisabledTime>
529        <MeanThreadDispatchDisabledTime unit="ns">2</MeanThreadDispatchDisabledTime>
530        <TotalThreadDispatchDisabledTime unit="ns">195926627</TotalThreadDispatchDisabledTime>
531        <ThreadDispatchDisabledCount>77908688</ThreadDispatchDisabledCount>
532        <MaxInterruptDelay unit="ns">0</MaxInterruptDelay>
533        <MaxInterruptTime unit="ns">688</MaxInterruptTime>
534        <MeanInterruptTime unit="ns">127</MeanInterruptTime>
535        <TotalInterruptTime unit="ns">282651157</TotalInterruptTime>
536        <InterruptCount>2215855</InterruptCount>
537        </PerCPUProfilingReport>
538        <PerCPUProfilingReport processorIndex="1">
539        <MaxThreadDispatchDisabledTime unit="ns">9053</MaxThreadDispatchDisabledTime>
540        <MeanThreadDispatchDisabledTime unit="ns">41</MeanThreadDispatchDisabledTime>
541        <TotalThreadDispatchDisabledTime unit="ns">3053830335</TotalThreadDispatchDisabledTime>
542        <ThreadDispatchDisabledCount>73334202</ThreadDispatchDisabledCount>
543        <MaxInterruptDelay unit="ns">0</MaxInterruptDelay>
544        <MaxInterruptTime unit="ns">57</MaxInterruptTime>
545        <MeanInterruptTime unit="ns">35</MeanInterruptTime>
546        <TotalInterruptTime unit="ns">76980203</TotalInterruptTime>
547        <InterruptCount>2141179</InterruptCount>
548        </PerCPUProfilingReport>
549        <SMPLockProfilingReport name="SMP lock stats">
550        <MaxAcquireTime unit="ns">608</MaxAcquireTime>
551        <MaxSectionTime unit="ns">1387</MaxSectionTime>
552        <MeanAcquireTime unit="ns">112</MeanAcquireTime>
553        <MeanSectionTime unit="ns">338</MeanSectionTime>
554        <TotalAcquireTime unit="ns">119031</TotalAcquireTime>
555        <TotalSectionTime unit="ns">357222</TotalSectionTime>
556        <UsageCount>1055</UsageCount>
557        <ContentionCount initialQueueLength="0">1055</ContentionCount>
558        <ContentionCount initialQueueLength="1">0</ContentionCount>
559        <ContentionCount initialQueueLength="2">0</ContentionCount>
560        <ContentionCount initialQueueLength="3">0</ContentionCount>
561        </SMPLockProfilingReport>
562        <SMPLockProfilingReport name="Giant">
563        <MaxAcquireTime unit="ns">4186</MaxAcquireTime>
564        <MaxSectionTime unit="ns">7575</MaxSectionTime>
565        <MeanAcquireTime unit="ns">160</MeanAcquireTime>
566        <MeanSectionTime unit="ns">183</MeanSectionTime>
567        <TotalAcquireTime unit="ns">1772793111</TotalAcquireTime>
568        <TotalSectionTime unit="ns">2029733879</TotalSectionTime>
569        <UsageCount>11039140</UsageCount>
570        <ContentionCount initialQueueLength="0">11037655</ContentionCount>
571        <ContentionCount initialQueueLength="1">1485</ContentionCount>
572        <ContentionCount initialQueueLength="2">0</ContentionCount>
573        <ContentionCount initialQueueLength="3">0</ContentionCount>
574        </SMPLockProfilingReport>
575        </ProfilingReport>
576
577.. index:: CONFIGURE_SHELL_NO_COMMAND_PROFREPORT
578.. index:: CONFIGURE_SHELL_COMMAND_PROFREPORT
579
580CONFIGURATION:
581    When building a custom command set, define
582    ``CONFIGURE_SHELL_COMMAND_PROFREPORT`` to have this command included.
583
584    This command can be excluded from the shell command set by defining
585    ``CONFIGURE_SHELL_NO_COMMAND_PROFREPORT`` when all shell commands have been
586    configured.
587
588PROGRAMMING INFORMATION:
589    The configuration structure for the ``profreport`` has the following
590    prototype:
591
592    .. code-block:: c
593
594        extern rtems_shell_cmd_t rtems_shell_PROFREPORT_Command;
595
596.. raw:: latex
597
598   \clearpage
599
600.. _wkspace:
601
602wkspace - display information on executive workspace
603----------------------------------------------------
604.. index:: wkspace
605
606SYNOPSYS:
607    .. code-block:: shell
608
609        wkspace
610
611DESCRIPTION:
612    This command prints information on the current state of the RTEMS Executive
613    Workspace reported.  This includes the following information:
614
615    - Number of free blocks
616
617    - Largest free block
618
619    - Total bytes free
620
621    - Number of used blocks
622
623    - Largest used block
624
625    - Total bytes used
626
627EXIT STATUS:
628    This command always succeeds and returns 0.
629
630NOTES:
631    NONE
632
633EXAMPLES:
634    The following is an example of how to use ``wkspace``:
635
636    .. code-block:: shell
637
638        SHLL [/] $ wkspace
639        Number of free blocks: 1
640        Largest free block:    132336
641        Total bytes free:      132336
642        Number of used blocks: 36
643        Largest used block:    16408
644        Total bytes used:      55344
645
646.. index:: CONFIGURE_SHELL_NO_COMMAND_WKSPACE
647.. index:: CONFIGURE_SHELL_COMMAND_WKSPACE
648
649CONFIGURATION:
650    This command is included in the default shell command set.  When building a
651    custom command set, define ``CONFIGURE_SHELL_COMMAND_WKSPACE`` to have this
652    command included.
653
654    This command can be excluded from the shell command set by defining
655    ``CONFIGURE_SHELL_NO_COMMAND_WKSPACE`` when all shell commands have been
656    configured.
657
658.. index:: rtems_shell_rtems_main_wkspace
659
660PROGRAMMING INFORMATION:
661    The ``wkspace`` is implemented by a C language function which has the
662    following prototype:
663
664    .. code-block:: c
665
666        int rtems_shell_rtems_main_wkspace(
667            int    argc,
668            char **argv
669        );
670
671    The configuration structure for the ``wkspace`` has the following prototype:
672
673    .. code-block:: c
674
675        extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command;
676
677.. raw:: latex
678
679   \clearpage
680
681.. _config:
682
683config - show the system configuration.
684---------------------------------------
685.. index:: config
686
687SYNOPSYS:
688    .. code-block:: shell
689
690        config
691
692DESCRIPTION:
693    This command display information about the RTEMS Configuration.
694
695EXIT STATUS:
696    This command always succeeds and returns 0.
697
698NOTES:
699    At this time, it does not report every configuration parameter.  This is an
700    area in which user submissions or sponsorship of a developer would be
701    appreciated.
702
703EXAMPLES:
704    The following is an example of how to use ``config``:
705
706    .. code-block:: shell
707
708        SHLL [/] $ config
709        INITIAL (startup) Configuration Info
710
711        WORKSPACE      start: 0x23d22e0;  size: 0x2dd20
712        TIME           usec/tick: 10000;  tick/timeslice: 50;  tick/sec: 100
713        MAXIMUMS       tasks: 20;  timers: 0;  sems: 50;  que's: 20;  ext's: 1
714        partitions: 0;  regions: 0;  ports: 0;  periods: 0
715
716.. index:: CONFIGURE_SHELL_NO_COMMAND_CONFIG
717.. index:: CONFIGURE_SHELL_COMMAND_CONFIG
718
719CONFIGURATION:
720    This command is included in the default shell command set.  When building a
721    custom command set, define ``CONFIGURE_SHELL_COMMAND_CONFIG`` to have this
722    command included.
723
724    This command can be excluded from the shell command set by defining
725    ``CONFIGURE_SHELL_NO_COMMAND_CONFIG`` when all shell commands have been
726    configured.
727
728.. index:: rtems_shell_rtems_main_config
729
730PROGRAMMING INFORMATION:
731    The ``config`` is implemented by a C language function which has the
732    following prototype:
733
734    .. code-block:: c
735
736        int rtems_shell_rtems_main_config(
737            int    argc,
738            char **argv
739        );
740
741    The configuration structure for the ``config`` has the following prototype:
742
743    .. code-block:: c
744
745        extern rtems_shell_cmd_t rtems_shell_CONFIG_Command;
746
747.. raw:: latex
748
749   \clearpage
750
751.. _itask:
752
753itask - list init tasks for the system
754--------------------------------------
755.. index:: itask
756
757SYNOPSYS:
758    .. code-block:: shell
759
760        itask
761
762DESCRIPTION:
763    This command prints a report on the set of initialization tasks and threads
764    in the system.
765
766EXIT STATUS:
767    This command always succeeds and returns 0.
768
769NOTES:
770    At this time, it includes only Classic API Initialization Tasks.  This is an
771    area in which user submissions or sponsorship of a developer would be
772    appreciated.
773
774EXAMPLES:
775    The following is an example of how to use ``itask``:
776
777    .. code-block:: shell
778
779        SHLL [/] $ itask
780        #    NAME   ENTRY        ARGUMENT    PRIO   MODES  ATTRIBUTES   STACK SIZE
781        ------------------------------------------------------------------------------
782        0   UI1    [0x2002258] 0 [0x0]        1    nP      DEFAULT     4096 [0x1000]
783
784.. index:: CONFIGURE_SHELL_NO_COMMAND_ITASK
785.. index:: CONFIGURE_SHELL_COMMAND_ITASK
786
787CONFIGURATION:
788    This command is included in the default shell command set.  When building a
789    custom command set, define ``CONFIGURE_SHELL_COMMAND_ITASK`` to have this
790    command included.
791
792    This command can be excluded from the shell command set by defining
793    ``CONFIGURE_SHELL_NO_COMMAND_ITASK`` when all shell commands have been
794    configured.
795
796.. index:: rtems_shell_rtems_main_itask
797
798PROGRAMMING INFORMATION:
799    The ``itask`` is implemented by a C language function which has the
800    following prototype:
801
802    .. code-block:: c
803
804        int rtems_shell_rtems_main_itask(
805            int    argc,
806            char **argv
807        );
808
809    The configuration structure for the ``itask`` has the following prototype:
810
811    .. code-block:: c
812
813        extern rtems_shell_cmd_t rtems_shell_ITASK_Command;
814
815.. raw:: latex
816
817   \clearpage
818
819.. _extension:
820
821extension - display information about extensions
822------------------------------------------------
823.. index:: extension
824
825SYNOPSYS:
826    .. code-block:: shell
827
828        extension [id [id ...]]
829
830DESCRIPTION:
831    When invoked with no arguments, this command prints information on the set
832    of User Extensions currently active in the system.
833
834    If invoked with a set of ids as arguments, then just those objects are
835    included in the information printed.
836
837EXIT STATUS:
838    This command returns 0 on success and non-zero if an error is encountered.
839
840NOTES:
841    NONE
842
843EXAMPLES:
844    The following is an example of using the ``extension`` command on a system
845    with no user extensions.
846
847    .. code-block:: shell
848
849        SHLL [/] $ extension
850        ID       NAME
851        ------------------------------------------------------------------------------
852
853.. index:: CONFIGURE_SHELL_NO_COMMAND_EXTENSION
854.. index:: CONFIGURE_SHELL_COMMAND_EXTENSION
855
856CONFIGURATION:
857    This command is included in the default shell command set.  When building a
858    custom command set, define ``CONFIGURE_SHELL_COMMAND_EXTENSION`` to have
859    this command included.
860
861    This command can be excluded from the shell command set by defining
862    ``CONFIGURE_SHELL_NO_COMMAND_EXTENSION`` when all shell commands have been
863    configured.
864
865.. index:: rtems_shell_rtems_main_extension
866
867PROGRAMMING INFORMATION:
868    The ``extension`` is implemented by a C language function which has the
869    following prototype:
870
871    .. code-block:: c
872
873        int rtems_shell_rtems_main_extension(
874            int    argc,
875            char **argv
876        );
877
878    The configuration structure for the ``extension`` has the following prototype:
879
880    .. code-block:: c
881
882        extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command;
883
884.. raw:: latex
885
886   \clearpage
887
888.. _task:
889
890task - display information about tasks
891--------------------------------------
892.. index:: task
893
894SYNOPSYS:
895    .. code-block:: shell
896
897        task [id [id ...]]
898
899DESCRIPTION:
900    When invoked with no arguments, this command prints information on the set
901    of Classic API Tasks currently active in the system.
902
903    If invoked with a set of ids as arguments, then just those objects are
904    included in the information printed.
905
906EXIT STATUS:
907    This command returns 0 on success and non-zero if an error is encountered.
908
909NOTES:
910    NONE
911
912EXAMPLES:
913    The following is an example of how to use the ``task`` on an application
914    with just two Classic API tasks:
915
916    .. code-block:: shell
917
918        SHLL [/] # task
919        ID       NAME                 SHED PRI STATE  MODES    EVENTS WAITINFO
920        ------------------------------------------------------------------------------
921        0a010001 UI1                  UPD  254 EV     P:T:nA   NONE
922        0a010002 SHLL                 UPD  100 READY  P:T:nA   NONE
923
924.. index:: CONFIGURE_SHELL_NO_COMMAND_TASK
925.. index:: CONFIGURE_SHELL_COMMAND_TASK
926
927CONFIGURATION:
928    This command is included in the default shell command set.  When building a
929    custom command set, define ``CONFIGURE_SHELL_COMMAND_TASK`` to have this
930    command included.
931
932    This command can be excluded from the shell command set by defining
933    ``CONFIGURE_SHELL_NO_COMMAND_TASK`` when all shell commands have been
934    configured.
935
936.. index:: rtems_shell_rtems_main_task
937
938PROGRAMMING INFORMATION:
939    The ``task`` is implemented by a C language function which has the
940    following prototype:
941
942    .. code-block:: shell
943
944        int rtems_shell_rtems_main_task(
945            int    argc,
946            char **argv
947        );
948
949    The configuration structure for the ``task`` has the following prototype:
950
951    .. code-block:: c
952
953        extern rtems_shell_cmd_t rtems_shell_TASK_Command;
954
955.. raw:: latex
956
957   \clearpage
958
959.. _queue:
960
961queue - display information about message queues
962------------------------------------------------
963.. index:: queue
964
965SYNOPSYS:
966    .. code-block:: shell
967
968        queue [id [id ... ]]
969
970DESCRIPTION:
971    When invoked with no arguments, this command prints information on the set
972    of Classic API Message Queues currently active in the system.
973
974    If invoked with a set of ids as arguments, then just those objects are
975    included in the information printed.
976
977EXIT STATUS:
978    This command returns 0 on success and non-zero if an error is encountered.
979
980NOTES:
981    NONE
982
983EXAMPLES:
984    The following is an example of using the ``queue`` command on a system with
985    no Classic API Message Queues.
986
987    .. code-block:: shell
988
989        SHLL [/] $ queue
990        ID       NAME   ATTRIBUTES   PEND   MAXPEND  MAXSIZE
991        ------------------------------------------------------------------------------
992
993.. index:: CONFIGURE_SHELL_NO_COMMAND_QUEUE
994.. index:: CONFIGURE_SHELL_COMMAND_QUEUE
995
996CONFIGURATION:
997    This command is included in the default shell command set.  When building a
998    custom command set, define ``CONFIGURE_SHELL_COMMAND_QUEUE`` to have this
999    command included.
1000
1001    This command can be excluded from the shell command set by defining
1002    ``CONFIGURE_SHELL_NO_COMMAND_QUEUE`` when all shell commands have been
1003    configured.
1004
1005.. index:: rtems_shell_rtems_main_queue
1006
1007PROGRAMMING INFORMATION:
1008    The ``queue`` is implemented by a C language function which has the
1009    following prototype:
1010
1011    .. code-block:: c
1012
1013        int rtems_shell_rtems_main_queue(
1014            int    argc,
1015            char **argv
1016        );
1017
1018    The configuration structure for the ``queue`` has the following prototype:
1019
1020    .. code-block:: c
1021
1022        extern rtems_shell_cmd_t rtems_shell_QUEUE_Command;
1023
1024.. raw:: latex
1025
1026   \clearpage
1027
1028.. _sema:
1029
1030sema - display information about semaphores
1031-------------------------------------------
1032.. index:: sema
1033
1034SYNOPSYS:
1035    .. code-block:: shell
1036
1037        sema [id [id ... ]]
1038
1039DESCRIPTION:
1040    When invoked with no arguments, this command prints information on the set
1041    of Classic API Semaphores currently active in the system.
1042
1043    If invoked with a set of objects ids as arguments, then just those objects
1044    are included in the information printed.
1045
1046EXIT STATUS:
1047    This command returns 0 on success and non-zero if an error is encountered.
1048
1049NOTES:
1050    NONE
1051
1052EXAMPLES:
1053    The following is an example of how to use ``sema``:
1054
1055    .. code-block:: shell
1056
1057        SHLL [/] $ sema
1058        ID       NAME   ATTR        PRICEIL CURR_CNT HOLDID
1059        ------------------------------------------------------------------------------
1060        1a010001   LBIO   PR:BI:IN      0        1     00000000
1061        1a010002   TRmi   PR:BI:IN      0        1     00000000
1062        1a010003   LBI00  PR:BI:IN      0        1     00000000
1063        1a010004   TRia   PR:BI:IN      0        1     00000000
1064        1a010005   TRoa   PR:BI:IN      0        1     00000000
1065        1a010006   TRxa   <assoc.c: BAD NAME>   0    0 09010001
1066        1a010007   LBI01  PR:BI:IN      0        1     00000000
1067        1a010008   LBI02  PR:BI:IN      0        1     00000000
1068
1069.. index:: CONFIGURE_SHELL_NO_COMMAND_SEMA
1070.. index:: CONFIGURE_SHELL_COMMAND_SEMA
1071
1072CONFIGURATION:
1073    This command is included in the default shell command set.  When building a
1074    custom command set, define ``CONFIGURE_SHELL_COMMAND_SEMA`` to have this
1075    command included.
1076
1077    This command can be excluded from the shell command set by defining
1078    ``CONFIGURE_SHELL_NO_COMMAND_SEMA`` when all shell commands have been
1079    configured.
1080
1081.. index:: rtems_shell_rtems_main_sema
1082
1083PROGRAMMING INFORMATION:
1084    The ``sema`` is implemented by a C language function which has the following
1085    prototype:
1086
1087    .. code-block:: c
1088
1089        int rtems_shell_rtems_main_sema(
1090            int    argc,
1091            char **argv
1092        );
1093
1094    The configuration structure for the ``sema`` has the following prototype:
1095
1096    .. code-block:: c
1097
1098        extern rtems_shell_cmd_t rtems_shell_SEMA_Command;
1099
1100.. raw:: latex
1101
1102   \clearpage
1103
1104.. _region:
1105
1106region - display information about regions
1107------------------------------------------
1108.. index:: region
1109
1110SYNOPSYS:
1111    .. code-block:: shell
1112
1113        region [id [id ... ]]
1114
1115DESCRIPTION:
1116    When invoked with no arguments, this command prints information on the set
1117    of Classic API Regions currently active in the system.
1118
1119    If invoked with a set of object ids as arguments, then just those object
1120    are included in the information printed.
1121
1122EXIT STATUS:
1123    This command returns 0 on success and non-zero if an error is encountered.
1124
1125NOTES:
1126    NONE
1127
1128EXAMPLES:
1129    The following is an example of using the ``region`` command on a system
1130    with no user extensions.
1131
1132    .. code-block:: shell
1133
1134        SHLL [/] $ region
1135        ID       NAME   ATTR        STARTADDR LENGTH    PAGE_SIZE USED_BLOCKS
1136        ------------------------------------------------------------------------------
1137
1138.. index:: CONFIGURE_SHELL_NO_COMMAND_REGION
1139.. index:: CONFIGURE_SHELL_COMMAND_REGION
1140
1141CONFIGURATION:
1142    This command is included in the default shell command set.  When building a
1143    custom command set, define ``CONFIGURE_SHELL_COMMAND_REGION`` to have this
1144    command included.
1145
1146    This command can be excluded from the shell command set by defining
1147    ``CONFIGURE_SHELL_NO_COMMAND_REGION`` when all shell commands have been
1148    configured.
1149
1150.. index:: rtems_shell_rtems_main_region
1151
1152PROGRAMMING INFORMATION:
1153    The ``region`` is implemented by a C language function which has the
1154    following prototype:
1155
1156    .. code-block:: c
1157
1158        int rtems_shell_rtems_main_region(
1159            int    argc,
1160            char **argv
1161        );
1162
1163    The configuration structure for the ``region`` has the following prototype:
1164
1165    .. code-block:: c
1166
1167        extern rtems_shell_cmd_t rtems_shell_REGION_Command;
1168
1169.. raw:: latex
1170
1171   \clearpage
1172
1173.. _part:
1174
1175part - display information about partitions
1176-------------------------------------------
1177.. index:: part
1178
1179SYNOPSYS:
1180    .. code-block:: shell
1181
1182        part [id [id ... ]]
1183
1184DESCRIPTION:
1185    When invoked with no arguments, this command prints information on the set
1186    of Classic API Partitions currently active in the system.
1187
1188    If invoked with a set of object ids as arguments, then just those objects
1189    are included in the information printed.
1190
1191EXIT STATUS:
1192    This command returns 0 on success and non-zero if an error is encountered.
1193
1194NOTES:
1195    NONE
1196
1197EXAMPLES:
1198    The following is an example of using the ``part`` command on a system with
1199    no user extensions.
1200
1201    .. code-block:: shell
1202
1203        SHLL [/] $ part
1204        ID       NAME   ATTR        STARTADDR LENGTH    BUF_SIZE  USED_BLOCKS
1205        ------------------------------------------------------------------------------
1206
1207.. index:: CONFIGURE_SHELL_NO_COMMAND_PART
1208.. index:: CONFIGURE_SHELL_COMMAND_PART
1209
1210CONFIGURATION:
1211    This command is included in the default shell command set.  When building a
1212    custom command set, define ``CONFIGURE_SHELL_COMMAND_PART`` to have this
1213    command included.
1214
1215    This command can be excluded from the shell command set by defining
1216    ``CONFIGURE_SHELL_NO_COMMAND_PART`` when all shell commands have been
1217    configured.
1218
1219.. index:: rtems_shell_rtems_main_part
1220
1221PROGRAMMING INFORMATION:
1222    The ``part`` is implemented by a C language function which has the
1223    following prototype:
1224
1225    .. code-block:: c
1226
1227        int rtems_shell_rtems_main_part(
1228            int    argc,
1229            char **argv
1230        );
1231
1232    The configuration structure for the ``part`` has the following prototype:
1233
1234    .. code-block:: c
1235
1236        extern rtems_shell_cmd_t rtems_shell_PART_Command;
1237
1238.. raw:: latex
1239
1240   \clearpage
1241
1242.. _object:
1243
1244object - display information about RTEMS objects
1245------------------------------------------------
1246.. index:: object
1247
1248SYNOPSYS:
1249    .. code-block:: shell
1250
1251        object [id [id ...]]
1252
1253DESCRIPTION:
1254    When invoked with a set of object ids as arguments, then a report on those
1255    objects is printed.
1256
1257EXIT STATUS:
1258    This command returns 0 on success and non-zero if an error is encountered.
1259
1260NOTES:
1261    NONE
1262
1263EXAMPLES:
1264    The following is an example of how to use ``object``:
1265
1266    .. code-block:: shell
1267
1268        SHLL [/] $ object 0a010001 1a010002
1269        ID       NAME   PRIO   STAT   MODES  EVENTS   WAITID  WAITARG  NOTES
1270        ------------------------------------------------------------------------------
1271        0a010001   UI1      1   SUSP   P:T:nA  NONE
1272        ID       NAME   ATTR        PRICEIL CURR_CNT HOLDID
1273        ------------------------------------------------------------------------------
1274        1a010002   TRmi   PR:BI:IN      0        1     00000000
1275
1276.. index:: CONFIGURE_SHELL_NO_COMMAND_OBJECT
1277.. index:: CONFIGURE_SHELL_COMMAND_OBJECT
1278
1279CONFIGURATION:
1280    This command is included in the default shell command set.  When building a
1281    custom command set, define ``CONFIGURE_SHELL_COMMAND_OBJECT`` to have this
1282    command included.
1283
1284    This command can be excluded from the shell command set by defining
1285    ``CONFIGURE_SHELL_NO_COMMAND_OBJECT`` when all shell commands have been
1286    configured.
1287
1288.. index:: rtems_shell_rtems_main_object
1289
1290PROGRAMMING INFORMATION:
1291    The ``object`` is implemented by a C language function which has the
1292    following prototype:
1293
1294    .. code-block:: c
1295
1296        int rtems_shell_rtems_main_object(
1297            int    argc,
1298            char **argv
1299        );
1300
1301    The configuration structure for the ``object`` has the
1302    following prototype:
1303
1304    .. code-block:: c
1305
1306        extern rtems_shell_cmd_t rtems_shell_OBJECT_Command;
1307
1308.. raw:: latex
1309
1310   \clearpage
1311
1312.. _driver:
1313
1314driver - display the RTEMS device driver table
1315----------------------------------------------
1316.. index:: driver
1317
1318SYNOPSYS:
1319    .. code-block:: shell
1320
1321        driver [major [major ...]]
1322
1323DESCRIPTION:
1324    When invoked with no arguments, this command prints information on the set
1325    of Device Drivers currently active in the system.
1326
1327    If invoked with a set of major numbers as arguments, then just those Device
1328    Drivers are included in the information printed.
1329
1330EXIT STATUS:
1331    This command returns 0 on success and non-zero if an error is encountered.
1332
1333NOTES:
1334    NONE
1335
1336EXAMPLES:
1337    The following is an example of how to use ``driver``:
1338
1339    .. code-block:: shell
1340
1341        SHLL [/] $ driver
1342        Major      Entry points
1343        ------------------------------------------------------------------------------
1344        0          init: [0x200256c];  control: [0x20024c8]
1345        open: [0x2002518];  close: [0x2002504]
1346        read: [0x20024f0];  write: [0x20024dc]
1347        1          init: [0x20023fc];  control: [0x2002448]
1348        open: [0x0];  close: [0x0]
1349        read: [0x0];  write: [0x0]
1350        SHLL [/] $
1351
1352.. index:: CONFIGURE_SHELL_NO_COMMAND_DRIVER
1353.. index:: CONFIGURE_SHELL_COMMAND_DRIVER
1354
1355CONFIGURATION:
1356    This command is included in the default shell command set.  When building a
1357    custom command set, define ``CONFIGURE_SHELL_COMMAND_DRIVER`` to have this
1358    command included.
1359
1360    This command can be excluded from the shell command set by defining
1361    ``CONFIGURE_SHELL_NO_COMMAND_DRIVER`` when all shell commands have been
1362    configured.
1363
1364.. index:: rtems_shell_rtems_main_driver
1365
1366PROGRAMMING INFORMATION:
1367    The ``driver`` is implemented by a C language function which has the
1368    following prototype:
1369
1370    .. code-block:: c
1371
1372        int rtems_shell_rtems_main_driver(
1373            int    argc,
1374            char **argv
1375        );
1376
1377    The configuration structure for the ``driver`` has the following prototype:
1378
1379    .. code-block:: c
1380
1381        extern rtems_shell_cmd_t rtems_shell_DRIVER_Command;
1382
1383.. raw:: latex
1384
1385   \clearpage
1386
1387.. _dname:
1388
1389dname - displays information about named drivers
1390------------------------------------------------
1391.. index:: dname
1392
1393SYNOPSYS:
1394    .. code-block:: shell
1395
1396        dname
1397
1398DESCRIPTION:
1399    WARNING! This command does not appear to work as of 27 February 2008.
1400
1401EXIT STATUS:
1402    This command returns 0 on success and non-zero if an error is encountered.
1403
1404NOTES:
1405    NONE
1406
1407EXAMPLES:
1408    The following is an example of how to use ``dname``:
1409
1410    .. code-block:: shell
1411
1412        EXAMPLE_TBD
1413
1414.. index:: CONFIGURE_SHELL_NO_COMMAND_DNAME
1415.. index:: CONFIGURE_SHELL_COMMAND_DNAME
1416
1417CONFIGURATION:
1418    This command is included in the default shell command set.  When building a
1419    custom command set, define ``CONFIGURE_SHELL_COMMAND_DNAME`` to have this
1420    command included.
1421
1422    This command can be excluded from the shell command set by defining
1423    ``CONFIGURE_SHELL_NO_COMMAND_DNAME`` when all shell commands have been
1424    configured.
1425
1426.. index:: rtems_shell_rtems_main_dname
1427
1428PROGRAMMING INFORMATION:
1429    The ``dname`` is implemented by a C language function which has the
1430    following prototype:
1431
1432    .. code-block:: c
1433
1434        int rtems_shell_rtems_main_dname(
1435            int    argc,
1436            char **argv
1437        );
1438
1439    The configuration structure for the ``dname`` has the following prototype:
1440
1441    .. code-block:: c
1442
1443        extern rtems_shell_cmd_t rtems_shell_DNAME_Command;
1444
1445.. raw:: latex
1446
1447   \clearpage
1448
1449.. _pthread:
1450
1451pthread - display information about POSIX threads
1452-------------------------------------------------
1453.. index:: pthread
1454
1455SYNOPSYS:
1456    .. code-block:: shell
1457
1458        pthread [id [id ...]]
1459
1460DESCRIPTION:
1461    When invoked with no arguments, this command prints information on the set
1462    of POSIX API threads currently active in the system.
1463
1464    If invoked with a set of ids as arguments, then just those objects are
1465    included in the information printed.
1466
1467EXIT STATUS:
1468    This command returns 0 on success and non-zero if an error is encountered.
1469
1470NOTES:
1471    This command is only available when the POSIX API is configured.
1472
1473EXAMPLES:
1474    The following is an example of how to use the ``task`` on an application
1475    with four POSIX threads:
1476
1477    .. code-block:: shell
1478
1479        SHLL [/] $ pthread
1480        ID       NAME           PRI  STATE MODES   EVENTS    WAITID  WAITARG  NOTES
1481        ------------------------------------------------------------------------------
1482        0b010002   Main           133 READY  P:T:nA    NONE   43010001 0x7b1148
1483        0b010003   ISR            133 Wcvar  P:T:nA    NONE   43010003 0x7b1148
1484        0b01000c                  133 READY  P:T:nA    NONE   33010002 0x7b1148
1485        0b01000d                  133 Wmutex P:T:nA    NONE   33010002 0x7b1148
1486
1487CONFIGURATION:
1488    This command is part of the monitor commands which are always available in
1489    the shell.
1490
1491PROGRAMMING INFORMATION:
1492    This command is not directly available for invocation.
Note: See TracBrowser for help on using the repository browser.