doc/man: add notes about shell escaping

[lttng-tools.git] / doc / man / lttng-enable-event.1.txt

diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt
index 6a5bd17365f11e71b6be5a07eb175b52aa374bfe..f0755333c8f6ac510ae4b88d79211b4013a29c0b 100644 (file)
--- a/doc/man/lttng-enable-event.1.txt
+++ b/doc/man/lttng-enable-event.1.txt
@@ -181,6 +181,10 @@ when creating a new event rule. If the filter expression evaluates
 to true when executed against the dynamic values of an event's fields
 when tracing, the filtering condition passes.
 
+NOTE: Make sure to **single-quote** the filter expression when running
+the command from a shell, as filter expressions typically include
+characters having a special meaning for most shells.
+
 The filter expression syntax is very similar to C language conditional
 expressions (expressions that can be evaluated by an `if` statement).
 
@@ -230,7 +234,7 @@ expression evaluates to false (the event is discarded).
 C integer and floating point number constants are supported, as well as
 literal strings between double quotes (`"`). Literal strings can contain
 a wildcard character (`*`) at the end to match more than one string.
-This wildcard can be escaped using `\\*`.
+This wildcard can be escaped using :escwc:.
 
 LTTng-UST enumeration fields can be compared to integer values (fields
 or constants).