Docs: add high-level debug info doc

[babeltrace.git] / doc / babeltrace.1

diff --git a/doc/babeltrace.1 b/doc/babeltrace.1
index 319629909a34ce462e93531c7c403c2bfd10d1d4..01afc7dc34e620a6524d7f328bafb9be58a742c3 100644 (file)
--- a/doc/babeltrace.1
+++ b/doc/babeltrace.1
@@ -14,7 +14,7 @@ babeltrace [OPTIONS] FILE...
 .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
 .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


@@ -29,7 +29,7 @@ Input trace FILE(s) or directory(ies)
 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)


@@ -72,6 +72,9 @@ Print clock date
 .BR "--clock-gmt"
 Print clock in GMT time zone (default: local time zone)
 .TP
 .BR "--clock-gmt"
 Print clock in GMT time zone (default: local time zone)
 .TP

+.BR "--stream-intersection"
+Only print events when all streams are active
+.TP

 
 .fi
 Formats available: ctf, dummy, text.
 
 .fi
 Formats available: ctf, dummy, text.


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

-No known 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