.. _tools:

=======
 Tools
=======

.. toctree::
   :hidden:

   common
   bag-record
   bag-play
   bag-info
   bag-cat
   bag-merge

.. seealso::

   :ref:`common-options`
     For a description of common options accepted by more than one
     program.

The following tools are available:

* :ref:`bag-record`

  This tool is used to capture and store RSB :term:`events` from one
  or more :term:`channels`. The captured :term:`events` are serialized
  and written to one or more :term:`channels` (based on their
  :term:`scopes` and :term:`payload` types) of a :term:`log file`.

* :ref:`bag-play`

  This tool "replays" RSB :term:`events` stored in a :term:`log
  file`. :term:`Events` from all :term:`channels` or a subset of the
  :term:`channels` stored in a :term:`log file` are deserialized and
  sent via RSB :term:`informers` preserving the recorded timing as
  closely as possible. Other replay timings are also possible.

* :ref:`bag-info`

  The purpose of this tool is inspecting :term:`log files`. It is
  capable of extracting and displaying some high-level information
  form :term:`log files`.

* :ref:`bag-cat`

  Like UNIX :command:`cat`, this program makes a stream of data
  available on its standard output stream. Unlike UNIX :command:`cat`,
  the data is obtained by processing :term:`log files`.

* :ref:`bag-merge`

  This tool merges multiple :term:`log files` into one, optionally
  applying transformations to :term:`log file` :term:`channels` and/or
  entries in the process.