X-Git-Url: https://git.lttng.org/?p=lttngtop.git;a=blobdiff_plain;f=doc%2Flttngtop.1;h=243571f6da37e2c48ef8d85c101170ef31e970c7;hp=0f4614eb267fa6a9cfe9546db5aa74d0a94a4ef1;hb=26d63ddf68515dd749de4b22465b28ef6bce2ed2;hpb=41ff0645d8cee0c0280edefeff7a161b96ecbf03

diff --git a/doc/lttngtop.1 b/doc/lttngtop.1
index 0f4614e..243571f 100644
--- a/doc/lttngtop.1
+++ b/doc/lttngtop.1
@@ -30,6 +30,11 @@ Input trace path
 
 LTTngTop requires that the pid, procname, tid and ppid context information
 are enabled during tracing.
+
+The command --create-local-session does all the required setup for a local
+trace (that must be stopped and destroyed manually by the user).
+And the command --create-live-session does all the required setup for a live
+trace on localhost (it must also be stopped and destroyed manually by the user).
 .PP
 
 .PP
@@ -48,14 +53,36 @@ launched as root.
 
 .nf
 lttng create lttngtop
-lttng enable-event -k -a
-lttng add-context -k -t pid -t procname -t tid -t ppid -t perf:cache-misses -t perf:major-faults -t perf:branch-load-misses
-lttng start
+lttng enable-event -k lttng_statedump_start,lttng_statedump_end,lttng_statedump_process_state,lttng_statedump_file_descriptor,lttng_statedump_vm_map,lttng_statedump_network_interface,lttng_statedump_interrupt,sched_process_free,sched_switchsched_process_fork -s lttngtop
+lttng enable-event -k --syscall -a -s lttngtop
+lttng add-context -k -t pid -t procname -t tid -t ppid -t perf:cache-misses -t perf:major-faults -t perf:branch-load-misses -s lttngtop
+lttng start lttngtop
 sleep 10
-lttng stop
-lttng destroy
+lttng stop lttngtop
+lttng destroy lttngtop
 .fi
 
+.SH "LIVE STREAMING"
+
+.PP
+In addition to offline traces, LTTngTop can read traces while they are being
+recorded. The official supported way of doing live streaming is using
+lttng-tools >=2.4 and following the documentation in live-reading-howto.txt of
+lttng-tools and README-LIVE of lttngtop.
+An other experimental way of doing live tracing is with mmap, but this requires some
+more work because is not officially supported and requires out-of-tree patches to
+lttng-tools and babeltrace.
+
+.PP
+To use the network live-reading, the user only needs to specify the relayd hostname
+or IP address with the option -r. For now, LTTngTop will only connect to the first
+live session established on the relay, but in a near future, the user will be able
+to choose which session to attach to.
+
+The default mode after attaching to a session is to start reading the trace from
+this point in time. In order to read the trace from the beginning, the user can specify
+the -b option.
+
 .SH "KEY BINDINGS"
 
 .TP 7