doc/babeltrace.1

   1 .TH "BABELTRACE" "1" "February 6, 2012" "" ""
   2
   3 .SH "NAME"
   4 babeltrace \(em Babeltrace Trace Viewer and Converter
   5
   6 .SH "SYNOPSIS"
   7
   8 .PP
   9 .nf
  10 babeltrace [OPTIONS] FILE...
  11 .fi
  12 .SH "DESCRIPTION"
  13
  14 .PP
  15 Babeltrace is a trace viewer and converter reading and writing the
  16 Common Trace Format (CTF). Its main use is to pretty-print CTF traces
  17 into a human-readable text output ordered by time.
  18
  19 .PP
  20 This program follow the usual GNU command line syntax with long options
  21 starting with two dashes. Below is a summary of the available options.
  22 .PP
  23
  24 .TP
  25 .BR "FILE"
  26 Input trace FILE(s) or directory(ies)
  27 .TP
  28 .BR "-w, --output OUTPUT"
  29 Output trace path (default: stdout)
  30 .TP
  31 .BR "-i, --input-format FORMAT"
  32 Input trace format (default: ctf). CTF is currently the only supported input format.
  33 .TP
  34 .BR "-o, --output-format FORMAT"
  35 Output trace format (default: text)
  36 .TP
  37 .BR "-h, --help"
  38 This help message
  39 .TP
  40 .BR "-l, --list"
  41 List available formats
  42 .TP
  43 .BR "-v, --verbose"
  44 Verbose mode (or set BABELTRACE_VERBOSE environment variable)
  45 .TP
  46 .BR "-d, --debug"
  47 Debug mode (or set BABELTRACE_DEBUG environment variable)
  48 .TP
  49 .BR "--no-delta"
  50 Do not print time delta between consecutive events
  51 .TP
  52 .BR "-n, --names name1<,name2,...>"
  53 Print field names: (payload OR args OR arg), none, all, scope, header,
  54 (context OR ctx), (default: payload,context).
  55 .TP
  56 .BR "-f, --fields name1<,name2,...>"
  57 Print additional fields: all, trace, trace:hostname, trace:domain,
  58 trace:procname, trace:vpid, loglevel.
  59 .TP
  60 .BR "--clock-raw"
  61 Disregard internal clock offset (use raw value)
  62 .TP
  63 .BR "--clock-offset seconds"
  64 Clock offset in seconds
  65 .TP
  66 .BR "--clock-seconds"
  67 Print the timestamps as [sec.ns] (default is: [hh:mm:ss.ns])
  68 .TP
  69 .BR "--clock-date"
  70 Print clock date
  71 .TP
  72 .BR "--clock-gmt"
  73 Print clock in GMT time zone (default: local time zone)
  74 .TP
  75 .BR "--stream-intersection"
  76 Only print events when all streams are active
  77 .TP
  78 .BR "--debug-info-full-dir"
  79 Directory in which to look for debugging information files. (default: /usr/lib/debug/)
  80 .TP
  81 .BR "--debug-info-full-path"
  82 Show full debug info source and binary paths (if available)
  83 .TP
  84
  85 .fi
  86 Formats available: ctf, dummy, text.
  87
  88 .SH "ENVIRONMENT VARIABLES"
  89
  90 .PP
  91 Note that all command line options will override environmenal variables.
  92 .PP
  93
  94 .PP
  95 .IP "BABELTRACE_VERBOSE"
  96 Activate verbose Babeltrace output.
  97 .PP
  98 .IP "BABELTRACE_DEBUG"
  99 Activate debug Babeltrace output.
 100
 101 .SH "SEE ALSO"
 102
 103 .PP
 104 babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8)
 105 .PP
 106 .SH "BUGS"
 107
 108 .PP
 109 The lttng-live plugin does not honor the the "--output" command line
 110 option.
 111
 112 If you encounter any issues or usability problem, please report it on
 113 our mailing list <lttng-dev@lists.lttng.org> to help improve this
 114 project.
 115 .SH "CREDITS"
 116
 117 Babeltrace and the babeltrace library are distributed under the MIT
 118 license. See the files LICENSE and mit-license.txt for details.
 119 .PP
 120 A Web site is available at http://www.efficios.com/babeltrace for more
 121 information on Babeltrace and the Common Trace Format. See
 122 http://lttng.org for more information on the LTTng project.
 123 .PP
 124 Mailing list for support and development: <lttng-dev@lists.lttng.org>.
 125 .PP
 126 You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
 127 .PP
 128 .SH "THANKS"
 129
 130 Thanks to the Linux Foundation and Ericsson for funding part of this
 131 work. Thanks to the Multicore Association Tool Infrastructure Working
 132 Group for their active role in the creation of the Common Trace Format.
 133 .PP
 134 .SH "AUTHORS"
 135
 136 .PP
 137 Babeltrace was originally written by Mathieu Desnoyers, with additional
 138 contributions from various other people. It is currently maintained by
 139 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>.
 140 .PP