Commit | Line | Data |
---|---|---|
e70712b3 | 1 | = babeltrace2(1) |
0659f3af | 2 | :manpagetype: program |
e70712b3 | 3 | :revdate: 14 September 2019 |
0659f3af PP |
4 | |
5 | ||
e70712b3 PP |
6 | == NAME |
7 | ||
a8be4294 | 8 | babeltrace2 - Convert or process one or more traces, and more |
0659f3af PP |
9 | |
10 | ||
e70712b3 PP |
11 | == SYNOPSIS |
12 | ||
0659f3af | 13 | [verse] |
e70712b3 PP |
14 | *babeltrace2* [opt:--debug | opt:--verbose | opt:--log-level='LVL'] |
15 | [opt:--omit-home-plugin-path] [opt:--omit-system-plugin-path] | |
16 | [opt:--plugin-path='PATH'[:__PATH__]...] ['<<commands,CMD>>'] ['CMD ARGS'] | |
17 | ||
18 | ||
19 | == DESCRIPTION | |
20 | ||
21 | `babeltrace2` is an open-source trace converter and processor | |
22 | command-line program. The tool can open one or more traces and convert | |
23 | between multiple formats, possibly with one or more filters in the | |
24 | conversion path, and perform other operations depending on the | |
25 | command 'CMD' (see <<commands,``COMMANDS''>>). | |
0659f3af | 26 | |
e70712b3 PP |
27 | [NOTE] |
28 | -- | |
29 | You might be looking for the man:babeltrace2-convert(1) command's | |
30 | manual page; the `convert` command is the default command of | |
31 | `babeltrace2` and is backward compatible with man:babeltrace(1). | |
0659f3af | 32 | |
e70712b3 PP |
33 | See <<examples,``EXAMPLES''>> for `convert` command examples. |
34 | -- | |
0659f3af | 35 | |
e70712b3 | 36 | include::common-see-babeltrace2-intro.txt[] |
0659f3af | 37 | |
e70712b3 PP |
38 | Most of the `babeltrace2` commands load Babeltrace~2 plugins to |
39 | perform their operation. The search path for Babeltrace~2 plugins | |
40 | is, in this order: | |
0659f3af | 41 | |
e70712b3 PP |
42 | . The colon-separated (or semicolon, on Windows) list of directories in |
43 | the `BABELTRACE_PLUGIN_PATH` environment variable. | |
0659f3af | 44 | |
e70712b3 PP |
45 | . The colon-separated (or semicolon, on Windows) list of directories in |
46 | the opt:--plugin-path option. | |
0659f3af | 47 | |
a8be4294 | 48 | . `$HOME/.local/lib/babeltrace2/plugins` |
0659f3af PP |
49 | |
50 | . +{system_plugin_path}+ | |
51 | ||
a8be4294 | 52 | You can use the man:babeltrace2-list-plugins(1) command to dynamically |
e70712b3 PP |
53 | list the available plugins and what they offer. See |
54 | <<plugins,``PROJECT'S PLUGINS''>> for a list of plugins shipped with | |
55 | Babeltrace~2. | |
0659f3af PP |
56 | |
57 | ||
e70712b3 | 58 | == OPTIONS |
0659f3af | 59 | |
e70712b3 PP |
60 | opt:-d:: |
61 | opt:--debug:: | |
62 | Legacy option: this is equivalent to opt:--log-level=`TRACE`. | |
63 | ||
64 | opt:-l 'LVL':: | |
65 | opt:--log-level='LVL':: | |
66 | Set the log level of all known Babeltrace~2 loggers to 'LVL', | |
67 | including individual components for the man:babeltrace2-convert(1) | |
68 | and man:babeltrace2-run(1) commands. | |
69 | + | |
70 | You can override the log level of a specific component with the | |
71 | nlopt:--log-level option of the man:babeltrace2-convert(1) or | |
72 | man:babeltrace2-run(1) commands. | |
73 | + | |
74 | You can override the log level of the library with the | |
75 | `LIBBABELTRACE2_INIT_LOG_LEVEL` environment variable. | |
76 | + | |
77 | You can override the log level of the CLI with the | |
78 | `BABELTRACE_CLI_LOG_LEVEL` environment variable. | |
79 | + | |
80 | You can override the log level of the Babeltrace~2 Python bindings | |
81 | with the `BABELTRACE_PYTHON_BT2_LOG_LEVEL` environment variable. | |
0659f3af PP |
82 | + |
83 | The available values for 'LVL' are: | |
84 | + | |
85 | -- | |
e70712b3 | 86 | include::common-log-levels.txt[] |
0659f3af PP |
87 | -- |
88 | ||
e70712b3 PP |
89 | opt:--omit-home-plugin-path:: |
90 | Do not search for plugins in `$HOME/.local/lib/babeltrace2/plugins`. | |
91 | ||
92 | opt:--omit-system-plugin-path:: | |
93 | Do not search for plugins in +{system_plugin_path}+. | |
94 | ||
95 | opt:--plugin-path='PATH'[:__PATH__]...:: | |
96 | Add 'PATH' to the list of paths in which plugins can be found. | |
97 | ||
98 | opt:-v:: | |
99 | opt:--verbose:: | |
100 | Legacy option: this is equivalent to opt:--log-level=`INFO`. | |
0659f3af | 101 | + |
e70712b3 PP |
102 | If 'CMD' is `convert` or is missing, then this also sets the |
103 | manparam:sink.text.pretty:verbose parameter of the implicit | |
104 | compcls:sink.text.pretty component (see | |
105 | man:babeltrace2-sink.text.pretty(7)) to true. | |
106 | ||
0659f3af | 107 | |
e70712b3 PP |
108 | opt:-h:: |
109 | opt:--help:: | |
0659f3af PP |
110 | Show help and quit. |
111 | ||
e70712b3 PP |
112 | opt:-V:: |
113 | opt:--version:: | |
0659f3af PP |
114 | Show version and quit. |
115 | ||
116 | ||
117 | [[commands]] | |
e70712b3 PP |
118 | == COMMANDS |
119 | ||
0659f3af PP |
120 | The following commands also have their own nlopt:--help option. |
121 | ||
e70712b3 PP |
122 | `convert`:: |
123 | Convert one or more traces to a given format, possibly with filters | |
124 | in the conversion path. | |
125 | + | |
126 | This is the default command: you don't need to explicitly specify this | |
127 | command's name to use it. | |
128 | + | |
129 | This command is backward compatible with the man:babeltrace(1) program. | |
0659f3af | 130 | + |
e70712b3 | 131 | See man:babeltrace2-convert(1). |
0659f3af | 132 | |
e70712b3 | 133 | `help`:: |
0659f3af | 134 | Get help for a specific plugin or plugin's component class. |
e70712b3 PP |
135 | + |
136 | See man:babeltrace2-help(1). | |
0659f3af | 137 | |
e70712b3 PP |
138 | `list-plugins`:: |
139 | List the available Babeltrace~2 plugins and their component | |
140 | classes. | |
141 | + | |
142 | See man:babeltrace2-list-plugins(1). | |
0659f3af | 143 | |
e70712b3 | 144 | `query`:: |
0659f3af | 145 | Query an object from a component class. |
e70712b3 PP |
146 | + |
147 | See man:babeltrace2-query(1). | |
0659f3af | 148 | |
e70712b3 | 149 | `run`:: |
0659f3af | 150 | Build a trace processing graph and run it. |
e70712b3 PP |
151 | + |
152 | See man:babeltrace2-run(1). | |
0659f3af PP |
153 | |
154 | ||
155 | [[plugins]] | |
e70712b3 PP |
156 | == PROJECT'S PLUGINS |
157 | ||
158 | The following plugins are provided by the Babeltrace~2 project | |
159 | itself. | |
0659f3af | 160 | |
a8be4294 | 161 | man:babeltrace2-plugin-ctf(7):: |
0659f3af PP |
162 | CTF trace input (from the file system and from the LTTng-live |
163 | protocol) and output to the file system. | |
164 | + | |
e70712b3 PP |
165 | Component classes: |
166 | + | |
a8be4294 MJ |
167 | * man:babeltrace2-source.ctf.fs(7) |
168 | * man:babeltrace2-source.ctf.lttng-live(7) | |
e70712b3 | 169 | * man:babeltrace2-sink.ctf.fs(7) |
0659f3af PP |
170 | |
171 | ifeval::[{enable_debug_info} == 1] | |
a8be4294 | 172 | man:babeltrace2-plugin-lttng-utils(7):: |
0659f3af PP |
173 | Processing graph utilities for LTTng traces. |
174 | + | |
e70712b3 PP |
175 | Component class: |
176 | + | |
a8be4294 | 177 | * man:babeltrace2-filter.lttng-utils.debug-info(7) |
0659f3af PP |
178 | endif::[] |
179 | ||
a8be4294 | 180 | man:babeltrace2-plugin-text(7):: |
e70712b3 PP |
181 | Plain text input and output. |
182 | + | |
183 | Component classes: | |
0659f3af | 184 | + |
a8be4294 | 185 | * man:babeltrace2-source.text.dmesg(7) |
e70712b3 PP |
186 | * man:babeltrace2-sink.text.details(7) |
187 | * man:babeltrace2-sink.text.pretty(7) | |
0659f3af | 188 | |
a8be4294 | 189 | man:babeltrace2-plugin-utils(7):: |
0659f3af PP |
190 | Processing graph utilities. |
191 | + | |
e70712b3 PP |
192 | Component classes: |
193 | + | |
a8be4294 MJ |
194 | * man:babeltrace2-filter.utils.muxer(7) |
195 | * man:babeltrace2-filter.utils.trimmer(7) | |
196 | * man:babeltrace2-sink.utils.counter(7) | |
197 | * man:babeltrace2-sink.utils.dummy(7) | |
0659f3af PP |
198 | |
199 | ||
e70712b3 PP |
200 | [[examples]] |
201 | == EXAMPLES | |
202 | ||
203 | The following examples are the same as the man:babeltrace2-convert(1) | |
204 | manual page's examples because `convert` is the default `babeltrace2` | |
205 | program's command. | |
206 | ||
207 | include::common-convert-examples.txt[] | |
208 | ||
209 | ||
0659f3af PP |
210 | include::common-cli-env.txt[] |
211 | ||
e70712b3 | 212 | |
0659f3af PP |
213 | include::common-cli-files.txt[] |
214 | ||
e70712b3 | 215 | |
0659f3af PP |
216 | include::common-cmd-footer.txt[] |
217 | ||
218 | ||
e70712b3 PP |
219 | == SEE ALSO |
220 | ||
221 | man:babeltrace2-intro(7), | |
a8be4294 MJ |
222 | man:babeltrace2-convert(1), |
223 | man:babeltrace2-help(1), | |
224 | man:babeltrace2-list-plugins(1), | |
225 | man:babeltrace2-query(1), | |
e70712b3 | 226 | man:babeltrace2-run(1) |