From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 17 May 2021 19:44:06 +0000 (-0400)
Subject: lttng-remove-trigger(1): add usage examples
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=b2094ef9a271eeb4dac76db39e1c98ed26097ded;p=lttng-tools.git

lttng-remove-trigger(1): add usage examples

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: Ic34f148f061999b90ad47df8efc5c1db2d07f762
---

diff --git a/doc/man/lttng-remove-trigger.1.txt b/doc/man/lttng-remove-trigger.1.txt
index 016b5271a..1f5285d2f 100644
--- 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: 29 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -27,6 +27,8 @@ 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
 -------
@@ -45,6 +47,31 @@ 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-footer.txt[]