1 babeltrace2-sink.text.pretty(7)
2 ==============================
3 :manpagetype: component class
4 :revdate: 5 October 2017
9 babeltrace2-sink.text.pretty - Babeltrace's pretty-printing sink
15 The Babeltrace compcls:sink.text.pretty component class, provided by the
16 man:babeltrace2-plugin-text(7) plugin, once instantiated, pretty-prints
17 the events it receives from its input port to the console or to a file.
19 By default, a compcls:sink.text.pretty component pretty-prints to
20 the standard output. You can use the param:path parameter for the
21 component to write to a file instead.
23 The component also prints warnings on the standard error stream when it
24 receives a discarded packets or discarded events notification.
26 If you don't use the param:path parameter and the application's
27 standard output is connected to a color-capable terminal, the component
28 emits terminal color codes to enhance the text output for human
29 consumption. You can use the param:color parameter to force the color
30 support or to disable it.
33 INITIALIZATION PARAMETERS
34 -------------------------
35 The following parameters are optional.
37 param:clock-cycles=`yes` (boolean)::
38 Print event times in clock cycles instead of hours, minutes,
39 seconds, and nanoseconds.
41 param:clock-date=`yes` (boolean)::
42 Print event times _and_ dates.
44 param:clock-gmt=`yes` (boolean)::
45 Print event times in the GMT time zone instead of the local time
48 param:clock-seconds=`yes` (boolean)::
49 Print event times in seconds instead of hours, minutes,
50 seconds, and nanoseconds.
52 param:color=(`never` | `auto` | `always`) (string)::
53 Force the terminal color support, one of:
57 Only emit terminal color codes when the standard output and error
58 streams are connected to a color-capable terminal.
61 Never emit terminal color codes.
64 Always emit terminal color codes.
67 The `BABELTRACE_TERM_COLOR` environment variable overrides this
70 param:field-default=(`show` | `hide`) (string)::
71 By default, show or hide all the fields. This sets the default value
72 of all the parameters which start with `field-`.
74 param:field-emf=(`yes` | `no`) (boolean)::
75 Show or hide the event's Eclipse Modeling Framework URI field.
77 param:field-loglevel=(`yes` | `no`) (boolean)::
78 Show or hide the event's logging level field.
80 param:field-trace=(`yes` | `no`) (boolean)::
81 Show or hide the trace name field.
83 param:field-trace:domain=(`yes` | `no`) (boolean)::
84 Show or hide the tracing domain field.
86 param:field-trace:hostname=(`yes` | `no`) (boolean)::
87 Show or hide the hostname field.
89 param:field-trace:procname=(`yes` | `no`) (boolean)::
90 Show or hide the process name field.
92 param:field-trace:vpid=(`yes` | `no`) (boolean)::
93 Show or hide the virtual process ID field.
95 param:name-context=(`yes` | `no`) (boolean)::
96 Show or hide the field names in the context scopes.
98 param:name-default=(`show` | `hide`) (string)::
99 By default, show or hide all the names. This sets the
100 default value of all the parameters which start with `name-`.
102 param:name-header=(`yes` | `no`) (boolean)::
103 Show or hide the field names in the header scopes.
105 param:name-payload=(`yes` | `no`) (boolean)::
106 Show or hide the field names in the event payload scopes.
108 param:name-scope=(`yes` | `no`) (boolean)::
109 Show or hide the scope names.
111 param:no-delta=`yes` (boolean)::
112 Do not print the time delta between consecutive lines.
114 param:path='PATH' (string)::
115 Print the text output to the file 'PATH' instead of the standard
118 param:verbose=`yes` (boolean)::
119 Turn the verbose mode on.
127 Single input port from which the component receives the
128 event notifications to pretty-print.
133 This component class has no objects to query.
136 ENVIRONMENT VARIABLES
137 ---------------------
138 include::common-common-compat-env.txt[]
141 include::common-footer.txt[]
146 man:babeltrace2-plugin-text(7),
147 man:babeltrace2-intro(7)