.. _rsbag:

Welcome to the |project| Manual! (for version |version|)
========================================================

The goal of the |project| project is to provide specifications,
libraries and tools for efficient and flexible recording and replay of
:ref:`RSB <rsb>` :term:`event` s. It is similar to `ROSBag`_ in this
regard but not tied to a particular communication framework (however,
currently only RSB is supported) or file format (currently, the
`TIDELog`_ file format is supported and some support for the `Elan`_
XML file format, ``eaf``, is available).

Contents:

.. toctree::
   :maxdepth: 2

   preparation
   Use Case Examples <use-cases>

.. toctree::
   :hidden:

   tools
   glossary

* :ref:`Tool Man-pages <tools>`

  * :ref:`bag-record`
  * :ref:`bag-play`
  * :ref:`bag-info`
  * :ref:`bag-cat`
  * :ref:`bag-merge`

Indices and tables
==================

* :ref:`genindex`
* :ref:`glossary`
* :ref:`search`