Fix: ir: bt_ctf_field_copy(): copy payload_set
[babeltrace.git] / doc / babeltrace.1
index c9bb723eaca6b3e357cf8e83d8eb6639c5c88caf..cb5f2e7688a4aeb5d543ed9e7fe35e9b2485f64d 100644 (file)
@@ -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)
@@ -79,7 +79,7 @@ Formats available: ctf, dummy, text.
 .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 +92,12 @@ 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.
+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
@@ -120,7 +120,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
This page took 0.029243 seconds and 4 git commands to generate.