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
  79 .fi
  80 Formats available: ctf, dummy, text.
  81
  82 .SH "ENVIRONMENT VARIABLES"
  83
  84 .PP
  85 Note that all command line options will override environmenal variables.
  86 .PP
  87
  88 .PP
  89 .IP "BABELTRACE_VERBOSE"
  90 Activate verbose Babeltrace output.
  91 .PP
  92 .IP "BABELTRACE_DEBUG"
  93 Activate debug Babeltrace output.
  94
  95 .SH "SEE ALSO"
  96
  97 .PP
  98 babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8)
  99 .PP
 100 .SH "BUGS"
 101
 102 .PP
 103 The lttng-live plugin does not honor the the "--output" command line
 104 option.
 105
 106 If you encounter any issues or usability problem, please report it on
 107 our mailing list <lttng-dev@lists.lttng.org> to help improve this
 108 project.
 109 .SH "CREDITS"
 110
 111 Babeltrace and the babeltrace library are distributed under the MIT
 112 license. See the files LICENSE and mit-license.txt for details.
 113 .PP
 114 A Web site is available at http://www.efficios.com/babeltrace for more
 115 information on Babeltrace and the Common Trace Format. See
 116 http://lttng.org for more information on the LTTng project.
 117 .PP
 118 Mailing list for support and development: <lttng-dev@lists.lttng.org>.
 119 .PP
 120 You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
 121 .PP
 122 .SH "THANKS"
 123
 124 Thanks to the Linux Foundation and Ericsson for funding part of this
 125 work. Thanks to the Multicore Association Tool Infrastructure Working
 126 Group for their active role in the creation of the Common Trace Format.
 127 .PP
 128 .SH "AUTHORS"
 129
 130 .PP
 131 Babeltrace was originally written by Mathieu Desnoyers, with additional
 132 contributions from various other people. It is currently maintained by
 133 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>.
 134 .PP