=======
rtcheck
=======

---------------------------
check RT-System consistency
---------------------------

.. include:: ../common/docinfo_block.txt

Synopsis
========

rtcheck [options] <RTSProfile specification file>

Description
===========

Checks the consistency of a running system against an RTSProfile. Identifies
errors including missing connections and components in the incorrect state.

XML format is used by default; to use RTSProfiles specified in YAML,
specify ``--yaml``.

Options
=======

--dry-run
  Print what will be done but don't actually do anything.

-s STATE, --state=STATE
  The expected state of the RT Components in the system. The default is
  ``Active``.

-x, --xml
  Use XML input format.

-y, --yaml
  Use YAML input format.

.. include:: ../common/common_opts.txt

.. include:: ../common/common_body.txt

Examples
========

::

  $ rtcheck sys.rtsys

Check if the system specified in the RTSProfile stored in ``sys.rtsys``
is correctly set up in the current running components, with all
components in the ``active`` state.

::

  $ rtcheck sys.rtsys -s Inactive

The same as above, but expect the components to be in the ``inactive``
state.

::

  $ rtcheck sys.rtsys --dry-run

Display the actions that will be performed to check the system state.

See Also
========

``rtcat`` (1),
``rtresurrect`` (1),
``rtstart`` (1)

