doc/man: lttng(1) command pages: always include `common-footer.txt`
[lttng-tools.git] / doc / man / lttng-disable-channel.1.txt
index 1218739f3f3b521eb311610511f3717e0140d13e..7f86d6d189c230a884edac478b49e4bd9e95e8d0 100644 (file)
@@ -1,6 +1,6 @@
 lttng-disable-channel(1)
-=======================
-
+========================
+:revdate: 29 April 2021
 
 NAME
 ----
@@ -17,46 +17,58 @@ SYNOPSIS
 DESCRIPTION
 -----------
 The `lttng disable-channel` command disables one or more channels
-previously enabled by the man:lttng-enable-channel(1) command.
+previously enabled with the man:lttng-enable-channel(1) 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).
 
-A channel is always contained in a tracing session
-(see man:lttng-create(1) for creating a tracing session). The
-session in which a channel is disabled using `lttng disable-channel` can
-be specified using the option:--session option. If the option:--session
-option is omitted, the current tracing session is targeted.
+See man:lttng-concepts(7) to learn more about channels.
 
-Note that re-enabling a disabled channel once its tracing session
-has been active at least once is currently not supported.
+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
+man:lttng-start(1)) at least once.
 
-include::common-cmd-options-head.txt[]
 
+include::common-lttng-cmd-options-head.txt[]
 
-Domain
-~~~~~~
+
+Tracing domain
+~~~~~~~~~~~~~~
 One of:
 
 option:-k, option:--kernel::
-    Disable channel in the Linux kernel domain.
+    Disable one or more Linux kernel channels.
 
 option:-u, option:--userspace::
-    Disable channel in the user space domain.
+    Disable one or more user space channels.
 
 
-Target
-~~~~~~
-option:-s, option:--session='SESSION'::
-    Disable channels in the tracing session named 'SESSION'
+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.
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]
+
+
+include::common-lttng-cmd-after-options.txt[]
 
 
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO
 --------
-man:lttng-disable-channel(1),
-man:lttng(1)
+man:lttng(1),
+man:lttng-enable-channel(1),
+man:lttng-concepts(7)
This page took 0.024772 seconds and 4 git commands to generate.