doc/man: add notes about shell escaping

[lttng-tools.git] / doc / man / lttng-add-context.1.txt

diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt
index 4f133b80e03a478f838d6f36b845d55e1f9f7b92..529a7da26478f15891d002c29e666ad29b7bbd48 100644 (file)
--- a/doc/man/lttng-add-context.1.txt
+++ b/doc/man/lttng-add-context.1.txt
@@ -20,7 +20,7 @@ Add context fields to a channel:
 List the available context fields:
 
 [verse]
-*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *add-context* --list
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *add-context* option:--list
 
 
 DESCRIPTION
@@ -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.