LTTng-live usage documentation

[babeltrace.git] / doc / babeltrace.1

diff --git a/doc/babeltrace.1 b/doc/babeltrace.1
index 54ff70e7ec24fa33c37d80617551d88ac84aeb5a..929c5634e51d7fc83b040983477fc4fb93ce059d 100644 (file)
--- a/doc/babeltrace.1
+++ b/doc/babeltrace.1
@@ -7,14 +7,14 @@ babeltrace \(em Babeltrace Trace Viewer and Converter
 
 .PP
 .nf
 
 .PP
 .nf

-babeltrace [OPTIONS] INPUT <OUTPUT>
+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
 .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.
+into a human-readable text output ordered by time.

 
 .PP
 This program follow the usual GNU command line syntax with long options
 
 .PP
 This program follow the usual GNU command line syntax with long options


@@ -22,14 +22,14 @@ starting with two dashes. Below is a summary of the available options.
 .PP
 
 .TP
 .PP
 
 .TP

-.BR "INPUT"
-Input trace path
+.BR "FILE"
+Input trace FILE(s) or directory(ies)

 .TP
 .TP

-.BR "OUTPUT"
+.BR "-w, --output OUTPUT"

 Output trace path (default: stdout)
 .TP
 .BR "-i, --input-format FORMAT"
 Output trace path (default: stdout)
 .TP
 .BR "-i, --input-format FORMAT"

-Input trace format (default: ctf)
+Input trace format (default: ctf). CTF is currently the only supported input format.

 .TP
 .BR "-o, --output-format FORMAT"
 Output trace format (default: text)
 .TP
 .BR "-o, --output-format FORMAT"
 Output trace format (default: text)


@@ -50,12 +50,12 @@ Debug mode (or set BABELTRACE_DEBUG environment variable)
 Do not print time delta between consecutive events
 .TP
 .BR "-n, --names name1<,name2,...>"
 Do not print time delta between consecutive events
 .TP
 .BR "-n, --names name1<,name2,...>"

-Print field names: (payload OR args OR arg), all, scope, header,
-(context OR ctx), (payload active by default).
+Print field names: (payload OR args OR arg), none, all, scope, header,
+(context OR ctx), (default: payload,context).

 .TP
 .BR "-f, --fields name1<,name2,...>"
 .TP
 .BR "-f, --fields name1<,name2,...>"

-Print additional fields: all, trace, trace:domain, trace:procname,
-trace:vpid, loglevel.
+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-raw"
 Disregard internal clock offset (use raw value)


@@ -92,12 +92,12 @@ Activate debug Babeltrace output.
 .SH "SEE ALSO"
 
 .PP
 .SH "SEE ALSO"
 
 .PP

-babeltrace-log(1), lttng-tools(1), lttng-ust(3), lttng-sessiond(8)
+babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8)

 .PP
 .SH "BUGS"
 
 .PP
 .PP
 .SH "BUGS"
 
 .PP

-No knows bugs at this point.
+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
 
 If you encounter any issues or usability problem, please report it on
 our mailing list <lttng-dev@lists.lttng.org> to help improve this