Explain how Windows batch newline variable hack works

The trick uses the behaviour of the caret.
Also explained at Long commands split over multiple lines in Windows Vista batch (.bat) file

The caret is an escape character for the next character, or at the line end it is used as multiline character, but this is nearly the same.

At the line end it simply escapes the next character, in this case the <Linefeed>, but there is a hidden feature, so if the escaped character is a <LF> it is ignored and the next character is read and escaped, but this charater will be always escaped, even if it is also a <LF>.

Now you can understand

set NLM=^


rem Two empty lines are required here

The NLM-Variable contains exactly one <LF> character.
But if you try to use it with echo Line1%NLM%Line2 it fails, as the parser stops parsing at a single <LF>.
But this works

echo Line1^

Line2

So you need to add an escaped linefeed into the line and that is the NL-Variable.
The NL-Variable consists of only three characters.
NL=^<LF><LF>
And if this is expanded, it creates only one escaped <LF> as the first <LF> after the caret will be ignored.

Btw. In my opinion, it is much easier to use linefeeds with delayed expansion, as there is no need to escape anything.
In this example I use %=EMPTY=% instead of an empty line (for self commenting), but as the variable =EMPTY= can’t exists it will be expanded to an empty line.

setlocal EnableDelayedExpansion
(set NLM=^
%=EMPTY=%
)
echo Line1!NLM!Line2

EDIT: Append some hints for useful using the <LF>

1) Use it as newline in an echo

setlocal EnableDelayedExpansion
(set LF=^
%=EMPTY=%
)
echo Line1!LF!Line2

2) Use it to split commands in a parenthesis block

setlocal EnableDelayedExpansion
(set LF=^
%=EMPTY=%
)
(
    echo Line1%LF%set x=4%LF%echo !x!%LF%
)

3) Create a (nearly) empty EOL-chararcter in a FOR /F loop,
as <LF> is the line delimiter an EOL of <LF> is the same than an empty one.

FOR /F ^"eol^=^

delims^=^" %%a in (myFile.php) do echo %%a

4) Use LF for splitting text in a FOR /F loop

setlocal EnableDelayedExpansion
(set LF=^
%=EMPTY=%
)
set "var=Content1;Content2"
FOR /F "delims=" %%a in ("%var:;=!LF!%") do (
  echo %%a
)

Related Contents:

  1. How to read a text file line by line and modify every line using a batch file?
  2. What are the undocumented features and limitations of the Windows FINDSTR command?
  3. What are the ERRORLEVEL values set by internal cmd.exe commands?
  4. Ignore percent sign in batch file
  5. How to call a batch file that is one level up from the current directory?
  6. Defining and using a variable in batch file
  7. Why are other folder paths also added to system PATH with SetX and not only the specified folder path?
  8. What does %~dp0 mean, and how does it work?
  9. Displaying Windows command prompt output and redirecting it to a file
  10. Why doesn’t this FINDSTR example with multiple literal search strings find a match?
  11. How Should I Set Default Python Version In Windows?
  12. Windows Bat file optional argument parsing
  13. What must be taken into account on executing a batch file as scheduled task?
  14. How to create empty text file from a batch file?
  15. Adding the current directory to Windows path permanently
  16. How do I make a batch file terminate upon encountering an error?
  17. How do you loop in a Windows batch file?
  18. What is the current directory in a batch file?
  19. Batch script to find and replace a string in text file without creating an extra output file for storing the modified file
  20. BATCH file asks for file or folder [duplicate]
  21. How to run multiple DOS commands in parallel?
  22. How to search and replace a string in environment variable PATH?
  23. creating a shortcut for a exe from a batch file
  24. BAT file: Open new cmd window and execute a command in there
  25. How to use if – else structure in a batch file?
  26. How can I check the size of a file in a Windows batch script?
  27. What does “&&” do in this batch file?
  28. How to make .BAT file delete it self after completion?
  29. batch file – counting number of files in folder and storing in a variable
  30. Drag and drop batch file for multiple files?
  31. How to search and replace a string that have an equal-to sign “=” inside
  32. batch cmd exits as I enter the input with space
  33. ERRORLEVEL inside IF
  34. Why does the command XCOPY in batch file ask for file or folder?
  35. How to call a batch file that is one level up from the current batch file directory?
  36. How can a batch file run a program and set the position and size of the window?
  37. How to set PATH environment variable in batch file only once on Windows?
  38. Comparing two number in batch script
  39. Batch Files – Error Handling
  40. Batch / Find And Edit Lines in TXT file
  41. Waiting for parallel batch scripts
  42. Multiple choices menu on batch file?
  43. Batch file to copy files from one folder to another folder
  44. How to run a “.bat” file during installation?
  45. batch echo pipe symbol causing unexpected behaviour
  46. windows batch files: setting variable in for loop
  47. Command Prompt Error ‘C:\Program’ is not recognized as an internal or external command, operable program or batch file
  48. What’s the relative order with which Windows search for executable files in PATH?
  49. To “Call” or “Not to Call” a batch file?
  50. How can I move all the files from one folder to another using the command line?

Leave a Comment