Rename "tracing session" -> "recording session"

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

diff --git a/doc/man/lttng-disable-channel.1.txt b/doc/man/lttng-disable-channel.1.txt
index 7f86d6d189c230a884edac478b49e4bd9e95e8d0..244e9c4b13474228107002dcd68ebfd1ca615243 100644 (file)
--- a/doc/man/lttng-disable-channel.1.txt
+++ b/doc/man/lttng-disable-channel.1.txt
@@ -1,6 +1,7 @@
 lttng-disable-channel(1)
 ========================
-:revdate: 29 April 2021
+:revdate: 14 June 2021
+
 
 NAME
 ----
@@ -21,11 +22,11 @@ previously enabled with the man:lttng-enable-channel(1) command
 which belong to:
 
 With the option:--session='SESSION' option::
-    The tracing session named 'SESSION'.
+    The recording 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).
+    The current recording session (see man:lttng-concepts(7) to learn
+    more about the current recording session).
 
 See man:lttng-concepts(7) to learn more about channels.
 
@@ -33,9 +34,11 @@ The `disable-channel` command disables one channel per 'CHANNEL'
 argument.
 
 As of LTTng{nbsp}{lttng_version}, you may :not: enable a disabled
-channel once its tracing session has ben started (see
+channel once its recording session has been started (see
 man:lttng-start(1)) at least once.
 
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
+
 
 include::common-lttng-cmd-options-head.txt[]
 
@@ -54,8 +57,8 @@ option:-u, option:--userspace::
 Recording target
 ~~~~~~~~~~~~~~~~
 option:-s 'SESSION', option:--session='SESSION'::
-    Disable one or more channels of the tracing session named 'SESSION'
-    instead of the current tracing session.
+    Disable one or more channels of the recording session named
+    'SESSION' instead of the current recording session.
 
 
 include::common-lttng-cmd-help-options.txt[]
@@ -64,6 +67,29 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Disable one Linux kernel channel of the current recording session.
+====
+[role="term"]
+----
+$ lttng disable-channel --kernel my-channel
+----
+====
+
+.Disable two user space channels of a specific recording session.
+====
+See the option:--session option.
+
+[role="term"]
+----
+$ lttng disable-channel --kernel --session=my-session \
+                        little,box
+----
+====
+
+
 include::common-footer.txt[]