backport error handling add_trace_recursive from babeltrace
[lttngtop.git] / README
diff --git a/README b/README
index 592e10948fde996112ed440cc33851ea60540b82..0d67972735d7e0cfdd672dd28a44eb13ae8dddac 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,12 @@
-lttngtop
+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
 -----
@@ -22,29 +22,20 @@ $ lttngtop /path/to/your/trace
 
 Make sure you have read permissions on the whole directory.
 
-NOTE
-----
-
-Since this is an early release of lttngtop, it is still inside the babeltrace
-source tree. As soon as all babeltrace dependencies are  available from the
-library and header files, lttngtop will be in its own repository. Until then,
-changes in the babeltrace source tree will be merged in this tree to avoid
-conflicts. This repository doesn't install the babeltrace binary, or any of its
-libraries. This way you can safely install it in the default locations.
-
 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
 --------
@@ -66,14 +57,12 @@ To compile Babeltrace and lttngtop, you will need:
        glib 2.22 or better development libraries
          (Debian : libglib2.0-0, libglib2.0-dev)
          (Fedora : glib2, glib2-devel)
-       uuid development libraries
-         (Debian : uuid-dev)
-         (Fedora : uuid-devel)
        libpopt >= 1.13 development libraries
          (Debian : libpopt-dev)
          (Fedora : popt)
        ncurses development libraries
          (Debian : libncurses5-dev)
+       babeltrace development library
 
 For developers using the git tree:
 
This page took 0.030944 seconds and 4 git commands to generate.