Rename UST.class to LTTNG_UST.class

[ust.git] / README

diff --git a/README b/README
index 3d7e18e3de27f59a124de7ecbf0a9d4f64f5ec9c..746b1666fabb2de3ddcd3be4222a56f6494cb02e 100644 (file)
--- a/README
+++ b/README
@@ -16,7 +16,7 @@ PREREQUISITES:
   - liburcu
     Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
 
-    -> This release depends on liburcu v0.6
+    -> This release depends on liburcu v0.6.6
 
       * Debian/Ubuntu package: liburcu-dev
       * Website:  http://lttng.org/urcu
@@ -45,18 +45,24 @@ USAGE:
   - Link application with -lust.
   - (TODO: start tracing with the "lttng" command from lttng-tools)
 
-  Note: libust debug can be activated by either of the following means:
-    - Setting the environment variable "UST_DEBUG" when launching the
-      application.
-    - Compiling libust with -DUST_DEBUG.
+ENVIRONMENT VARIABLES:
 
+  - liblttng-ust debug can be activated by setting the environment variable
+    "LTTNG_UST_DEBUG" when launching the application. It can also be enabled
+    at compile-time by compiling libust with -DLTTNG_UST_DEBUG.
+
+  - The environment variable "LTTNG_UST_REGISTER_TIMEOUT" can be used to
+    specify how long the applications should wait for sessiond
+    "registration done" command before proceeding to execute the main
+    program. The default is 3000ms (3 seconds). The timeout value is
+    specified in milliseconds. The value 0 means "don't wait". The value
+    -1 means "wait forever".
 
-TRACE VIEWER:
 
-  LTTV is used for viewing UST traces. LTTV may be obtained at
-  http://lttng.org in the Downloads section.
+TRACE VIEWER:
 
-  This release has been tested with LTTV 0.12.32.
+  Use babeltrace for viewing traces generated by LTTng UST 2.0.
+  See http://lttng.org for download.
 
 
 CONTACT:
@@ -69,48 +75,38 @@ PACKAGE CONTENTS:
 
   This package contains the following elements.
 
-  - libust
+  - liblttng-ust
     The actual userspace tracing library that must be linked to the
     instrumented programs.
 
-  - ustctl
-    A program to control the tracing of userspace applications. It can list
-    markers, start the tracing, stop the tracing, enable/disable markers, etc.
-
   - include
     The public header files that will be installed on the system.
 
-  - ust-consumerd
-    The daemon that collects trace data and writes it to the disk.
-
   - doc
     The documentation.
 
   - tests
     Various test programs
 
-  - libustinstr-malloc
+  - liblttng-ust-malloc
     An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
     in any program without need to recompile it.
 
-  - libustfork
+  - liblttng-ust-fork
     A library that is LD_PRELOAD'ed, and that hijacks calls to several system
     calls in order to trace across these calls. It _has_ to be LD_PRELOAD'ed
     in order to hijack calls. In contrast, libust may be linked at build time.
 
-  - libustctl
-    A library to control tracing in other processes. Used by ustctl.
+  - liblttng-ust-ctl
+    A library to control tracing in other processes. Used by lttng-tools.
 
-  - libustcomm
-    A static library shared between libust, ust-consumerd and libustctl, that
+  - liblttng-ust-comm
+    A static library shared between libust and lttng-tools, that
     provides functions that allow these components to communicate together.
 
-  - libustconsumer
-    A library to create ust consumers by registering callbacks, used by
-    ust-consumerd.
-
   - snprintf
     An asynchronous signal-safe version of snprintf.
 
   - java
     A simple library that uses JNI to allow tracing in java programs.
+    See java/README for build instructions.