From 4bf0a3323200d6a657c6b50953f7ee1aba74a09f Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Fri, 13 Nov 2015 13:43:22 -0500 Subject: [PATCH] doc/man: create lttng-disable-channel(1) and update/fix content MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- doc/man/Makefile.am | 3 +- doc/man/lttng-disable-channel.1.txt | 62 +++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 doc/man/lttng-disable-channel.1.txt diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 059004938..c40c71281 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -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 index 000000000..2470c2356 --- /dev/null +++ b/doc/man/lttng-disable-channel.1.txt @@ -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) -- 2.34.1