1 = babeltrace2-sink.text.pretty(7)
2 :manpagetype: component class
3 :revdate: 1 September 2023
8 babeltrace2-sink.text.pretty - Babeltrace 2's pretty-printing sink
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.
21 | +--> Pretty-printed messages to
22 Messages -->@ in | the standard output or a file and
23 +------------------+ to the standard error
26 include::common-see-babeltrace2-intro.txt[]
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.
32 The component prints warnings on the standard error stream when it
33 consumes a discarded events or discarded packets message.
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.
40 This component class is equivalent to the `text` output format of
41 man:babeltrace(1) (Babeltrace~1 command-line tool).
44 == INITIALIZATION PARAMETERS
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.
52 param:clock-date='VAL' vtype:[optional boolean]::
53 If 'VAL' is true, then print event times _and_ dates.
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.
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.
69 param:color=(`never` | `auto` | `always`) vtype:[optional string]::
70 Force the terminal color support, one of:
74 Only emit terminal color codes when the standard output and error
75 streams are connected to a color-capable terminal.
78 Never emit terminal color codes.
81 Always emit terminal color codes.
84 The `BABELTRACE_TERM_COLOR` environment variable overrides this
87 param:field-default=(`show` | `hide`) vtype:[optional string]::
88 By default, show or hide all the fields. This sets the default value
89 of all the parameters which start with `field-`.
91 param:field-emf='VAL' vtype:[optional boolean]::
92 Show or hide the event's Eclipse Modeling Framework URI field.
94 Default, depending on the param:field-default parameter:
107 param:field-loglevel='VAL' vtype:[optional boolean]::
108 Show or hide the event's logging level field.
110 Default, depending on the param:field-default parameter:
123 param:field-trace='VAL' vtype:[optional boolean]::
124 Show or hide the trace name field.
126 Default, depending on the param:field-default parameter:
139 param:field-trace:domain='VAL' vtype:[optional boolean]::
140 Show or hide the tracing domain field.
142 Default, depending on the param:field-default parameter:
155 param:field-trace:hostname='VAL' vtype:[optional boolean]::
156 Show or hide the hostname field.
158 Default, depending on the param:field-default parameter:
171 param:field-trace:procname='VAL' vtype:[optional boolean]::
172 Show or hide the process name field.
174 Default, depending on the param:field-default parameter:
187 param:field-trace:vpid='VAL' vtype:[optional boolean]::
188 Show or hide the virtual process ID field.
190 Default, depending on the param:field-default parameter:
203 param:name-default=(`show` | `hide`) vtype:[optional string]::
204 By default, show or hide all the names. This sets the
205 default value of all the parameters which start with `name-`.
207 param:name-header='VAL' vtype:[optional boolean]::
208 Show or hide the field names in the header scopes.
210 Default, depending on the param:name-default parameter:
223 param:name-context='VAL' vtype:[optional boolean]::
224 Show or hide the field names in the context scopes.
226 Default, depending on the param:name-default parameter:
239 param:name-payload='VAL' vtype:[optional boolean]::
240 Show or hide the field names in the event payload scopes.
242 Default, depending on the param:name-default parameter:
255 param:name-scope='VAL' vtype:[optional boolean]::
256 Show or hide the scope names.
258 Default, depending on the param:name-default parameter:
271 param:no-delta='VAL' vtype:[optional boolean]::
272 If 'VAL' is true, then do not print the time delta between
277 param:path='PATH' vtype:[optional string]::
278 Print the text output to the file 'PATH' instead of the standard
281 param:verbose='VAL' vtype:[optional boolean]::
282 If 'VAL' if true, then turn the verbose mode on.
304 == ENVIRONMENT VARIABLES
306 include::common-common-env.txt[]
309 include::common-footer.txt[]
314 man:babeltrace2-intro(7),
315 man:babeltrace2-plugin-text(7)