babeltrace2-list-plugins(1)

1BABELTRACE2-LIST-P(1)         Babeltrace 2 manual        BABELTRACE2-LIST-P(1)
2
3
4

NAME

6       babeltrace2-list-plugins - List Babeltrace 2 plugins and their
7       properties
8

SYNOPSIS

10       babeltrace2 [GENERAL OPTIONS] list-plugins
11

DESCRIPTION

13       The list-plugins command prints a list of available Babeltrace 2
14       plugins along with their component classes and their properties.
15
16       See babeltrace2-intro(7) to learn more about the Babeltrace 2 project
17       and its core concepts.
18

OPTIONS

20   General
21       You can use those options before the command name.
22
23       See babeltrace2(1) for more details.
24
25       -d, --debug
26           Legacy option: this is equivalent to --log-level=TRACE.
27
28       -l LVL, --log-level=LVL
29           Set the log level of all known Babeltrace 2 loggers to LVL.
30
31       --omit-home-plugin-path
32           Do not search for plugins in $HOME/.local/lib/babeltrace2/plugins.
33
34       --omit-system-plugin-path
35           Do not search for plugins in /usr/local/lib/babeltrace2/plugins.
36
37       --plugin-path=PATH[:PATH]...
38           Add PATH to the list of paths in which plugins can be found.
39
40       -v, --verbose
41           Legacy option: this is equivalent to --log-level=INFO.
42
43   Command information
44       -h, --help
45           Show the command’s help and quit.
46

ENVIRONMENT VARIABLES

