doc/man: add notes about shell escaping

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

diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt
index c7f8d3d6848f11264a0f9b0176efcd6042a7b415..529a7da26478f15891d002c29e666ad29b7bbd48 100644 (file)
--- a/doc/man/lttng-add-context.1.txt
+++ b/doc/man/lttng-add-context.1.txt
@@ -59,6 +59,10 @@ with:
 'TYPE'::
     Context type name.
 
 'TYPE'::
     Context type name.
 

+NOTE: Make sure to **single-quote** the type when running the command
+from a shell, as `$` is a special character for variable substitution in
+most shells.
+

 Use the option:--list option without other arguments to list the
 available context field names.
 
 Use the option:--list option without other arguments to list the
 available context field names.
 

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).