debian/control: Update list of supported sites.

[youtubedl] / README.txt

diff --git a/README.txt b/README.txt
index e40f1d4a8b309cc95c6a50ce859a28b0623b66f8..1a674b5c11a51fc5ffcf54189547eb85d399e002 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -9,6 +9,7 @@ youtube-dl - download videos from youtube.com or other video platforms
 -   VIDEO SELECTION
 -   FAQ
 -   DEVELOPER INSTRUCTIONS
 -   VIDEO SELECTION
 -   FAQ
 -   DEVELOPER INSTRUCTIONS

+-   EMBEDDING YOUTUBE-DL

 -   BUGS
 -   COPYRIGHT
 
 -   BUGS
 -   COPYRIGHT
 


@@ -38,10 +39,9 @@ You can also use pip:
 
     sudo pip install youtube-dl
 
 
     sudo pip install youtube-dl
 

-Alternatively, refer to the developer instructions below for how to
-check out and work with the git repository. For further options,
-including PGP signatures, see
-https://rg3.github.io/youtube-dl/download.html .
+Alternatively, refer to the developer instructions for how to check out
+and work with the git repository. For further options, including PGP
+signatures, see the youtube-dl Download Page.

 
 
 
 
 
 


@@ -64,106 +64,218 @@ OPTIONS
 
     -h, --help                       Print this help text and exit
     --version                        Print program version and exit
 
     -h, --help                       Print this help text and exit
     --version                        Print program version and exit

-    -U, --update                     Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)
-    -i, --ignore-errors              Continue on download errors, for example to skip unavailable videos in a playlist
-    --abort-on-error                 Abort downloading of further videos (in the playlist or the command line) if an error occurs
+    -U, --update                     Update this program to latest version. Make
+                                     sure that you have sufficient permissions
+                                     (run with sudo if needed)
+    -i, --ignore-errors              Continue on download errors, for example to
+                                     skip unavailable videos in a playlist
+    --abort-on-error                 Abort downloading of further videos (in the
+                                     playlist or the command line) if an error
+                                     occurs

     --dump-user-agent                Display the current browser identification
     --list-extractors                List all supported extractors
     --dump-user-agent                Display the current browser identification
     --list-extractors                List all supported extractors

-    --extractor-descriptions         Output descriptions of all supported extractors
-    --force-generic-extractor        Force extraction to use the generic extractor
-    --default-search PREFIX          Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for youtube-dl "large apple".
-                                     Use the value "auto" to let youtube-dl guess ("auto_warning" to emit a warning when guessing). "error" just throws an error. The
-                                     default value "fixup_error" repairs broken URLs, but emits an error if this is not possible instead of searching.
-    --ignore-config                  Do not read configuration files. When given in the global configuration file /etc/youtube-dl.conf: Do not read the user configuration
-                                     in ~/.config/youtube-dl/config (%APPDATA%/youtube-dl/config.txt on Windows)
-    --flat-playlist                  Do not extract the videos of a playlist, only list them.
+    --extractor-descriptions         Output descriptions of all supported
+                                     extractors
+    --force-generic-extractor        Force extraction to use the generic
+                                     extractor
+    --default-search PREFIX          Use this prefix for unqualified URLs. For
+                                     example "gvsearch2:" downloads two videos
+                                     from google videos for youtube-dl "large
+                                     apple". Use the value "auto" to let
+                                     youtube-dl guess ("auto_warning" to emit a
+                                     warning when guessing). "error" just throws
+                                     an error. The default value "fixup_error"
+                                     repairs broken URLs, but emits an error if
+                                     this is not possible instead of searching.
+    --ignore-config                  Do not read configuration files. When given
+                                     in the global configuration file /etc
+                                     /youtube-dl.conf: Do not read the user
+                                     configuration in ~/.config/youtube-
+                                     dl/config (%APPDATA%/youtube-dl/config.txt
+                                     on Windows)
+    --flat-playlist                  Do not extract the videos of a playlist,
+                                     only list them.

     --no-color                       Do not emit color codes in output
 
 
 Network Options:
 
     --no-color                       Do not emit color codes in output
 
 
 Network Options:
 

-    --proxy URL                      Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection
+    --proxy URL                      Use the specified HTTP/HTTPS proxy. Pass in
+                                     an empty string (--proxy "") for direct
+                                     connection

     --socket-timeout SECONDS         Time to wait before giving up, in seconds
     --socket-timeout SECONDS         Time to wait before giving up, in seconds

-    --source-address IP              Client-side IP address to bind to (experimental)
-    -4, --force-ipv4                 Make all connections via IPv4 (experimental)
-    -6, --force-ipv6                 Make all connections via IPv6 (experimental)
-    --cn-verification-proxy URL      Use this proxy to verify the IP address for some Chinese sites. The default proxy specified by --proxy (or none, if the options is
-                                     not present) is used for the actual downloading. (experimental)
+    --source-address IP              Client-side IP address to bind to
+                                     (experimental)
+    -4, --force-ipv4                 Make all connections via IPv4
+                                     (experimental)
+    -6, --force-ipv6                 Make all connections via IPv6
+                                     (experimental)
+    --cn-verification-proxy URL      Use this proxy to verify the IP address for
+                                     some Chinese sites. The default proxy
+                                     specified by --proxy (or none, if the
+                                     options is not present) is used for the
+                                     actual downloading. (experimental)

 
 
 Video Selection:
 
     --playlist-start NUMBER          Playlist video to start at (default is 1)
     --playlist-end NUMBER            Playlist video to end at (default is last)
 
 
 Video Selection:
 
     --playlist-start NUMBER          Playlist video to start at (default is 1)
     --playlist-end NUMBER            Playlist video to end at (default is last)

-    --playlist-items ITEM_SPEC       Playlist video items to download. Specify indices of the videos in the playlist separated by commas like: "--playlist-items 1,2,5,8"
-                                     if you want to download videos indexed 1, 2, 5, 8 in the playlist. You can specify range: "--playlist-items 1-3,7,10-13", it will
-                                     download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13.
-    --match-title REGEX              Download only matching titles (regex or caseless sub-string)
-    --reject-title REGEX             Skip download for matching titles (regex or caseless sub-string)
+    --playlist-items ITEM_SPEC       Playlist video items to download. Specify
+                                     indices of the videos in the playlist
+                                     separated by commas like: "--playlist-items
+                                     1,2,5,8" if you want to download videos
+                                     indexed 1, 2, 5, 8 in the playlist. You can
+                                     specify range: "--playlist-items
+                                     1-3,7,10-13", it will download the videos
+                                     at index 1, 2, 3, 7, 10, 11, 12 and 13.
+    --match-title REGEX              Download only matching titles (regex or
+                                     caseless sub-string)
+    --reject-title REGEX             Skip download for matching titles (regex or
+                                     caseless sub-string)

     --max-downloads NUMBER           Abort after downloading NUMBER files
     --max-downloads NUMBER           Abort after downloading NUMBER files

-    --min-filesize SIZE              Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)
-    --max-filesize SIZE              Do not download any videos larger than SIZE (e.g. 50k or 44.6m)
+    --min-filesize SIZE              Do not download any videos smaller than
+                                     SIZE (e.g. 50k or 44.6m)
+    --max-filesize SIZE              Do not download any videos larger than SIZE
+                                     (e.g. 50k or 44.6m)

     --date DATE                      Download only videos uploaded in this date
     --date DATE                      Download only videos uploaded in this date

