Docs: update debuginfo doc

[babeltrace.git] / doc / babeltrace.1

diff --git a/doc/babeltrace.1 b/doc/babeltrace.1
index 3d4c6ff72ba1a60ecc18b3d2ddc8d9ecfee2e587..d621623d3b4360bd9971fd5b0ef3529da0215a13 100644 (file)
--- a/doc/babeltrace.1
+++ b/doc/babeltrace.1
@@ -7,14 +7,14 @@ babeltrace \(em Babeltrace Trace Viewer and Converter
 
 .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
-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
@@ -22,14 +22,14 @@ starting with two dashes. Below is a summary of the available options.
 .PP
 
 .TP
-.BR "INPUT"
-Input trace path
+.BR "FILE"
+Input trace FILE(s) or directory(ies)
 .TP
-.BR "OUTPUT"
+.BR "-w, --output OUTPUT"
 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)
@@ -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,...>"
-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,...>"
-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)
@@ -72,6 +72,18 @@ Print clock date
 .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
+.BR "--debug-info-dir"
+Directory in which to look for debugging information files (default: /usr/lib/debug/)
+.TP
+.BR "--debug-info-target-prefix"
+Directory to use as a prefix for executable lookup
+.TP
+.BR "--debug-info-full-path"
+Show full debug info source and binary paths (if available)
+.TP
 
 .fi
 Formats available: ctf, dummy, text.
@@ -92,12 +104,13 @@ Activate debug Babeltrace output.
 .SH "SEE ALSO"
 
 .PP
-lttng-tools(1), lttng-ust(3), lttng-sessiond(8)
+babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8)
 .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