From: David Goulet <dgoulet@efficios.com>
Date: Thu, 10 Oct 2013 18:41:46 +0000 (-0400)
Subject: Add --live to lttng.1 man page
X-Git-Tag: v2.4.0-rc1~97
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=0794f51b6d35321e48c4cdf3533bc21a495f964d;p=lttng-tools.git

Add --live to lttng.1 man page

Signed-off-by: David Goulet <dgoulet@efficios.com>
---

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index 84bc370c7..42f25e435 100644
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -253,6 +253,26 @@ Traces will not be outputted
 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"