From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 17 May 2021 18:05:02 +0000 (-0400)
Subject: lttng-disable-event(1): add usage examples
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=f93c553f5f60768db47fcb56c21f354c6b0bc805;p=lttng-tools.git

lttng-disable-event(1): add usage examples

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I111fbfca2a12517ea6b2f315f4adf0c1b60c37de
---

diff --git a/doc/man/lttng-disable-event.1.txt b/doc/man/lttng-disable-event.1.txt
index 1fdeba198..8d27a46d7 100644
--- a/doc/man/lttng-disable-event.1.txt
+++ b/doc/man/lttng-disable-event.1.txt
@@ -1,6 +1,6 @@
 lttng-disable-event(1)
 ======================
-:revdate: 3 May 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -74,6 +74,8 @@ You may disable an enabled recording event rule regardless of the
 activity (started or stopped) of its tracing session (see
 man:lttng-start(1) and man:lttng-stop(1)).
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 
 include::common-lttng-cmd-options-head.txt[]
 
@@ -155,6 +157,50 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Disable all Linux kernel tracepoint recording event rules in the default channel of the current tracing session.
+====
+See the option:--all-events option.
+
+[role="term"]
+----
+$ lttng disable-event --kernel --tracepoint --all-events
+----
+====
+
+.Disable specific Apache log4j recording event rules in the default channel of a specific tracing session.
+====
+See the option:--session option.
+
+[role="term"]
+----
+$ lttng disable-event --session=my-session --log4j \
+                      MySingleton,MyProxy,MyFacade
+----
+====
+
+.Disable all user space recording event rules in a specific channel of the current tracing session.
+====
+See the option:--channel option.
+
+[role="term"]
+----
+$ lttng disable-event --channel=my-channel --userspace \
+                      --all-events
+----
+====
+
+.Disable specific Linux kernel system call recording event rules in the default channel of the current tracing session.
+====
+[role="term"]
+----
+$ lttng disable-event --kernel --syscall pipe2,eventfd
+----
+====
+
+
 include::common-footer.txt[]