Changeset f052446 in rtems-docs for shell/rtems_specific_commands.rst


Ignore:
Timestamp:
08/03/22 05:01:43 (4 months ago)
Author:
Chris Johns <chrisj@…>
Branches:
master
Children:
cf9f212
Parents:
1c17ec4
git-author:
Chris Johns <chrisj@…> (08/03/22 05:01:43)
git-committer:
Chris Johns <chrisj@…> (08/12/22 22:50:33)
Message:

commands: Add 'rtems' command

File:
1 edited

Legend:

Unmodified
Added
Removed
  • shell/rtems_specific_commands.rst

    r1c17ec4 rf052446  
    1010
    1111The RTEMS shell has the following RTEMS specific commands:
     12
     13- rtems_ - Display RTEMS specific detail
    1214
    1315- shutdown_ - Shutdown the system
     
    5557dedicated to each of the commands and describes the behavior and configuration
    5658of that command as well as providing an example usage.
     59
     60.. raw:: latex
     61
     62   \clearpage
     63
     64.. _rtems:
     65
     66rtems - RTEMS Details
     67---------------------
     68.. index:: rtems
     69
     70SYNOPSYS:
     71    .. code-block:: shell
     72
     73        rtems
     74
     75DESCRIPTION:
     76    This command reports various RTEMS specific details such as a the
     77    version, CPU and CPU module, BSP name, version of tools and the
     78    build options.
     79
     80EXIT STATUS:
     81    This command returns 0 on success and non-zero if an error is encountered.
     82
     83NOTES:
     84    The following commands are supported:
     85
     86    - ``ver``:
     87      Version of RTEMS running
     88
     89    - ``cpu``:
     90      CPU name and model
     91
     92    - ``bsp``:
     93      Name of the BSP
     94
     95    - ``tools``:
     96      Version of the tools used to build RTEMS
     97
     98    - ``opts``:
     99      RTEMS build options
     100
     101    - ``all``:
     102      All of the available commands
     103
     104
     105EXAMPLES:
     106    The following is an example of how to use ``rtems``:
     107
     108    .. code-block:: shell
     109
     110        SHLL [/] # rtems
     111        RTEMS: 6.0.0 (071640d310b432d15350188c2ebf086653a0d578)
     112
     113    The version of RTEMS running is displayed. To see the CPU name and
     114    moduel enter:
     115
     116    .. code-block:: shell
     117
     118        SHLL [/] # rtems cpu
     119        CPU: SPARC (w/FPU)
     120
     121    The ``help`` command will list all available commands. The ``all``
     122    command will display all avalable output:
     123
     124    .. code-block:: shell
     125
     126        SHLL [/] # rtems all
     127        RTEMS: 6.0.0 (071640d310b432d15350188c2ebf086653a0d578)
     128        CPU: SPARC (w/FPU)
     129        BSP: erc32
     130        Tools: 12.1.1 20220622 (RTEMS 6, RSB f4f5d43a98051f7562103aaa2ec7723c628c6947, Newlib ea99f21)
     131        Options: DEBUG POSIX
     132
     133.. index:: CONFIGURE_SHELL_NO_COMMAND_RTEMS
     134.. index:: CONFIGURE_SHELL_COMMAND_RTEMS
     135
     136CONFIGURATION:
     137    This command is included in the default shell command set.  When building a
     138    custom command set, define ``CONFIGURE_SHELL_COMMAND_RTEMS`` to have
     139    this command included.
     140
     141    This command can be excluded from the shell command set by defining
     142    ``CONFIGURE_SHELL_NO_COMMAND_RTEMS`` when all shell commands have been
     143    configured.
     144
     145PROGRAMMING INFORMATION:
     146    The configuration structure for the ``rtems`` has the following
     147    prototype:
     148
     149    .. code-block:: c
     150
     151        extern rtems_shell_cmd_t rtems_shell_RTEMS_Command;
    57152
    58153.. raw:: latex
Note: See TracChangeset for help on using the changeset viewer.