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