.. _bag-info:
.. _tool-info:

==========
 bag info
==========

.. program:: bag info

Synopsis
========

:samp:`bag info {[OPTIONS]} {LOGFILE}`

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

The :program:`bag info` program can be used to inspect the structure
and, to some extent, contents of :term:`log files <log file>`. Given a
log file, it displays the :term:`channels <channel>` stored in the
file, some information regarding timing as well as some :term:`event`
counts and sizes.

.. seealso::

   :ref:`rsb:common-options`
     The usual RSB-related commandline options are accepted.

.. option:: --style SPEC

   Format information about the :term:`log files <log file>` and
   :term:`channels <channel>` according to the output style designated
   by :samp:`{SPEC}`. See :option:`logger --style` for details.

Examples
========

* .. code-block:: sh

     $ bag info 1314442144.tide

  should produce output similar to the following::

    File "1314442144.tide"
      Events  : 7,620
      Start   : 2011-08-27T12:49:17.356679+02:00
      End     : 2011-08-27T12:56:41.333822+02:00
      Duration: 443.977143
      Rate    : 102.319
      Channel "/KuHa/test/:UTF-8-STRING"
        Type    : (RSB-EVENT UTF-8-STRING)
        Events  : 28
        Start   : 2011-08-27T12:49:41.037310+02:00
        End     : 2011-08-27T12:56:10.710000+02:00
        Duration: 389.67269
        Rate    : 0.071
    [...]