Initial implementation of the debuginfo API

[babeltrace.git] / doc / babeltrace.1

diff --git a/doc/babeltrace.1 b/doc/babeltrace.1
index c9bb723eaca6b3e357cf8e83d8eb6639c5c88caf..cee9f7b9f60b88cfb77065870fbba12aa2cfbba3 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,10 +22,10 @@ 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"
@@ -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,14 +72,17 @@ 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
 
 .fi
-Formats available: ctf, dummy, text.
+Formats available: ctf, lttng-live, dummy, text, ctf_metadata.
 
 .SH "ENVIRONMENT VARIABLES"
 
 .PP
-Note that all command line options will override environmenal variables.
+Note that all command line options will override environment variables.
 .PP
 
 .PP
@@ -92,12 +95,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
@@ -120,7 +124,7 @@ You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
 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
+.PP
 .SH "AUTHORS"
 
 .PP