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