From 628bf39597c1817f8c87aa5f3c674792890fb981 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Fri, 18 Mar 2016 21:35:07 -0400 Subject: [PATCH] doc/man: add notes about shell escaping MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- doc/man/lttng-add-context.1.txt | 4 ++++ doc/man/lttng-enable-event.1.txt | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt index c7f8d3d68..529a7da26 100644 --- 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. +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. diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt index d1b17c856..f0755333c 100644 --- 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). -- 2.34.1