-    --datebefore DATE                Download only videos uploaded on or before this date (i.e. inclusive)
-    --dateafter DATE                 Download only videos uploaded on or after this date (i.e. inclusive)
-    --min-views COUNT                Do not download any videos with less than COUNT views
-    --max-views COUNT                Do not download any videos with more than COUNT views
-    --match-filter FILTER            Generic video filter (experimental). Specify any key (see help for -o for a list of available keys) to match if the key is present,
-                                     !key to check if the key is not present,key > NUMBER (like "comment_count > 12", also works with >=, <, <=, !=, =) to compare against
-                                     a number, and & to require multiple matches. Values which are not known are excluded unless you put a question mark (?) after the
-                                     operator.For example, to only match videos that have been liked more than 100 times and disliked less than 50 times (or the dislike
-                                     functionality is not available at the given service), but who also have a description, use  --match-filter "like_count > 100 &
+    --datebefore DATE                Download only videos uploaded on or before
+                                     this date (i.e. inclusive)
+    --dateafter DATE                 Download only videos uploaded on or after
+                                     this date (i.e. inclusive)
+    --min-views COUNT                Do not download any videos with less than
+                                     COUNT views
+    --max-views COUNT                Do not download any videos with more than
+                                     COUNT views
+    --match-filter FILTER            Generic video filter (experimental).
+                                     Specify any key (see help for -o for a list
+                                     of available keys) to match if the key is
+                                     present, !key to check if the key is not
+                                     present,key > NUMBER (like "comment_count >
+                                     12", also works with >=, <, <=, !=, =) to
+                                     compare against a number, and & to require
+                                     multiple matches. Values which are not
+                                     known are excluded unless you put a
+                                     question mark (?) after the operator.For
+                                     example, to only match videos that have
+                                     been liked more than 100 times and disliked
+                                     less than 50 times (or the dislike
+                                     functionality is not available at the given
+                                     service), but who also have a description,
+                                     use --match-filter "like_count > 100 &

                                      dislike_count <? 50 & description" .
                                      dislike_count <? 50 & description" .

-    --no-playlist                    Download only the video, if the URL refers to a video and a playlist.
-    --yes-playlist                   Download the playlist, if the URL refers to a video and a playlist.
-    --age-limit YEARS                Download only videos suitable for the given age
-    --download-archive FILE          Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.
-    --include-ads                    Download advertisements as well (experimental)
+    --no-playlist                    Download only the video, if the URL refers
+                                     to a video and a playlist.
+    --yes-playlist                   Download the playlist, if the URL refers to
+                                     a video and a playlist.
+    --age-limit YEARS                Download only videos suitable for the given
+                                     age
+    --download-archive FILE          Download only videos not listed in the
+                                     archive file. Record the IDs of all
+                                     downloaded videos in it.
+    --include-ads                    Download advertisements as well
+                                     (experimental)

 
 
 Download Options:
 
 
 
 Download Options:
 

-    -r, --rate-limit LIMIT           Maximum download rate in bytes per second (e.g. 50K or 4.2M)
-    -R, --retries RETRIES            Number of retries (default is 10), or "infinite".
-    --buffer-size SIZE               Size of download buffer (e.g. 1024 or 16K) (default is 1024)
-    --no-resize-buffer               Do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.
+    -r, --rate-limit LIMIT           Maximum download rate in bytes per second
+                                     (e.g. 50K or 4.2M)
+    -R, --retries RETRIES            Number of retries (default is 10), or
+                                     "infinite".
+    --buffer-size SIZE               Size of download buffer (e.g. 1024 or 16K)
+                                     (default is 1024)
+    --no-resize-buffer               Do not automatically adjust the buffer
+                                     size. By default, the buffer size is
+                                     automatically resized from an initial value
+                                     of SIZE.

     --playlist-reverse               Download playlist videos in reverse order
     --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-args ARGS  Give these arguments to the external downloader
+    --xattr-set-filesize             Set file xattribute ytdl.filesize with
+                                     expected filesize (experimental)
+    --hls-prefer-native              Use the native HLS downloader instead of
+                                     ffmpeg (experimental)
+    --hls-use-mpegts                 Use the mpegts container for HLS videos,
+                                     allowing to play the video while
+                                     downloading (some players may not be able
+                                     to play it)
+    --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

 
 
 Filesystem Options:
 
 
 
 Filesystem Options:
 

-    -a, --batch-file FILE            File containing URLs to download ('-' for stdin)
+    -a, --batch-file FILE            File containing URLs to download ('-' for
+                                     stdin)

     --id                             Use only video ID in file name
     --id                             Use only video ID in file name

-    -o, --output TEMPLATE            Output filename template. Use %(title)s to get the title, %(uploader)s for the uploader name, %(uploader_id)s for the uploader
-                                     nickname if different, %(autonumber)s to get an automatically incremented number, %(ext)s for the filename extension, %(format)s for
-                                     the format description (like "22 - 1280x720" or "HD"), %(format_id)s for the unique id of the format (like YouTube's itags: "137"),
-                                     %(upload_date)s for the upload date (YYYYMMDD), %(extractor)s for the provider (youtube, metacafe, etc), %(id)s for the video id,
-                                     %(playlist_title)s, %(playlist_id)s, or %(playlist)s (=title if present, ID otherwise) for the playlist the video is in,
-                                     %(playlist_index)s for the position in the playlist. %(height)s and %(width)s for the width and height of the video format.
-                                     %(resolution)s for a textual description of the resolution of the video format. %% for a literal percent. Use - to output to stdout.
-                                     Can also be used to download to a different directory, for example with -o '/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s' .
-    --autonumber-size NUMBER         Specify the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given
-    --restrict-filenames             Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames
-    -A, --auto-number                [deprecated; use  -o "%(autonumber)s-%(title)s.%(ext)s" ] Number downloaded files starting from 00000
-    -t, --title                      [deprecated] Use title in file name (default)
+    -o, --output TEMPLATE            Output filename template. Use %(title)s to
+                                     get the title, %(uploader)s for the
+                                     uploader name, %(uploader_id)s for the
+                                     uploader nickname if different,
+                                     %(autonumber)s to get an automatically
+                                     incremented number, %(ext)s for the
+                                     filename extension, %(format)s for the
+                                     format description (like "22 - 1280x720" or
+                                     "HD"), %(format_id)s for the unique id of
+                                     the format (like YouTube's itags: "137"),
+                                     %(upload_date)s for the upload date
+                                     (YYYYMMDD), %(extractor)s for the provider
+                                     (youtube, metacafe, etc), %(id)s for the
+                                     video id, %(playlist_title)s,
+                                     %(playlist_id)s, or %(playlist)s (=title if
+                                     present, ID otherwise) for the playlist the
+                                     video is in, %(playlist_index)s for the
+                                     position in the playlist. %(height)s and
+                                     %(width)s for the width and height of the
+                                     video format. %(resolution)s for a textual
+                                     description of the resolution of the video
+                                     format. %% for a literal percent. Use - to
+                                     output to stdout. Can also be used to
+                                     download to a different directory, for
+                                     example with -o '/my/downloads/%(uploader)s
+                                     /%(title)s-%(id)s.%(ext)s' .
+    --autonumber-size NUMBER         Specify the number of digits in
+                                     %(autonumber)s when it is present in output
+                                     filename template or --auto-number option
+                                     is given
+    --restrict-filenames             Restrict filenames to only ASCII
+                                     characters, and avoid "&" and spaces in
+                                     filenames
+    -A, --auto-number                [deprecated; use -o
+                                     "%(autonumber)s-%(title)s.%(ext)s" ] Number
+                                     downloaded files starting from 00000
+    -t, --title                      [deprecated] Use title in file name
+                                     (default)

     -l, --literal                    [deprecated] Alias of --title
     -w, --no-overwrites              Do not overwrite files
     -l, --literal                    [deprecated] Alias of --title
     -w, --no-overwrites              Do not overwrite files

-    -c, --continue                   Force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.
-    --no-continue                    Do not resume partially downloaded files (restart from beginning)
-    --no-part                        Do not use .part files - write directly into output file
-    --no-mtime                       Do not use the Last-modified header to set the file modification time
-    --write-description              Write video description to a .description file
+    -c, --continue                   Force resume of partially downloaded files.
+                                     By default, youtube-dl will resume
+                                     downloads if possible.
+    --no-continue                    Do not resume partially downloaded files
+                                     (restart from beginning)
+    --no-part                        Do not use .part files - write directly
+                                     into output file
+    --no-mtime                       Do not use the Last-modified header to set
+                                     the file modification time
+    --write-description              Write video description to a .description
+                                     file

     --write-info-json                Write video metadata to a .info.json file
     --write-info-json                Write video metadata to a .info.json file

-    --write-annotations              Write video annotations to a .annotations.xml file
-    --load-info FILE                 JSON file containing the video information (created with the "--write-info-json" option)
-    --cookies FILE                   File to read cookies from and dump cookie jar in
-    --cache-dir DIR                  Location in the filesystem where youtube-dl can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl
-                                     or ~/.cache/youtube-dl . At the moment, only YouTube player files (for videos with obfuscated signatures) are cached, but that may
-                                     change.
+    --write-annotations              Write video annotations to a
+                                     .annotations.xml file
+    --load-info FILE                 JSON file containing the video information
+                                     (created with the "--write-info-json"
+                                     option)
+    --cookies FILE                   File to read cookies from and dump cookie
+                                     jar in
+    --cache-dir DIR                  Location in the filesystem where youtube-dl
+                                     can store some downloaded information
+                                     permanently. By default $XDG_CACHE_HOME
+                                     /youtube-dl or ~/.cache/youtube-dl . At the
+                                     moment, only YouTube player files (for
+                                     videos with obfuscated signatures) are
+                                     cached, but that may change.

     --no-cache-dir                   Disable filesystem caching
     --rm-cache-dir                   Delete all filesystem cache files
 
     --no-cache-dir                   Disable filesystem caching
     --rm-cache-dir                   Delete all filesystem cache files
 


@@ -172,14 +284,16 @@ Thumbnail images:
 
     --write-thumbnail                Write thumbnail image to disk
     --write-all-thumbnails           Write all thumbnail image formats to disk
 
     --write-thumbnail                Write thumbnail image to disk
     --write-all-thumbnails           Write all thumbnail image formats to disk

-    --list-thumbnails                Simulate and list all available thumbnail formats
+    --list-thumbnails                Simulate and list all available thumbnail
+                                     formats

 
 
 Verbosity / Simulation Options:
 
     -q, --quiet                      Activate quiet mode
     --no-warnings                    Ignore warnings
 
 
 Verbosity / Simulation Options:
 
     -q, --quiet                      Activate quiet mode
     --no-warnings                    Ignore warnings

-    -s, --simulate                   Do not download the video and do not write anything to disk
+    -s, --simulate                   Do not download the video and do not write
+                                     anything to disk

     --skip-download                  Do not download the video
     -g, --get-url                    Simulate, quiet but print URL
     -e, --get-title                  Simulate, quiet but print title
     --skip-download                  Do not download the video
     -g, --get-url                    Simulate, quiet but print URL
     -e, --get-title                  Simulate, quiet but print title


@@ -189,100 +303,167 @@ Verbosity / Simulation Options:
     --get-duration                   Simulate, quiet but print video length
     --get-filename                   Simulate, quiet but print output filename
     --get-format                     Simulate, quiet but print output format
     --get-duration                   Simulate, quiet but print video length
     --get-filename                   Simulate, quiet but print output filename
     --get-format                     Simulate, quiet but print output format

-    -j, --dump-json                  Simulate, quiet but print JSON information. See --output for a description of available keys.
-    -J, --dump-single-json           Simulate, quiet but print JSON information for each command-line argument. If the URL refers to a playlist, dump the whole playlist
-                                     information in a single line.
-    --print-json                     Be quiet and print the video information as JSON (video is still being downloaded).
+    -j, --dump-json                  Simulate, quiet but print JSON information.
+                                     See --output for a description of available
+                                     keys.
+    -J, --dump-single-json           Simulate, quiet but print JSON information
+                                     for each command-line argument. If the URL
+                                     refers to a playlist, dump the whole
+                                     playlist information in a single line.
+    --print-json                     Be quiet and print the video information as
+                                     JSON (video is still being downloaded).

     --newline                        Output progress bar as new lines
     --no-progress                    Do not print progress bar
     --console-title                  Display progress in console titlebar
     -v, --verbose                    Print various debugging information
     --newline                        Output progress bar as new lines
     --no-progress                    Do not print progress bar
     --console-title                  Display progress in console titlebar
     -v, --verbose                    Print various debugging information

-    --dump-pages                     Print downloaded pages encoded using base64 to debug problems (very verbose)
-    --write-pages                    Write downloaded intermediary pages to files in the current directory to debug problems
+    --dump-pages                     Print downloaded pages encoded using base64
+                                     to debug problems (very verbose)
+    --write-pages                    Write downloaded intermediary pages to
+                                     files in the current directory to debug
+                                     problems

     --print-traffic                  Display sent and read HTTP traffic
     -C, --call-home                  Contact the youtube-dl server for debugging
     --print-traffic                  Display sent and read HTTP traffic
     -C, --call-home                  Contact the youtube-dl server for debugging

-    --no-call-home                   Do NOT contact the youtube-dl server for debugging
+    --no-call-home                   Do NOT contact the youtube-dl server for
+                                     debugging

 
 
 Workarounds:
 
     --encoding ENCODING              Force the specified encoding (experimental)
     --no-check-certificate           Suppress HTTPS certificate validation
 
 
 Workarounds:
 
     --encoding ENCODING              Force the specified encoding (experimental)
     --no-check-certificate           Suppress HTTPS certificate validation

-    --prefer-insecure                Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)
+    --prefer-insecure                Use an unencrypted connection to retrieve
+                                     information about the video. (Currently
+                                     supported only for YouTube)

     --user-agent UA                  Specify a custom user agent
     --user-agent UA                  Specify a custom user agent

-    --referer URL                    Specify a custom referer, use if the video access is restricted to one domain
-    --add-header FIELD:VALUE         Specify a custom HTTP header and its value, separated by a colon ':'. You can use this option multiple times
-    --bidi-workaround                Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH
-    --sleep-interval SECONDS         Number of seconds to sleep before each download.
+    --referer URL                    Specify a custom referer, use if the video
+                                     access is restricted to one domain
+    --add-header FIELD:VALUE         Specify a custom HTTP header and its value,
+                                     separated by a colon ':'. You can use this
+                                     option multiple times
+    --bidi-workaround                Work around terminals that lack
+                                     bidirectional text support. Requires bidiv
+                                     or fribidi executable in PATH
+    --sleep-interval SECONDS         Number of seconds to sleep before each
+                                     download.

 
 
 Video Format Options:
 
 
 
 Video Format Options:
 

-    -f, --format FORMAT              Video format code, see the "FORMAT SELECTION" for all the info
+    -f, --format FORMAT              Video format code, see the "FORMAT
+                                     SELECTION" for all the info

     --all-formats                    Download all available video formats
     --all-formats                    Download all available video formats

-    --prefer-free-formats            Prefer free video formats unless a specific one is requested
-    -F, --list-formats               List all available formats
-    --youtube-skip-dash-manifest     Do not download the DASH manifests and related data on YouTube videos
-    --merge-output-format FORMAT     If a merge is required (e.g. bestvideo+bestaudio), output to given container format. One of mkv, mp4, ogg, webm, flv. Ignored if no
-                                     merge is required
+    --prefer-free-formats            Prefer free video formats unless a specific
+                                     one is requested
+    -F, --list-formats               List all available formats of requested
+                                     videos
+    --youtube-skip-dash-manifest     Do not download the DASH manifests and
+                                     related data on YouTube videos
+    --merge-output-format FORMAT     If a merge is required (e.g.
+                                     bestvideo+bestaudio), output to given
+                                     container format. One of mkv, mp4, ogg,
+                                     webm, flv. Ignored if no merge is required

 
 
 Subtitle Options:
 
     --write-sub                      Write subtitle file
 
 
 Subtitle Options:
 
     --write-sub                      Write subtitle file

-    --write-auto-sub                 Write automatic subtitle file (YouTube only)
-    --all-subs                       Download all the available subtitles of the video
+    --write-auto-sub                 Write automatically generated subtitle file
+                                     (YouTube only)
+    --all-subs                       Download all the available subtitles of the
+                                     video

     --list-subs                      List all available subtitles for the video
     --list-subs                      List all available subtitles for the video

-    --sub-format FORMAT              Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"
-    --sub-lang LANGS                 Languages of the subtitles to download (optional) separated by commas, use IETF language tags like 'en,pt'
+    --sub-format FORMAT              Subtitle format, accepts formats
+                                     preference, for example: "srt" or
+                                     "ass/srt/best"
+    --sub-lang LANGS                 Languages of the subtitles to download
+                                     (optional) separated by commas, use --list-
+                                     subs for available language tags

 
 
 Authentication Options:
 
     -u, --username USERNAME          Login with this account ID
 
 
 Authentication Options:
 
     -u, --username USERNAME          Login with this account ID

-    -p, --password PASSWORD          Account password. If this option is left out, youtube-dl will ask interactively.
+    -p, --password PASSWORD          Account password. If this option is left
+                                     out, youtube-dl will ask interactively.

     -2, --twofactor TWOFACTOR        Two-factor auth code
     -n, --netrc                      Use .netrc authentication data
     -2, --twofactor TWOFACTOR        Two-factor auth code
     -n, --netrc                      Use .netrc authentication data

-    --video-password PASSWORD        Video password (vimeo, smotri)
+    --video-password PASSWORD        Video password (vimeo, smotri, youku)

 
 
 Post-processing Options:
 
 
 
 Post-processing Options:
 

-    -x, --extract-audio              Convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)
-    --audio-format FORMAT            Specify audio format: "best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "best" by default
-    --audio-quality QUALITY          Specify ffmpeg/avconv audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default
-                                     5)
-    --recode-video FORMAT            Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv|avi)
+    -x, --extract-audio              Convert video files to audio-only files
+                                     (requires ffmpeg or avconv and ffprobe or
+                                     avprobe)
+    --audio-format FORMAT            Specify audio format: "best", "aac",
+                                     "vorbis", "mp3", "m4a", "opus", or "wav";
+                                     "best" by default
+    --audio-quality QUALITY          Specify ffmpeg/avconv audio quality, insert
+                                     a value between 0 (better) and 9 (worse)
+                                     for VBR or a specific bitrate like 128K
+                                     (default 5)
+    --recode-video FORMAT            Encode the video to another format if
+                                     necessary (currently supported:
+                                     mp4|flv|ogg|webm|mkv|avi)

     --postprocessor-args ARGS        Give these arguments to the postprocessor
     --postprocessor-args ARGS        Give these arguments to the postprocessor

