X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-ust.3;fp=doc%2Fman%2Flttng-ust.3;h=591c1db014eef7acf3f8d4b1f11cf14adc1772f0;hb=641c659aa0558ea68008e96c64abe9629d540ae7;hp=2c58fba19197cbfe1fc89d86f3f328b1c6cf3f69;hpb=17ca060039dadc36eff49429af850c95659ab471;p=lttng-ust.git

diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3
index 2c58fba1..591c1db0 100644
--- a/doc/man/lttng-ust.3
+++ b/doc/man/lttng-ust.3
@@ -17,7 +17,35 @@ port of the low-overhead tracing capabilities of the LTTng kernel tracer
 to user-space. The library "liblttng-ust" enables tracing of
 applications and libraries.
 
-.SH "USAGE"
+.SH "USAGE WITH TRACEF"
+.PP
+The simplest way to add instrumentation to your code is by far the
+tracef() API. To you it, in a nutshell:
+
+1) #include <lttng/tracef.h>
+
+2) /* in your code, use like a printf */
+   tracef("my message, this integer %d", 1234);
+
+3) Link your program against liblttng-ust.so.
+
+4) Enable the UST event "lttng_ust_tracef:event" when tracing with the
+   following sequence of commands from lttng-tools:
+
+   lttng create; lttng enable-event -u "lttng_ust_tracef:event"; lttng start
+   [... run your program ...]
+   lttng stop; lttng view
+
+That's it!
+
+If you want to have more flexibility and control on the event names,
+payload typing, etc, you can continue reading on and use the tracepoints
+below. "tracef()" is there for quick and dirty ad hoc instrumentation,
+whereas tracepoint.h is meant for thorough instrumentation of a code
+base to be integrated with an upstream project.
+.PP
+
+.SH "USAGE WITH TRACEPOINT"
 .PP
 The simple way to generate the lttng-ust tracepoint probes is to use the
 lttng-gen-tp(1) tool. See the lttng-gen-tp(1) manpage for explanation.