From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Thu, 3 Nov 2011 16:35:22 +0000 (-0400)
Subject: Update readme
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=f3049ad9e7b72287888452b9ed542c0f36e6eefe;p=ust.git

Update readme

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/README b/README
index 2d9c5fc..746b166 100644
--- a/README
+++ b/README
@@ -47,11 +47,11 @@ USAGE:
 
 ENVIRONMENT VARIABLES:
 
-  - libust debug can be activated by setting the environment variable
-    "UST_DEBUG" when launching the application. It can also be enabled
-    at compile-time by compiling libust with -DUST_DEBUG.
+  - 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 "UST_REGISTER_TIMEOUT" can be used to
+  - 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
@@ -61,10 +61,8 @@ ENVIRONMENT VARIABLES:
 
 TRACE VIEWER:
 
-  LTTV is used for viewing UST traces. LTTV may be obtained at
-  http://lttng.org in the Downloads section.
-
-  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:
@@ -77,46 +75,35 @@ 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.