aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSergey M․ <dstftw@gmail.com>2016-08-25 18:27:15 +0700
committerSergey M․ <dstftw@gmail.com>2016-08-25 18:27:15 +0700
commit4c8f9c2577da2f4ba7300d44613599e96cde5c9f (patch)
tree614ff8db99fc7ea423bfe6d162e5e8a71c9752dd /README.md
parentf26a298247fe19bc8114d6f7a280140dfabee984 (diff)
downloadyoutube-dl-4c8f9c2577da2f4ba7300d44613599e96cde5c9f.zip
youtube-dl-4c8f9c2577da2f4ba7300d44613599e96cde5c9f.tar.gz
youtube-dl-4c8f9c2577da2f4ba7300d44613599e96cde5c9f.tar.bz2
[README.md] Add comments in sample configuration for clarity
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 04f423c..e01b71c 100644
--- 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`.