]> git.bitcoin.ninja Git - youtube-dl/commitdiff
[README.md] Add comments in sample configuration for clarity
authorSergey M․ <dstftw@gmail.com>
Thu, 25 Aug 2016 11:27:15 +0000 (18:27 +0700)
committerSergey M․ <dstftw@gmail.com>
Thu, 25 Aug 2016 11:27:15 +0000 (18:27 +0700)
README.md

index 04f423c17cbfdaed532943ed00a1ecb1bc7310b4..e01b71cff5290fbf4f50fadaa99a01d71813aa4a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -412,11 +412,19 @@ You can configure youtube-dl by placing any supported command line option to a c
 
 For example, with the following configuration file youtube-dl will always extract the audio, not copy the mtime, use a proxy and save all videos under `Movies` directory in your home directory:
 ```
+# Lines starting with # are comments
+
+# Always extract audio
 -x
+
+# Do not copy the mtime
 --no-mtime
+
+# Use this proxy
 --proxy 127.0.0.1:3128
+
+# Save all videos under Movies directory in your home directory
 -o ~/Movies/%(title)s.%(ext)s
-# Lines starting with # are comments
 ```
 
 Note that options in configuration file are just the same options aka switches used in regular command line calls thus there **must be no whitespace** after `-` or `--`, e.g. `-o` or `--proxy` but not `- o` or `-- proxy`.