Fix: lttng-live flush when output to file

[babeltrace.git] / doc / babeltrace.1

diff --git a/doc/babeltrace.1 b/doc/babeltrace.1
index db07cafa0477b8cbd2fe53c5b9533f4e013331b3..1ee2281fd9a79d1c0c22ee9b200b94f88339889f 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)


@@ -54,8 +54,8 @@ Print field names: (payload OR args OR arg), none, all, scope, header,
 (context OR ctx), (default: payload,context).
 .TP
 .BR "-f, --fields name1<,name2,...>"
 (context OR ctx), (default: payload,context).
 .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)


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

-No knows bugs at this point.
+The lttng-live plugin does not honor the the "--output" command line
+option.

 
 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