tracepoint: Remove TRACEPOINT_LIB declaration

[ust.git] / README

diff --git a/README b/README
index 8eaf618ed9a28c1b150da2fa56fcf71a42f514ea..901e17514c85d06fa81b4e4280fefa905a2e28b1 100644 (file)
--- a/README
+++ b/README
@@ -7,8 +7,8 @@ Updated versions of this package may be found at:
 
   * Website:  http://lttng.org/ust
   * Releases: http://lttng.org/files/ust/releases
-  * GitWeb:   http://git.dorsal.polymtl.ca (project: ust)
-  * Git:      git://git.dorsal.polymtl.ca/git/ust.git
+  * GitWeb:   http://git.lttng.org (project: ust)
+  * Git:      git://git.lttng.org/ust.git
 
 
 PREREQUISITES:
@@ -16,7 +16,7 @@ PREREQUISITES:
   - liburcu
     Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
 
-    -> This release was tested with liburcu v0.4.6
+    -> This release depends on liburcu v0.6
 
       * Debian/Ubuntu package: liburcu-dev
       * Website:  http://lttng.org/urcu
@@ -38,6 +38,27 @@ INSTALLATION INSTRUCTIONS:
   the configure script, to generate it.
 
 
+USAGE:
+
+  - Create an instrumentation header following the tracepoint examples.
+    (see tracepoint.h and tests/hello/tp.h).
+  - Link application with -lust.
+  - (TODO: start tracing with the "lttng" command from lttng-tools)
+
+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.
+
+  - The environment variable "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
@@ -46,6 +67,12 @@ TRACE VIEWER:
   This release has been tested with LTTV 0.12.32.
 
 
+CONTACT:
+
+  Maintainer: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+  Mailing list: ltt-dev@lists.casi.polymtl.ca
+
+
 PACKAGE CONTENTS:
 
   This package contains the following elements.
@@ -61,7 +88,7 @@ PACKAGE CONTENTS:
   - include
     The public header files that will be installed on the system.
 
-  - ustd
+  - ust-consumerd
     The daemon that collects trace data and writes it to the disk.
 
   - doc
@@ -79,15 +106,20 @@ PACKAGE CONTENTS:
     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.
 
-  - libustcmd
+  - libustctl
     A library to control tracing in other processes. Used by ustctl.
 
   - libustcomm
-    A static library shared between libust, ustd and libustcmd, that provides
-    functions that allow these components to communicate together.
+    A static library shared between libust, ust-consumerd and libustctl, 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.