-    -k, --keep-video                 Keep the video file on disk after the post-processing; the video is erased by default
-    --no-post-overwrites             Do not overwrite post-processed files; the post-processed files are overwritten by default
-    --embed-subs                     Embed subtitles in the video (only for mkv and mp4 videos)
+    -k, --keep-video                 Keep the video file on disk after the post-
+                                     processing; the video is erased by default
+    --no-post-overwrites             Do not overwrite post-processed files; the
+                                     post-processed files are overwritten by
+                                     default
+    --embed-subs                     Embed subtitles in the video (only for mkv
+                                     and mp4 videos)

     --embed-thumbnail                Embed thumbnail in the audio as cover art
     --add-metadata                   Write metadata to the video file
     --embed-thumbnail                Embed thumbnail in the audio as cover art
     --add-metadata                   Write metadata to the video file

-    --metadata-from-title FORMAT     Parse additional metadata like song title / artist from the video title. The format syntax is the same as --output, the parsed
-                                     parameters replace existing values. Additional templates: %(album)s, %(artist)s. Example: --metadata-from-title "%(artist)s -
-                                     %(title)s" matches a title like "Coldplay - Paradise"
-    --xattrs                         Write metadata to the video file's xattrs (using dublin core and xdg standards)
-    --fixup POLICY                   Automatically correct known faults of the file. One of never (do nothing), warn (only emit a warning), detect_or_warn (the default;
-                                     fix file if we can, warn otherwise)
-    --prefer-avconv                  Prefer avconv over ffmpeg for running the postprocessors (default)
-    --prefer-ffmpeg                  Prefer ffmpeg over avconv for running the postprocessors
-    --ffmpeg-location PATH           Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory.
-    --exec CMD                       Execute a command on the file after downloading, similar to find's -exec syntax. Example: --exec 'adb push {} /sdcard/Music/ && rm
-                                     {}'
-    --convert-subtitles FORMAT       Convert the subtitles to other format (currently supported: srt|ass|vtt)
+    --metadata-from-title FORMAT     Parse additional metadata like song title /
+                                     artist from the video title. The format
+                                     syntax is the same as --output, the parsed
+                                     parameters replace existing values.
+                                     Additional templates: %(album)s,
+                                     %(artist)s. Example: --metadata-from-title
+                                     "%(artist)s - %(title)s" matches a title
+                                     like "Coldplay - Paradise"
+    --xattrs                         Write metadata to the video file's xattrs
+                                     (using dublin core and xdg standards)
+    --fixup POLICY                   Automatically correct known faults of the
+                                     file. One of never (do nothing), warn (only
+                                     emit a warning), detect_or_warn (the
+                                     default; fix file if we can, warn
+                                     otherwise)
+    --prefer-avconv                  Prefer avconv over ffmpeg for running the
+                                     postprocessors (default)
+    --prefer-ffmpeg                  Prefer ffmpeg over avconv for running the
+                                     postprocessors
+    --ffmpeg-location PATH           Location of the ffmpeg/avconv binary;
+                                     either the path to the binary or its
+                                     containing directory.
+    --exec CMD                       Execute a command on the file after
+                                     downloading, similar to find's -exec
+                                     syntax. Example: --exec 'adb push {}
+                                     /sdcard/Music/ && rm {}'
+    --convert-subs FORMAT            Convert the subtitles to other format
+                                     (currently supported: srt|ass|vtt)

 
 
 
 CONFIGURATION
 
 
 
 
 
 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 ~/.config/youtube-dl/config. On
