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

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

diff --git a/doc/man/lttng-add-trigger.1.txt b/doc/man/lttng-add-trigger.1.txt
index d111c43b9f3f7991117ed2fec83bdf71780c81ea..092163cfceec78d397df2c261870fc59899b6a12 100644 (file)
--- a/doc/man/lttng-add-trigger.1.txt
+++ b/doc/man/lttng-add-trigger.1.txt
@@ -1,6 +1,6 @@
 lttng-add-trigger(1)
 ====================
-:revdate: 6 May 2021
+:revdate: 18 May 2021
 
 
 NAME
@@ -35,13 +35,13 @@ specifier>> and its actions with one or more <<action-spec,action
 specifiers>>. The order of the action specifiers is significant: LTTng
 attempts to execute the actions of a firing trigger in this order.
 
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
+
 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.
 
 Remove a trigger with the man:lttng-remove-trigger(1) command.
 
-See the <<examples,EXAMPLES>> section below for usage examples.
-
 
 [[cond-spec]]
 Condition specifier
@@ -71,11 +71,11 @@ See man:lttng-event-rule(7) to learn how to specify an event rule
 ('ERSPEC' part).
 +
 Capture event record and context fields with one or more
-nloption:--capture options (see the <<capture-descr,Capture descriptor>>
-section below to learn more). When an `event-rule-matches` condition
-with capture descriptors is satisfied, the captured field values are
-available in the evaluation object of the condition using the
-liblttng-ctl C{nbsp}API.
+nloption:--capture options (see the ``<<capture-descr,Capture
+descriptor>>'' section below to learn more). When an
+`event-rule-matches` condition with capture descriptors is satisfied,
+the captured field values are available in the evaluation object of the
+condition using the liblttng-ctl C{nbsp}API.
 +
 IMPORTANT: Make sure to **single-quote** 'CDESCR' when you run the
 `add-trigger` command from a shell, as capture descriptors can include
@@ -294,12 +294,14 @@ Specifier
 option:--condition='CONDTYPE'::
     Introductory option for a condition specifier of type 'CONDTYPE'.
 +
-See the <<cond-spec,Condition specifier>> section above to learn more.
+See the ``<<cond-spec,Condition specifier>>'' section above to learn
+more.
 
 option:--action='ACTTYPE'::
     Introductory option for an action specifier of type 'ACTTYPE'.
 +
-See the <<action-spec,Action specifier>> section above to learn more.
+See the ``<<action-spec,Action specifier>>'' section above to learn
+more.
 
 
 include::common-lttng-cmd-help-options.txt[]
@@ -320,7 +322,7 @@ with `exec`.
 [role="term"]
 ----
 $ lttng add-trigger --condition=event-rule-matches \
-                    --domain=kernel --type=syscall:entry \
+                    --type=syscall:entry \
                     --name='exec*' --action=notify
 ----
 ====
@@ -336,7 +338,7 @@ The order of the option:--action options below is significant.
 [role="term"]
 ----
 $ lttng add-trigger --condition=event-rule-matches \
-                    --domain=user --name='my_app:*' \
+                    --type=user --name='my_app:*' \
                     --log-level=TRACE_WARNING.. \
                     --action=stop-session my-session \
                     --action=rotate-session my-session
@@ -361,7 +363,7 @@ See the option:--name option.
 ----
 $ lttng add-trigger --name=my-trigger \
                     --condition=event-rule-matches \
-                    --domain=python --name=my-logger \
+                    --type=python --name=my-logger \
                     --action=snapshot-session my-session
 ----
 ====
@@ -379,7 +381,7 @@ kernel tracepoint events with a name which starts with `sched`.
 ----
 # lttng add-trigger --owner-uid=$(id --user mireille) \
                     --condition=event-rule-matches \
-                    --domain=kernel --name='sched*' \
+                    --type=kernel --name='sched*' \
                     --action=notify
 ----
 ====
@@ -394,7 +396,7 @@ See the nloption:--rate-policy option above.
 [role="term"]
 ----
 $ lttng add-trigger --condition=event-rule-matches \
-                    --domain=user --action=notify \
+                    --type=user --action=notify \
                     --rate-policy=every:10
 ----
 ====
@@ -410,8 +412,7 @@ See the nloption:--rate-policy option above.
 [role="term"]
 ----
 $ lttng add-trigger --condition=event-rule-matches \
-                    --domain=kernel --type=syscall \
-                    --filter='fd < 3' \
+                    --type=syscall --filter='fd < 3' \
                     --action=start-session my-session \
                     --rate-policy=once-after:40
 ----