Markers: API change: rename trace_mark() to ust_marker()

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

diff --git a/doc/info/ust.texi b/doc/info/ust.texi
index e0565f39a96261c73e291fca68eeee6dd58760c9..60c73c1804a08bd8658aa0ac46fc8e3c6c691f10 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(ust, myevent, "firstarg %d secondarg %s", v, st);
 
        /* a marker without arguments: */
-       trace_mark(ust, myotherevent, MARK_NOARGS);
+       ust_marker(ust, myotherevent, MARK_NOARGS);
 
        return 0;
 }
@@ -240,17 +240,17 @@ 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(main, myevent, "firstarg %d secondarg %s", v, st);
 
        /* another marker without arguments: */
-       trace_mark(main, myotherevent, MARK_NOARGS);
+       ust_marker(main, myotherevent, MARK_NOARGS);
 
        return 0;
 }
 @end verbatim
 @end example
 
-The invocation of the trace_mark() macro requires at least 3 arguments. The
+The invocation of the ust_marker() 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
@@ -318,7 +318,7 @@ DEFINE_TRACE(mychannel_myevent);
 
 void mychannel_myevent_probe(int v, char *st)
 {
-       trace_mark(mychannel, myevent, "v %d st %s", v, st);
+       ust_marker(mychannel, myevent, "v %d st %s", v, st);
 }
 
 static void __attribute__((constructor)) init()
@@ -385,35 +385,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 +543,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