-Windows, the configuration file locations are
-%APPDATA%\youtube-dl\config.txt and
-C:\Users\<user name>\youtube-dl.conf.
+You can configure youtube-dl by placing any supported command line
+option to a configuration file. On Linux, the system wide configuration
+file is located at /etc/youtube-dl.conf and the user wide configuration
+file at ~/.config/youtube-dl/config. On Windows, the user wide
+configuration file locations are %APPDATA%\youtube-dl\config.txt or
+C:\Users\<user name>\youtube-dl.conf. For example, with the following
+configuration file youtube-dl will always extract the audio, not copy
+the mtime and use a proxy:
+
+    --extract-audio
+    --no-mtime
+    --proxy 127.0.0.1:3128
+
+You can use --ignore-config if you want to disable the configuration
+file for a particular youtube-dl run.

 
 Authentication with .netrc file
 
 
 Authentication with .netrc file
 


@@ -290,10 +471,10 @@ You may also want to configure automatic credentials storage for
 extractors that support authentication (by providing login and password
 with --username and --password) in order not to pass credentials as
 command line arguments on every youtube-dl execution and prevent
 extractors that support authentication (by providing login and password
 with --username and --password) in order not to pass credentials as
 command line arguments on every youtube-dl execution and prevent

-tracking plain text passwords in shell command history. You can achieve
-this using .netrc file on per extractor basis. For that you will need to
-create .netrc file in your $HOME and restrict permissions to read/write
-by you only:
+tracking plain text passwords in the shell command history. You can
+achieve this using a .netrc file on per extractor basis. For that you
+will need to create a.netrc file in your $HOME and restrict permissions
+to read/write by you only:

 
     touch $HOME/.netrc
     chmod a-rwx,u+rw $HOME/.netrc
 
     touch $HOME/.netrc
     chmod a-rwx,u+rw $HOME/.netrc


@@ -308,10 +489,10 @@ For example:
     machine youtube login myaccount@gmail.com password my_youtube_password
     machine twitch login my_twitch_account_name password my_twitch_password
 
     machine youtube login myaccount@gmail.com password my_youtube_password
     machine twitch login my_twitch_account_name password my_twitch_password
 

-To activate authentication with .netrc file you should pass --netrc to
-youtube-dl or to place it in configuration file.
+To activate authentication with the .netrc file you should pass --netrc
+to youtube-dl or place it in the configuration file.

 
 

-On Windows you may also need to setup %HOME% environment variable
+On Windows you may also need to setup the %HOME% environment variable

 manually.
 
 
 manually.
 
 


@@ -325,26 +506,89 @@ downloading a single file, like in
 youtube-dl -o funny_video.flv "http://some/video". However, it may
 contain special sequences that will be replaced when downloading each
 video. The special sequences have the format %(NAME)s. To clarify, that
 youtube-dl -o funny_video.flv "http://some/video". However, it may
 contain special sequences that will be replaced when downloading each
 video. The special sequences have the format %(NAME)s. To clarify, that

-is a percent symbol followed by a name in parenthesis, followed by a
+is a percent symbol followed by a name in parentheses, followed by a

 lowercase S. Allowed names are:
 
 lowercase S. Allowed names are:
 

