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