From df4bad32454164552716da994f9a578178d918fd Mon Sep 17 00:00:00 2001 From: Philipp Hagemeister Date: Mon, 26 Nov 2012 23:24:55 +0100 Subject: [PATCH] Document configuration --- Makefile | 4 ++-- README.md | 4 ++++ youtube-dl.1 | 6 ++++++ 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 3746c08bd1..a026215342 100644 --- 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 diff --git a/README.md b/README.md index abd8a5ef10..9775c9b044 100644 --- 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? diff --git a/youtube-dl.1 b/youtube-dl.1 index 963bc8d68f..17fa16d522 100644 --- a/youtube-dl.1 +++ b/youtube-dl.1 @@ -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