[README.md] Document using output template in batch files (Closes #9717)
authorSergey M․ <dstftw@gmail.com>
Sat, 11 Jun 2016 23:39:31 +0000 (06:39 +0700)
committerSergey M․ <dstftw@gmail.com>
Sat, 11 Jun 2016 23:39:31 +0000 (06:39 +0700)
README.md

index 3ff33c1567e8cdef3f33160160accea54433a07c..43e5114ea13169a82aeeb067a0330d186e662974 100644 (file)
--- a/README.md
+++ b/README.md
@@ -553,6 +553,10 @@ The current default template is `%(title)s-%(id)s.%(ext)s`.
 
 In some cases, you don't want special characters such as 中, spaces, or &, such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the `--restrict-filenames` flag to get a shorter title:
 
+#### Output template and Windows batch files
+
+If you are using output template inside a Windows batch file then you must escape plain percent characters (`%`) by doubling, so that `-o "%(title)s-%(id)s.%(ext)s"` should become `-o "%%(title)s-%%(id)s.%%(ext)s"`. However you should not touch `%`'s that are not plain characters, e.g. environment variables for expansion should stay intact: `-o "C:\%HOMEPATH%\Desktop\%%(title)s.%%(ext)s"`.
+
 #### Output template examples
 
 Note on Windows you may need to use double quotes instead of single.