doc/man: use double quotes when referring to internal section
[lttng-tools.git] / doc / man / lttng-disable-channel.1.txt
CommitLineData
4bf0a332 1lttng-disable-channel(1)
4605890e 2========================
efee6ee0 3:revdate: 17 May 2021
4bf0a332
PP
4
5NAME
6----
7lttng-disable-channel - Disable LTTng channels
8
9
10SYNOPSIS
11--------
12[verse]
ce19b9ed 13*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-channel* (option:--kernel | option:--userspace)
4bf0a332
PP
14 [option:--session='SESSION'] 'CHANNEL'[,'CHANNEL']...
15
16
17DESCRIPTION
18-----------
19The `lttng disable-channel` command disables one or more channels
26f0c779
PP
20previously enabled with the man:lttng-enable-channel(1) command
21which belong to:
4bf0a332 22
26f0c779
PP
23With the option:--session='SESSION' option::
24 The tracing session named 'SESSION'.
25
26Without the option:--session option::
27 The current tracing session (see man:lttng-concepts(7) to learn more
28 about the current tracing session).
29
30See man:lttng-concepts(7) to learn more about channels.
4bf0a332 31
484b2a0c
PP
32The `disable-channel` command disables one channel per 'CHANNEL'
33argument.
34
35As of LTTng{nbsp}{lttng_version}, you may :not: enable a disabled
b0c1a0c7 36channel once its tracing session has been started (see
484b2a0c 37man:lttng-start(1)) at least once.
4bf0a332 38
da39b67c 39See the ``<<examples,EXAMPLES>>'' section below for usage examples.
efee6ee0 40
4bf0a332 41
f5511eea 42include::common-lttng-cmd-options-head.txt[]
4bf0a332
PP
43
44
484b2a0c
PP
45Tracing domain
46~~~~~~~~~~~~~~
4bf0a332
PP
47One of:
48
49option:-k, option:--kernel::
484b2a0c 50 Disable one or more Linux kernel channels.
4bf0a332
PP
51
52option:-u, option:--userspace::
484b2a0c 53 Disable one or more user space channels.
4bf0a332
PP
54
55
26f0c779
PP
56Recording target
57~~~~~~~~~~~~~~~~
59b19c3c 58option:-s 'SESSION', option:--session='SESSION'::
484b2a0c 59 Disable one or more channels of the tracing session named 'SESSION'
4bf0a332
PP
60 instead of the current tracing session.
61
62
f5511eea 63include::common-lttng-cmd-help-options.txt[]
4bf0a332
PP
64
65
f5511eea
PP
66include::common-lttng-cmd-after-options.txt[]
67
68
efee6ee0
PP
69[[examples]]
70EXAMPLES
71--------
72.Disable one Linux kernel channel of the current tracing session.
73====
74[role="term"]
75----
76$ lttng disable-channel --kernel my-channel
77----
78====
79
80.Disable two user space channels of a specific tracing session.
81====
82See the option:--session option.
83
84[role="term"]
85----
86$ lttng disable-channel --kernel --session=my-session \
87 little,box
88----
89====
90
91
f5511eea 92include::common-footer.txt[]
4bf0a332
PP
93
94
95SEE ALSO
96--------
484b2a0c 97man:lttng(1),
af1c4164
PP
98man:lttng-enable-channel(1),
99man:lttng-concepts(7)
This page took 0.035775 seconds and 4 git commands to generate.