Add --live to lttng.1 man page

[lttng-tools.git] / doc / man / lttng.1

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index 6e0efb73abeca4181478c1bcc43188c9e11e1c0f..42f25e4354350e6ffbe3a3885a730421bf33334a 100644 (file)
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -247,12 +247,32 @@ Simple listing of options
 Specify output path for traces
 .TP
 .BR "\-\-no-output"
 Specify output path for traces
 .TP
 .BR "\-\-no-output"

-Traces will not be outputed
+Traces will not be outputted

 .TP
 .BR "\-\-snapshot"
 Set the session in snapshot mode. Created in no-output mode and uses the
 URL, if one, as the default snapshot output.  Every channel will be set
 in overwrite mode and with mmap output (splice not supported).
 .TP
 .BR "\-\-snapshot"
 Set the session in snapshot mode. Created in no-output mode and uses the
 URL, if one, as the default snapshot output.  Every channel will be set
 in overwrite mode and with mmap output (splice not supported).

+.TP
+.BR "\-\-live USEC"
+Set the session exclusively in live mode. The paremeter is the delay in micro
+seconds before the data is flushed and streamed. The live mode allows you to
+stream the trace and view it while it's being recorded by any tracer. For that,
+you need a lttng-relayd and this session requires a network URL (\-U or
+\-C/\-D).
+
+To read a live session, you can use babeltrace(1) or the live streaming
+protocol in doc/live-reading-protocol.txt. Here is an example:
+
+.nf
+$ lttng-relayd -o /tmp/lttng
+$ lttng create --live 200000 -U net://localhost
+$ lttng enable-event -a --userspace
+$ lttng start
+.fi
+
+After the start, you'll be able to read the events while they are being
+recorded in /tmp/lttng.

 
 .TP
 .BR "\-U, \-\-set-url=URL"
 
 .TP
 .BR "\-U, \-\-set-url=URL"


@@ -742,7 +762,7 @@ size will override the current output values. For instance, you can record a
 snapshot with a custom maximum size or with a different name.
 
 .nf
 snapshot with a custom maximum size or with a different name.
 
 .nf

-$ lttng add-output -n mysnapshot file:///data/snapshot
+$ lttng snapshot add-output -n mysnapshot file:///data/snapshot

 [...]
 $ lttng snapshot record -n new_name_snapshot
 .fi
 [...]
 $ lttng snapshot record -n new_name_snapshot
 .fi


@@ -761,8 +781,9 @@ Apply to session name.
 Name of the snapshot's output.
 .TP
 .BR "\-m, \-\-max-size SIZE"
 Name of the snapshot's output.
 .TP
 .BR "\-m, \-\-max-size SIZE"

-Maximum size in bytes of the snapshot. The maxium size does not include
-the metadata file.
+Maximum size in bytes of the snapshot. The maxium size does not include the
+metadata file. Human readable format is accepted: {+k,+M,+G}. For instance,
+\-\-max-size 5M

 .TP
 .BR "\-C, \-\-ctrl-url URL"
 Set control path URL. (Must use -D also)
 .TP
 .BR "\-C, \-\-ctrl-url URL"
 Set control path URL. (Must use -D also)


@@ -888,7 +909,6 @@ tool. You can also use \-\-sessiond-path option having the same effect.
 .BR lttng-ust(3),
 .BR lttng-sessiond(8),
 .BR lttng-relayd(8),
 .BR lttng-ust(3),
 .BR lttng-sessiond(8),
 .BR lttng-relayd(8),

-.BR lttng-health-check(3)

 
 .SH "BUGS"
 
 
 .SH "BUGS"