Update manual

[ust.git] / doc / info / ust.texi

diff --git a/doc/info/ust.texi b/doc/info/ust.texi
index e0565f39a96261c73e291fca68eeee6dd58760c9..4a06ccdf94273caaf6becaa68c87cbe789d0ce3c 100644 (file)
--- a/doc/info/ust.texi
+++ b/doc/info/ust.texi
@@ -36,7 +36,7 @@ Permission is granted to ...
 @node Top
 @top LTTng Userspace Tracer
 
-This manual is for UST 0.5.
+This manual is for UST 0.11.
 @end ifnottex
 
 @menu
@@ -91,8 +91,8 @@ Components licensed as LGPL v2.1:
 Components licensed as GPL v2:
 @itemize @bullet
 @item ustctl
-@item libustcmd
-@item ustd
+@item libustctl
+@item ust-consumerd
 @end itemize
 
 @node Supported platforms
@@ -112,7 +112,7 @@ The following packages are required:
 @item
 ust
 
-This contains the tracing library, the ustd daemon, trace control tools
+This contains the tracing library, the ust-consumerd daemon, trace control tools
 and other helper tools.
 
 Repository: @url{http://git.dorsal.polymtl.ca}
@@ -162,10 +162,10 @@ int main(int argc, char **argv)
        /* ... set values of v and st ... */
 
        /* a marker: */
-       trace_mark(ust, myevent, "firstarg %d secondarg %s", v, st);
+       ust_marker(myevent, "firstarg %d secondarg %s", v, st);
 
        /* a marker without arguments: */
-       trace_mark(ust, myotherevent, MARK_NOARGS);
+       ust_marker(myotherevent, MARK_NOARGS);
 
        return 0;
 }
@@ -240,22 +240,21 @@ int main(int argc, char **argv)
        /* ... set values of v and st ... */
 
        /* a marker: */
-       trace_mark(main, myevent, "firstarg %d secondarg %s", v, st);
+       ust_marker(myevent, "firstarg %d secondarg %s", v, st);
 
        /* another marker without arguments: */
-       trace_mark(main, myotherevent, MARK_NOARGS);
+       ust_marker(myotherevent, MARK_NOARGS);
 
        return 0;
 }
 @end verbatim
 @end example
 
-The invocation of the trace_mark() macro requires at least 3 arguments. The
-first, here "main", is the name of the event category. It is also the name of
-the channel the event will go in. The second, here "myevent" is the name of the
-event. The third is a format string that announces the names and the types of
-the event arguments. Its format resembles that of a printf() format string; it
-is described thoroughly in Appendix x.
+The invocation of the ust_marker() macro requires at least 2 arguments. The
+first, "myevent", is the name of the event. The second is a format string
+that announces the names and the types of the event arguments. Its
+format resembles that of a printf() format string; it is described
+thoroughly in Appendix x.
 
 A given Marker may appear more than once in the same program. Other Markers may
 have the same name and a different format string, although this might induce
@@ -271,10 +270,7 @@ format strings directly in the code and to have format strings appear more than
 once if a given marker is reused.
 
 @quotation Note
-Although this example uses @emph{mychannel} as the channel, the
-only channel name currently supported with early tracing is @strong{ust}. The
-@command{usttrace} tool always uses the early tracing mode. When using manual
-mode without early tracing, any channel name may be used.
+The @command{usttrace} tool always uses the early tracing mode.
 @end quotation
 
 A function instrumented with a tracepoint looks like this:
@@ -283,7 +279,7 @@ A function instrumented with a tracepoint looks like this:
 @verbatim
 #include "tp.h"
 
-void function()
+void function(void)
 {
        int v;
        char *st;
@@ -291,7 +287,7 @@ void function()
        /* ... set values of v and st ... */
 
        /* a tracepoint: */
-       trace_mychannel_myevent(v, st);
+       trace_myevent(v, st);
 }
 @end verbatim
 @end example
@@ -302,8 +298,8 @@ Another file, here tp.h, contains declarations for the tracepoint.
 @verbatim
 #include <ust/tracepoint.h>
 
-DECLARE_TRACE(mychannel_myevent, TP_PROTO(int v, char *st),
-             TP_ARGS(v, st));
+DECLARE_TRACEPOINT(myevent, TP_PROTO(int v, char *st),
+                  TP_ARGS(v, st));
 @end verbatim
 @end example
 
@@ -314,16 +310,16 @@ A third file, here tp.c, contains definitions for the tracepoint.
 #include <ust/marker.h>
 #include "tp.h"
 
-DEFINE_TRACE(mychannel_myevent);
+DEFINE_TRACEPOINT(myevent);
 
-void mychannel_myevent_probe(int v, char *st)
+void myevent_probe(int v, char *st)
 {
-       trace_mark(mychannel, myevent, "v %d st %s", v, st);
+       ust_marker(myevent, "v %d st %s", v, st);
 }
 
 static void __attribute__((constructor)) init()
 {
-       register_trace_mychannel_myevent(mychannel_myevent_probe);
+       register_trace_myevent(myevent_probe);
 }
 @end verbatim
 @end example
@@ -385,35 +381,35 @@ First the daemon must be started.
 # Make sure the directory for the communication sockets exists.
 $ mkdir /tmp/ustsocks
 
-# Make sure the directory where ustd will write the trace exists.
+# Make sure the directory where ust-consumerd will write the trace exists.
 $ mkdir /tmp/trace
 
 # Start the daemon
-$ ustd
+$ ust-consumerd
 
 # We assume the program we want to trace is already running and that
 # it has pid 1234.
 
 # List the available markers
-$ ustctl --list-markers 1234
+$ ustctl list-markers 1234
 # A column indicates 0 for an inactive marker and 1 for an active marker.
 
 # Enable a marker
-$ ustctl --enable-marker ust/mymark 1234
+$ ustctl enable-marker 1234 auto ust/mymark
 
 # Create a trace
-$ ustctl --create-trace 1234
+$ ustctl create-trace 1234 auto
 
 # Start tracing
-$ ustctl --start-trace 1234
+$ ustctl start-trace 1234 auto
 
 # Do things...
 
 # Stop tracing
-$ ustctl --stop-trace 1234
+$ ustctl stop-trace 1234 auto
 
 # Destroy the trace
-$ ustctl --destroy-trace 1234
+$ ustctl destroy-trace 1234 auto
 @end verbatim
 @end example
 
@@ -543,7 +539,7 @@ the application (or library) being linked to libust.
 Libust is initialized by a constructor, which by definition runs before the
 @code{main()} function of the application starts. This constructor creates a
 thread called the @emph{listener thread}.  The listener thread initializes a
-named socket and waits for connections for ustd or ustctl.
+named socket and waits for connections for ust-consumerd or ustctl.
 
 Libust-specific code may:
 @itemize @bullet