BABELTRACE2-HELP(1)           Babeltrace manual          BABELTRACE2-HELP(1)

NAME         top

       babeltrace2-help - Get help for a Babeltrace plugin or component

SYNOPSIS         top

       babeltrace2 help [GENERAL OPTIONS] [--omit-home-plugin-path]
                       (PLUGIN | TYPE.PLUGIN.COMPCLS)

DESCRIPTION         top

       The help command prints the details and help text of either the
       plugin PLUGIN or the specific component class TYPE.PLUGIN.COMPCLS.

       See babeltrace2-intro(7) to learn more about the Babeltrace project
       and its core concepts.

       The available values for TYPE are:

       source or src
           Source component class.

       filter or flt
           Filter component class.

           Sink component class.

       See EXAMPLES for usage examples.

   Plugin path
       This command loads Babeltrace plugins to perform its operation. The
       search path for Babeltrace plugins is, in this order:

        1. The colon-separated list of directories in the
           BABELTRACE_PLUGIN_PATH environment variable.

        2. The colon-separated list of directories in the --plugin-path

        3. If the --omit-home-plugin-path option is absent:

        4. If the --omit-system-plugin-path option is absent:

       You can use the babeltrace2-list-plugins(1) command to dynamically
       list the available plugins.

OPTIONS         top

   General options
       See babeltrace2(1) for more details.

       -d, --debug
           Turn the debugging mode on.

           Set the log level of all known Babeltrace loggers to LVL.

       -v, --verbose
           Turn the verbose mode on.

       -h, --help
           Show general help and quit.

       -V, --version
           Show version and quit.

   Plugin path
           Do not search for plugins in

           Do not search for plugins in /usr/local/lib/babeltrace2/plugins.

           Add PATH to the list of paths in which dynamic plugins can be

   Command information
       -h, --help
           Show the command’s help and quit.

EXAMPLES         top

       Example 1. Get help for a plugin and all its component classes.

           $ babeltrace2 help my-plugin

       Example 2. Get help for a specific plugin’s source component class.

           $ babeltrace2 help

       Example 3. Get help for a specific plugin’s sink component class.

           $ babeltrace2 help


   Babeltrace library
           Common functions’s log level. The available values are the same
           as for the --log-level option of babeltrace2(1).

           Compatibility functions’s log level. The available values are the
           same as for the --log-level option of babeltrace2(1).

           Force the terminal color support. The available values are:

               Only emit terminal color codes when the standard output and
               error streams are connected to a color-capable terminal.

               Never emit terminal color codes.

               Always emit terminal color codes.

           Set to 1 to disable the loading of any Babeltrace Python plugin.

           Babeltrace library’s global log level. The available values are
           the same as for the --log-level option of babeltrace2(1)

           Set to 1 to make the Babeltrace library leave any dynamically
           loaded modules (plugins and Python plugin provider) open at exit.
           This can be useful for debugging purposes.

           Colon-separated list of directories, in order, in which dynamic
           plugins can be found before other directories are considered.

   Python plugin provider
           Python plugin provider’s log level. The available values are the
           same as for the --log-level option of babeltrace2(1).

           babeltrace2 CLI’s log level. The available values are the same as
           for the --log-level option.

           Set to 0 to disable the warning message which babeltrace2 prints
           when you convert a trace with a relative path that’s also the
           name of a babeltrace2 command.

FILES         top

           User plugin directory.

           System plugin directory.

EXIT STATUS         top

       0 on success, 1 otherwise.

BUGS         top

       If you encounter any issue or usability problem, please report it on
       the Babeltrace bug tracker (see

RESOURCES         top

       The Babeltrace project shares some communication channels with the
       LTTng project (see <>).

       ·   Babeltrace website (see <>)

       ·   Git repository (see

       ·   EfficiOS GitHub organization (see <>)

       ·   Continuous integration (see

       ·   Mailing list (see <>) for support and

       ·   IRC channel (see <irc://>): #lttng on

AUTHORS         top

       The Babeltrace project is the result of efforts by many regular
       developers and occasional contributors.

       The current project maintainer is Jérémie Galarneau

COPYRIGHT         top

       This command is part of the Babeltrace project.

       Babeltrace is distributed under the MIT license (see

SEE ALSO         top

       babeltrace2(1), babeltrace2-list-plugins(1) babeltrace2-intro(7)

COLOPHON         top

       This page is part of the babeltrace (trace read and write libraries
       and a trace converter) project.  Information about the project can be
       found at ⟨⟩.  If you have a bug
       report for this manual page, send it to
       This page was obtained from the project's upstream Git repository
       ⟨git://⟩ on 2019-07-28.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2019-07-26.)  If you discover any rendering problems in
       this HTML version of the page, or you believe there is a better or
       more up-to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not part
       of the original manual page), send a mail to

Babeltrace 2.0.0-pre6          5 October 2017            BABELTRACE2-HELP(1)

Pages that refer to this page: babeltrace2(1)babeltrace2-list-plugins(1)babeltrace2-query(1)