Fix Python: Add a comment warning about an API limitation

[babeltrace.git] / doc / babeltrace.1

diff --git a/doc/babeltrace.1 b/doc/babeltrace.1
index c41d4ddc06db7b95af7819c9208b9ba90c937470..929c5634e51d7fc83b040983477fc4fb93ce059d 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)


@@ -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)