lttng-disable-rotation(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 9719a631c1fa441bdbcd35b49f19901140a3caac..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: 21 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -33,7 +33,22 @@ DESCRIPTION
 -----------
 The `lttng disable-event` command disables one or more enabled recording
 event rules previously created with the man:lttng-enable-event(1)
-command.
+command which belong to:
+
+With the option:--session='SESSION' option::
+    The tracing session named 'SESSION'.
+
+Without the option:--session option::
+    The current tracing session (see man:lttng-concepts(7) to learn more
+    about the current tracing session).
+
+With the option:--channel='CHANNEL' option::
+    The channel named 'CHANNEL'.
+
+Without the option:--channel option::
+    The channel named `channel0`.
+
+See man:lttng-concepts(7) to learn more about recording event rules.
 
 As of LTTng{nbsp}{lttng_version}, the `disable-event` command can only
 find recording event rules to disable by their instrumentation point
@@ -41,7 +56,12 @@ type and event name conditions. Therefore, you cannot disable recording
 event rules having a specific instrumentation point log level condition,
 for example.
 
-List the existing recording event rules of a given tracing session
+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.
 
 Without the option:--all-events option, the `disable-event` command
@@ -50,20 +70,14 @@ exact event name condition pattern of the recording event rule to
 disable, as listed in the output of `lttng list` (see
 man:lttng-list(1)).
 
-Without the option:--channel option, the `disable-event` command selects
-the channel named `channel0`.
-
-Without the option:--session option, the `disable-event` command selects
-the current tracing session (see man:lttng-create(1) and
-man:lttng-set-session(1) to learn more about the current tracing
-session).
-
 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
@@ -128,26 +142,71 @@ 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
 ~~~~~~~~~~~~~~~~~~~~
 option:-a, option:--all-events::
     Disable recording event rules regardless of their event name
-    condition is.
+    condition.
+
+
+include::common-lttng-cmd-help-options.txt[]
 
 
-include::common-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
 --------
 man:lttng(1),
 man:lttng-enable-event(1),
-man:lttng-list(1)
+man:lttng-list(1),
+man:lttng-concepts(7)