From: Philippe Proulx Date: Sat, 19 Mar 2016 01:35:07 +0000 (-0400) Subject: doc/man: add notes about shell escaping X-Git-Tag: v2.9.0-rc1~328 X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=60f7980c81806587206b495626d3cdc3ac170c6b doc/man: add notes about shell escaping Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt index 26df16d2b..c201fa6a6 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 4d88bdb1b..f33507cec 100644 --- a/doc/man/lttng-enable-event.1.txt +++ b/doc/man/lttng-enable-event.1.txt @@ -180,6 +180,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).