NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | ENVIRONMENT VARIABLES | FILES | EXIT STATUS | BUGS | RESOURCES | AUTHORS | COPYRIGHT | SEE ALSO | COLOPHON

BABELTRACE-HELP(1)            Babeltrace manual           BABELTRACE-HELP(1)

NAME         top

       babeltrace-help - Get help for a Babeltrace plugin or component class

SYNOPSIS         top

       babeltrace help [GENERAL OPTIONS] [--omit-home-plugin-path]
                       [--omit-system-plugin-path]
                       [--plugin-path=PATH[: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 babeltrace-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
           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
           option.

        3. If the --omit-home-plugin-path option is absent:
           $HOME/.local/lib/babeltrace/plugins

        4. If the --omit-system-plugin-path option is absent:
           /usr/local/lib/babeltrace/plugins

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

OPTIONS         top

   General options
       See babeltrace(1) for more details.

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

       --log-level=LVL
           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
       --omit-home-plugin-path
           Do not search for plugins in $HOME/.local/lib/babeltrace/plugins.

       --omit-system-plugin-path
           Do not search for plugins in /usr/local/lib/babeltrace/plugins.

       --plugin-path=PATH[:PATH]...
           Add PATH to the list of paths in which dynamic plugins can be
           found.

   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.

           $ babeltrace help my-plugin

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

           $ babeltrace help src.my-plugin.my-source

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

           $ babeltrace help sink.my-plugin.my-sink

ENVIRONMENT VARIABLES         top

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

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

       BABELTRACE_TERM_COLOR
           Force the terminal color support. The available values are:

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

           NEVER
               Never emit terminal color codes.

           ALWAYS
               Always emit terminal color codes.

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

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

       BABELTRACE_NO_DLCLOSE
           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.

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

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

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

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

FILES         top

       $HOME/.local/lib/babeltrace/plugins
           User plugin directory.

       /usr/local/lib/babeltrace/plugins
           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
       <https://bugs.linuxfoundation.org/buglist.cgi?product=Diamon&component=Babeltrace>).

RESOURCES         top

       The Babeltrace project shares some communication channels with the
       LTTng project (see <http://lttng.org/>).

       ·   Babeltrace website (see <http://diamon.org/babeltrace>)

       ·   Git repository (see
           <http://git.linuxfoundation.org/?p=diamon/babeltrace.git>)

       ·   EfficiOS GitHub organization (see <http://github.com/efficios/>)

       ·   Continuous integration (see
           <https://ci.lttng.org/job/babeltrace_master_build/>)

       ·   Mailing list (see <http://lists.lttng.org>) for support and
           development: lttng-dev@lists.lttng.org

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

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
       <mailto:jeremie.galarneau@efficios.com>.

COPYRIGHT         top

       This command is part of the Babeltrace project.

       Babeltrace is distributed under the MIT license (see
       <https://opensource.org/licenses/MIT>).

SEE ALSO         top

       babeltrace(1), babeltrace-list-plugins(1) babeltrace-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 ⟨http://www.efficios.com/babeltrace⟩.  If you have a bug
       report for this manual page, send it to lttng-dev@lists.lttng.org.
       This page was obtained from the project's upstream Git repository
       ⟨git://git.efficios.com/babeltrace.git⟩ on 2017-11-25.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2017-11-23.)  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 man-pages@man7.org

Babeltrace 2.0.0-pre4          5 October 2017             BABELTRACE-HELP(1)

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