projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 0659f3af PP |
1 | babeltrace-sink.text.pretty(7) |
| 2 | ============================== | |
| 3 | :manpagetype: component class | |
| 4 | :revdate: 5 October 2017 | |
| 5 | ||
| 6 | ||
| 7 | NAME | |
| 8 | ---- | |
| 9 | babeltrace-sink.text.pretty - Babeltrace's pretty-printing sink | |
| 10 | component class | |
| 11 | ||
| 12 | ||
| 13 | DESCRIPTION | |
| 14 | ----------- | |
| 15 | The Babeltrace compcls:sink.text.pretty component class, provided by the | |
| 16 | man:babeltrace-plugin-text(7) plugin, once instantiated, pretty-prints | |
| 17 | the events it receives from its input port to the console or to a file. | |
| 18 | ||
| 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. | |
| 22 | ||
| 23 | The component also prints warnings on the standard error stream when it | |
| 24 | receives a discarded packets or discarded events notification. | |
| 25 | ||
| 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. | |
| 31 | ||
| 32 | ||
| 33 | INITIALIZATION PARAMETERS | |
| 34 | ------------------------- | |
| 35 | The following parameters are optional. | |
| 36 | ||
| 37 | param:clock-cycles=`yes` (boolean):: | |
| 38 | Print event times in clock cycles instead of hours, minutes, | |
| 39 | seconds, and nanoseconds. | |
| 40 | ||
| 41 | param:clock-date=`yes` (boolean):: | |
| 42 | Print event times _and_ dates. | |
| 43 | ||
| 44 | param:clock-gmt=`yes` (boolean):: | |
| 45 | Print event times in the GMT time zone instead of the local time | |
| 46 | zone. | |
| 47 | ||
| 48 | param:clock-seconds=`yes` (boolean):: | |
| 49 | Print event times in seconds instead of hours, minutes, | |
| 50 | seconds, and nanoseconds. | |
| 51 | ||
| 52 | param:color=(`never` | `auto` | `always`) (string):: | |
| 53 | Force the terminal color support, one of: | |
| 54 | + | |
| 55 | -- | |
| 56 | `auto` (default):: | |
| 57 | Only emit terminal color codes when the standard output and error | |
| 58 | streams are connected to a color-capable terminal. | |
| 59 | ||
| 60 | `never`:: | |
| 61 | Never emit terminal color codes. | |
| 62 | ||
| 63 | `always`:: | |
| 64 | Always emit terminal color codes. | |
| 65 | -- | |
| 66 | + | |
| 67 | The `BABELTRACE_TERM_COLOR` environment variable overrides this | |
| 68 | parameter. | |
| 69 | ||
| 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-`. | |
| 73 | ||
| 74 | param:field-emf=(`yes` | `no`) (boolean):: | |
| 75 | Show or hide the event's Eclipse Modeling Framework URI field. | |
| 76 | ||
| 77 | param:field-loglevel=(`yes` | `no`) (boolean):: | |
| 78 | Show or hide the event's logging level field. | |
| 79 | ||
| 80 | param:field-trace=(`yes` | `no`) (boolean):: | |
| 81 | Show or hide the trace name field. | |
| 82 | ||
| 83 | param:field-trace:domain=(`yes` | `no`) (boolean):: | |
| 84 | Show or hide the tracing domain field. | |
| 85 | ||
| 86 | param:field-trace:hostname=(`yes` | `no`) (boolean):: | |
| 87 | Show or hide the hostname field. | |
| 88 | ||
| 89 | param:field-trace:procname=(`yes` | `no`) (boolean):: | |
| 90 | Show or hide the process name field. | |
| 91 | ||
| 92 | param:field-trace:vpid=(`yes` | `no`) (boolean):: | |
| 93 | Show or hide the virtual process ID field. | |
| 94 | ||
| 95 | param:name-context=(`yes` | `no`) (boolean):: | |
| 96 | Show or hide the field names in the context scopes. | |
| 97 | ||
| 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-`. | |
| 101 | ||
| 102 | param:name-header=(`yes` | `no`) (boolean):: | |
| 103 | Show or hide the field names in the header scopes. | |
| 104 | ||
| 105 | param:name-payload=(`yes` | `no`) (boolean):: | |
| 106 | Show or hide the field names in the event payload scopes. | |
| 107 | ||
| 108 | param:name-scope=(`yes` | `no`) (boolean):: | |
| 109 | Show or hide the scope names. | |
| 110 | ||
| 111 | param:no-delta=`yes` (boolean):: | |
| 112 | Do not print the time delta between consecutive lines. | |
| 113 | ||
| 114 | param:path='PATH' (string):: | |
| 115 | Print the text output to the file 'PATH' instead of the standard | |
| 116 | output. | |
| 117 | ||
| 118 | param:verbose=`yes` (boolean):: | |
| 119 | Turn the verbose mode on. | |
| 120 | ||
| 121 | ||
| 122 | PORTS | |
| 123 | ----- | |
| 124 | Input | |
| 125 | ~~~~~ | |
| 126 | `in`:: | |
| 127 | Single input port from which the component receives the | |
| 128 | event notifications to pretty-print. | |
| 129 | ||
| 130 | ||
| 131 | QUERY OBJECTS | |
| 132 | ------------- | |
| 133 | This component class has no objects to query. | |
| 134 | ||
| 135 | ||
| 136 | ENVIRONMENT VARIABLES | |
| 137 | --------------------- | |
| 138 | include::common-common-compat-env.txt[] | |
| 139 | ||
| 140 | ||
| 141 | include::common-footer.txt[] | |
| 142 | ||
| 143 | ||
| 144 | SEE ALSO | |
| 145 | -------- | |
| 146 | man:babeltrace-plugin-text(7), | |
| 147 | man:babeltrace-intro(7) |