X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=README;h=ef11607f633d0fed55e70fa880015b24d940de82;hb=c60764827b5c81fc41d243dd2ab647ce60a80837;hp=ffff6c22b3733d188f44d954839647b5bbe16087;hpb=5609732975848531a05afa18285e46949ae78eec;p=ust.git diff --git a/README b/README index ffff6c2..ef11607 100644 --- a/README +++ b/README @@ -11,7 +11,6 @@ Updated versions of this package may be found at: * Git: git://git.dorsal.polymtl.ca/git/ust.git - PREREQUISITES: - liburcu @@ -35,6 +34,8 @@ INSTALLATION INSTRUCTIONS: - Run ldconfig. - See the manual for usage instructions. + If compiling from the git repository, run ./bootstrap before running + the configure script, to generate it. TRACE VIEWER: @@ -66,8 +67,8 @@ PACKAGE CONTENTS: - doc The documentation. - - hello - An example application that uses the userspace tracer. + - tests + Various test programs - libustinstr-malloc An example library that can be LD_PRELOAD'ed to instrument calls to malloc() @@ -75,4 +76,18 @@ PACKAGE CONTENTS: - libustfork A library that is LD_PRELOAD'ed, and that hijacks calls to several system - calls in order to trace across these calls. + 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 + 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. + + - snprintf + An asynchronous signal-safe version of snprintf. + + - java + A simple library that uses JNI to allow tracing in java programs.