X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=doc%2Flttngtop.1;h=54f7c14518ea1c98dcd8fda80827d309e94edc2a;hb=3012757f8942d76ed7be09953475c618f05b7fbb;hp=83ad7614effefbae1973c2fca4e3895c579abe6f;hpb=e15ed00a84c8afc3a4cee38b2a96128c313b9d13;p=lttngtop.git

diff --git a/doc/lttngtop.1 b/doc/lttngtop.1
index 83ad761..54f7c14 100644
--- a/doc/lttngtop.1
+++ b/doc/lttngtop.1
@@ -48,14 +48,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
@@ -100,6 +122,12 @@ Move up the blue line to select processes \fR
 .TP 7
 \ \ \'\fBDown arrow\' / \'j\'\fR: \fIMove DOWN the cursor \fR
 Move down the blue line to select processes
+.TP 7
+\ \ \'\fB>\fR': \fI Sort the next column \fR
+Update the sorting to the next column
+.TP 7
+\ \ \'\fB<\fR': \fI Sort the previous column \fR
+Update the sorting to the previous column
 
 .SH "SEE ALSO"