fix segfault if no kprobe defined
[lttngtop.git] / README
diff --git a/README b/README
index b2fed8845367c8274f66224046eeee31e4d693da..0a64510ee3c98f06cc0cea67195fe58759ec34a8 100644 (file)
--- a/README
+++ b/README
@@ -1,41 +1,18 @@
 LTTngTop
-Julien Desfossez <julien.desfossez@polymtl.ca>
-August 2011
+Julien Desfossez <julien.desfossez@efficios.com>
+April 2012
 
 Lttngtop is an ncurses interface for reading and browsing traces recorded by
 the LTTng tracer and displaying various statistics.
-As of now, the cpu usage and perf counters are displayed. This version currently
-only supports offline traces, but a live version is in alpha and will be
-available for testing soon.
+As of now, the cpu usage, per file/process I/O bandwidth and perf counters are
+displayed. This version currently only supports offline traces, but a live
+version is in alpha and will be available for testing soon.
 
 USAGE
 -----
 
-Record a trace with LTTng 2.0 with at least the sched_switch event, and the pid,
-procname, tid, ppid contexts. To have the perftop view working you can enable
-any number of perf contexts (depending on your hardware).
-For the iotop view, you need to have some syscall events : sys_read, sys_write
-and exit_syscall.
-
-Once your trace is recorded, you can use lttngtop this way :
-$ lttngtop /path/to/your/trace
-
-Make sure you have read permissions on the whole directory.
-
-EXAMPLE
--------
-# Get root (or ideally just launch lttng-sessiond as root)
-lttng create lttngtop
-lttng enable-event -k sched_switch
-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
-#...do stuff...
-lttng stop
-lttng destroy
-
-# Run lttngtop
-lttngtop $HOME/lttng-traces/lttngtop-...
+The manpage located in the doc folder of this source tree documents the usage
+of LTTngTop.
 
 BUILDING
 --------
@@ -74,8 +51,6 @@ compile the git repository tree :
   (make sure your system wide "automake" points to a recent version!)
 - GNU Libtool >=2.2
   (for more information, go to http://www.gnu.org/software/autoconf/)
-- Flex >=2.5.35.
-- Bison >=2.4.
 
 If you get the tree from the repository, you will need to use the "bootstrap"
 script in the root of the tree. It calls all the GNU tools needed to prepare the
This page took 0.031549 seconds and 4 git commands to generate.