doc/man: put short option's argument too
[lttng-tools.git] / doc / man / lttng-disable-event.1.txt
CommitLineData
290294e8
PP
1lttng-disable-event(1)
2======================
3
4
5NAME
6----
7lttng-disable-event - Disable LTTng event rules
8
9
10SYNOPSIS
11--------
12[verse]
ce19b9ed 13*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-event*
290294e8
PP
14 (option:--kernel [option:--probe | option:--function | option:--syscall] |
15 option:--userspace | option:--jul | option:--log4j | option:--python)
16 [option:--session='SESSION'] [option:--channel='CHANNEL']
17 (option:--all-events | 'EVENT'[,'EVENT']...)
18
19DESCRIPTION
20-----------
21The `lttng disable-event` command disables one or more event rules
7c1a4458 22previously enabled by the man:lttng-enable-event(1) command.
290294e8
PP
23
24Event rules are always assigned to a channel when they are created. If
25the option:--channel option is omitted, the default channel named
26`channel0` is used.
27
28If the option:--session option is omitted, the chosen channel is picked
29from the current tracing session.
30
31If the option:--all-events option is used, all the existing event rules
32of the chosen domain are disabled. Otherwise, at least one event rule
33to disable named 'EVENT' must be specified.
34
35With the option:--kernel option, the event source type can be specified
36using one of the option:--tracepoint, option:--probe,
37option:--function, or option:--syscall options. See
7c1a4458 38man:lttng-enable-event(1) for more details about event source
290294e8
PP
39types.
40
41Events can be disabled while tracing is active
7c1a4458 42(use man:lttng-start(1) to make a tracing session active).
290294e8
PP
43
44
45include::common-cmd-options-head.txt[]
46
47
48Domain
49~~~~~~
50One of:
51
52option:-j, option:--jul::
53 Disable event rules in the `java.util.logging` (JUL) domain.
54
55option:-k, option:--kernel::
56 Disable event rules in the Linux kernel domain.
57
58option:-l, option:--log4j::
59 Disable event rules in the Apache log4j domain.
60
61option:-p, option:--python::
62 Disable event rules in the Python domain.
63
64option:-u, option:--userspace::
65 Disable event rules in the user space domain.
66
67
68Target
69~~~~~~
59b19c3c 70option:-c 'CHANNEL', option:--channel='CHANNEL'::
290294e8
PP
71 Disable event rules in the channel named 'CHANNEL' instead
72 of the default channel name `channel0`.
73
59b19c3c 74option:-s 'SESSION', option:--session='SESSION'::
290294e8
PP
75 Disable event rules in the tracing session named 'SESSION'
76 instead of the current tracing session.
77
78
79Event source type
80~~~~~~~~~~~~~~~~~
81One of:
82
83option:--function::
84 Linux kernel kretprobe. Only available with the option:--kernel
85 domain option.
86
87option:--probe::
88 Linux kernel kprobe. Only available with the option:--kernel
89 domain option.
90
91option:--syscall::
92 Linux kernel system call. Only available with the option:--kernel
93 domain option.
94
95option:--tracepoint::
96 Linux kernel or application tracepoint. Only available
97 with the option:--kernel domain option (default Linux kernel
98 domain event source type).
99
100
101Disabling
102~~~~~~~~~
103option:-a, option:--all-events::
104 Disable all enabled event rules in the chosen tracing session,
105 tracing domain, and channel.
106
107include::common-cmd-help-options.txt[]
108
109
110include::common-cmd-footer.txt[]
111
112
113SEE ALSO
114--------
7c1a4458
PP
115man:lttng-enable-event(1),
116man:lttng(1)
This page took 0.031709 seconds and 4 git commands to generate.