Commit | Line | Data |
---|---|---|
d2c0553c MD |
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 | |
4e85cbfd | 10 | babeltrace [OPTIONS] FILE... |
d2c0553c MD |
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 | |
e9a6238d | 17 | into a human-readable text output ordered by time. |
d2c0553c MD |
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 | |
4e85cbfd MD |
25 | .BR "FILE" |
26 | Input trace FILE(s) or directory(ies) | |
d2c0553c | 27 | .TP |
4e85cbfd | 28 | .BR "-w, --output OUTPUT" |
d2c0553c MD |
29 | Output trace path (default: stdout) |
30 | .TP | |
31 | .BR "-i, --input-format FORMAT" | |
35654abd | 32 | Input trace format (default: ctf) |
d2c0553c MD |
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,...>" | |
12c9c3bc MD |
53 | Print field names: (payload OR args OR arg), none, all, scope, header, |
54 | (context OR ctx), (default: payload,context). | |
d2c0553c MD |
55 | .TP |
56 | .BR "-f, --fields name1<,name2,...>" | |
32cfb8ad MD |
57 | Print additional fields: all, trace, trace:hostname, trace:domain, |
58 | trace:procname, trace:vpid, loglevel. | |
d2c0553c | 59 | .TP |
051ac50f | 60 | .BR "--clock-cycles" |
d2c0553c MD |
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 | |
108bede2 JG |
75 | .BR "--stream-intersection" |
76 | Only print events when all streams are active | |
77 | .TP | |
5e28eb5b JG |
78 | .BR "--debug-info-dir" |
79 | Directory in which to look for debugging information files (default: /usr/lib/debug/) | |
80 | .TP | |
81 | .BR "--debug-info-target-prefix" | |
82 | Directory to use as a prefix for executable lookup | |
2ec620a4 JG |
83 | .TP |
84 | .BR "--debug-info-full-path" | |
85 | Show full debug info source and binary paths (if available) | |
86 | .TP | |
d2c0553c MD |
87 | |
88 | .fi | |
56f91711 | 89 | Formats available: ctf, lttng-live, dummy, text, ctf-metadata. |
d2c0553c MD |
90 | |
91 | .SH "ENVIRONMENT VARIABLES" | |
92 | ||
93 | .PP | |
9faffb81 | 94 | Note that all command line options will override environment variables. |
d2c0553c MD |
95 | .PP |
96 | ||
97 | .PP | |
98 | .IP "BABELTRACE_VERBOSE" | |
99 | Activate verbose Babeltrace output. | |
100 | .PP | |
101 | .IP "BABELTRACE_DEBUG" | |
102 | Activate debug Babeltrace output. | |
103 | ||
104 | .SH "SEE ALSO" | |
105 | ||
106 | .PP | |
28070aac | 107 | babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8) |
d2c0553c MD |
108 | .PP |
109 | .SH "BUGS" | |
110 | ||
111 | .PP | |
220e0cbe MD |
112 | The lttng-live plugin does not honor the the "--output" command line |
113 | option. | |
d2c0553c MD |
114 | |
115 | If you encounter any issues or usability problem, please report it on | |
116 | our mailing list <lttng-dev@lists.lttng.org> to help improve this | |
117 | project. | |
118 | .SH "CREDITS" | |
119 | ||
120 | Babeltrace and the babeltrace library are distributed under the MIT | |
121 | license. See the files LICENSE and mit-license.txt for details. | |
122 | .PP | |
123 | A Web site is available at http://www.efficios.com/babeltrace for more | |
124 | information on Babeltrace and the Common Trace Format. See | |
125 | http://lttng.org for more information on the LTTng project. | |
126 | .PP | |
127 | Mailing list for support and development: <lttng-dev@lists.lttng.org>. | |
128 | .PP | |
129 | You can find us on IRC server irc.oftc.net (OFTC) in #lttng. | |
130 | .PP | |
131 | .SH "THANKS" | |
132 | ||
133 | Thanks to the Linux Foundation and Ericsson for funding part of this | |
134 | work. Thanks to the Multicore Association Tool Infrastructure Working | |
135 | Group for their active role in the creation of the Common Trace Format. | |
86bc640a | 136 | .PP |
d2c0553c MD |
137 | .SH "AUTHORS" |
138 | ||
139 | .PP | |
140 | Babeltrace was originally written by Mathieu Desnoyers, with additional | |
141 | contributions from various other people. It is currently maintained by | |
142 | Mathieu Desnoyers <mathieu.desnoyers@efficios.com>. | |
143 | .PP |