doc/man/babeltrace2.1.txt

   1 babeltrace2(1)
   2 =============
   3 :manpagetype: program
   4 :revdate: 5 October 2017
   5
   6
   7 NAME
   8 ----
   9 babeltrace2 - Convert or process one or more traces, and more
  10
  11
  12 SYNOPSIS
  13 --------
  14 [verse]
  15 *babeltrace2* [opt:--debug | opt:--verbose | opt:--log-level='LVL'] ['<<commands,CMD>>'] ['CMD ARGS']
  16
  17
  18 DESCRIPTION
  19 -----------
  20 `babeltrace2` is an open-source trace converter and processor. The tool
  21 can convert from one trace format to another, possibly with one or more
  22 filters in the conversion path, and perform other operations depending
  23 on the command 'CMD'.
  24
  25 See man:babeltrace2-intro(7) to learn more about the Babeltrace
  26 project and its core concepts.
  27
  28 Most of the `babeltrace2` commands load Babeltrace plugins to perform
  29 their operation. The search path for Babeltrace plugins is, in this
  30 order:
  31
  32 . The colon-separated list of directories in the
  33   `BABELTRACE_PLUGIN_PATH` environment variable.
  34
  35 . The colon-separated list of directories in the specific command's
  36   nlopt:--plugin-path option.
  37
  38 . `$HOME/.local/lib/babeltrace2/plugins`
  39
  40 . +{system_plugin_path}+
  41
  42 You can use the man:babeltrace2-list-plugins(1) command to dynamically
  43 list the available plugins and what they offer. See <<plugins,PLUGINS>>
  44 for a list of plugins shipped with Babeltrace.
  45
  46
  47 OPTIONS
  48 -------
  49 opt:-d, opt:--debug::
  50     Turn the debugging mode on.
  51 +
  52 This is equivalent to opt:--log-level=`TRACE`.
  53
  54 opt:-l 'LVL', opt:--log-level='LVL'::
  55     Set the log level of all known Babeltrace loggers to 'LVL'. You
  56     can override the level of a specific logger with a dedicated
  57     log level environment variable. If you don't specify this option,
  58     it is equivalent to nlopt:--log-level=`WARNING`.
  59 +
  60 The available values for 'LVL' are:
  61 +
  62 --
  63 `NONE`::
  64 `N`::
  65     Logging is disabled.
  66
  67 `FATAL`::
  68 `F`::
  69     Severe errors that lead the execution to abort immediately. This
  70     level should be enabled in production.
  71
  72 `ERROR`::
  73 `E`::
  74     Errors that might still allow the execution to continue. Usually,
  75     once one or more errors are reported at this level, the application,
  76     plugin, or library won't perform any more useful task, but it should
  77     still exit cleanly. This level should be enabled in production.
  78
  79 `WARN`::
  80 `WARNING`::
  81 `W`::
  82     Potentially harmful situations which still allow the execution
  83     to continue. This level should be enabled in production.
  84
  85 `INFO`::
  86 `I`::
  87     Informational messages that highlight progress or important states
  88     of the application, plugin, or library. This level can be enabled in
  89     production.
  90
  91 `DEBUG`::
  92 `D`::
  93     Debugging information, with a higher level of details than the
  94     `TRACE` level. This level should :not: be enabled in production.
  95
  96 `TRACE`::
  97 `T`::
  98     Low-level debugging context information. This level should :not: be
  99     enabled in production.
 100 --
 101
 102 opt:-v, opt:--verbose::
 103     Turn the verbose mode on.
 104 +
 105 This is equivalent to opt:--log-level=`INFO`.
 106
 107 opt:-h, opt:--help::
 108     Show help and quit.
 109
 110 opt:-V, opt:--version::
 111     Show version and quit.
 112
 113
 114 [[commands]]
 115 COMMANDS
 116 --------
 117 The following commands also have their own nlopt:--help option.
 118
 119 man:babeltrace2-convert(1)::
 120     Build a trace conversion graph and run it.
 121 +
 122 This is the default command: you don't need to explicitly
 123 specify this command name to use it.
 124
 125 man:babeltrace2-help(1)::
 126     Get help for a specific plugin or plugin's component class.
 127
 128 man:babeltrace2-list-plugins(1)::
 129     List the available Babeltrace plugins and their component classes.
 130
 131 man:babeltrace2-query(1)::
 132     Query an object from a component class.
 133
 134 man:babeltrace2-run(1)::
 135     Build a trace processing graph and run it.
 136
 137
 138 [[plugins]]
 139 PLUGINS
 140 -------
 141 The following plugins are provided by the Babeltrace project itself:
 142
 143 man:babeltrace2-plugin-ctf(7)::
 144     CTF trace input (from the file system and from the LTTng-live
 145     protocol) and output to the file system.
 146 +
 147 * man:babeltrace2-sink.ctf.fs(7)
 148 * man:babeltrace2-source.ctf.fs(7)
 149 * man:babeltrace2-source.ctf.lttng-live(7)
 150
 151 ifeval::[{enable_debug_info} == 1]
 152 man:babeltrace2-plugin-lttng-utils(7)::
 153     Processing graph utilities for LTTng traces.
 154 +
 155 * man:babeltrace2-filter.lttng-utils.debug-info(7)
 156 endif::[]
 157
 158 man:babeltrace2-plugin-text(7)::
 159     Text input and output.
 160 +
 161 * man:babeltrace2-sink.text.pretty(7)
 162 * man:babeltrace2-source.text.dmesg(7)
 163
 164 man:babeltrace2-plugin-utils(7)::
 165     Processing graph utilities.
 166 +
 167 * man:babeltrace2-filter.utils.muxer(7)
 168 * man:babeltrace2-filter.utils.trimmer(7)
 169 * man:babeltrace2-sink.utils.counter(7)
 170 * man:babeltrace2-sink.utils.dummy(7)
 171
 172
 173 include::common-cli-env.txt[]
 174
 175 include::common-cli-files.txt[]
 176
 177 include::common-cmd-footer.txt[]
 178
 179
 180 SEE ALSO
 181 --------
 182 man:babeltrace2-convert(1),
 183 man:babeltrace2-help(1),
 184 man:babeltrace2-list-plugins(1),
 185 man:babeltrace2-query(1),
 186 man:babeltrace2-run(1),
 187 man:babeltrace2-intro(7)