--   id: The sequence will be replaced by the video identifier.
--   url: The sequence will be replaced by the video URL.
--   uploader: The sequence will be replaced by the nickname of the
-    person who uploaded the video.
--   upload_date: The sequence will be replaced by the upload date in
-    YYYYMMDD format.
--   title: The sequence will be replaced by the video title.
--   ext: The sequence will be replaced by the appropriate extension
-    (like flv or mp4).
--   epoch: The sequence will be replaced by the Unix epoch when creating
-    the file.
--   autonumber: The sequence will be replaced by a five-digit number
-    that will be increased with each download, starting at zero.
--   playlist: The name or the id of the playlist that contains the
-    video.
--   playlist_index: The index of the video in the playlist, a five-digit
-    number.
+-   id: Video identifier
+-   title: Video title
+-   url: Video URL
+-   ext: Video filename extension
+-   alt_title: A secondary title of the video
+-   display_id: An alternative identifier for the video
+-   uploader: Full name of the video uploader
+-   creator: The main artist who created the video
+-   release_date: The date (YYYYMMDD) when the video was released
+-   timestamp: UNIX timestamp of the moment the video became available
+-   upload_date: Video upload date (YYYYMMDD)
+-   uploader_id: Nickname or id of the video uploader
+-   location: Physical location where the video was filmed
+-   duration: Length of the video in seconds
+-   view_count: How many users have watched the video on the platform
+-   like_count: Number of positive ratings of the video
+-   dislike_count: Number of negative ratings of the video
+-   repost_count: Number of reposts of the video
+-   average_rating: Average rating give by users, the scale used depends
+    on the webpage
+-   comment_count: Number of comments on the video
+-   age_limit: Age restriction for the video (years)
+-   format: A human-readable description of the format
+-   format_id: Format code specified by --format
+-   format_note: Additional info about the format
+-   width: Width of the video
+-   height: Height of the video
+-   resolution: Textual description of width and height
+-   tbr: Average bitrate of audio and video in KBit/s
+-   abr: Average audio bitrate in KBit/s
+-   acodec: Name of the audio codec in use
+-   asr: Audio sampling rate in Hertz
+-   vbr: Average video bitrate in KBit/s
+-   fps: Frame rate
+-   vcodec: Name of the video codec in use
+-   container: Name of the container format
+-   filesize: The number of bytes, if known in advance
+-   filesize_approx: An estimate for the number of bytes
+-   protocol: The protocol that will be used for the actual download
+-   extractor: Name of the extractor
+-   extractor_key: Key name of the extractor
+-   epoch: Unix epoch when creating the file
+-   autonumber: Five-digit number that will be increased with each
+    download, starting at zero
+-   playlist: Name or id of the playlist that contains the video
+-   playlist_index: Index of the video in the playlist padded with
+    leading zeros according to the total length of the playlist
+
+Available for the video that belongs to some logical chapter or section:
+- chapter: Name or title of the chapter the video belongs to -
+chapter_number: Number of the chapter the video belongs to - chapter_id:
+Id of the chapter the video belongs to
+
+Available for the video that is an episode of some series or programme:
+- series: Title of the series or programme the video episode belongs to
+- season: Title of the season the video episode belongs to -
+season_number: Number of the season the video episode belongs to -
+season_id: Id of the season the video episode belongs to - episode:
+Title of the video episode - episode_number: Number of the video episode
+within a season - episode_id: Id of the video episode
+
+Each aforementioned sequence when referenced in output template will be
+replaced by the actual value corresponding to the sequence name. Note
+that some of the sequences are not guaranteed to be present since they
+depend on the metadata obtained by particular extractor, such sequences
+will be replaced with NA.
+
+For example for -o %(title)s-%(id)s.%(ext)s and mp4 video with title
+youtube-dl test video and id BaW_jenozKcj this will result in a
+youtube-dl test video-BaW_jenozKcj.mp4 file created in the current
+directory.
+
+Output template can also contain arbitrary hierarchical path, e.g.
+-o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' that will
+result in downloading each video in a directory corresponding to this
+path template. Any missing directory will be automatically created for
+you.
+
+To specify percent literal in output template use %%. To output to
+stdout use -o -.

 
 The current default template is %(title)s-%(id)s.%(ext)s.
 
 
 The current default template is %(title)s-%(id)s.%(ext)s.
 


@@ -353,51 +597,130 @@ In some cases, you don't want special characters such as 中, spaces, or
 or the filename through an 8bit-unsafe channel. In these cases, add the
 --restrict-filenames flag to get a shorter title:
 
 or the filename through an 8bit-unsafe channel. In these cases, add the
 --restrict-filenames flag to get a shorter title:
 

-``` {.bash}
-$ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
-youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters
-$ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
-youtube-dl_test_video_.mp4          # A simple file name
-```
+Examples (note on Windows you may need to use double quotes instead of
+single):
+
+    $ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
+    youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters
+
+    $ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
+    youtube-dl_test_video_.mp4          # A simple file name
+
+    # Download YouTube playlist videos in separate directory indexed by video order in a playlist
+    $ youtube-dl -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
+
+    # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
+    $ youtube-dl -u user -p password -o '~/MyVideos/%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s' https://www.udemy.com/java-tutorial/
+
+    # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
+    $ youtube-dl -o "C:/MyVideos/%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" http://videomore.ru/kino_v_detalayah/5_sezon/367617
+
+    # Stream the video being downloaded to stdout
+    $ youtube-dl -o - BaW_jenozKc

 
 
 
 FORMAT SELECTION
 
 
 
 
 
 FORMAT SELECTION
 
 

-By default youtube-dl tries to download the best quality, but sometimes
-you may want to download other format. The simplest case is requesting a
-specific format, for example -f 22. You can get the list of available
-formats using --list-formats, you can also use a file extension
-(currently it supports aac, m4a, mp3, mp4, ogg, wav, webm) or the
-special names best, bestvideo, bestaudio and worst.
+By default youtube-dl tries to download the best available quality, i.e.
+if you want the best quality you DON'T NEED to pass any special options,
+youtube-dl will guess it for you by DEFAULT.
+
+But sometimes you may want to download in a different format, for
+example when you are on a slow or intermittent connection. The key
+mechanism for achieving this is so called _format selection_ based on
+which you can explicitly specify desired format, select formats based on
+some criterion or criteria, setup precedence and much more.
+
+The general syntax for format selection is --format FORMAT or shorter
+-f FORMAT where FORMAT is a _selector expression_, i.e. an expression
+that describes format or formats you would like to download.
+
+The simplest case is requesting a specific format, for example with
+-f 22 you can download the format with format code equal to 22. You can
+get the list of available format codes for particular video using
+--list-formats or -F. Note that these format codes are extractor
+specific.
+
+You can also use a file extension (currently 3gp, aac, flv, m4a, mp3,
+mp4, ogg, wav, webm are supported) to download best quality format of
+particular file extension served as a single file, e.g. -f webm will
+download best quality format with webm extension served as a single
+file.
+
+You can also use special names to select particular edge case format: -
+best: Select best quality format represented by single file with video
+and audio - worst: Select worst quality format represented by single
+file with video and audio - bestvideo: Select best quality video only
+format (e.g. DASH video), may not be available - worstvideo: Select
+worst quality video only format, may not be available - bestaudio:
+Select best quality audio only format, may not be available -
+worstaudio: Select worst quality audio only format, may not be available
+
+For example, to download worst quality video only format you can use
+-f worstvideo.

 
 If you want to download multiple videos and they don't have the same
 formats available, you can specify the order of preference using
 
 If you want to download multiple videos and they don't have the same
 formats available, you can specify the order of preference using

