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 236603fa087eaa3dbe5432f867653f7c2acef816..42f25e4354350e6ffbe3a3885a730421bf33334a 100644 (file)
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -214,7 +214,7 @@ Dynamic function entry/return probe (default)
 .PP
 
 .PP
-.IP \fBcreate\fP [NAME] [OPTIONS]
+\fBcreate\fP [NAME] [OPTIONS]
 .RS
 Create tracing session.
 
@@ -247,12 +247,32 @@ Simple listing of options
 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 "\-\-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"
@@ -453,8 +473,10 @@ Enable tracing event
 
 A tracing event is always assigned to a channel. If \fB\-c, \-\-channel\fP is
 omitted, a default channel named '\fBchannel0\fP' is created and the event is
-added to it. For the user-space tracer, using \fB\-a, \-\-all\fP is the same as
-using the wildcard "*".
+added to it. If \fB\-c, \-\-channel\fP is omitted, but a non-default
+channel already exists within the session, an error is returned. For the
+user-space tracer, using \fB\-a, \-\-all\fP is the same as using the
+wildcard "*".
 
 If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
 file.
@@ -595,6 +617,10 @@ NAME\fP again.
 If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
 file.
 
+If \fB\-c, \-\-channel\fP is omitted, the default channel name is used.
+If \fB\-c, \-\-channel\fP is omitted, but a non-default channel already
+exists within the session, an error is returned.
+
 .B OPTIONS:
 
 .TP
@@ -607,6 +633,9 @@ Simple listing of options
 .BR "\-s, \-\-session NAME"
 Apply on session name
 .TP
+.BR "\-c, \-\-channel NAME"
+Apply on channel name
+.TP
 .BR "\-a, \-\-all-events"
 Disable all events. This does NOT disable "*" but rather every known
 events of the session.
@@ -733,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
-$ 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
@@ -752,8 +781,9 @@ Apply to session name.
 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)
@@ -879,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-health-check(3)
 
 .SH "BUGS"