Fix: Documentation cleanup

[babeltrace.git] / doc / babeltrace.1

.TH "BABELTRACE" "1" "February 6, 2012" "" ""

.SH "NAME"
babeltrace \(em Babeltrace Trace Viewer and Converter

.SH "SYNOPSIS"

.PP
.nf
babeltrace [OPTIONS] FILE...
.fi
.SH "DESCRIPTION"

.PP
Babeltrace is a trace viewer and converter reading and writing the
Common Trace Format (CTF). Its main use is to pretty-print CTF traces
into a human-readable text output.

.PP
This program follow the usual GNU command line syntax with long options
starting with two dashes. Below is a summary of the available options.
.PP

.TP
.BR "FILE"
Input trace FILE(s) or directory(ies)
.TP
.BR "-w, --output OUTPUT"
Output trace path (default: stdout)
.TP
.BR "-i, --input-format FORMAT"
Input trace format (default: ctf)
.TP
.BR "-o, --output-format FORMAT"
Output trace format (default: text)
.TP
.BR "-h, --help"
This help message
.TP
.BR "-l, --list"
List available formats
.TP
.BR "-v, --verbose"
Verbose mode (or set BABELTRACE_VERBOSE environment variable)
.TP
.BR "-d, --debug"
Debug mode (or set BABELTRACE_DEBUG environment variable)
.TP
.BR "--no-delta"
Do not print time delta between consecutive events
.TP
.BR "-n, --names name1<,name2,...>"
Print field names: (payload OR args OR arg), none, all, scope, header,
(context OR ctx), (default: payload,context).
.TP
.BR "-f, --fields name1<,name2,...>"
Print additional fields: all, trace, trace:hostname, trace:domain,
trace:procname, trace:vpid, loglevel.
.TP
.BR "--clock-raw"
Disregard internal clock offset (use raw value)
.TP
.BR "--clock-offset seconds"
Clock offset in seconds
.TP
.BR "--clock-seconds"
Print the timestamps as [sec.ns] (default is: [hh:mm:ss.ns])
.TP
.BR "--clock-date"
Print clock date
.TP
.BR "--clock-gmt"
Print clock in GMT time zone (default: local time zone)
.TP

.fi
Formats available: ctf, dummy, text.

.SH "ENVIRONMENT VARIABLES"

.PP
Note that all command line options will override environmenal variables.
.PP

.PP
.IP "BABELTRACE_VERBOSE"
Activate verbose Babeltrace output.
.PP
.IP "BABELTRACE_DEBUG"
Activate debug Babeltrace output.

.SH "SEE ALSO"

.PP
babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8)
.PP
.SH "BUGS"

.PP
No known bugs at this point.

If you encounter any issues or usability problem, please report it on
our mailing list <lttng-dev@lists.lttng.org> to help improve this
project.
.SH "CREDITS"

Babeltrace and the babeltrace library are distributed under the MIT
license. See the files LICENSE and mit-license.txt for details.
.PP
A Web site is available at http://www.efficios.com/babeltrace for more
information on Babeltrace and the Common Trace Format. See
http://lttng.org for more information on the LTTng project.
.PP
Mailing list for support and development: <lttng-dev@lists.lttng.org>.
.PP
You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
.PP
.SH "THANKS"

Thanks to the Linux Foundation and Ericsson for funding part of this
work. Thanks to the Multicore Association Tool Infrastructure Working
Group for their active role in the creation of the Common Trace Format.
.PP
.SH "AUTHORS"

.PP
Babeltrace was originally written by Mathieu Desnoyers, with additional
contributions from various other people. It is currently maintained by
Mathieu Desnoyers <mathieu.desnoyers@efficios.com>.
.PP