-slashes, as in -f 22/17/18. You can also filter the video results by
-putting a condition in brackets, as in -f "best[height=720]" (or
--f "[filesize>10M]"). This works for filesize, height, width, tbr, abr,
-vbr, asr, and fps and the comparisons <, <=, >, >=, =, != and for ext,
-acodec, vcodec, container, and protocol and the comparisons =, != .
+slashes. Note that slash is left-associative, i.e. formats on the left
+hand side are preferred, for example -f 22/17/18 will download format 22
+if it's available, otherwise it will download format 17 if it's
+available, otherwise it will download format 18 if it's available,
+otherwise it will complain that no suitable formats are available for
+download.
+
+If you want to download several formats of the same video use comma as a
+separator, e.g. -f 22,17,18 will download all these three formats, of
+course if they are available. Or more sophisticated example combined
+with precedence feature -f 136/137/mp4/bestvideo,140/m4a/bestaudio.
+
+You can also filter the video formats by putting a condition in
+brackets, as in -f "best[height=720]" (or -f "[filesize>10M]").
+
+The following numeric meta fields can be used with comparisons <, <=, >,
+>=, = (equals), != (not equals): - filesize: The number of bytes, if
+known in advance - width: Width of the video, if known - height: Height
+of the video, if known - tbr: Average bitrate of audio and video in
+KBit/s - abr: Average audio bitrate in KBit/s - vbr: Average video
+bitrate in KBit/s - asr: Audio sampling rate in Hertz - fps: Frame rate
+
+Also filtering work for comparisons = (equals), != (not equals), ^=
+(begins with), $= (ends with), *= (contains) and following string meta
+fields: - ext: File extension - acodec: Name of the audio codec in use -
+vcodec: Name of the video codec in use - container: Name of the
+container format - protocol: The protocol that will be used for the
+actual download, lower-case. http, https, rtsp, rtmp, rtmpe, m3u8, or
+m3u8_native
+
+Note that none of the aforementioned meta fields are guaranteed to be
+present since this solely depends on the metadata obtained by particular
+extractor, i.e. the metadata offered by video hoster.
+

 Formats for which the value is not known are excluded unless you put a
 question mark (?) after the operator. You can combine format filters, so
 -f "[height <=? 720][tbr>500]" selects up to 720p videos (or videos
 where the height is not known) with a bitrate of at least 500 KBit/s.
 Formats for which the value is not known are excluded unless you put a
 question mark (?) after the operator. You can combine format filters, so
 -f "[height <=? 720][tbr>500]" selects up to 720p videos (or videos
 where the height is not known) with a bitrate of at least 500 KBit/s.

