Document configuration
authorPhilipp Hagemeister <phihag@phihag.de>
Mon, 26 Nov 2012 22:24:55 +0000 (23:24 +0100)
committerPhilipp Hagemeister <phihag@phihag.de>
Mon, 26 Nov 2012 22:24:55 +0000 (23:24 +0100)
Makefile
README.md
youtube-dl.1

index 3746c08bd105dc3a81722cfbfbcaa6548ce26133..a0262153427aaab26c94bfceea0096c321bbf365 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -33,13 +33,13 @@ youtube-dl.exe: youtube_dl/*.py
 README.md: youtube_dl/*.py
        @options=$$(COLUMNS=80 python -m youtube_dl --help | sed -e '1,/.*General Options.*/ d' -e 's/^\W\{2\}\(\w\)/## \1/') && \
                header=$$(sed -e '/.*# OPTIONS/,$$ d' README.md) && \
-               footer=$$(sed -e '1,/.*# FAQ/ d' README.md) && \
+               footer=$$(sed -e '1,/.*# CONFIGURATION/ d' README.md) && \
                echo "$${header}" > README.md && \
                echo >> README.md && \
                echo '# OPTIONS' >> README.md && \
                echo "$${options}" >> README.md&& \
                echo >> README.md && \
-               echo '# FAQ' >> README.md && \
+               echo '# CONFIGURATION' >> README.md && \
                echo "$${footer}" >> README.md
 
 youtube-dl.1: README.md
index abd8a5ef10cbd3d02a10e0854886603668ef6394..9775c9b0446bcad932810be3ef661c553fef8e83 100644 (file)
--- a/README.md
+++ b/README.md
@@ -102,6 +102,10 @@ which means you can modify it, redistribute it or use it however you like.
     -k, --keep-video         keeps the video file on disk after the post-
                              processing; the video is erased by default
 
+# CONFIGURATION
+
+You can configure youtube-dl by placing default arguments (such as `--extract-audio --no-mtime` to always extract the audio and not copy the mtime) into `/etc/youtube-dl.conf` and/or `~/.local/config/youtube-dl.conf`.
+
 # FAQ
 
 ### Can you please put the -b option back?
index 963bc8d68f5e5cb203c5c0c8dd4b269e92442f00..17fa16d522aa4953ae0ac94bb253f4b74ca24c83 100644 (file)
@@ -131,6 +131,12 @@ redistribute it or use it however you like.
 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ processing;\ the\ video\ is\ erased\ by\ default
 \f[]
 .fi
+.SH CONFIGURATION
+.PP
+You can configure youtube-dl by placing default arguments (such as
+\f[C]--extract-audio\ --no-mtime\f[] to always extract the audio and not
+copy the mtime) into \f[C]/etc/youtube-dl.conf\f[] and/or
+\f[C]~/.local/config/youtube-dl.conf\f[].
 .SH FAQ
 .SS Can you please put the -b option back?
 .PP