Docs: add high-level debug info doc
[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
4e85cbfd 10babeltrace [OPTIONS] FILE...
d2c0553c
MD
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
e9a6238d 17into a human-readable text output ordered by time.
d2c0553c
MD
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
4e85cbfd
MD
25.BR "FILE"
26Input trace FILE(s) or directory(ies)
d2c0553c 27.TP
4e85cbfd 28.BR "-w, --output OUTPUT"
d2c0553c
MD
29Output trace path (default: stdout)
30.TP
31.BR "-i, --input-format FORMAT"
05cab525 32Input trace format (default: ctf). CTF is currently the only supported input format.
d2c0553c
MD
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,...>"
32cfb8ad
MD
57Print additional fields: all, trace, trace:hostname, trace:domain,
58trace:procname, trace:vpid, loglevel.
d2c0553c
MD
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
dcfc8a69
JG
75.BR "--stream-intersection"
76Only print events when all streams are active
77.TP
d2c0553c
MD
78
79.fi
80Formats available: ctf, dummy, text.
81
82.SH "ENVIRONMENT VARIABLES"
83
84.PP
85Note that all command line options will override environmenal variables.
86.PP
87
88.PP
89.IP "BABELTRACE_VERBOSE"
90Activate verbose Babeltrace output.
91.PP
92.IP "BABELTRACE_DEBUG"
93Activate debug Babeltrace output.
94
95.SH "SEE ALSO"
96
97.PP
28070aac 98babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8)
d2c0553c
MD
99.PP
100.SH "BUGS"
101
102.PP
857eaa68
MD
103The lttng-live plugin does not honor the the "--output" command line
104option.
d2c0553c
MD
105
106If you encounter any issues or usability problem, please report it on
107our mailing list <lttng-dev@lists.lttng.org> to help improve this
108project.
109.SH "CREDITS"
110
111Babeltrace and the babeltrace library are distributed under the MIT
112license. See the files LICENSE and mit-license.txt for details.
113.PP
114A Web site is available at http://www.efficios.com/babeltrace for more
115information on Babeltrace and the Common Trace Format. See
116http://lttng.org for more information on the LTTng project.
117.PP
118Mailing list for support and development: <lttng-dev@lists.lttng.org>.
119.PP
120You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
121.PP
122.SH "THANKS"
123
124Thanks to the Linux Foundation and Ericsson for funding part of this
125work. Thanks to the Multicore Association Tool Infrastructure Working
126Group for their active role in the creation of the Common Trace Format.
86bc640a 127.PP
d2c0553c
MD
128.SH "AUTHORS"
129
130.PP
131Babeltrace was originally written by Mathieu Desnoyers, with additional
132contributions from various other people. It is currently maintained by
133Mathieu Desnoyers <mathieu.desnoyers@efficios.com>.
134.PP
This page took 0.030795 seconds and 4 git commands to generate.