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 d1b17c856326e2e710b782347dfe778f5206e88d..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.
 
 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).
 
 The filter expression syntax is very similar to C language conditional
 expressions (expressions that can be evaluated by an `if` statement).