-Use commas to download multiple formats, such as
--f 136/137/mp4/bestvideo,140/m4a/bestaudio. You can merge the video and
-audio of two formats into a single file using
--f <video-format>+<audio-format> (requires ffmpeg or avconv), for
-example -f bestvideo+bestaudio.
+
+You can merge the video and audio of two formats into a single file
+using -f <video-format>+<audio-format> (requires ffmpeg or avconv
+installed), for example -f bestvideo+bestaudio will download best video
+only format, best audio only format and mux them together with
+ffmpeg/avconv.
+
+Format selectors can also be grouped using parentheses, for example if
+you want to download the best mp4 and webm formats with a height lower
+than 480 you can use -f '(mp4,webm)[height<480]'.

 
 Since the end of April 2015 and version 2015.04.26 youtube-dl uses
 -f bestvideo+bestaudio/best as default format selection (see #5447,
 #5456). If ffmpeg or avconv are installed this results in downloading
 bestvideo and bestaudio separately and muxing them together into a
 single file giving the best overall quality available. Otherwise it
 
 Since the end of April 2015 and version 2015.04.26 youtube-dl uses
 -f bestvideo+bestaudio/best as default format selection (see #5447,
 #5456). If ffmpeg or avconv are installed this results in downloading
 bestvideo and bestaudio separately and muxing them together into a
 single file giving the best overall quality available. Otherwise it

-falls back to best and results in downloading best available quality
+falls back to best and results in downloading the best available quality

 served as a single file. best is also needed for videos that don't come
 from YouTube because they don't provide the audio and video in two
 served as a single file. best is also needed for videos that don't come
 from YouTube because they don't provide the audio and video in two

-different files. If you want to only download some dash formats (for
+different files. If you want to only download some DASH formats (for

 example if you are not interested in getting videos with a resolution
 higher than 1080p), you can add
 -f bestvideo[height<=?1080]+bestaudio/best to your configuration file.
 example if you are not interested in getting videos with a resolution
 higher than 1080p), you can add
 -f bestvideo[height<=?1080]+bestaudio/best to your configuration file.


@@ -408,10 +731,25 @@ order to start content delivery immediately to your player and not to
 wait until bestvideo and bestaudio are downloaded and muxed.
 
 If you want to preserve the old format selection behavior (prior to
 wait until bestvideo and bestaudio are downloaded and muxed.
 
 If you want to preserve the old format selection behavior (prior to

-youtube-dl 2015.04.26), i.e. you want to download best available quality
-media served as a single file, you should explicitly specify your choice
-with -f best. You may want to add it to the configuration file in order
-not to type it every time you run youtube-dl.
+youtube-dl 2015.04.26), i.e. you want to download the best available
+quality media served as a single file, you should explicitly specify
+your choice with -f best. You may want to add it to the configuration
+file in order not to type it every time you run youtube-dl.
+
+Examples (note on Windows you may need to use double quotes instead of
+single):
+
+    # Download best mp4 format available or any other best if no mp4 available
+    $ youtube-dl -f 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best'
+
+    # Download best format available but not better that 480p
+    $ youtube-dl -f 'bestvideo[height<=480]+bestaudio/best[height<=480]'
+
+    # Download best video only format but no bigger that 50 MB
+    $ youtube-dl -f 'best[filesize<50M]'
+
+    # Download best format available via direct link over HTTP/HTTPS protocol
+    $ youtube-dl -f '(bestvideo+bestaudio/best)[protocol^=http]'

 
 
 
 
 
 


@@ -419,7 +757,7 @@ VIDEO SELECTION
 
 
 Videos can be filtered by their upload date using the options --date,
 
 
 Videos can be filtered by their upload date using the options --date,

---datebefore or --dateafter, they accept dates in two formats:
+--datebefore or --dateafter. They accept dates in two formats:

 
 -   Absolute dates: Dates in the format YYYYMMDD.
 -   Relative dates: Dates in the format
 
 -   Absolute dates: Dates in the format YYYYMMDD.
 -   Relative dates: Dates in the format


@@ -427,16 +765,14 @@ Videos can be filtered by their upload date using the options --date,
 
 Examples:
 
 
 Examples:
 

-``` {.bash}
-# Download only the videos uploaded in the last 6 months
-$ youtube-dl --dateafter now-6months
+    # Download only the videos uploaded in the last 6 months
+    $ youtube-dl --dateafter now-6months

 
 

-# Download only the videos uploaded on January 1, 1970
-$ youtube-dl --date 19700101
+    # Download only the videos uploaded on January 1, 1970
+    $ youtube-dl --date 19700101

 
 

-$ # will only download the videos uploaded in the 200x decade
-$ youtube-dl --dateafter 20000101 --datebefore 20091231
-```
+    $ # Download only the videos uploaded in the 200x decade
+    $ youtube-dl --dateafter 20000101 --datebefore 20091231

 
 
 
 
 
 


@@ -456,7 +792,7 @@ or _yum_, use the standard system update mechanism to update. Note that
 distribution packages are often outdated. As a rule of thumb, youtube-dl
 releases at least once a month, and often weekly or even daily. Simply
 go to http://yt-dl.org/ to find out the current version. Unfortunately,
 distribution packages are often outdated. As a rule of thumb, youtube-dl
 releases at least once a month, and often weekly or even daily. Simply
 go to http://yt-dl.org/ to find out the current version. Unfortunately,

-there is nothing we youtube-dl developers can do if your distributions
+there is nothing we youtube-dl developers can do if your distribution

 serves a really outdated version. You can (and should) complain to your
 distribution in their bugtracker or support forum.
 
 serves a really outdated version. You can (and should) complain to your
 distribution in their bugtracker or support forum.
 


@@ -513,6 +849,18 @@ CAPTCHA, but at the moment, your best course of action is pointing a
 webbrowser to the youtube URL, solving the CAPTCHA, and restart
 youtube-dl.
 
 webbrowser to the youtube URL, solving the CAPTCHA, and restart
 youtube-dl.
 

+Do I need any other programs?
+
+youtube-dl works fine on its own on most sites. However, if you want to
+convert video/audio, you'll need avconv or ffmpeg. On some sites - most
+notably YouTube - videos can be retrieved in a higher quality format
+without sound. youtube-dl will detect whether avconv/ffmpeg is present
+and automatically pick the best option.
+
+Videos or video formats streamed via RTMP protocol can only be
+downloaded when rtmpdump is installed. Downloading MMS and RTSP videos
+requires either mplayer or mpv to be installed.
+

 I have downloaded a video but how can I play it?
 
 Once the video is fully downloaded, use any video player, such as vlc or
 I have downloaded a video but how can I play it?
 
 Once the video is fully downloaded, use any video player, such as vlc or


@@ -557,8 +905,8 @@ youtube-dl.
 Video URL contains an ampersand and I'm getting some strange output [1] 2839 or 'v' is not recognized as an internal or external command
 
 That's actually the output from your shell. Since ampersand is one of
 Video URL contains an ampersand and I'm getting some strange output [1] 2839 or 'v' is not recognized as an internal or external command
 
 That's actually the output from your shell. Since ampersand is one of

-the special shell characters it's interpreted by shell preventing you
-from passing the whole URL to youtube-dl. To disable your shell from
+the special shell characters it's interpreted by the shell preventing
+you from passing the whole URL to youtube-dl. To disable your shell from

 interpreting the ampersands (or any other special characters) you have
 to either put the whole URL in quotes or escape them with a backslash
 (which approach will work depends on your shell).
 interpreting the ampersands (or any other special characters) you have
 to either put the whole URL in quotes or escape them with a backslash
 (which approach will work depends on your shell).


@@ -635,7 +983,7 @@ Use the -o to specify an output template, for example
 -o "/home/user/videos/%(title)s-%(id)s.%(ext)s". If you want this for
 all of your downloads, put the option into your configuration file.
 
 -o "/home/user/videos/%(title)s-%(id)s.%(ext)s". If you want this for
 all of your downloads, put the option into your configuration file.
 

-How do I download a video starting with a - ?
+How do I download a video starting with a -?

 
 Either prepend http://www.youtube.com/watch?v= or separate the ID from
 the options with --:
 
 Either prepend http://www.youtube.com/watch?v= or separate the ID from
 the options with --:


@@ -643,6 +991,22 @@ the options with --:
     youtube-dl -- -wNyEUrxzFU
     youtube-dl "http://www.youtube.com/watch?v=-wNyEUrxzFU"
 
     youtube-dl -- -wNyEUrxzFU
     youtube-dl "http://www.youtube.com/watch?v=-wNyEUrxzFU"
 

+How do I pass cookies to youtube-dl?
+
+Use the --cookies option, for example
+--cookies /path/to/cookies/file.txt. Note that the cookies file must be
+in Mozilla/Netscape format and the first line of the cookies file must
+be either # HTTP Cookie File or # Netscape HTTP Cookie File. Make sure
+you have correct newline format in the cookies file and convert newlines
+if necessary to correspond with your OS, namely CRLF (\r\n) for Windows,
+LF (\n) for Linux and CR (\r) for Mac OS. HTTP Error 400: Bad Request
+when using --cookies is a good sign of invalid newline format.
+
+Passing cookies to youtube-dl is a good way to workaround login when a
+particular extractor does not implement it explicitly. Another use case
+is working around CAPTCHA some websites require you to solve in
+particular cases in order to get access (e.g. YouTube, CloudFlare).
+

 Can you add support for this anime video site, or site which shows current movies for free?
 
 As a matter of policy (as well as legality), youtube-dl does not include
 Can you add support for this anime video site, or site which shows current movies for free?
 
 As a matter of policy (as well as legality), youtube-dl does not include


@@ -755,57 +1119,56 @@ list (assuming your service is called yourextractor):
 4.  Start with this simple template and save it to
     youtube_dl/extractor/yourextractor.py:
 
 4.  Start with this simple template and save it to
     youtube_dl/extractor/yourextractor.py:
 

-    ``` {.python}
-    # coding: utf-8
-    from __future__ import unicode_literals
-
-    from .common import InfoExtractor
-
-
-    class YourExtractorIE(InfoExtractor):
-        _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
-        _TEST = {
-            'url': 'http://yourextractor.com/watch/42',
-            'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
-            'info_dict': {
-                'id': '42',
-                'ext': 'mp4',
-                'title': 'Video title goes here',
-                'thumbnail': 're:^https?://.*\.jpg$',
-                # TODO more properties, either as:
-                # * A value
-                # * MD5 checksum; start the string with md5:
-                # * A regular expression; start the string with re:
-                # * Any Python type (for example int or float)
+        # coding: utf-8
+        from __future__ import unicode_literals
+
+        from .common import InfoExtractor
+
+
+        class YourExtractorIE(InfoExtractor):
+            _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
+            _TEST = {
+                'url': 'http://yourextractor.com/watch/42',
+                'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
+                'info_dict': {
+                    'id': '42',
+                    'ext': 'mp4',
+                    'title': 'Video title goes here',
+                    'thumbnail': 're:^https?://.*\.jpg$',
+                    # TODO more properties, either as:
+                    # * A value
+                    # * MD5 checksum; start the string with md5:
+                    # * A regular expression; start the string with re:
+                    # * Any Python type (for example int or float)
+                }

             }
             }

-        }

 
 

-        def _real_extract(self, url):
-            video_id = self._match_id(url)
-            webpage = self._download_webpage(url, video_id)
+            def _real_extract(self, url):
+                video_id = self._match_id(url)
+                webpage = self._download_webpage(url, video_id)

 
 

-            # TODO more code goes here, for example ...
-            title = self._html_search_regex(r'<h1>(.*?)</h1>', webpage, 'title')
+                # TODO more code goes here, for example ...
+                title = self._html_search_regex(r'<h1>(.+?)</h1>', webpage, 'title')

 
 

-            return {
-                'id': video_id,
-                'title': title,
-                'description': self._og_search_description(webpage),
-                # TODO more properties (see youtube_dl/extractor/common.py)
-            }
-    ```
+                return {
+                    'id': video_id,
+                    'title': title,
+                    'description': self._og_search_description(webpage),
+                    'uploader': self._search_regex(r'<div[^>]+id="uploader"[^>]*>([^<]+)<', webpage, 'uploader', fatal=False),
+                    # TODO more properties (see youtube_dl/extractor/common.py)
+                }

 
 5.  Add an import in youtube_dl/extractor/__init__.py.
 6.  Run python test/test_download.py TestDownload.test_YourExtractor.
     This _should fail_ at first, but you can continually re-run it until
     you're done. If you decide to add more than one test, then rename
     _TEST to _TESTS and make it into a list of dictionaries. The tests
 
 5.  Add an import in youtube_dl/extractor/__init__.py.
 6.  Run python test/test_download.py TestDownload.test_YourExtractor.
     This _should fail_ at first, but you can continually re-run it until
     you're done. If you decide to add more than one test, then rename
     _TEST to _TESTS and make it into a list of dictionaries. The tests

-    will be then be named TestDownload.test_YourExtractor,
+    will then be named TestDownload.test_YourExtractor,

     TestDownload.test_YourExtractor_1,
     TestDownload.test_YourExtractor_2, etc.
     TestDownload.test_YourExtractor_1,
     TestDownload.test_YourExtractor_2, etc.

-7.  Have a look at youtube_dl/common/extractor/common.py for possible
-    helper methods and a detailed description of what your extractor
-    should return. Add tests and code for as many as you want.
+7.  Have a look at youtube_dl/extractor/common.py for possible helper
+    methods and a detailed description of what your extractor should and
+    may return. Add tests and code for as many as you want.

 8.  If you can, check the code with flake8.
 9.  When the tests pass, add the new files and commit them and push the
     result, like this:
 8.  If you can, check the code with flake8.
 9.  When the tests pass, add the new files and commit them and push the
     result, like this:


@@ -831,14 +1194,12 @@ any problems parsing its output, feel free to create a report.
 From a Python program, you can embed youtube-dl in a more powerful
 fashion, like this:
 
 From a Python program, you can embed youtube-dl in a more powerful
 fashion, like this:
 

-``` {.python}
-from __future__ import unicode_literals
-import youtube_dl
+    from __future__ import unicode_literals
+    import youtube_dl

 
 

-ydl_opts = {}
-with youtube_dl.YoutubeDL(ydl_opts) as ydl:
-    ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
-```
+    ydl_opts = {}
+    with youtube_dl.YoutubeDL(ydl_opts) as ydl:
+        ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])

 
 Most likely, you'll want to use various options. For a list of what can
 be done, have a look at youtube_dl/YoutubeDL.py. For a start, if you
 
 Most likely, you'll want to use various options. For a list of what can
 be done, have a look at youtube_dl/YoutubeDL.py. For a start, if you


