Add Mapping for j/k to up/down

[lttngtop.git] / README

diff --git a/README b/README
index 4bb510cae2b7cf94f7dbc14daa7d5390ad05e3ce..0d67972735d7e0cfdd672dd28a44eb13ae8dddac 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,12 @@
 LTTngTop
 Julien Desfossez <julien.desfossez@polymtl.ca>
-August 2011
+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
 -----
@@ -24,17 +24,18 @@ Make sure you have read permissions on the whole directory.
 
 EXAMPLE
 -------
-
-# 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 \
+# 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
+lttng start
+#...do stuff...
+lttng stop
+lttng destroy
 
-$ lttngtop $HOME/lttng-traces/lttngtop-...
+# Run lttngtop
+lttngtop $HOME/lttng-traces/lttngtop-...
 
 BUILDING
 --------