Batch character escaping
As dbhenham points out in this comment, a (MUCH) more detailed answer can be found in portions of this answer (originally by another user jeb and significantly edited and updated by dbhenham since) on a related but much more general question:
- parsing - How does the Windows Command Interpreter (CMD.EXE) parse scripts? - Stack Overflow
Note that, per dbhenham, this answer is:
incorrect, misleading, and incomplete
I think this answer is still good enough, for almost all cases, but a careful reading of the above answer might be warranted depending on one's exact character escaping needs and the limitations of this answer.
The remaining has been adapted with permission of the author from the page Batch files - Escape Characters on Rob van der Woude's Scripting Pages site.
TLDR
Windows (and DOS) batch file character escaping is complicated:
Much like the universe, if anyone ever does fully come to understand Batch then the language will instantly be replaced by an infinitely weirder and more complex version of itself. This has obviously happened at least once before ;)
Percent Sign %
%
can be escaped as %%
– "May not always be required [to be escaped] in doublequoted strings, just try"
Generally, Use a Caret ^
These characters "may not always be required [to be escaped] in doublequoted strings, but it won't hurt":
^
&
<
>
|
Example: echo a ^> b
to print a > b
on screen
'
is "required [to be escaped] only in the FOR /F
"subject" (i.e. between the parenthesis), unless backq
is used"
`
is "required [to be escaped] only in the FOR /F
"subject" (i.e. between the parenthesis), if backq
is used"
These characters are "required [to be escaped] only in the FOR /F
"subject" (i.e. between the parenthesis), even in doublequoted strings":
,
;
=
(
)
Double Escape Exclamation Points when Using Delayed Variable Expansion
!
must be escaped ^^!
when delayed variable expansion is active.
Double Double-Quotes in find
Search Patterns
"
→ ""
Use a Backslash in findstr
Regex Patterns
\
[
]
"
.
*
?
Also
Rob commented further on this question (via email correspondence with myself):
As for the answer, I'm afraid the chaos is even worse than the original poster realizes: requirements for escaping parentheses also depend on the string being inside a code block or not!
I guess an automated tool could just insert a caret before every character, then doubling all percent signs - and it would still fail if the string is doublequoted!
Further, individual programs are responsible for parsing their command line arguments so some of the escaping required for, e.g. for sed
or ssed
, may be due to the specific programs called in the batch scripts.
The escape character for batch is the caret (^
). If you want to include any of the pipeline characters in your script you need to prefix the character with the caret:
:: Won't work:
@echo Syntax: MyCommand > [file]
:: Will work:
@echo Syntax: MyCommand ^> [file]