Rename "tracing session" -> "recording session"

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

lttng-disable-channel(1)
========================
:revdate: 14 June 2021


NAME
----
lttng-disable-channel - Disable LTTng channels


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(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 with the man:lttng-enable-channel(1) command
which belong to:

With the option:--session='SESSION' option::
    The recording session named 'SESSION'.

Without the option:--session option::
    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.

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 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[]


Tracing domain
~~~~~~~~~~~~~~
One of:

option:-k, option:--kernel::
    Disable one or more Linux kernel channels.

option:-u, option:--userspace::
    Disable one or more user space channels.


Recording target
~~~~~~~~~~~~~~~~
option:-s 'SESSION', option:--session='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[]


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[]


SEE ALSO
--------
man:lttng(1),
man:lttng-enable-channel(1),
man:lttng-concepts(7)