lttng-{enable,disable}-event(1): document default channel limitation

[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 9492a390391ab69ac856f115d2d30a1f4688ef56..b25ea3c286c42c917a19ae28b39c84ce8617223b 100644 (file)
--- a/doc/man/lttng-disable-channel.1.txt
+++ b/doc/man/lttng-disable-channel.1.txt
@@ -1,6 +1,6 @@
 lttng-disable-channel(1)
 ========================
-:revdate: 29 April 2021
+:revdate: 17 May 2021
 
 NAME
 ----
@@ -36,8 +36,10 @@ As of LTTng{nbsp}{lttng_version}, you may :not: enable a disabled
 channel once its tracing session has ben started (see
 man:lttng-start(1)) at least once.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
 
-include::common-cmd-options-head.txt[]
+
+include::common-lttng-cmd-options-head.txt[]
 
 
 Tracing domain
@@ -58,10 +60,36 @@ option:-s 'SESSION', option:--session='SESSION'::
     instead of the current tracing session.
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]
+
+
+include::common-lttng-cmd-after-options.txt[]
+
+
+[[examples]]
+EXAMPLES
+--------
+.Disable one Linux kernel channel of the current tracing session.
+====
+[role="term"]
+----
+$ lttng disable-channel --kernel my-channel
+----
+====
+
+.Disable two user space channels of a specific tracing session.
+====
+See the option:--session option.
+
+[role="term"]
+----
+$ lttng disable-channel --kernel --session=my-session \
+                        little,box
+----
+====
 
 
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO