Commit | Line | Data |
---|---|---|
e70712b3 | 1 | = babeltrace2-sink.text.pretty(7) |
0659f3af | 2 | :manpagetype: component class |
6f6e5e61 | 3 | :revdate: 1 September 2023 |
0659f3af PP |
4 | |
5 | ||
e70712b3 PP |
6 | == NAME |
7 | ||
8 | babeltrace2-sink.text.pretty - Babeltrace 2's pretty-printing sink | |
0659f3af PP |
9 | component class |
10 | ||
11 | ||
e70712b3 PP |
12 | == DESCRIPTION |
13 | ||
14 | A Babeltrace~2 compcls:sink.text.pretty component pretty-prints the | |
15 | events, discarded events, and discarded packets messages it consumes to | |
16 | the standard output or to a file. | |
17 | ||
18 | ---- | |
19 | +------------------+ | |
20 | | sink.text.pretty | | |
21 | | +--> Pretty-printed messages to | |
22 | Messages -->@ in | the standard output or a file and | |
23 | +------------------+ to the standard error | |
24 | ---- | |
25 | ||
26 | include::common-see-babeltrace2-intro.txt[] | |
27 | ||
28 | By default, a compcls:sink.text.pretty component pretty-prints to the | |
29 | standard output. You can use the param:path parameter to make the | |
30 | component write to a file instead. | |
0659f3af | 31 | |
e70712b3 PP |
32 | The component prints warnings on the standard error stream when it |
33 | consumes a discarded events or discarded packets message. | |
0659f3af | 34 | |
e70712b3 PP |
35 | If you don't use the param:path parameter and the application's standard |
36 | output is connected to a color-capable terminal, the component emits | |
37 | terminal color codes to enhance the text output. You can use the | |
38 | param:color parameter to force the color support or to disable it. | |
0659f3af | 39 | |
e70712b3 PP |
40 | This component class is equivalent to the `text` output format of |
41 | man:babeltrace(1) (Babeltrace~1 command-line tool). | |
0659f3af PP |
42 | |
43 | ||
e70712b3 | 44 | == INITIALIZATION PARAMETERS |
0659f3af | 45 | |
6f6e5e61 PP |
46 | param:clock-cycles='VAL' vtype:[optional boolean]:: |
47 | If 'VAL' is true, then print event times in clock cycles instead of | |
48 | hours, minutes, seconds, and nanoseconds. | |
49 | + | |
50 | Default: false. | |
0659f3af | 51 | |
6f6e5e61 PP |
52 | param:clock-date='VAL' vtype:[optional boolean]:: |
53 | If 'VAL' is true, then print event times _and_ dates. | |
54 | + | |
55 | Default: false. | |
0659f3af | 56 | |
6f6e5e61 PP |
57 | param:clock-gmt='VAL' vtype:[optional boolean]:: |
58 | If 'VAL' is true, then print event times in the GMT time zone | |
59 | instead of the local time zone. | |
60 | + | |
61 | Default: false. | |
0659f3af | 62 | |
6f6e5e61 PP |
63 | param:clock-seconds='VAL' vtype:[optional boolean]:: |
64 | If 'VAL' is true, then print event times in seconds instead of | |
65 | hours, minutes, seconds, and nanoseconds. | |
66 | + | |
67 | Default: false. | |
0659f3af | 68 | |
e70712b3 | 69 | param:color=(`never` | `auto` | `always`) vtype:[optional string]:: |
0659f3af PP |
70 | Force the terminal color support, one of: |
71 | + | |
72 | -- | |
73 | `auto` (default):: | |
74 | Only emit terminal color codes when the standard output and error | |
75 | streams are connected to a color-capable terminal. | |
76 | ||
77 | `never`:: | |
78 | Never emit terminal color codes. | |
79 | ||
80 | `always`:: | |
81 | Always emit terminal color codes. | |
82 | -- | |
83 | + | |
84 | The `BABELTRACE_TERM_COLOR` environment variable overrides this | |
85 | parameter. | |
86 | ||
e70712b3 | 87 | param:field-default=(`show` | `hide`) vtype:[optional string]:: |
0659f3af PP |
88 | By default, show or hide all the fields. This sets the default value |
89 | of all the parameters which start with `field-`. | |
90 | ||
6f6e5e61 | 91 | param:field-emf='VAL' vtype:[optional boolean]:: |
0659f3af | 92 | Show or hide the event's Eclipse Modeling Framework URI field. |
6f6e5e61 PP |
93 | + |
94 | Default, depending on the param:field-default parameter: | |
95 | + | |
96 | -- | |
97 | `show`:: | |
98 | True | |
99 | ||
100 | `hide`:: | |
101 | False | |
102 | ||
103 | Not set:: | |
104 | False | |
105 | -- | |
0659f3af | 106 | |
6f6e5e61 | 107 | param:field-loglevel='VAL' vtype:[optional boolean]:: |
0659f3af | 108 | Show or hide the event's logging level field. |
6f6e5e61 PP |
109 | + |
110 | Default, depending on the param:field-default parameter: | |
111 | + | |
112 | -- | |
113 | `show`:: | |
114 | True | |
0659f3af | 115 | |
6f6e5e61 PP |
116 | `hide`:: |
117 | False | |
118 | ||
119 | Not set:: | |
120 | False | |
121 | -- | |
122 | ||
123 | param:field-trace='VAL' vtype:[optional boolean]:: | |
0659f3af | 124 | Show or hide the trace name field. |
6f6e5e61 PP |
125 | + |
126 | Default, depending on the param:field-default parameter: | |
127 | + | |
128 | -- | |
129 | `show`:: | |
130 | True | |
0659f3af | 131 | |
6f6e5e61 PP |
132 | `hide`:: |
133 | False | |
134 | ||
135 | Not set:: | |
136 | False | |
137 | -- | |
138 | ||
139 | param:field-trace:domain='VAL' vtype:[optional boolean]:: | |
0659f3af | 140 | Show or hide the tracing domain field. |
6f6e5e61 PP |
141 | + |
142 | Default, depending on the param:field-default parameter: | |
143 | + | |
144 | -- | |
145 | `show`:: | |
146 | True | |
147 | ||
148 | `hide`:: | |
149 | False | |
150 | ||
151 | Not set:: | |
152 | False | |
153 | -- | |
0659f3af | 154 | |
6f6e5e61 | 155 | param:field-trace:hostname='VAL' vtype:[optional boolean]:: |
0659f3af | 156 | Show or hide the hostname field. |
6f6e5e61 PP |
157 | + |
158 | Default, depending on the param:field-default parameter: | |
159 | + | |
160 | -- | |
161 | `show`:: | |
162 | True | |
0659f3af | 163 | |
6f6e5e61 PP |
164 | `hide`:: |
165 | False | |
166 | ||
167 | Not set:: | |
168 | True | |
169 | -- | |
170 | ||
171 | param:field-trace:procname='VAL' vtype:[optional boolean]:: | |
0659f3af | 172 | Show or hide the process name field. |
6f6e5e61 PP |
173 | + |
174 | Default, depending on the param:field-default parameter: | |
175 | + | |
176 | -- | |
177 | `show`:: | |
178 | True | |
0659f3af | 179 | |
6f6e5e61 PP |
180 | `hide`:: |
181 | False | |
182 | ||
183 | Not set:: | |
184 | True | |
185 | -- | |
186 | ||
187 | param:field-trace:vpid='VAL' vtype:[optional boolean]:: | |
0659f3af | 188 | Show or hide the virtual process ID field. |
6f6e5e61 PP |
189 | + |
190 | Default, depending on the param:field-default parameter: | |
191 | + | |
192 | -- | |
193 | `show`:: | |
194 | True | |
0659f3af | 195 | |
6f6e5e61 PP |
196 | `hide`:: |
197 | False | |
198 | ||
199 | Not set:: | |
200 | True | |
201 | -- | |
0659f3af | 202 | |
e70712b3 | 203 | param:name-default=(`show` | `hide`) vtype:[optional string]:: |
0659f3af PP |
204 | By default, show or hide all the names. This sets the |
205 | default value of all the parameters which start with `name-`. | |
206 | ||
6f6e5e61 | 207 | param:name-header='VAL' vtype:[optional boolean]:: |
0659f3af | 208 | Show or hide the field names in the header scopes. |
6f6e5e61 PP |
209 | + |
210 | Default, depending on the param:name-default parameter: | |
211 | + | |
212 | -- | |
213 | `show`:: | |
214 | True | |
215 | ||
216 | `hide`:: | |
217 | False | |
218 | ||
219 | Not set:: | |
220 | False | |
221 | -- | |
0659f3af | 222 | |
6f6e5e61 PP |
223 | param:name-context='VAL' vtype:[optional boolean]:: |
224 | Show or hide the field names in the context scopes. | |
225 | + | |
226 | Default, depending on the param:name-default parameter: | |
227 | + | |
228 | -- | |
229 | `show`:: | |
230 | True | |
231 | ||
232 | `hide`:: | |
233 | False | |
234 | ||
235 | Not set:: | |
236 | True | |
237 | -- | |
238 | ||
239 | param:name-payload='VAL' vtype:[optional boolean]:: | |
0659f3af | 240 | Show or hide the field names in the event payload scopes. |
6f6e5e61 PP |
241 | + |
242 | Default, depending on the param:name-default parameter: | |
243 | + | |
244 | -- | |
245 | `show`:: | |
246 | True | |
247 | ||
248 | `hide`:: | |
249 | False | |
250 | ||
251 | Not set:: | |
252 | True | |
253 | -- | |
0659f3af | 254 | |
6f6e5e61 | 255 | param:name-scope='VAL' vtype:[optional boolean]:: |
0659f3af | 256 | Show or hide the scope names. |
6f6e5e61 PP |
257 | + |
258 | Default, depending on the param:name-default parameter: | |
259 | + | |
260 | -- | |
261 | `show`:: | |
262 | True | |
0659f3af | 263 | |
6f6e5e61 PP |
264 | `hide`:: |
265 | False | |
266 | ||
267 | Not set:: | |
268 | False | |
269 | -- | |
270 | ||
271 | param:no-delta='VAL' vtype:[optional boolean]:: | |
272 | If 'VAL' is true, then do not print the time delta between | |
273 | consecutive lines. | |
274 | + | |
275 | Default: false. | |
0659f3af | 276 | |
e70712b3 | 277 | param:path='PATH' vtype:[optional string]:: |
0659f3af PP |
278 | Print the text output to the file 'PATH' instead of the standard |
279 | output. | |
280 | ||
6f6e5e61 PP |
281 | param:verbose='VAL' vtype:[optional boolean]:: |
282 | If 'VAL' if true, then turn the verbose mode on. | |
283 | + | |
284 | Default: false. | |
0659f3af PP |
285 | |
286 | ||
e70712b3 PP |
287 | == PORTS |
288 | ||
289 | ---- | |
290 | +------------------+ | |
291 | | sink.text.pretty | | |
292 | | | | |
293 | @ in | | |
294 | +------------------+ | |
295 | ---- | |
0659f3af PP |
296 | |
297 | ||
e70712b3 PP |
298 | === Input |
299 | ||
300 | `in`:: | |
301 | Single input port. | |
0659f3af PP |
302 | |
303 | ||
e70712b3 PP |
304 | == ENVIRONMENT VARIABLES |
305 | ||
306 | include::common-common-env.txt[] | |
0659f3af PP |
307 | |
308 | ||
309 | include::common-footer.txt[] | |
310 | ||
311 | ||
e70712b3 PP |
312 | == SEE ALSO |
313 | ||
314 | man:babeltrace2-intro(7), | |
315 | man:babeltrace2-plugin-text(7) |