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

[lttng-tools.git] / doc / man / lttng-disable-event.1.txt

diff --git a/doc/man/lttng-disable-event.1.txt b/doc/man/lttng-disable-event.1.txt
index 7ace9d1b4c9ff97814db813e331c493d433f41f6..8d27a46d7f775c71b8023d1774de96f6a6033115 100644 (file)
--- 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
@@ -56,6 +56,11 @@ type and event name conditions. Therefore, you cannot disable recording
 event rules having a specific instrumentation point log level condition,
 for example.
 
+With the option:--kernel option and no instrumentation point type
+condition option, the `disable-event` command disables one or more Linux
+kernel recording event rules regardless of their instrumentation point
+type.
+
 List the recording event rules of a given tracing session
 and/or channel with the man:lttng-list(1) command.
 
@@ -69,8 +74,10 @@ 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-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]
 
 
 Tracing domain
@@ -135,9 +142,6 @@ With the option:--kernel or option:--userspace option:::
 With the option:--jul, option:--log4j, or option:--python option:::
     Logging events.
 --
-+
-As of LTTng{nbsp}{lttng_version}, this is the default instrumentation
-point type condition option, but this may change in the future.
 
 
 Event name condition
@@ -147,10 +151,57 @@ option:-a, option:--all-events::
     condition.
 
 
-include::common-cmd-help-options.txt[]
+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-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO