prepare the 0.3 release

[lttngtop.git] / doc / lttngtop.1

diff --git a/doc/lttngtop.1 b/doc/lttngtop.1
index 5f2ba35f4fa12ab99bb0fb8968993f4213b2a2e9..dad4f88429c908ad9d577d28cae4cc0c29026598 100644 (file)
--- a/doc/lttngtop.1
+++ b/doc/lttngtop.1
@@ -1,4 +1,4 @@
-.TH "LTTNGTOP" "1" "April 18, 2012" "" ""
+.TH "LTTNGTOP" "1" "June 01, 2015" "" ""
 
 .SH "NAME"
 lttngtop \(em LTTng Trace Viewer
@@ -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
@@ -77,6 +104,9 @@ Highlights the process under the blue line to make it easy to find it across all
 \ \ \'\fBq\fR\': \fIQuit \fR
 Exit the program
 .TP 7
+\ \ \'\fBt\fR\': \fIThreads \fR
+Toggle threads display in CPUTop
+.TP 7
 \ \ \'\fBr\fR\': \fIPreferences \fR
 Display the preference menu for the current view, this menu helps select the column displayed (only in PerfTop view for now) and the column to sort, use 's' to sort and 'space' to toggle the view
 .TP 7
@@ -97,6 +127,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"
 
@@ -106,7 +142,8 @@ babeltrace(1), babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8)
 .SH "BUGS"
 
 .PP
-No knows bugs at this point.
+The I/O history has some problems with the file names, and we are missing some
+system calls parsing to have the complete I/O accounting.
 
 If you encounter any issues or usability problem, please report it on
 our mailing list <lttng-dev@lists.lttng.org> to help improve this