From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Thu, 7 Apr 2016 01:29:22 +0000 (-0400)
Subject: doc/man: lttng-ust(3): add tracing control to example
X-Git-Tag: v2.8.0-rc2~14
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=94f9dc944ea8c60b632c832aa6faaa78eb349417;p=lttng-ust.git

doc/man: lttng-ust(3): add tracing control to example

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/doc/man/lttng-ust.3.txt b/doc/man/lttng-ust.3.txt
index dda9cec6..1f4d7e48 100644
--- a/doc/man/lttng-ust.3.txt
+++ b/doc/man/lttng-ust.3.txt
@@ -843,6 +843,39 @@ cc -c app.c
 cc -o app tp.o app.o -llttng-ust -ldl
 -------------------------------------
 
+Using the man:lttng(1) tool, create an LTTng tracing session, enable
+all the events of this tracepoint provider, and start tracing:
+
+[role="term"]
+----------------------------------------------
+lttng create my-session
+lttng enable-event --userspace 'my_provider:*'
+lttng start
+----------------------------------------------
+
+You may also enable specific events:
+
+[role="term"]
+----------------------------------------------------------
+lttng enable-event --userspace my_provider:big_event
+lttng enable-event --userspace my_provider:event_instance2
+----------------------------------------------------------
+
+Run the application:
+
+[role="term"]
+--------------------
+./app some arguments
+--------------------
+
+Stop the current tracing session and inspect the recorded events:
+
+[role="term"]
+----------
+lttng stop
+lttng view
+----------
+
 
 Tracepoint provider header file
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~