@@ -848,40 +1209,38 @@ Here's a more complete example of a program that outputs only errors
 (and a short message after the download is finished), and
 downloads/converts the video to an mp3 file:
 
 (and a short message after the download is finished), and
 downloads/converts the video to an mp3 file:
 

-``` {.python}
-from __future__ import unicode_literals
-import youtube_dl
+    from __future__ import unicode_literals
+    import youtube_dl

 
 
 
 

-class MyLogger(object):
-    def debug(self, msg):
-        pass
+    class MyLogger(object):
+        def debug(self, msg):
+            pass

 
 

-    def warning(self, msg):
-        pass
+        def warning(self, msg):
+            pass

 
 

-    def error(self, msg):
-        print(msg)
+        def error(self, msg):
+            print(msg)

 
 
 
 

-def my_hook(d):
-    if d['status'] == 'finished':
-        print('Done downloading, now converting ...')
+    def my_hook(d):
+        if d['status'] == 'finished':
+            print('Done downloading, now converting ...')

 
 
 
 

-ydl_opts = {
-    'format': 'bestaudio/best',
-    'postprocessors': [{
-        'key': 'FFmpegExtractAudio',
-        'preferredcodec': 'mp3',
-        'preferredquality': '192',
-    }],
-    'logger': MyLogger(),
-    'progress_hooks': [my_hook],
-}
-with youtube_dl.YoutubeDL(ydl_opts) as ydl:
-    ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
-```
+    ydl_opts = {
+        'format': 'bestaudio/best',
+        'postprocessors': [{
+            'key': 'FFmpegExtractAudio',
+            'preferredcodec': 'mp3',
+            'preferredquality': '192',
+        }],
+        'logger': MyLogger(),
+        'progress_hooks': [my_hook],
+    }
+    with youtube_dl.YoutubeDL(ydl_opts) as ydl:
+        ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])

 
 
 
 
 
 


@@ -889,14 +1248,32 @@ BUGS
 
 
 Bugs and suggestions should be reported at:
 
 
 Bugs and suggestions should be reported at:

-https://github.com/rg3/youtube-dl/issues . Unless you were prompted so
-or there is another pertinent reason (e.g. GitHub fails to accept the
-bug report), please do not send bug reports via personal email. For
-discussions, join us in the irc channel #youtube-dl on freenode.
-
-PLEASE INCLUDE THE FULL OUTPUT OF YOUTUBE-DL WHEN RUN WITH -v.
-
-The output (including the first lines) contain important debugging
+https://github.com/rg3/youtube-dl/issues. Unless you were prompted so or
+there is another pertinent reason (e.g. GitHub fails to accept the bug
+report), please do not send bug reports via personal email. For
+discussions, join us in the IRC channel #youtube-dl on freenode
+(webchat).
+
+PLEASE INCLUDE THE FULL OUTPUT OF YOUTUBE-DL WHEN RUN WITH -v, i.e. ADD
+-v flag to YOUR COMMAND LINE, copy the WHOLE output and post it in the
+issue body wrapped in ``` for better formatting. It should look similar
+to this:
+
+    $ youtube-dl -v <your command line>
+    [debug] System config: []
+    [debug] User config: []
+    [debug] Command-line args: [u'-v', u'http://www.youtube.com/watch?v=BaW_jenozKcj']
+    [debug] Encodings: locale cp1251, fs mbcs, out cp866, pref cp1251
+    [debug] youtube-dl version 2015.12.06
+    [debug] Git HEAD: 135392e
+    [debug] Python version 2.6.6 - Windows-2003Server-5.2.3790-SP2
+    [debug] exe versions: ffmpeg N-75573-g1d0487f, ffprobe N-75573-g1d0487f, rtmpdump 2.4
+    [debug] Proxy map: {}
+    ...
+
+DO NOT POST SCREENSHOTS OF VERBOSE LOG ONLY PLAIN TEXT IS ACCEPTABLE.
+
+The output (including the first lines) contains important debugging

 information. Issues without the full output are often not reproducible
 and therefore do not get solved in short order, if ever.
 
 information. Issues without the full output are often not reproducible
 and therefore do not get solved in short order, if ever.
 


@@ -921,7 +1298,7 @@ want to be fixed. Make sure that it's obvious
 If your report is shorter than two lines, it is almost certainly missing
 some of these, which makes it hard for us to respond to it. We're often
 too polite to close the issue outright, but the missing info makes
 If your report is shorter than two lines, it is almost certainly missing
 some of these, which makes it hard for us to respond to it. We're often
 too polite to close the issue outright, but the missing info makes

-misinterpretation likely. As a commiter myself, I often get frustrated
+misinterpretation likely. As a committer myself, I often get frustrated

 by these issues, since the only possible way for me to move forward on
 them is to ask for clarification over and over.
 
 by these issues, since the only possible way for me to move forward on
 them is to ask for clarification over and over.
 


@@ -930,19 +1307,19 @@ _complete_ output of youtube-dl when called with the -v flag. The error
 message you get for (most) bugs even says so, but you would not believe
 how many of our bug reports do not contain this information.
 
 message you get for (most) bugs even says so, but you would not believe
 how many of our bug reports do not contain this information.
 

-If your server has multiple IPs or you suspect censorship,
-adding --call-home may be a good idea to get more diagnostics. If the
-error is ERROR: Unable to extract ... and you cannot reproduce it from
-multiple countries, add --dump-pages (warning: this will yield a rather
-large output, redirect it to the file log.txt by adding >log.txt 2>&1 to
-your command-line) or upload the .dump files you get when you add
+If your server has multiple IPs or you suspect censorship, adding
+--call-home may be a good idea to get more diagnostics. If the error is
+ERROR: Unable to extract ... and you cannot reproduce it from multiple
+countries, add --dump-pages (warning: this will yield a rather large
+output, redirect it to the file log.txt by adding >log.txt 2>&1 to your
+command-line) or upload the .dump files you get when you add

 --write-pages somewhere.
 
 SITE SUPPORT REQUESTS MUST CONTAIN AN EXAMPLE URL. An example URL is a
 URL you might want to download, like
 --write-pages somewhere.
 
 SITE SUPPORT REQUESTS MUST CONTAIN AN EXAMPLE URL. An example URL is a
 URL you might want to download, like

-http://www.youtube.com/watch?v=BaW_jenozKc . There should be an obvious
+http://www.youtube.com/watch?v=BaW_jenozKc. There should be an obvious

 video present. Except under very special circumstances, the main page of
 video present. Except under very special circumstances, the main page of

-a video service (e.g. http://www.youtube.com/ ) is _not_ an example URL.
+a video service (e.g. http://www.youtube.com/) is _not_ an example URL.

 
 Are you using the latest version?
 
 
 Are you using the latest version?
 


@@ -954,12 +1331,11 @@ requests as well.
 Is the issue already documented?
 
 Make sure that someone has not already opened the issue you're trying to
 Is the issue already documented?
 
 Make sure that someone has not already opened the issue you're trying to

-open. Search at the top of the window or at
-https://github.com/rg3/youtube-dl/search?type=Issues . If there is an
-issue, feel free to write something along the lines of "This affects me
-as well, with version 2015.01.01. Here is some more information on the
-issue: ...". While some issues may be old, a new post into them often
-spurs rapid activity.
+open. Search at the top of the window or browse the GitHub Issues of
+this repository. If there is an issue, feel free to write something
+along the lines of "This affects me as well, with version 2015.01.01.
+Here is some more information on the issue: ...". While some issues may
+be old, a new post into them often spurs rapid activity.

 
 Why are existing options not enough?
 
 
 Why are existing options not enough?
 


@@ -1030,6 +1406,5 @@ COPYRIGHT
 
 youtube-dl is released into the public domain by the copyright holders.
 
 
 youtube-dl is released into the public domain by the copyright holders.
 

-This README file was originally written by Daniel Bolton
-(https://github.com/dbbolton) and is likewise released into the public
-domain.
+This README file was originally written by Daniel Bolton and is likewise
+released into the public domain.