1 | @c |
---|
2 | @c COPYRIGHT (c) 1988-2008. |
---|
3 | @c On-Line Applications Research Corporation (OAR). |
---|
4 | @c All rights reserved. |
---|
5 | @c |
---|
6 | @c $Id$ |
---|
7 | @c |
---|
8 | |
---|
9 | @chapter RTEMS Commands |
---|
10 | |
---|
11 | @section Introduction |
---|
12 | |
---|
13 | The RTEMS shell has the following rtems commands: |
---|
14 | |
---|
15 | @itemize @bullet |
---|
16 | |
---|
17 | @item @code{cpuuse} - print or reset per thread cpu usage |
---|
18 | @item @code{stackuse} - print per thread stack usage |
---|
19 | @item @code{perioduse} - print or reset per period usage |
---|
20 | @item @code{wkspace} - Display information on Executive Workspace |
---|
21 | @item @code{config} - Show the system configuration. |
---|
22 | @item @code{itask} - List init tasks for the system |
---|
23 | @item @code{extension} - Display information about extensions |
---|
24 | @item @code{task} - Display information about tasks |
---|
25 | @item @code{queue} - Display information about message queues |
---|
26 | @item @code{sema} - display information about semaphores |
---|
27 | @item @code{region} - display information about regions |
---|
28 | @item @code{part} - display information about partitions |
---|
29 | @item @code{object} - Display information about RTEMS objects |
---|
30 | @item @code{driver} - Display the RTEMS device driver table |
---|
31 | @item @code{dname} - Displays information about named drivers |
---|
32 | |
---|
33 | @end itemize |
---|
34 | |
---|
35 | @section Commands |
---|
36 | |
---|
37 | @c |
---|
38 | @c |
---|
39 | @c |
---|
40 | @page |
---|
41 | @subsection cpuuse - print or reset per thread cpu usage |
---|
42 | |
---|
43 | @pgindex cpuuse |
---|
44 | |
---|
45 | @subheading SYNOPSYS: |
---|
46 | |
---|
47 | @example |
---|
48 | cpuuse [-r] |
---|
49 | @end example |
---|
50 | |
---|
51 | @subheading DESCRIPTION: |
---|
52 | |
---|
53 | This command XXX |
---|
54 | |
---|
55 | @subheading EXIT STATUS: |
---|
56 | |
---|
57 | This command returns 0 on success and non-zero if an error is encountered. |
---|
58 | |
---|
59 | @subheading NOTES: |
---|
60 | |
---|
61 | NONE |
---|
62 | |
---|
63 | @subheading EXAMPLES: |
---|
64 | |
---|
65 | The following is an example of how to use cpuuse: |
---|
66 | |
---|
67 | @example |
---|
68 | EXAMPLE_TBD |
---|
69 | @end example |
---|
70 | |
---|
71 | @subheading CONFIGURATION: |
---|
72 | |
---|
73 | @findex CONFIGURE_SHELL_NO_COMMAND_CPUUSE |
---|
74 | @findex CONFIGURE_SHELL_COMMAND_CPUUSE |
---|
75 | |
---|
76 | This command is included in the default shell command set. |
---|
77 | When building a custom command set, define |
---|
78 | @code{CONFIGURE_SHELL_COMMAND_CPUUSE} to have this |
---|
79 | command included. |
---|
80 | |
---|
81 | This command can be excluded from the shell command set by |
---|
82 | defining @code{CONFIGURE_SHELL_NO_COMMAND_CPUUSE} when all |
---|
83 | shell commands have been configured. |
---|
84 | |
---|
85 | @subheading PROGRAMMING INFORMATION: |
---|
86 | |
---|
87 | @findex rtems_shell_rtems_main_cpuuse |
---|
88 | |
---|
89 | The @code{COMMAND} is implemented by a C language function |
---|
90 | which has the following prototype: |
---|
91 | |
---|
92 | @example |
---|
93 | int rtems_shell_rtems_main_cpuuse( |
---|
94 | int argc, |
---|
95 | char **argv |
---|
96 | ); |
---|
97 | @end example |
---|
98 | |
---|
99 | The configuration structure for the @code{COMMAND} has the |
---|
100 | following prototype: |
---|
101 | |
---|
102 | @example |
---|
103 | extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command; |
---|
104 | @end example |
---|
105 | |
---|
106 | @c |
---|
107 | @c |
---|
108 | @c |
---|
109 | @page |
---|
110 | @subsection stackuse - print per thread stack usage |
---|
111 | |
---|
112 | @pgindex stackuse |
---|
113 | |
---|
114 | @subheading SYNOPSYS: |
---|
115 | |
---|
116 | @example |
---|
117 | stackuse |
---|
118 | @end example |
---|
119 | |
---|
120 | @subheading DESCRIPTION: |
---|
121 | |
---|
122 | This command XXX |
---|
123 | |
---|
124 | @subheading EXIT STATUS: |
---|
125 | |
---|
126 | This command returns 0 on success and non-zero if an error is encountered. |
---|
127 | |
---|
128 | @subheading NOTES: |
---|
129 | |
---|
130 | NONE |
---|
131 | |
---|
132 | @subheading EXAMPLES: |
---|
133 | |
---|
134 | The following is an example of how to use stackuse: |
---|
135 | |
---|
136 | @example |
---|
137 | EXAMPLE_TBD |
---|
138 | @end example |
---|
139 | |
---|
140 | @subheading CONFIGURATION: |
---|
141 | |
---|
142 | @findex CONFIGURE_SHELL_NO_COMMAND_STACKUSE |
---|
143 | @findex CONFIGURE_SHELL_COMMAND_STACKUSE |
---|
144 | |
---|
145 | This command is included in the default shell command set. |
---|
146 | When building a custom command set, define |
---|
147 | @code{CONFIGURE_SHELL_COMMAND_STACKUSE} to have this |
---|
148 | command included. |
---|
149 | |
---|
150 | This command can be excluded from the shell command set by |
---|
151 | defining @code{CONFIGURE_SHELL_NO_COMMAND_STACKUSE} when all |
---|
152 | shell commands have been configured. |
---|
153 | |
---|
154 | @subheading PROGRAMMING INFORMATION: |
---|
155 | |
---|
156 | @findex rtems_shell_rtems_main_stackuse |
---|
157 | |
---|
158 | The @code{COMMAND} is implemented by a C language function |
---|
159 | which has the following prototype: |
---|
160 | |
---|
161 | @example |
---|
162 | int rtems_shell_rtems_main_stackuse( |
---|
163 | int argc, |
---|
164 | char **argv |
---|
165 | ); |
---|
166 | @end example |
---|
167 | |
---|
168 | The configuration structure for the @code{COMMAND} has the |
---|
169 | following prototype: |
---|
170 | |
---|
171 | @example |
---|
172 | extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command; |
---|
173 | @end example |
---|
174 | |
---|
175 | @c |
---|
176 | @c |
---|
177 | @c |
---|
178 | @page |
---|
179 | @subsection perioduse - print or reset per period usage |
---|
180 | |
---|
181 | @pgindex perioduse |
---|
182 | |
---|
183 | @subheading SYNOPSYS: |
---|
184 | |
---|
185 | @example |
---|
186 | perioduse [-r] |
---|
187 | @end example |
---|
188 | |
---|
189 | @subheading DESCRIPTION: |
---|
190 | |
---|
191 | This command XXX |
---|
192 | |
---|
193 | @subheading EXIT STATUS: |
---|
194 | |
---|
195 | This command returns 0 on success and non-zero if an error is encountered. |
---|
196 | |
---|
197 | @subheading NOTES: |
---|
198 | |
---|
199 | NONE |
---|
200 | |
---|
201 | @subheading EXAMPLES: |
---|
202 | |
---|
203 | The following is an example of how to use perioduse: |
---|
204 | |
---|
205 | @example |
---|
206 | EXAMPLE_TBD |
---|
207 | @end example |
---|
208 | |
---|
209 | @subheading CONFIGURATION: |
---|
210 | |
---|
211 | @findex CONFIGURE_SHELL_NO_COMMAND_PERIODUSE |
---|
212 | @findex CONFIGURE_SHELL_COMMAND_PERIODUSE |
---|
213 | |
---|
214 | This command is included in the default shell command set. |
---|
215 | When building a custom command set, define |
---|
216 | @code{CONFIGURE_SHELL_COMMAND_PERIODUSE} to have this |
---|
217 | command included. |
---|
218 | |
---|
219 | This command can be excluded from the shell command set by |
---|
220 | defining @code{CONFIGURE_SHELL_NO_COMMAND_PERIODUSE} when all |
---|
221 | shell commands have been configured. |
---|
222 | |
---|
223 | @subheading PROGRAMMING INFORMATION: |
---|
224 | |
---|
225 | @findex rtems_shell_rtems_main_perioduse |
---|
226 | |
---|
227 | The @code{COMMAND} is implemented by a C language function |
---|
228 | which has the following prototype: |
---|
229 | |
---|
230 | @example |
---|
231 | int rtems_shell_rtems_main_perioduse( |
---|
232 | int argc, |
---|
233 | char **argv |
---|
234 | ); |
---|
235 | @end example |
---|
236 | |
---|
237 | The configuration structure for the @code{COMMAND} has the |
---|
238 | following prototype: |
---|
239 | |
---|
240 | @example |
---|
241 | extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command; |
---|
242 | @end example |
---|
243 | |
---|
244 | @c |
---|
245 | @c |
---|
246 | @c |
---|
247 | @page |
---|
248 | @subsection wkspace - display information on executive workspace |
---|
249 | |
---|
250 | @pgindex wkspace |
---|
251 | |
---|
252 | @subheading SYNOPSYS: |
---|
253 | |
---|
254 | @example |
---|
255 | wkspace |
---|
256 | @end example |
---|
257 | |
---|
258 | @subheading DESCRIPTION: |
---|
259 | |
---|
260 | This command XXX |
---|
261 | |
---|
262 | @subheading EXIT STATUS: |
---|
263 | |
---|
264 | This command returns 0 on success and non-zero if an error is encountered. |
---|
265 | |
---|
266 | @subheading NOTES: |
---|
267 | |
---|
268 | NONE |
---|
269 | |
---|
270 | @subheading EXAMPLES: |
---|
271 | |
---|
272 | The following is an example of how to use wkspace: |
---|
273 | |
---|
274 | @example |
---|
275 | EXAMPLE_TBD |
---|
276 | @end example |
---|
277 | |
---|
278 | @subheading CONFIGURATION: |
---|
279 | |
---|
280 | @findex CONFIGURE_SHELL_NO_COMMAND_WKSPACE |
---|
281 | @findex CONFIGURE_SHELL_COMMAND_WKSPACE |
---|
282 | |
---|
283 | This command is included in the default shell command set. |
---|
284 | When building a custom command set, define |
---|
285 | @code{CONFIGURE_SHELL_COMMAND_WKSPACE} to have this |
---|
286 | command included. |
---|
287 | |
---|
288 | This command can be excluded from the shell command set by |
---|
289 | defining @code{CONFIGURE_SHELL_NO_COMMAND_WKSPACE} when all |
---|
290 | shell commands have been configured. |
---|
291 | |
---|
292 | @subheading PROGRAMMING INFORMATION: |
---|
293 | |
---|
294 | @findex rtems_shell_rtems_main_wkspace |
---|
295 | |
---|
296 | The @code{COMMAND} is implemented by a C language function |
---|
297 | which has the following prototype: |
---|
298 | |
---|
299 | @example |
---|
300 | int rtems_shell_rtems_main_wkspace( |
---|
301 | int argc, |
---|
302 | char **argv |
---|
303 | ); |
---|
304 | @end example |
---|
305 | |
---|
306 | The configuration structure for the @code{COMMAND} has the |
---|
307 | following prototype: |
---|
308 | |
---|
309 | @example |
---|
310 | extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command; |
---|
311 | @end example |
---|
312 | |
---|
313 | @c |
---|
314 | @c |
---|
315 | @c |
---|
316 | @page |
---|
317 | @subsection config - show the system configuration. |
---|
318 | |
---|
319 | @pgindex config |
---|
320 | |
---|
321 | @subheading SYNOPSYS: |
---|
322 | |
---|
323 | @example |
---|
324 | config |
---|
325 | @end example |
---|
326 | |
---|
327 | @subheading DESCRIPTION: |
---|
328 | |
---|
329 | This command XXX |
---|
330 | |
---|
331 | @subheading EXIT STATUS: |
---|
332 | |
---|
333 | This command returns 0 on success and non-zero if an error is encountered. |
---|
334 | |
---|
335 | @subheading NOTES: |
---|
336 | |
---|
337 | NONE |
---|
338 | |
---|
339 | @subheading EXAMPLES: |
---|
340 | |
---|
341 | The following is an example of how to use config: |
---|
342 | |
---|
343 | @example |
---|
344 | EXAMPLE_TBD |
---|
345 | @end example |
---|
346 | |
---|
347 | @subheading CONFIGURATION: |
---|
348 | |
---|
349 | @findex CONFIGURE_SHELL_NO_COMMAND_CONFIG |
---|
350 | @findex CONFIGURE_SHELL_COMMAND_CONFIG |
---|
351 | |
---|
352 | This command is included in the default shell command set. |
---|
353 | When building a custom command set, define |
---|
354 | @code{CONFIGURE_SHELL_COMMAND_CONFIG} to have this |
---|
355 | command included. |
---|
356 | |
---|
357 | This command can be excluded from the shell command set by |
---|
358 | defining @code{CONFIGURE_SHELL_NO_COMMAND_CONFIG} when all |
---|
359 | shell commands have been configured. |
---|
360 | |
---|
361 | @subheading PROGRAMMING INFORMATION: |
---|
362 | |
---|
363 | @findex rtems_shell_rtems_main_config |
---|
364 | |
---|
365 | The @code{COMMAND} is implemented by a C language function |
---|
366 | which has the following prototype: |
---|
367 | |
---|
368 | @example |
---|
369 | int rtems_shell_rtems_main_config( |
---|
370 | int argc, |
---|
371 | char **argv |
---|
372 | ); |
---|
373 | @end example |
---|
374 | |
---|
375 | The configuration structure for the @code{COMMAND} has the |
---|
376 | following prototype: |
---|
377 | |
---|
378 | @example |
---|
379 | extern rtems_shell_cmd_t rtems_shell_CONFIG_Command; |
---|
380 | @end example |
---|
381 | |
---|
382 | @c |
---|
383 | @c |
---|
384 | @c |
---|
385 | @page |
---|
386 | @subsection itask - list init tasks for the system |
---|
387 | |
---|
388 | @pgindex itask |
---|
389 | |
---|
390 | @subheading SYNOPSYS: |
---|
391 | |
---|
392 | @example |
---|
393 | itask |
---|
394 | @end example |
---|
395 | |
---|
396 | @subheading DESCRIPTION: |
---|
397 | |
---|
398 | This command XXX |
---|
399 | |
---|
400 | @subheading EXIT STATUS: |
---|
401 | |
---|
402 | This command returns 0 on success and non-zero if an error is encountered. |
---|
403 | |
---|
404 | @subheading NOTES: |
---|
405 | |
---|
406 | NONE |
---|
407 | |
---|
408 | @subheading EXAMPLES: |
---|
409 | |
---|
410 | The following is an example of how to use itask: |
---|
411 | |
---|
412 | @example |
---|
413 | EXAMPLE_TBD |
---|
414 | @end example |
---|
415 | |
---|
416 | @subheading CONFIGURATION: |
---|
417 | |
---|
418 | @findex CONFIGURE_SHELL_NO_COMMAND_ITASK |
---|
419 | @findex CONFIGURE_SHELL_COMMAND_ITASK |
---|
420 | |
---|
421 | This command is included in the default shell command set. |
---|
422 | When building a custom command set, define |
---|
423 | @code{CONFIGURE_SHELL_COMMAND_ITASK} to have this |
---|
424 | command included. |
---|
425 | |
---|
426 | This command can be excluded from the shell command set by |
---|
427 | defining @code{CONFIGURE_SHELL_NO_COMMAND_ITASK} when all |
---|
428 | shell commands have been configured. |
---|
429 | |
---|
430 | @subheading PROGRAMMING INFORMATION: |
---|
431 | |
---|
432 | @findex rtems_shell_rtems_main_itask |
---|
433 | |
---|
434 | The @code{COMMAND} is implemented by a C language function |
---|
435 | which has the following prototype: |
---|
436 | |
---|
437 | @example |
---|
438 | int rtems_shell_rtems_main_itask( |
---|
439 | int argc, |
---|
440 | char **argv |
---|
441 | ); |
---|
442 | @end example |
---|
443 | |
---|
444 | The configuration structure for the @code{COMMAND} has the |
---|
445 | following prototype: |
---|
446 | |
---|
447 | @example |
---|
448 | extern rtems_shell_cmd_t rtems_shell_ITASK_Command; |
---|
449 | @end example |
---|
450 | |
---|
451 | @c |
---|
452 | @c |
---|
453 | @c |
---|
454 | @page |
---|
455 | @subsection extension - display information about extensions |
---|
456 | |
---|
457 | @pgindex extension |
---|
458 | |
---|
459 | @subheading SYNOPSYS: |
---|
460 | |
---|
461 | @example |
---|
462 | extension [id [id ...] ] |
---|
463 | @end example |
---|
464 | |
---|
465 | @subheading DESCRIPTION: |
---|
466 | |
---|
467 | This command XXX |
---|
468 | |
---|
469 | @subheading EXIT STATUS: |
---|
470 | |
---|
471 | This command returns 0 on success and non-zero if an error is encountered. |
---|
472 | |
---|
473 | @subheading NOTES: |
---|
474 | |
---|
475 | NONE |
---|
476 | |
---|
477 | @subheading EXAMPLES: |
---|
478 | |
---|
479 | The following is an example of how to use extension: |
---|
480 | |
---|
481 | @example |
---|
482 | EXAMPLE_TBD |
---|
483 | @end example |
---|
484 | |
---|
485 | @subheading CONFIGURATION: |
---|
486 | |
---|
487 | @findex CONFIGURE_SHELL_NO_COMMAND_EXTENSION |
---|
488 | @findex CONFIGURE_SHELL_COMMAND_EXTENSION |
---|
489 | |
---|
490 | This command is included in the default shell command set. |
---|
491 | When building a custom command set, define |
---|
492 | @code{CONFIGURE_SHELL_COMMAND_EXTENSION} to have this |
---|
493 | command included. |
---|
494 | |
---|
495 | This command can be excluded from the shell command set by |
---|
496 | defining @code{CONFIGURE_SHELL_NO_COMMAND_EXTENSION} when all |
---|
497 | shell commands have been configured. |
---|
498 | |
---|
499 | @subheading PROGRAMMING INFORMATION: |
---|
500 | |
---|
501 | @findex rtems_shell_rtems_main_extension |
---|
502 | |
---|
503 | The @code{COMMAND} is implemented by a C language function |
---|
504 | which has the following prototype: |
---|
505 | |
---|
506 | @example |
---|
507 | int rtems_shell_rtems_main_extension( |
---|
508 | int argc, |
---|
509 | char **argv |
---|
510 | ); |
---|
511 | @end example |
---|
512 | |
---|
513 | The configuration structure for the @code{COMMAND} has the |
---|
514 | following prototype: |
---|
515 | |
---|
516 | @example |
---|
517 | extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command; |
---|
518 | @end example |
---|
519 | |
---|
520 | @c |
---|
521 | @c |
---|
522 | @c |
---|
523 | @page |
---|
524 | @subsection task - display information about tasks |
---|
525 | |
---|
526 | @pgindex task |
---|
527 | |
---|
528 | @subheading SYNOPSYS: |
---|
529 | |
---|
530 | @example |
---|
531 | task [id [id ...] ] |
---|
532 | @end example |
---|
533 | |
---|
534 | @subheading DESCRIPTION: |
---|
535 | |
---|
536 | This command XXX |
---|
537 | |
---|
538 | @subheading EXIT STATUS: |
---|
539 | |
---|
540 | This command returns 0 on success and non-zero if an error is encountered. |
---|
541 | |
---|
542 | @subheading NOTES: |
---|
543 | |
---|
544 | NONE |
---|
545 | |
---|
546 | @subheading EXAMPLES: |
---|
547 | |
---|
548 | The following is an example of how to use task: |
---|
549 | |
---|
550 | @example |
---|
551 | EXAMPLE_TBD |
---|
552 | @end example |
---|
553 | |
---|
554 | @subheading CONFIGURATION: |
---|
555 | |
---|
556 | @findex CONFIGURE_SHELL_NO_COMMAND_TASK |
---|
557 | @findex CONFIGURE_SHELL_COMMAND_TASK |
---|
558 | |
---|
559 | This command is included in the default shell command set. |
---|
560 | When building a custom command set, define |
---|
561 | @code{CONFIGURE_SHELL_COMMAND_TASK} to have this |
---|
562 | command included. |
---|
563 | |
---|
564 | This command can be excluded from the shell command set by |
---|
565 | defining @code{CONFIGURE_SHELL_NO_COMMAND_TASK} when all |
---|
566 | shell commands have been configured. |
---|
567 | |
---|
568 | @subheading PROGRAMMING INFORMATION: |
---|
569 | |
---|
570 | @findex rtems_shell_rtems_main_task |
---|
571 | |
---|
572 | The @code{COMMAND} is implemented by a C language function |
---|
573 | which has the following prototype: |
---|
574 | |
---|
575 | @example |
---|
576 | int rtems_shell_rtems_main_task( |
---|
577 | int argc, |
---|
578 | char **argv |
---|
579 | ); |
---|
580 | @end example |
---|
581 | |
---|
582 | The configuration structure for the @code{COMMAND} has the |
---|
583 | following prototype: |
---|
584 | |
---|
585 | @example |
---|
586 | extern rtems_shell_cmd_t rtems_shell_TASK_Command; |
---|
587 | @end example |
---|
588 | |
---|
589 | @c |
---|
590 | @c |
---|
591 | @c |
---|
592 | @page |
---|
593 | @subsection queue - display information about message queues |
---|
594 | |
---|
595 | @pgindex queue |
---|
596 | |
---|
597 | @subheading SYNOPSYS: |
---|
598 | |
---|
599 | @example |
---|
600 | queue [id [id ... ] ] |
---|
601 | @end example |
---|
602 | |
---|
603 | @subheading DESCRIPTION: |
---|
604 | |
---|
605 | This command XXX |
---|
606 | |
---|
607 | @subheading EXIT STATUS: |
---|
608 | |
---|
609 | This command returns 0 on success and non-zero if an error is encountered. |
---|
610 | |
---|
611 | @subheading NOTES: |
---|
612 | |
---|
613 | NONE |
---|
614 | |
---|
615 | @subheading EXAMPLES: |
---|
616 | |
---|
617 | The following is an example of how to use queue: |
---|
618 | |
---|
619 | @example |
---|
620 | EXAMPLE_TBD |
---|
621 | @end example |
---|
622 | |
---|
623 | @subheading CONFIGURATION: |
---|
624 | |
---|
625 | @findex CONFIGURE_SHELL_NO_COMMAND_QUEUE |
---|
626 | @findex CONFIGURE_SHELL_COMMAND_QUEUE |
---|
627 | |
---|
628 | This command is included in the default shell command set. |
---|
629 | When building a custom command set, define |
---|
630 | @code{CONFIGURE_SHELL_COMMAND_QUEUE} to have this |
---|
631 | command included. |
---|
632 | |
---|
633 | This command can be excluded from the shell command set by |
---|
634 | defining @code{CONFIGURE_SHELL_NO_COMMAND_QUEUE} when all |
---|
635 | shell commands have been configured. |
---|
636 | |
---|
637 | @subheading PROGRAMMING INFORMATION: |
---|
638 | |
---|
639 | @findex rtems_shell_rtems_main_queue |
---|
640 | |
---|
641 | The @code{COMMAND} is implemented by a C language function |
---|
642 | which has the following prototype: |
---|
643 | |
---|
644 | @example |
---|
645 | int rtems_shell_rtems_main_queue( |
---|
646 | int argc, |
---|
647 | char **argv |
---|
648 | ); |
---|
649 | @end example |
---|
650 | |
---|
651 | The configuration structure for the @code{COMMAND} has the |
---|
652 | following prototype: |
---|
653 | |
---|
654 | @example |
---|
655 | extern rtems_shell_cmd_t rtems_shell_QUEUE_Command; |
---|
656 | @end example |
---|
657 | |
---|
658 | @c |
---|
659 | @c |
---|
660 | @c |
---|
661 | @page |
---|
662 | @subsection sema - display information about semaphores |
---|
663 | |
---|
664 | @pgindex sema |
---|
665 | |
---|
666 | @subheading SYNOPSYS: |
---|
667 | |
---|
668 | @example |
---|
669 | sema [id [id ... ] ] |
---|
670 | @end example |
---|
671 | |
---|
672 | @subheading DESCRIPTION: |
---|
673 | |
---|
674 | This command XXX |
---|
675 | |
---|
676 | @subheading EXIT STATUS: |
---|
677 | |
---|
678 | This command returns 0 on success and non-zero if an error is encountered. |
---|
679 | |
---|
680 | @subheading NOTES: |
---|
681 | |
---|
682 | NONE |
---|
683 | |
---|
684 | @subheading EXAMPLES: |
---|
685 | |
---|
686 | The following is an example of how to use sema: |
---|
687 | |
---|
688 | @example |
---|
689 | EXAMPLE_TBD |
---|
690 | @end example |
---|
691 | |
---|
692 | @subheading CONFIGURATION: |
---|
693 | |
---|
694 | @findex CONFIGURE_SHELL_NO_COMMAND_SEMA |
---|
695 | @findex CONFIGURE_SHELL_COMMAND_SEMA |
---|
696 | |
---|
697 | This command is included in the default shell command set. |
---|
698 | When building a custom command set, define |
---|
699 | @code{CONFIGURE_SHELL_COMMAND_SEMA} to have this |
---|
700 | command included. |
---|
701 | |
---|
702 | This command can be excluded from the shell command set by |
---|
703 | defining @code{CONFIGURE_SHELL_NO_COMMAND_SEMA} when all |
---|
704 | shell commands have been configured. |
---|
705 | |
---|
706 | @subheading PROGRAMMING INFORMATION: |
---|
707 | |
---|
708 | @findex rtems_shell_rtems_main_sema |
---|
709 | |
---|
710 | The @code{COMMAND} is implemented by a C language function |
---|
711 | which has the following prototype: |
---|
712 | |
---|
713 | @example |
---|
714 | int rtems_shell_rtems_main_sema( |
---|
715 | int argc, |
---|
716 | char **argv |
---|
717 | ); |
---|
718 | @end example |
---|
719 | |
---|
720 | The configuration structure for the @code{COMMAND} has the |
---|
721 | following prototype: |
---|
722 | |
---|
723 | @example |
---|
724 | extern rtems_shell_cmd_t rtems_shell_SEMA_Command; |
---|
725 | @end example |
---|
726 | |
---|
727 | @c |
---|
728 | @c |
---|
729 | @c |
---|
730 | @page |
---|
731 | @subsection region - display information about regions |
---|
732 | |
---|
733 | @pgindex region |
---|
734 | |
---|
735 | @subheading SYNOPSYS: |
---|
736 | |
---|
737 | @example |
---|
738 | region [id [id ... ] ] |
---|
739 | @end example |
---|
740 | |
---|
741 | @subheading DESCRIPTION: |
---|
742 | |
---|
743 | This command XXX |
---|
744 | |
---|
745 | @subheading EXIT STATUS: |
---|
746 | |
---|
747 | This command returns 0 on success and non-zero if an error is encountered. |
---|
748 | |
---|
749 | @subheading NOTES: |
---|
750 | |
---|
751 | NONE |
---|
752 | |
---|
753 | @subheading EXAMPLES: |
---|
754 | |
---|
755 | The following is an example of how to use region: |
---|
756 | |
---|
757 | @example |
---|
758 | EXAMPLE_TBD |
---|
759 | @end example |
---|
760 | |
---|
761 | @subheading CONFIGURATION: |
---|
762 | |
---|
763 | @findex CONFIGURE_SHELL_NO_COMMAND_REGION |
---|
764 | @findex CONFIGURE_SHELL_COMMAND_REGION |
---|
765 | |
---|
766 | This command is included in the default shell command set. |
---|
767 | When building a custom command set, define |
---|
768 | @code{CONFIGURE_SHELL_COMMAND_REGION} to have this |
---|
769 | command included. |
---|
770 | |
---|
771 | This command can be excluded from the shell command set by |
---|
772 | defining @code{CONFIGURE_SHELL_NO_COMMAND_REGION} when all |
---|
773 | shell commands have been configured. |
---|
774 | |
---|
775 | @subheading PROGRAMMING INFORMATION: |
---|
776 | |
---|
777 | @findex rtems_shell_rtems_main_region |
---|
778 | |
---|
779 | The @code{COMMAND} is implemented by a C language function |
---|
780 | which has the following prototype: |
---|
781 | |
---|
782 | @example |
---|
783 | int rtems_shell_rtems_main_region( |
---|
784 | int argc, |
---|
785 | char **argv |
---|
786 | ); |
---|
787 | @end example |
---|
788 | |
---|
789 | The configuration structure for the @code{COMMAND} has the |
---|
790 | following prototype: |
---|
791 | |
---|
792 | @example |
---|
793 | extern rtems_shell_cmd_t rtems_shell_REGION_Command; |
---|
794 | @end example |
---|
795 | |
---|
796 | @c |
---|
797 | @c |
---|
798 | @c |
---|
799 | @page |
---|
800 | @subsection part - display information about partitions |
---|
801 | |
---|
802 | @pgindex part |
---|
803 | |
---|
804 | @subheading SYNOPSYS: |
---|
805 | |
---|
806 | @example |
---|
807 | part [id [id ... ] ] |
---|
808 | @end example |
---|
809 | |
---|
810 | @subheading DESCRIPTION: |
---|
811 | |
---|
812 | This command XXX |
---|
813 | |
---|
814 | @subheading EXIT STATUS: |
---|
815 | |
---|
816 | This command returns 0 on success and non-zero if an error is encountered. |
---|
817 | |
---|
818 | @subheading NOTES: |
---|
819 | |
---|
820 | NONE |
---|
821 | |
---|
822 | @subheading EXAMPLES: |
---|
823 | |
---|
824 | The following is an example of how to use part: |
---|
825 | |
---|
826 | @example |
---|
827 | EXAMPLE_TBD |
---|
828 | @end example |
---|
829 | |
---|
830 | @subheading CONFIGURATION: |
---|
831 | |
---|
832 | @findex CONFIGURE_SHELL_NO_COMMAND_PART |
---|
833 | @findex CONFIGURE_SHELL_COMMAND_PART |
---|
834 | |
---|
835 | This command is included in the default shell command set. |
---|
836 | When building a custom command set, define |
---|
837 | @code{CONFIGURE_SHELL_COMMAND_PART} to have this |
---|
838 | command included. |
---|
839 | |
---|
840 | This command can be excluded from the shell command set by |
---|
841 | defining @code{CONFIGURE_SHELL_NO_COMMAND_PART} when all |
---|
842 | shell commands have been configured. |
---|
843 | |
---|
844 | @subheading PROGRAMMING INFORMATION: |
---|
845 | |
---|
846 | @findex rtems_shell_rtems_main_part |
---|
847 | |
---|
848 | The @code{COMMAND} is implemented by a C language function |
---|
849 | which has the following prototype: |
---|
850 | |
---|
851 | @example |
---|
852 | int rtems_shell_rtems_main_part( |
---|
853 | int argc, |
---|
854 | char **argv |
---|
855 | ); |
---|
856 | @end example |
---|
857 | |
---|
858 | The configuration structure for the @code{COMMAND} has the |
---|
859 | following prototype: |
---|
860 | |
---|
861 | @example |
---|
862 | extern rtems_shell_cmd_t rtems_shell_PART_Command; |
---|
863 | @end example |
---|
864 | |
---|
865 | @c |
---|
866 | @c |
---|
867 | @c |
---|
868 | @page |
---|
869 | @subsection object - display information about rtems objects |
---|
870 | |
---|
871 | @pgindex object |
---|
872 | |
---|
873 | @subheading SYNOPSYS: |
---|
874 | |
---|
875 | @example |
---|
876 | object [id [id ...] ] |
---|
877 | @end example |
---|
878 | |
---|
879 | @subheading DESCRIPTION: |
---|
880 | |
---|
881 | This command XXX |
---|
882 | |
---|
883 | @subheading EXIT STATUS: |
---|
884 | |
---|
885 | This command returns 0 on success and non-zero if an error is encountered. |
---|
886 | |
---|
887 | @subheading NOTES: |
---|
888 | |
---|
889 | NONE |
---|
890 | |
---|
891 | @subheading EXAMPLES: |
---|
892 | |
---|
893 | The following is an example of how to use object: |
---|
894 | |
---|
895 | @example |
---|
896 | EXAMPLE_TBD |
---|
897 | @end example |
---|
898 | |
---|
899 | @subheading CONFIGURATION: |
---|
900 | |
---|
901 | @findex CONFIGURE_SHELL_NO_COMMAND_OBJECT |
---|
902 | @findex CONFIGURE_SHELL_COMMAND_OBJECT |
---|
903 | |
---|
904 | This command is included in the default shell command set. |
---|
905 | When building a custom command set, define |
---|
906 | @code{CONFIGURE_SHELL_COMMAND_OBJECT} to have this |
---|
907 | command included. |
---|
908 | |
---|
909 | This command can be excluded from the shell command set by |
---|
910 | defining @code{CONFIGURE_SHELL_NO_COMMAND_OBJECT} when all |
---|
911 | shell commands have been configured. |
---|
912 | |
---|
913 | @subheading PROGRAMMING INFORMATION: |
---|
914 | |
---|
915 | @findex rtems_shell_rtems_main_object |
---|
916 | |
---|
917 | The @code{COMMAND} is implemented by a C language function |
---|
918 | which has the following prototype: |
---|
919 | |
---|
920 | @example |
---|
921 | int rtems_shell_rtems_main_object( |
---|
922 | int argc, |
---|
923 | char **argv |
---|
924 | ); |
---|
925 | @end example |
---|
926 | |
---|
927 | The configuration structure for the @code{COMMAND} has the |
---|
928 | following prototype: |
---|
929 | |
---|
930 | @example |
---|
931 | extern rtems_shell_cmd_t rtems_shell_OBJECT_Command; |
---|
932 | @end example |
---|
933 | |
---|
934 | @c |
---|
935 | @c |
---|
936 | @c |
---|
937 | @page |
---|
938 | @subsection driver - display the rtems device driver table |
---|
939 | |
---|
940 | @pgindex driver |
---|
941 | |
---|
942 | @subheading SYNOPSYS: |
---|
943 | |
---|
944 | @example |
---|
945 | driver [ major [ major ... ] ] |
---|
946 | @end example |
---|
947 | |
---|
948 | @subheading DESCRIPTION: |
---|
949 | |
---|
950 | This command XXX |
---|
951 | |
---|
952 | @subheading EXIT STATUS: |
---|
953 | |
---|
954 | This command returns 0 on success and non-zero if an error is encountered. |
---|
955 | |
---|
956 | @subheading NOTES: |
---|
957 | |
---|
958 | NONE |
---|
959 | |
---|
960 | @subheading EXAMPLES: |
---|
961 | |
---|
962 | The following is an example of how to use driver: |
---|
963 | |
---|
964 | @example |
---|
965 | EXAMPLE_TBD |
---|
966 | @end example |
---|
967 | |
---|
968 | @subheading CONFIGURATION: |
---|
969 | |
---|
970 | @findex CONFIGURE_SHELL_NO_COMMAND_DRIVER |
---|
971 | @findex CONFIGURE_SHELL_COMMAND_DRIVER |
---|
972 | |
---|
973 | This command is included in the default shell command set. |
---|
974 | When building a custom command set, define |
---|
975 | @code{CONFIGURE_SHELL_COMMAND_DRIVER} to have this |
---|
976 | command included. |
---|
977 | |
---|
978 | This command can be excluded from the shell command set by |
---|
979 | defining @code{CONFIGURE_SHELL_NO_COMMAND_DRIVER} when all |
---|
980 | shell commands have been configured. |
---|
981 | |
---|
982 | @subheading PROGRAMMING INFORMATION: |
---|
983 | |
---|
984 | @findex rtems_shell_rtems_main_driver |
---|
985 | |
---|
986 | The @code{COMMAND} is implemented by a C language function |
---|
987 | which has the following prototype: |
---|
988 | |
---|
989 | @example |
---|
990 | int rtems_shell_rtems_main_driver( |
---|
991 | int argc, |
---|
992 | char **argv |
---|
993 | ); |
---|
994 | @end example |
---|
995 | |
---|
996 | The configuration structure for the @code{COMMAND} has the |
---|
997 | following prototype: |
---|
998 | |
---|
999 | @example |
---|
1000 | extern rtems_shell_cmd_t rtems_shell_DRIVER_Command; |
---|
1001 | @end example |
---|
1002 | |
---|
1003 | @c |
---|
1004 | @c |
---|
1005 | @c |
---|
1006 | @page |
---|
1007 | @subsection dname - displays information about named drivers |
---|
1008 | |
---|
1009 | @pgindex dname |
---|
1010 | |
---|
1011 | @subheading SYNOPSYS: |
---|
1012 | |
---|
1013 | @example |
---|
1014 | dname |
---|
1015 | @end example |
---|
1016 | |
---|
1017 | @subheading DESCRIPTION: |
---|
1018 | |
---|
1019 | This command XXX |
---|
1020 | |
---|
1021 | @subheading EXIT STATUS: |
---|
1022 | |
---|
1023 | This command returns 0 on success and non-zero if an error is encountered. |
---|
1024 | |
---|
1025 | @subheading NOTES: |
---|
1026 | |
---|
1027 | NONE |
---|
1028 | |
---|
1029 | @subheading EXAMPLES: |
---|
1030 | |
---|
1031 | The following is an example of how to use dname: |
---|
1032 | |
---|
1033 | @example |
---|
1034 | EXAMPLE_TBD |
---|
1035 | @end example |
---|
1036 | |
---|
1037 | @subheading CONFIGURATION: |
---|
1038 | |
---|
1039 | @findex CONFIGURE_SHELL_NO_COMMAND_DNAME |
---|
1040 | @findex CONFIGURE_SHELL_COMMAND_DNAME |
---|
1041 | |
---|
1042 | This command is included in the default shell command set. |
---|
1043 | When building a custom command set, define |
---|
1044 | @code{CONFIGURE_SHELL_COMMAND_DNAME} to have this |
---|
1045 | command included. |
---|
1046 | |
---|
1047 | This command can be excluded from the shell command set by |
---|
1048 | defining @code{CONFIGURE_SHELL_NO_COMMAND_DNAME} when all |
---|
1049 | shell commands have been configured. |
---|
1050 | |
---|
1051 | @subheading PROGRAMMING INFORMATION: |
---|
1052 | |
---|
1053 | @findex rtems_shell_rtems_main_dname |
---|
1054 | |
---|
1055 | The @code{COMMAND} is implemented by a C language function |
---|
1056 | which has the following prototype: |
---|
1057 | |
---|
1058 | @example |
---|
1059 | int rtems_shell_rtems_main_dname( |
---|
1060 | int argc, |
---|
1061 | char **argv |
---|
1062 | ); |
---|
1063 | @end example |
---|
1064 | |
---|
1065 | The configuration structure for the @code{COMMAND} has the |
---|
1066 | following prototype: |
---|
1067 | |
---|
1068 | @example |
---|
1069 | extern rtems_shell_cmd_t rtems_shell_DNAME_Command; |
---|
1070 | @end example |
---|
1071 | |
---|