rtems/doc/shell/rtems.t

@c
@c  COPYRIGHT (c) 1988-2008.
@c  On-Line Applications Research Corporation (OAR).
@c  All rights reserved.
@c
@c  $Id$
@c

@chapter RTEMS Commands

@section Introduction

The RTEMS shell has the following rtems commands:

@itemize @bullet

@item @code{cpuuse} - print or reset per thread cpu usage
@item @code{stackuse} - print per thread stack usage
@item @code{perioduse} - print or reset per period usage
@item @code{wkspace} - Display information on Executive Workspace
@item @code{config} - Show the system configuration.
@item @code{itask} - List init tasks for the system
@item @code{extension} - Display information about extensions
@item @code{task} - Display information about tasks
@item @code{queue} - Display information about message queues
@item @code{sema} - display information about semaphores
@item @code{region} - display information about regions
@item @code{part} - display information about partitions
@item @code{object} - Display information about RTEMS objects
@item @code{driver} - Display the RTEMS device driver table
@item @code{dname} - Displays information about named drivers

@end itemize

@section Commands

@c
@c
@c
@page
@subsection cpuuse - print or reset per thread cpu usage

@pgindex cpuuse

@subheading SYNOPSYS:

@example
cpuuse [-r]
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{cpuuse}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_CPUUSE
@findex CONFIGURE_SHELL_COMMAND_CPUUSE

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_CPUUSE} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_CPUUSE} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_cpuuse

The @code{cpuuse} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_cpuuse(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{cpuuse} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command;
@end example

@c
@c
@c
@page
@subsection stackuse - print per thread stack usage

@pgindex stackuse

@subheading SYNOPSYS:

@example
stackuse
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{stackuse}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_STACKUSE
@findex CONFIGURE_SHELL_COMMAND_STACKUSE

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_STACKUSE} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_STACKUSE} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_stackuse

The @code{stackuse} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_stackuse(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{stackuse} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command;
@end example

@c
@c
@c
@page
@subsection perioduse - print or reset per period usage

@pgindex perioduse

@subheading SYNOPSYS:

@example
perioduse [-r]
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{perioduse}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_PERIODUSE
@findex CONFIGURE_SHELL_COMMAND_PERIODUSE

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_PERIODUSE} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_PERIODUSE} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_perioduse

The @code{perioduse} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_perioduse(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{perioduse} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command;
@end example

@c
@c
@c
@page
@subsection wkspace - display information on executive workspace

@pgindex wkspace

@subheading SYNOPSYS:

@example
wkspace
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{wkspace}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_WKSPACE
@findex CONFIGURE_SHELL_COMMAND_WKSPACE

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_WKSPACE} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_WKSPACE} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_wkspace

The @code{wkspace} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_wkspace(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{wkspace} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command;
@end example

@c
@c
@c
@page
@subsection config - show the system configuration.

@pgindex config

@subheading SYNOPSYS:

@example
config
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{config}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_CONFIG
@findex CONFIGURE_SHELL_COMMAND_CONFIG

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_CONFIG} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_CONFIG} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_config

The @code{config} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_config(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{config} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_CONFIG_Command;
@end example

@c
@c
@c
@page
@subsection itask - list init tasks for the system

@pgindex itask

@subheading SYNOPSYS:

@example
itask
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{itask}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_ITASK
@findex CONFIGURE_SHELL_COMMAND_ITASK

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_ITASK} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_ITASK} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_itask

The @code{itask} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_itask(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{itask} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_ITASK_Command;
@end example

@c
@c
@c
@page
@subsection extension - display information about extensions

@pgindex extension

@subheading SYNOPSYS:

@example
extension [id [id ...] ]
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{extension}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_EXTENSION
@findex CONFIGURE_SHELL_COMMAND_EXTENSION

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_EXTENSION} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_EXTENSION} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_extension

The @code{extension} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_extension(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{extension} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command;
@end example

@c
@c
@c
@page
@subsection task - display information about tasks

@pgindex task

@subheading SYNOPSYS:

@example
task [id [id ...] ]
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{task}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_TASK
@findex CONFIGURE_SHELL_COMMAND_TASK

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_TASK} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_TASK} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_task

The @code{task} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_task(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{task} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_TASK_Command;
@end example

@c
@c
@c
@page
@subsection queue - display information about message queues

@pgindex queue

@subheading SYNOPSYS:

@example
queue [id [id ... ] ]
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{queue}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_QUEUE
@findex CONFIGURE_SHELL_COMMAND_QUEUE

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_QUEUE} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_QUEUE} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_queue

The @code{queue} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_queue(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{queue} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_QUEUE_Command;
@end example

@c
@c
@c
@page
@subsection sema - display information about semaphores

@pgindex sema

@subheading SYNOPSYS:

@example
sema [id [id ... ] ]
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{sema}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_SEMA
@findex CONFIGURE_SHELL_COMMAND_SEMA

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_SEMA} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_SEMA} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_sema

The @code{sema} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_sema(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{sema} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_SEMA_Command;
@end example

@c
@c
@c
@page
@subsection region - display information about regions

@pgindex region

@subheading SYNOPSYS:

@example
region [id [id ... ] ]
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{region}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_REGION
@findex CONFIGURE_SHELL_COMMAND_REGION

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_REGION} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_REGION} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_region

The @code{region} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_region(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{region} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_REGION_Command;
@end example

@c
@c
@c
@page
@subsection part - display information about partitions

@pgindex part

@subheading SYNOPSYS:

@example
part [id [id ... ] ]
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{part}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_PART
@findex CONFIGURE_SHELL_COMMAND_PART

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_PART} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_PART} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_part

The @code{part} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_part(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{part} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_PART_Command;
@end example

@c
@c
@c
@page
@subsection object - display information about rtems objects

@pgindex object

@subheading SYNOPSYS:

@example
object [id [id ...] ]
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{object}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_OBJECT
@findex CONFIGURE_SHELL_COMMAND_OBJECT

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_OBJECT} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_OBJECT} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_object

The @code{object} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_object(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{object} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_OBJECT_Command;
@end example

@c
@c
@c
@page
@subsection driver - display the rtems device driver table

@pgindex driver

@subheading SYNOPSYS:

@example
driver [ major [ major ... ] ]
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{driver}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_DRIVER
@findex CONFIGURE_SHELL_COMMAND_DRIVER

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_DRIVER} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_DRIVER} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_driver

The @code{driver} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_driver(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{driver} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_DRIVER_Command;
@end example

@c
@c
@c
@page
@subsection dname - displays information about named drivers

@pgindex dname

@subheading SYNOPSYS:

@example
dname
@end example

@subheading DESCRIPTION:

This command XXX

@subheading EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

@subheading NOTES:

NONE

@subheading EXAMPLES:

The following is an example of how to use @code{dname}:

@example
EXAMPLE_TBD
@end example

@subheading CONFIGURATION:

@findex CONFIGURE_SHELL_NO_COMMAND_DNAME
@findex CONFIGURE_SHELL_COMMAND_DNAME

This command is included in the default shell command set.  
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_DNAME} to have this
command included.

This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_DNAME} when all
shell commands have been configured.

@subheading PROGRAMMING INFORMATION:

@findex rtems_shell_rtems_main_dname

The @code{dname} is implemented by a C language function
which has the following prototype:

@example
int rtems_shell_rtems_main_dname(
  int    argc,
  char **argv
);
@end example

The configuration structure for the @code{dname} has the
following prototype:

@example
extern rtems_shell_cmd_t rtems_shell_DNAME_Command;
@end example