BABELTRACE2-HELP(1) | Babeltrace 2 manual | BABELTRACE2-HELP(1) |
NAME
babeltrace2-help - Get help for a Babeltrace 2 plugin or component class
SYNOPSIS
Get help for a Babeltrace 2 plugin:
babeltrace2 [GENERAL OPTIONS] help PLUGIN-NAME
Get help for a Babeltrace 2 component class:
babeltrace2 [GENERAL OPTIONS] help COMP-CLS-TYPE.PLUGIN-NAME.COMP-CLS-NAME
DESCRIPTION
The help command prints the details and help text of either the Babeltrace 2 plugin named PLUGIN-NAME or the specific component class of type COMP-CLS-TYPE named COMP-CLS-NAME found in the plugin named PLUGIN-NAME.
See babeltrace2-intro(7) to learn more about the Babeltrace 2 project and its core concepts.
The available values for COMP-CLS-TYPE are:
source, src
filter, flt
sink
See “EXAMPLES” for usage examples.
OPTIONS
General
You can use those options before the command name.
See babeltrace2(1) for more details.
-d, --debug
-l LVL, --log-level=LVL
--omit-home-plugin-path
--omit-system-plugin-path
--plugin-path=PATH[:PATH]...
-v, --verbose
Command information
-h, --help
EXAMPLES
Example 1. Get help for a plugin and all its component classes.
$ babeltrace2 help ctf
Example 2. Get help for a specific plugin’s source component class.
$ babeltrace2 help source.ctf.fs
Example 3. Get help for a specific plugin’s sink component class.
$ babeltrace2 help sink.text.pretty
ENVIRONMENT VARIABLES
Babeltrace 2 library
BABELTRACE_EXEC_ON_ABORT=CMDLINE
The application only aborts when the executed command returns, ignoring its exit status.
This environment variable is ignored when the application has the setuid or the setgid access right flag set.
BABELTRACE_TERM_COLOR=(AUTO | NEVER | ALWAYS)
The available values are:
AUTO
NEVER
ALWAYS
BABELTRACE_TERM_COLOR_BRIGHT_MEANS_BOLD=0
BABELTRACE_PLUGIN_PATH=PATHS
LIBBABELTRACE2_DISABLE_PYTHON_PLUGINS=1
LIBBABELTRACE2_INIT_LOG_LEVEL=LVL
If this environment variable is set, it overrides the log level set by the --log-level option for the Babeltrace 2 library logger.
The available values for LVL are:
NONE, N
FATAL, F
This level should be enabled in production.
ERROR, E
Usually, once one or more errors are reported at this level, the application, plugin, or library won’t perform any more useful task, but it should still exit cleanly.
This level should be enabled in production.
WARN, WARNING, W
This level should be enabled in production.
INFO, I
This level can be enabled in production.
DEBUG, D
This level should NOT be enabled in production.
TRACE, T
This level should NOT be enabled in production.
LIBBABELTRACE2_NO_DLCLOSE=1
LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=DIR
If this environment variable is set, it overrides the default plugin provider directory.
Babeltrace 2 Python bindings
BABELTRACE_PYTHON_BT2_LOG_LEVEL=LVL
If this environment variable is set, it overrides the log level set by the --log-level option for the Python bindings logger.
The available values for LVL are:
NONE, N
FATAL, F
This level should be enabled in production.
ERROR, E
Usually, once one or more errors are reported at this level, the application, plugin, or library won’t perform any more useful task, but it should still exit cleanly.
This level should be enabled in production.
WARN, WARNING, W
This level should be enabled in production.
INFO, I
This level can be enabled in production.
DEBUG, D
This level should NOT be enabled in production.
TRACE, T
This level should NOT be enabled in production.
CLI
BABELTRACE_CLI_LOG_LEVEL=LVL
If this environment variable is set, it overrides the log level set by the --log-level option for the CLI logger.
The available values for LVL are:
NONE, N
FATAL, F
This level should be enabled in production.
ERROR, E
Usually, once one or more errors are reported at this level, the application, plugin, or library won’t perform any more useful task, but it should still exit cleanly.
This level should be enabled in production.
WARN, WARNING, W
This level should be enabled in production.
INFO, I
This level can be enabled in production.
DEBUG, D
This level should NOT be enabled in production.
TRACE, T
This level should NOT be enabled in production.
BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH=0
BABELTRACE_DEBUG=1
BABELTRACE_VERBOSE=1
FILES
$HOME/.local/lib/babeltrace2/plugins
/usr/lib/babeltrace2/plugins
/usr/lib/babeltrace2/plugin-providers
EXIT STATUS
0 on success, 1 otherwise.
BUGS
If you encounter any issue or usability problem, please report it on the Babeltrace bug tracker (see https://bugs.lttng.org/projects/babeltrace).
RESOURCES
The Babeltrace project shares some communication channels with the LTTng project (see https://lttng.org/).
AUTHORS
The Babeltrace 2 project is the result of hard work by many regular developers and occasional contributors.
The current project maintainer is Jérémie Galarneau <mailto:jeremie.galarneau@efficios.com>.
COPYRIGHT
This command is part of the Babeltrace 2 project.
Babeltrace is distributed under the MIT license (see https://opensource.org/licenses/MIT).
SEE ALSO
babeltrace2-intro(7), babeltrace2(1), babeltrace2-list-plugins(1)
14 September 2019 | Babeltrace 2.0.4 |