doc/man: use double quotes when referring to internal section

[lttng-tools.git] / doc / man / lttng-remove-trigger.1.txt

diff --git a/doc/man/lttng-remove-trigger.1.txt b/doc/man/lttng-remove-trigger.1.txt
index e51fd10d0b7ad7cc8724f4e6d4373ef4e0321273..6bec8c55519713d4747a2c9fdd3af150734213d2 100644 (file)
--- a/doc/man/lttng-remove-trigger.1.txt
+++ b/doc/man/lttng-remove-trigger.1.txt
@@ -1,6 +1,6 @@
 lttng-remove-trigger(1)
 =======================
-:revdate: 5 March 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -18,15 +18,17 @@ DESCRIPTION
 -----------
 The `lttng remove-trigger` command removes the trigger named 'NAME'.
 
-See man:lttng-add-trigger(1) to learn more about LTTng triggers.
+See man:lttng-concepts(7) to learn more about LTTng triggers.
 
-List the available triggers and their name with the
-man:lttng-list-triggers(1) command.
+List the triggers of your Unix user, or of all users if your
+Unix user is `root`, with the man:lttng-list-triggers(1) command.
 
 The `remove-trigger` command removes a trigger which belong to your Unix
 user. If your Unix user is `root`, you can remove the trigger of another
 user with the option:--owner-uid option.
 
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
+
 
 OPTIONS
 -------
@@ -39,14 +41,43 @@ option:--owner-uid='UID'::
 You may only use this option if your Unix user is `root`.
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]
+
+
+include::common-lttng-cmd-after-options.txt[]
+
+
+[[examples]]
+EXAMPLES
+--------
+.Remove a trigger.
+====
+[role="term"]
+----
+$ lttng remove-trigger my-trigger
+----
+====
+
+.Remove a trigger as another Unix user.
+====
+The command line below removes a trigger as the `mireille` Unix user.
+
+Your Unix user must be `root` to use the option:--owner-uid option.
+
+[role="term"]
+----
+$ lttng remove-trigger --owner-uid=$(id --user mireille) \
+                       my-trigger
+----
+====
 
 
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO
 --------
+man:lttng(1),
 man:lttng-add-trigger(1),
 man:lttng-list-triggers(1),
-man:lttng(1)
+man:lttng-concepts(7)