Add UST_DEBUG env. var. support

[lttng-ust.git] / README

diff --git a/README b/README
index a2d115b19c52eb0ebc40a754b80c3a5cd5bbb853..3d7e18e3de27f59a124de7ecbf0a9d4f64f5ec9c 100644 (file)
--- a/README
+++ b/README
@@ -38,6 +38,19 @@ 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)
+
+  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.
+
+
 TRACE VIEWER:
 
   LTTV is used for viewing UST traces. LTTV may be obtained at