1BABELTRACE2-HELP(1) Babeltrace 2 manual BABELTRACE2-HELP(1)
2
3
4
6 babeltrace2-help - Get help for a Babeltrace 2 plugin or component
7 class
8
10 Get help for a Babeltrace 2 plugin:
11
12 babeltrace2 [GENERAL OPTIONS] help PLUGIN-NAME
13
14 Get help for a Babeltrace 2 component class:
15
16 babeltrace2 [GENERAL OPTIONS] help
17 COMP-CLS-TYPE.PLUGIN-NAME.COMP-CLS-NAME
18
20 The help command prints the details and help text of either the
21 Babeltrace 2 plugin named PLUGIN-NAME or the specific component class
22 of type COMP-CLS-TYPE named COMP-CLS-NAME found in the plugin named
23 PLUGIN-NAME.
24
25 See babeltrace2-intro(7) to learn more about the Babeltrace 2 project
26 and its core concepts.
27
28 The available values for COMP-CLS-TYPE are:
29
30 source, src
31 Source component class.
32
33 filter, flt
34 Filter component class.
35
36 sink
37 Sink component class.
38
39 See “EXAMPLES” for usage examples.
40
42 General
43 You can use those options before the command name.
44
45 See babeltrace2(1) for more details.
46
47 -d, --debug
48 Legacy option: this is equivalent to --log-level=TRACE.
49
50 -l LVL, --log-level=LVL
51 Set the log level of all known Babeltrace 2 loggers to LVL.
52
53 --omit-home-plugin-path
54 Do not search for plugins in $HOME/.local/lib/babeltrace2/plugins.
55
56 --omit-system-plugin-path
57 Do not search for plugins in /usr/local/lib/babeltrace2/plugins.
58
59 --plugin-path=PATH[:PATH]...
60 Add PATH to the list of paths in which plugins can be found.
61
62 -v, --verbose
63 Legacy option: this is equivalent to --log-level=INFO.
64
65 Command information
66 -h, --help
67 Show the command’s help and quit.
68
70 Example 1. Get help for a plugin and all its component classes.
71
72 $ babeltrace2 help ctf
73
74 Example 2. Get help for a specific plugin’s source component class.
75
76 $ babeltrace2 help source.ctf.fs
77
78 Example 3. Get help for a specific plugin’s sink component class.
79
80 $ babeltrace2 help sink.text.pretty
81
83 Babeltrace 2 library
84 BABELTRACE_EXEC_ON_ABORT=CMDLINE
85 Execute the command line CMDLINE, as parsed like a UNIX 98 shell,
86 when any part of the Babeltrace 2 project unexpectedly aborts.
87
88 The application only aborts when the executed command returns,
89 ignoring its exit status.
90
91 This environment variable is ignored when the application has the
92 setuid or the setgid access right flag set.
93
94 BABELTRACE_TERM_COLOR=(AUTO | NEVER | ALWAYS)
95 Force the terminal color support for the babeltrace2(1) program and
96 the project’s plugins.
97
98 The available values are:
99
100 AUTO
101 Only emit terminal color codes when the standard output and
102 error streams are connected to a color-capable terminal.
103
104 NEVER
105 Never emit terminal color codes.
106
107 ALWAYS
108 Always emit terminal color codes.
109
110 BABELTRACE_TERM_COLOR_BRIGHT_MEANS_BOLD=0
111 Set to 0 to emit SGR (see
112 <https://en.wikipedia.org/wiki/ANSI_escape_code>) codes 90 to 97
113 for bright colors instead of bold (SGR code 1) and standard color
114 codes (SGR codes 30 to 37).
115
116 BABELTRACE_PLUGIN_PATH=PATHS
117 Set the list of directories, in order, in which dynamic plugins can
118 be found before other directories are considered to PATHS
119 (colon-separated, or semicolon on Windows).
120
121 LIBBABELTRACE2_DISABLE_PYTHON_PLUGINS=1
122 Disable the loading of any Babeltrace 2 Python plugin.
123
124 LIBBABELTRACE2_INIT_LOG_LEVEL=LVL
125 Force the Babeltrace 2 library’s initial log level to be LVL.
126
127 If this environment variable is set, it overrides the log level set
128 by the --log-level option for the Babeltrace 2 library logger.
129
130 The available values for LVL are:
131
132 NONE, N
133 Logging is disabled.
134
135 FATAL, F
136 Severe errors that lead the execution to abort immediately.
137
138 This level should be enabled in production.
139
140 ERROR, E
141 Errors that might still allow the execution to continue.
142
143 Usually, once one or more errors are reported at this level,
144 the application, plugin, or library won’t perform any more
145 useful task, but it should still exit cleanly.
146
147 This level should be enabled in production.
148
149 WARN, WARNING, W
150 Unexpected situations which still allow the execution to
151 continue.
152
153 This level should be enabled in production.
154
155 INFO, I
156 Informational messages that highlight progress or important
157 states of the application, plugins, or library.
158
159 This level can be enabled in production.
160
161 DEBUG, D
162 Debugging information, with a higher level of details than the
163 TRACE level.
164
165 This level should NOT be enabled in production.
166
167 TRACE, T
168 Low-level debugging context information.
169
170 This level should NOT be enabled in production.
171
172 LIBBABELTRACE2_NO_DLCLOSE=1
173 Make the Babeltrace 2 library leave any dynamically loaded modules
174 (plugins and plugin providers) open at exit. This can be useful for
175 debugging purposes.
176
177 LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=DIR
178 Set the directory from which the Babeltrace 2 library dynamically
179 loads plugin provider shared objects to DIR.
180
181 If this environment variable is set, it overrides the default
182 plugin provider directory.
183
184 Babeltrace 2 Python bindings
185 BABELTRACE_PYTHON_BT2_LOG_LEVEL=LVL
186 Force the Babeltrace 2 Python bindings log level to be LVL.
187
188 If this environment variable is set, it overrides the log level set
189 by the --log-level option for the Python bindings logger.
190
191 The available values for LVL are:
192
193 NONE, N
194 Logging is disabled.
195
196 FATAL, F
197 Severe errors that lead the execution to abort immediately.
198
199 This level should be enabled in production.
200
201 ERROR, E
202 Errors that might still allow the execution to continue.
203
204 Usually, once one or more errors are reported at this level,
205 the application, plugin, or library won’t perform any more
206 useful task, but it should still exit cleanly.
207
208 This level should be enabled in production.
209
210 WARN, WARNING, W
211 Unexpected situations which still allow the execution to
212 continue.
213
214 This level should be enabled in production.
215
216 INFO, I
217 Informational messages that highlight progress or important
218 states of the application, plugins, or library.
219
220 This level can be enabled in production.
221
222 DEBUG, D
223 Debugging information, with a higher level of details than the
224 TRACE level.
225
226 This level should NOT be enabled in production.
227
228 TRACE, T
229 Low-level debugging context information.
230
231 This level should NOT be enabled in production.
232
233 CLI
234 BABELTRACE_CLI_LOG_LEVEL=LVL
235 Force babeltrace2 CLI’s log level to be LVL.
236
237 If this environment variable is set, it overrides the log level set
238 by the --log-level option for the CLI logger.
239
240 The available values for LVL are:
241
242 NONE, N
243 Logging is disabled.
244
245 FATAL, F
246 Severe errors that lead the execution to abort immediately.
247
248 This level should be enabled in production.
249
250 ERROR, E
251 Errors that might still allow the execution to continue.
252
253 Usually, once one or more errors are reported at this level,
254 the application, plugin, or library won’t perform any more
255 useful task, but it should still exit cleanly.
256
257 This level should be enabled in production.
258
259 WARN, WARNING, W
260 Unexpected situations which still allow the execution to
261 continue.
262
263 This level should be enabled in production.
264
265 INFO, I
266 Informational messages that highlight progress or important
267 states of the application, plugins, or library.
268
269 This level can be enabled in production.
270
271 DEBUG, D
272 Debugging information, with a higher level of details than the
273 TRACE level.
274
275 This level should NOT be enabled in production.
276
277 TRACE, T
278 Low-level debugging context information.
279
280 This level should NOT be enabled in production.
281
282 BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH=0
283 Disable the warning message which babeltrace2-convert(1) prints
284 when you convert a trace with a relative path that’s also the name
285 of a babeltrace2 command.
286
287 BABELTRACE_DEBUG=1
288 Legacy variable: equivalent to setting the --log-level option to
289 TRACE.
290
291 BABELTRACE_VERBOSE=1
292 Legacy variable: equivalent to setting the --log-level option to
293 INFO.
294
296 $HOME/.local/lib/babeltrace2/plugins
297 User plugin directory.
298
299 /usr/local/lib/babeltrace2/plugins
300 System plugin directory.
301
302 /usr/local/lib/babeltrace2/plugin-providers
303 System plugin provider directory.
304
306 0 on success, 1 otherwise.
307
309 If you encounter any issue or usability problem, please report it on
310 the Babeltrace bug tracker (see
311 <https://bugs.lttng.org/projects/babeltrace>).
312
314 The Babeltrace project shares some communication channels with the
315 LTTng project (see <https://lttng.org/>).
316
317 · Babeltrace website (see <https://babeltrace.org/>)
318
319 · Mailing list (see <https://lists.lttng.org>) for support and
320 development: lttng-dev@lists.lttng.org
321
322 · IRC channel (see <irc://irc.oftc.net/lttng>): #lttng on
323 irc.oftc.net
324
325 · Bug tracker (see <https://bugs.lttng.org/projects/babeltrace>)
326
327 · Git repository (see <https://git.efficios.com/?p=babeltrace.git>)
328
329 · GitHub project (see <https://github.com/efficios/babeltrace>)
330
331 · Continuous integration (see
332 <https://ci.lttng.org/view/Babeltrace/>)
333
334 · Code review (see <https://review.lttng.org/q/project:babeltrace>)
335
337 The Babeltrace 2 project is the result of hard work by many regular
338 developers and occasional contributors.
339
340 The current project maintainer is Jérémie Galarneau
341 <mailto:jeremie.galarneau@efficios.com>.
342
344 This command is part of the Babeltrace 2 project.
345
346 Babeltrace is distributed under the MIT license (see
347 <https://opensource.org/licenses/MIT>).
348
350 babeltrace2-intro(7), babeltrace2(1), babeltrace2-list-plugins(1)
351
352
353
354Babeltrace 2.0.3 14 September 2019 BABELTRACE2-HELP(1)