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