doc/man: create lttng-disable-channel(1) and update/fix content
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Fri, 13 Nov 2015 18:43:22 +0000 (13:43 -0500)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 17 Mar 2016 22:04:22 +0000 (18:04 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
doc/man/Makefile.am
doc/man/lttng-disable-channel.1.txt [new file with mode: 0644]

index 05900493840a9801b4a962b9898d2bba98f7fa3b..c40c712811134296e10030078fc7ba3db150ffda 100644 (file)
@@ -18,7 +18,8 @@ MAN1_NAMES = \
        lttng-stop \
        lttng-version \
        lttng-view \
-       lttng-enable-channel
+       lttng-enable-channel \
+       lttng-disable-channel
 MAN3_NAMES =
 MAN8_NAMES =
 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
diff --git a/doc/man/lttng-disable-channel.1.txt b/doc/man/lttng-disable-channel.1.txt
new file mode 100644 (file)
index 0000000..2470c23
--- /dev/null
@@ -0,0 +1,62 @@
+lttng-disable-channel(1)
+=======================
+
+
+NAME
+----
+lttng-disable-channel - Disable LTTng channels
+
+
+SYNOPSIS
+--------
+[verse]
+*lttng* ['GENERAL OPTIONS'] *disable-channel* (option:--kernel | option:--userspace)
+      [option:--session='SESSION'] 'CHANNEL'[,'CHANNEL']...
+
+
+DESCRIPTION
+-----------
+The `lttng disable-channel` command disables one or more channels
+previously enabled by the linklttng:lttng-enable-channel(1) command.
+
+A channel is always contained in a tracing session
+(see linklttng: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.
+
+Note that re-enabling a disabled channel once its tracing session
+has been active at least once is currently not supported.
+
+
+include::common-cmd-options-head.txt[]
+
+
+Domain
+~~~~~~
+One of:
+
+option:-k, option:--kernel::
+    Disable channel in the Linux kernel domain.
+
+option:-u, option:--userspace::
+    Disable channel in the user space domain.
+
+
+Target
+~~~~~~
+option:-s, option:--session='SESSION'::
+    Disable channels in the tracing session named 'SESSION'
+    instead of the current tracing session.
+
+
+include::common-cmd-help-options.txt[]
+
+
+include::common-cmd-footer.txt[]
+
+
+SEE ALSO
+--------
+linklttng:lttng-disable-channel(1),
+linklttng:lttng(1)
This page took 0.034337 seconds and 4 git commands to generate.