Commit | Line | Data |
---|---|---|
2facbdc3 | 1 | = babeltrace2-sink.text.pretty(7) |
838dd456 | 2 | :manpagetype: component class |
2facbdc3 | 3 | :revdate: 14 September 2019 |
838dd456 PP |
4 | |
5 | ||
2facbdc3 PP |
6 | == NAME |
7 | ||
8 | babeltrace2-sink.text.pretty - Babeltrace 2's pretty-printing sink | |
838dd456 PP |
9 | component class |
10 | ||
11 | ||
2facbdc3 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. | |
838dd456 | 31 | |
2facbdc3 PP |
32 | The component prints warnings on the standard error stream when it |
33 | consumes a discarded events or discarded packets message. | |
838dd456 | 34 | |
2facbdc3 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. | |
838dd456 | 39 | |
2facbdc3 PP |
40 | This component class is equivalent to the `text` output format of |
41 | man:babeltrace(1) (Babeltrace~1 command-line tool). | |
838dd456 PP |
42 | |
43 | ||
2facbdc3 | 44 | == INITIALIZATION PARAMETERS |
838dd456 | 45 | |
2facbdc3 | 46 | param:clock-cycles=`yes` vtype:[optional boolean]:: |
838dd456 PP |
47 | Print event times in clock cycles instead of hours, minutes, |
48 | seconds, and nanoseconds. | |
49 | ||
2facbdc3 | 50 | param:clock-date=`yes` vtype:[optional boolean]:: |
838dd456 PP |
51 | Print event times _and_ dates. |
52 | ||
2facbdc3 | 53 | param:clock-gmt=`yes` vtype:[optional boolean]:: |
838dd456 PP |
54 | Print event times in the GMT time zone instead of the local time |
55 | zone. | |
56 | ||
2facbdc3 | 57 | param:clock-seconds=`yes` vtype:[optional boolean]:: |
838dd456 PP |
58 | Print event times in seconds instead of hours, minutes, |
59 | seconds, and nanoseconds. | |
60 | ||
2facbdc3 | 61 | param:color=(`never` | `auto` | `always`) vtype:[optional string]:: |
838dd456 PP |
62 | Force the terminal color support, one of: |
63 | + | |
64 | -- | |
65 | `auto` (default):: | |
66 | Only emit terminal color codes when the standard output and error | |
67 | 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 | + | |
76 | The `BABELTRACE_TERM_COLOR` environment variable overrides this | |
77 | parameter. | |
78 | ||
2facbdc3 | 79 | param:field-default=(`show` | `hide`) vtype:[optional string]:: |
838dd456 PP |
80 | By default, show or hide all the fields. This sets the default value |
81 | of all the parameters which start with `field-`. | |
82 | ||
2facbdc3 | 83 | param:field-emf=(`yes` | `no`) vtype:[optional boolean]:: |
838dd456 PP |
84 | Show or hide the event's Eclipse Modeling Framework URI field. |
85 | ||
2facbdc3 | 86 | param:field-loglevel=(`yes` | `no`) vtype:[optional boolean]:: |
838dd456 PP |
87 | Show or hide the event's logging level field. |
88 | ||
2facbdc3 | 89 | param:field-trace=(`yes` | `no`) vtype:[optional boolean]:: |
838dd456 PP |
90 | Show or hide the trace name field. |
91 | ||
2facbdc3 | 92 | param:field-trace:domain=(`yes` | `no`) vtype:[optional boolean]:: |
838dd456 PP |
93 | Show or hide the tracing domain field. |
94 | ||
2facbdc3 | 95 | param:field-trace:hostname=(`yes` | `no`) vtype:[optional boolean]:: |
838dd456 PP |
96 | Show or hide the hostname field. |
97 | ||
2facbdc3 | 98 | param:field-trace:procname=(`yes` | `no`) vtype:[optional boolean]:: |
838dd456 PP |
99 | Show or hide the process name field. |
100 | ||
2facbdc3 | 101 | param:field-trace:vpid=(`yes` | `no`) vtype:[optional boolean]:: |
838dd456 PP |
102 | Show or hide the virtual process ID field. |
103 | ||
2facbdc3 | 104 | param:name-context=(`yes` | `no`) vtype:[optional boolean]:: |
838dd456 PP |
105 | Show or hide the field names in the context scopes. |
106 | ||
2facbdc3 | 107 | param:name-default=(`show` | `hide`) vtype:[optional string]:: |
838dd456 PP |
108 | By default, show or hide all the names. This sets the |
109 | default value of all the parameters which start with `name-`. | |
110 | ||
2facbdc3 | 111 | param:name-header=(`yes` | `no`) vtype:[optional boolean]:: |
838dd456 PP |
112 | Show or hide the field names in the header scopes. |
113 | ||
2facbdc3 | 114 | param:name-payload=(`yes` | `no`) vtype:[optional boolean]:: |
838dd456 PP |
115 | Show or hide the field names in the event payload scopes. |
116 | ||
2facbdc3 | 117 | param:name-scope=(`yes` | `no`) vtype:[optional boolean]:: |
838dd456 PP |
118 | Show or hide the scope names. |
119 | ||
2facbdc3 | 120 | param:no-delta=`yes` vtype:[optional boolean]:: |
838dd456 PP |
121 | Do not print the time delta between consecutive lines. |
122 | ||
2facbdc3 | 123 | param:path='PATH' vtype:[optional string]:: |
838dd456 PP |
124 | Print the text output to the file 'PATH' instead of the standard |
125 | output. | |
126 | ||
2facbdc3 | 127 | param:verbose=`yes` vtype:[optional boolean]:: |
838dd456 PP |
128 | Turn the verbose mode on. |
129 | ||
130 | ||
2facbdc3 PP |
131 | == PORTS |
132 | ||
133 | ---- | |
134 | +------------------+ | |
135 | | sink.text.pretty | | |
136 | | | | |
137 | @ in | | |
138 | +------------------+ | |
139 | ---- | |
838dd456 PP |
140 | |
141 | ||
2facbdc3 PP |
142 | === Input |
143 | ||
144 | `in`:: | |
145 | Single input port. | |
838dd456 PP |
146 | |
147 | ||
2facbdc3 PP |
148 | == ENVIRONMENT VARIABLES |
149 | ||
150 | include::common-common-env.txt[] | |
838dd456 PP |
151 | |
152 | ||
153 | include::common-footer.txt[] | |
154 | ||
155 | ||
2facbdc3 PP |
156 | == SEE ALSO |
157 | ||
158 | man:babeltrace2-intro(7), | |
159 | man:babeltrace2-plugin-text(7) |