summaryrefslogtreecommitdiff
path: root/network/youtube-dl/youtube-dl.1
diff options
context:
space:
mode:
Diffstat (limited to 'network/youtube-dl/youtube-dl.1')
-rw-r--r--network/youtube-dl/youtube-dl.135
1 files changed, 26 insertions, 9 deletions
diff --git a/network/youtube-dl/youtube-dl.1 b/network/youtube-dl/youtube-dl.1
index b27ad810f0..92af385317 100644
--- a/network/youtube-dl/youtube-dl.1
+++ b/network/youtube-dl/youtube-dl.1
@@ -92,7 +92,7 @@ redistribute it or use it however you like.
\-\-playlist\-reverse\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Download\ playlist\ videos\ in\ reverse\ order
\-\-xattr\-set\-filesize\ \ \ \ \ \ \ \ \ \ \ \ \ Set\ file\ xattribute\ ytdl.filesize\ with\ expected\ filesize\ (experimental)
\-\-hls\-prefer\-native\ \ \ \ \ \ \ \ \ \ \ \ \ \ Use\ the\ native\ HLS\ downloader\ instead\ of\ ffmpeg\ (experimental)
-\-\-external\-downloader\ COMMAND\ \ \ \ Use\ the\ specified\ external\ downloader.\ Currently\ supports\ aria2c,curl,httpie,wget
+\-\-external\-downloader\ COMMAND\ \ \ \ Use\ the\ specified\ external\ downloader.\ Currently\ supports\ aria2c,axel,curl,httpie,wget
\-\-external\-downloader\-args\ ARGS\ \ Give\ these\ arguments\ to\ the\ external\ downloader
\f[]
.fi
@@ -253,13 +253,27 @@ redistribute it or use it however you like.
.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
+You can configure youtube\-dl by placing any supported command line
+option to a configuration file.
+On Linux, system wide configuration file is located at
+\f[C]/etc/youtube\-dl.conf\f[] and user wide configuration file at
\f[C]~/.config/youtube\-dl/config\f[].
-On Windows, the configuration file locations are
-\f[C]%APPDATA%\\youtube\-dl\\config.txt\f[] and
+On Windows, the user wide configuration file locations are
+\f[C]%APPDATA%\\youtube\-dl\\config.txt\f[] or
\f[C]C:\\Users\\<user\ name>\\youtube\-dl.conf\f[].
+For example, with the following configration file youtube\-dl will
+always extract the audio, not copy the mtime and use proxy:
+.IP
+.nf
+\f[C]
+\-\-extract\-audio
+\-\-no\-mtime
+\-\-proxy\ 127.0.0.1:3128
+\f[]
+.fi
+.PP
+You can use \f[C]\-\-ignore\-config\f[] if you want to disable
+configuration file for a particular youtube\-dl run.
.SS Authentication with \f[C]\&.netrc\f[] file
.PP
You may also want to configure automatic credentials storage for
@@ -344,6 +358,9 @@ video.
.IP \[bu] 2
\f[C]playlist_index\f[]: The index of the video in the playlist, a
five\-digit number.
+.IP \[bu] 2
+\f[C]format_id\f[]: The sequence will be replaced by the format code
+specified by \f[C]\-\-format\f[].
.PP
The current default template is \f[C]%(title)s\-%(id)s.%(ext)s\f[].
.PP
@@ -896,8 +913,8 @@ The tests will be then be named
Have a look at
\f[C]youtube_dl/common/extractor/common.py\f[] (https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py)
for possible helper methods and a detailed description of what your
-extractor should
-return (https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L38).
+extractor should and may
+return (https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L62-L200).
Add tests and code for as many as you want.
.IP " 8." 4
If you can, check the code with
@@ -946,7 +963,7 @@ with\ youtube_dl.YoutubeDL(ydl_opts)\ as\ ydl:
.PP
Most likely, you\[aq]ll want to use various options.
For a list of what can be done, have a look at
-youtube_dl/YoutubeDL.py (https://github.com/rg3/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L69).
+youtube_dl/YoutubeDL.py (https://github.com/rg3/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L117-L265).
For a start, if you want to intercept youtube\-dl\[aq]s output, set a
\f[C]logger\f[] object.
.PP