48   Babeltrace 2 library
49       BABELTRACE_EXEC_ON_ABORT=CMDLINE
50           Execute the command line CMDLINE, as parsed like a UNIX 98 shell,
51           when any part of the Babeltrace 2 project unexpectedly aborts.
52
53           The application only aborts when the executed command returns,
54           ignoring its exit status.
55
56           This environment variable is ignored when the application has the
57           setuid or the setgid access right flag set.
58
59       BABELTRACE_TERM_COLOR=(AUTO | NEVER | ALWAYS)
60           Force the terminal color support for the babeltrace2(1) program and
61           the project’s plugins.
62
63           The available values are:
64
65           AUTO
66               Only emit terminal color codes when the standard output and
67               error streams are connected to a color-capable terminal.
68
69           NEVER
70               Never emit terminal color codes.
71
72           ALWAYS
73               Always emit terminal color codes.
74
75       BABELTRACE_TERM_COLOR_BRIGHT_MEANS_BOLD=0
76           Set to 0 to emit SGR (see
77           <https://en.wikipedia.org/wiki/ANSI_escape_code>) codes 90 to 97
78           for bright colors instead of bold (SGR code 1) and standard color
79           codes (SGR codes 30 to 37).
80
81       BABELTRACE_PLUGIN_PATH=PATHS
82           Set the list of directories, in order, in which dynamic plugins can
83           be found before other directories are considered to PATHS
84           (colon-separated, or semicolon on Windows).
85
86       LIBBABELTRACE2_DISABLE_PYTHON_PLUGINS=1
87           Disable the loading of any Babeltrace 2 Python plugin.
88
89       LIBBABELTRACE2_INIT_LOG_LEVEL=LVL
90           Force the Babeltrace 2 library’s initial log level to be LVL.
91
92           If this environment variable is set, it overrides the log level set
93           by the --log-level option for the Babeltrace 2 library logger.
94
95           The available values for LVL are:
96
97           NONE, N
98               Logging is disabled.
99
100           FATAL, F
101               Severe errors that lead the execution to abort immediately.
102
103               This level should be enabled in production.
104
105           ERROR, E
106               Errors that might still allow the execution to continue.
107
108               Usually, once one or more errors are reported at this level,
109               the application, plugin, or library won’t perform any more
110               useful task, but it should still exit cleanly.
111
112               This level should be enabled in production.
113
114           WARN, WARNING, W
115               Unexpected situations which still allow the execution to
116               continue.
117
118               This level should be enabled in production.
119
120           INFO, I
121               Informational messages that highlight progress or important
122               states of the application, plugins, or library.
123
124               This level can be enabled in production.
125
126           DEBUG, D
127               Debugging information, with a higher level of details than the
128               TRACE level.
129
130               This level should NOT be enabled in production.
131
132           TRACE, T
133               Low-level debugging context information.
134
135               This level should NOT be enabled in production.
136
137       LIBBABELTRACE2_NO_DLCLOSE=1
138           Make the Babeltrace 2 library leave any dynamically loaded modules
139           (plugins and plugin providers) open at exit. This can be useful for
140           debugging purposes.
141
142       LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=DIR
143           Set the directory from which the Babeltrace 2 library dynamically
144           loads plugin provider shared objects to DIR.
145
146           If this environment variable is set, it overrides the default
147           plugin provider directory.
148
149   Babeltrace 2 Python bindings
150       BABELTRACE_PYTHON_BT2_LOG_LEVEL=LVL
151           Force the Babeltrace 2 Python bindings log level to be LVL.
152
153           If this environment variable is set, it overrides the log level set
154           by the --log-level option for the Python bindings logger.
155
156           The available values for LVL are:
157
158           NONE, N
159               Logging is disabled.
160
161           FATAL, F
162               Severe errors that lead the execution to abort immediately.
163
164               This level should be enabled in production.
165
166           ERROR, E
167               Errors that might still allow the execution to continue.
168
169               Usually, once one or more errors are reported at this level,
170               the application, plugin, or library won’t perform any more
171               useful task, but it should still exit cleanly.
172
173               This level should be enabled in production.
174
175           WARN, WARNING, W
176               Unexpected situations which still allow the execution to
177               continue.
178
179               This level should be enabled in production.
180
181           INFO, I
182               Informational messages that highlight progress or important
183               states of the application, plugins, or library.
184
185               This level can be enabled in production.
186
187           DEBUG, D
188               Debugging information, with a higher level of details than the
189               TRACE level.
190
191               This level should NOT be enabled in production.
192
193           TRACE, T
194               Low-level debugging context information.
195
196               This level should NOT be enabled in production.
197
198   CLI
199       BABELTRACE_CLI_LOG_LEVEL=LVL
200           Force babeltrace2 CLI’s log level to be LVL.
201
202           If this environment variable is set, it overrides the log level set
203           by the --log-level option for the CLI logger.
204
205           The available values for LVL are:
206
207           NONE, N
208               Logging is disabled.
209
210           FATAL, F
211               Severe errors that lead the execution to abort immediately.
212
213               This level should be enabled in production.
214
215           ERROR, E
216               Errors that might still allow the execution to continue.
217
218               Usually, once one or more errors are reported at this level,
219               the application, plugin, or library won’t perform any more
220               useful task, but it should still exit cleanly.
221
222               This level should be enabled in production.
223
224           WARN, WARNING, W
225               Unexpected situations which still allow the execution to
226               continue.
227
228               This level should be enabled in production.
229
230           INFO, I
231               Informational messages that highlight progress or important
232               states of the application, plugins, or library.
233
234               This level can be enabled in production.
235
236           DEBUG, D
237               Debugging information, with a higher level of details than the
238               TRACE level.
239
240               This level should NOT be enabled in production.
241
242           TRACE, T
243               Low-level debugging context information.
244
245               This level should NOT be enabled in production.
246
247       BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH=0
248           Disable the warning message which babeltrace2-convert(1) prints
249           when you convert a trace with a relative path that’s also the name
250           of a babeltrace2 command.
251
252       BABELTRACE_DEBUG=1
253           Legacy variable: equivalent to setting the --log-level option to
254           TRACE.
255
256       BABELTRACE_VERBOSE=1
257           Legacy variable: equivalent to setting the --log-level option to
258           INFO.
259

FILES

261       $HOME/.local/lib/babeltrace2/plugins
262           User plugin directory.
263
264       /usr/local/lib/babeltrace2/plugins
265           System plugin directory.
266
267       /usr/local/lib/babeltrace2/plugin-providers
268           System plugin provider directory.
269

EXIT STATUS

271       0 on success, 1 otherwise.
272

BUGS

274       If you encounter any issue or usability problem, please report it on
275       the Babeltrace bug tracker (see
276       <https://bugs.lttng.org/projects/babeltrace>).
277

RESOURCES

279       The Babeltrace project shares some communication channels with the
280       LTTng project (see <https://lttng.org/>).
281
282       ·   Babeltrace website (see <https://babeltrace.org/>)
283
284       ·   Mailing list (see <https://lists.lttng.org>) for support and
285           development: lttng-dev@lists.lttng.org
286
287       ·   IRC channel (see <irc://irc.oftc.net/lttng>): #lttng on
288           irc.oftc.net
289
290       ·   Bug tracker (see <https://bugs.lttng.org/projects/babeltrace>)
291
292       ·   Git repository (see <https://git.efficios.com/?p=babeltrace.git>)
293
294       ·   GitHub project (see <https://github.com/efficios/babeltrace>)
295
296       ·   Continuous integration (see
297           <https://ci.lttng.org/view/Babeltrace/>)
298
299       ·   Code review (see <https://review.lttng.org/q/project:babeltrace>)
300

AUTHORS

302       The Babeltrace 2 project is the result of hard work by many regular
303       developers and occasional contributors.
304
305       The current project maintainer is Jérémie Galarneau
306       <mailto:jeremie.galarneau@efficios.com>.
307

COPYRIGHT

309       This command is part of the Babeltrace 2 project.
310
311       Babeltrace is distributed under the MIT license (see
312       <https://opensource.org/licenses/MIT>).
313