.. _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:`event` s from one
  or more :term:`channel` s. The captured :term:`event` s are
  serialized and written to one or more :term:`channel` s (based on
  their :term:`scope` s and :term:`payload` types) of a :term:`log
  file`.

* :ref:`bag-play`

  This tool "replays" RSB :term:`event` s stored in a :term:`log
  file`. :term:`Event` s from all :term:`channel` s or a subset of the
  :term:`channel` s stored in a :term:`log file` are deserialized and
  sent via RSB :term:`informer` s 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 file` s. It is
  capable of extracting and displaying some high-level information
  form :term:`log file` s.

* :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 file` s.

* :ref:`bag-merge`

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