docs: Give advice on dealing with quoting special characters
authorGeorge Dunlap <george.dunlap@eu.citrix.com>
Wed, 23 Apr 2014 13:19:43 +0000 (14:19 +0100)
committerIan Jackson <Ian.Jackson@eu.citrix.com>
Thu, 24 Apr 2014 15:22:14 +0000 (16:22 +0100)
commitf70cf6132e37e5e035895a06f8452a90d073c329
treecfd64fbd74f9f35100fa948b5511fa7e30d26c01
parent208ae82a265c065b7f39ca38b4ba25c14d2df0f0
docs: Give advice on dealing with quoting special characters

The man page mentions passing config snippets key=val in xl create.
Unfortunately, the config syntax contain characters which are
interpreted (and often discarded) by the shell before getting passed
in, resulting in a parsing error.

For example:

xl create hvm.cfg cpus="0-3"

The shell will eat the quotes and pass 'cpus=0-3' to xl, which won't
parse properly without the quotes.

Mention this in the man page, and recommend the use of single quotes, as well
as separating multiple arguments with a semicolon, thus:

xl create hvm.cfg 'cpus="0-3"; pci=["1.0","1.1"]'

Signed-off-by: George Dunlap <george.dunlap@eu.citrix.com>
Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>
docs/man/xl.pod.1