doc/man: use double quotes when referring to internal section
[lttng-tools.git] / doc / man / lttng-remove-trigger.1.txt
1 lttng-remove-trigger(1)
2 =======================
3 :revdate: 17 May 2021
4
5
6 NAME
7 ----
8 lttng-remove-trigger - Remove an LTTng trigger
9
10
11 SYNOPSIS
12 --------
13 [verse]
14 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *remove-trigger* [option:--owner-uid='UID'] 'NAME'
15
16
17 DESCRIPTION
18 -----------
19 The `lttng remove-trigger` command removes the trigger named 'NAME'.
20
21 See man:lttng-concepts(7) to learn more about LTTng triggers.
22
23 List the triggers of your Unix user, or of all users if your
24 Unix user is `root`, with the man:lttng-list-triggers(1) command.
25
26 The `remove-trigger` command removes a trigger which belong to your Unix
27 user. If your Unix user is `root`, you can remove the trigger of another
28 user with the option:--owner-uid option.
29
30 See the ``<<examples,EXAMPLES>>'' section below for usage examples.
31
32
33 OPTIONS
34 -------
35 Identification
36 ~~~~~~~~~~~~~~
37 option:--owner-uid='UID'::
38 Remove the trigger named 'NAME' of the Unix user having the user ID
39 'UID'.
40 +
41 You may only use this option if your Unix user is `root`.
42
43
44 include::common-lttng-cmd-help-options.txt[]
45
46
47 include::common-lttng-cmd-after-options.txt[]
48
49
50 [[examples]]
51 EXAMPLES
52 --------
53 .Remove a trigger.
54 ====
55 [role="term"]
56 ----
57 $ lttng remove-trigger my-trigger
58 ----
59 ====
60
61 .Remove a trigger as another Unix user.
62 ====
63 The command line below removes a trigger as the `mireille` Unix user.
64
65 Your Unix user must be `root` to use the option:--owner-uid option.
66
67 [role="term"]
68 ----
69 $ lttng remove-trigger --owner-uid=$(id --user mireille) \
70 my-trigger
71 ----
72 ====
73
74
75 include::common-footer.txt[]
76
77
78 SEE ALSO
79 --------
80 man:lttng(1),
81 man:lttng-add-trigger(1),
82 man:lttng-list-triggers(1),
83 man:lttng-concepts(7)
This page took 0.032059 seconds and 5 git commands to generate.