X-Git-Url: https://git.rapsys.eu/youtubedl/blobdiff_plain/00368b4c3a5d4e909e1b7ecfc4030bf28da020f3..b0b67c374528aca7bc76a9476d554a1d3ab96a9e:/youtube-dl.1

diff --git a/youtube-dl.1 b/youtube-dl.1
index 6c8c7bc..89a3fb6 100644
--- a/youtube-dl.1
+++ b/youtube-dl.1
@@ -1,4 +1,7 @@
+.\" Automatically generated by Pandoc 2.1.3
+.\"
 .TH "YOUTUBE\-DL" "1" "" "" ""
+.hy
 .SH NAME
 .PP
 youtube\-dl \- download videos from youtube.com or other video platforms
@@ -11,7 +14,7 @@ youtube\-dl \- download videos from youtube.com or other video platforms
 YouTube.com and a few more sites.
 It requires the Python interpreter, version 2.6, 2.7, or 3.2+, and it is
 not platform specific.
-It should work on your Unix box, on Windows or on Mac OS X.
+It should work on your Unix box, on Windows or on macOS.
 It is released to the public domain, which means you can modify it,
 redistribute it or use it however you like.
 .SH OPTIONS
@@ -113,7 +116,7 @@ Do not emit color codes in output
 .TP
 .B \-\-proxy \f[I]URL\f[]
 Use the specified HTTP/HTTPS/SOCKS proxy.
-To enable experimental SOCKS proxy, specify a proper scheme.
+To enable SOCKS proxy, specify a proper scheme.
 For example socks5://127.0.0.1:1080/.
 Pass in an empty string (\-\-proxy "") for direct connection
 .RS
@@ -142,26 +145,31 @@ Make all connections via IPv6
 .TP
 .B \-\-geo\-verification\-proxy \f[I]URL\f[]
 Use this proxy to verify the IP address for some geo\-restricted sites.
-The default proxy specified by \-\-proxy (or none, if the options is not
+The default proxy specified by \-\-proxy (or none, if the option is not
 present) is used for the actual downloading.
 .RS
 .RE
 .TP
 .B \-\-geo\-bypass
 Bypass geographic restriction via faking X\-Forwarded\-For HTTP header
-(experimental)
 .RS
 .RE
 .TP
 .B \-\-no\-geo\-bypass
 Do not bypass geographic restriction via faking X\-Forwarded\-For HTTP
-header (experimental)
+header
 .RS
 .RE
 .TP
 .B \-\-geo\-bypass\-country \f[I]CODE\f[]
 Force bypass geographic restriction with explicitly provided two\-letter
-ISO 3166\-2 country code (experimental)
+ISO 3166\-2 country code
+.RS
+.RE
+.TP
+.B \-\-geo\-bypass\-ip\-block \f[I]IP_BLOCK\f[]
+Force bypass geographic restriction with explicitly provided IP block in
+CIDR notation
 .RS
 .RE
 .SS Video Selection:
@@ -331,6 +339,14 @@ value of SIZE.
 .RS
 .RE
 .TP
+.B \-\-http\-chunk\-size \f[I]SIZE\f[]
+Size of a chunk for chunk\-based HTTP downloading (e.g.
+10485760 or 10M) (default is disabled).
+May be useful for bypassing bandwidth throttling imposed by a webserver
+(experimental)
+.RS
+.RE
+.TP
 .B \-\-playlist\-reverse
 Download playlist videos in reverse order
 .RS
@@ -342,7 +358,7 @@ Download playlist videos in random order
 .RE
 .TP
 .B \-\-xattr\-set\-filesize
-Set file xattribute ytdl.filesize with expected file size (experimental)
+Set file xattribute ytdl.filesize with expected file size
 .RS
 .RE
 .TP
@@ -375,7 +391,10 @@ Give these arguments to the external downloader
 .SS Filesystem Options:
 .TP
 .B \-a, \-\-batch\-file \f[I]FILE\f[]
-File containing URLs to download (\[aq]\-\[aq] for stdin)
+File containing URLs to download (\[aq]\-\[aq] for stdin), one URL per
+line.
+Lines starting with \[aq]#\[aq], \[aq];\[aq] or \[aq]]\[aq] are
+considered as comments and ignored.
 .RS
 .RE
 .TP
@@ -986,7 +1005,7 @@ machine\ twitch\ login\ my_twitch_account_name\ password\ my_twitch_password
 .PP
 To activate authentication with the \f[C]\&.netrc\f[] file you should
 pass \f[C]\-\-netrc\f[] to youtube\-dl or place it in the configuration
-file (#configuration).
+file.
 .PP
 On Windows you may also need to setup the \f[C]%HOME%\f[] environment
 variable manually.
@@ -1002,7 +1021,7 @@ set\ HOME=%USERPROFILE%
 The \f[C]\-o\f[] option allows users to indicate a template for the
 output file names.
 .PP
-\f[B]tl;dr:\f[] navigate me to examples (#output-template-examples).
+\f[B]tl;dr:\f[] navigate me to examples.
 .PP
 The basic usage is not to set any template arguments when downloading a
 single file, like in
@@ -1066,6 +1085,15 @@ scale used depends on the webpage
 .IP \[bu] 2
 \f[C]age_limit\f[] (numeric): Age restriction for the video (years)
 .IP \[bu] 2
+\f[C]is_live\f[] (boolean): Whether this video is a live stream or a
+fixed\-length video
+.IP \[bu] 2
+\f[C]start_time\f[] (numeric): Time in seconds where the reproduction
+should start, as specified in the URL
+.IP \[bu] 2
+\f[C]end_time\f[] (numeric): Time in seconds where the reproduction
+should end, as specified in the URL
+.IP \[bu] 2
 \f[C]format\f[] (string): A human\-readable description of the format
 .IP \[bu] 2
 \f[C]format_id\f[] (string): Format code specified by
@@ -1120,6 +1148,11 @@ padded with leading zeros according to the total length of the playlist
 \f[C]playlist_id\f[] (string): Playlist identifier
 .IP \[bu] 2
 \f[C]playlist_title\f[] (string): Playlist title
+.IP \[bu] 2
+\f[C]playlist_uploader\f[] (string): Full name of the playlist uploader
+.IP \[bu] 2
+\f[C]playlist_uploader_id\f[] (string): Nickname or id of the playlist
+uploader
 .PP
 Available for the video that belongs to some logical chapter or section:
 .IP \[bu] 2
@@ -1268,7 +1301,7 @@ expression\f[], i.e.
 an expression that describes format or formats you would like to
 download.
 .PP
-\f[B]tl;dr:\f[] navigate me to examples (#format-selection-examples).
+\f[B]tl;dr:\f[] navigate me to examples.
 .PP
 The simplest case is requesting a specific format, for example with
 \f[C]\-f\ 22\f[] you can download the format with format code equal to
@@ -1393,8 +1426,8 @@ If you want to preserve the old format selection behavior (prior to
 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[C]\-f\ best\f[].
-You may want to add it to the configuration file (#configuration) in
-order not to type it every time you run youtube\-dl.
+You may want to add it to the configuration file in order not to type it
+every time you run youtube\-dl.
 .SS Format selection examples
 .PP
 Note that on Windows you may need to use double quotes instead of
@@ -1604,12 +1637,12 @@ youtube\-dl in turn.
 .PP
 YouTube has switched to a new video info format in July 2011 which is
 not supported by old versions of youtube\-dl.
-See above (#how-do-i-update-youtube-dl) for how to update youtube\-dl.
+See above for how to update youtube\-dl.
 .SS ERROR: unable to download video
 .PP
 YouTube requires an additional signature since September 2012 which is
 not supported by old versions of youtube\-dl.
-See above (#how-do-i-update-youtube-dl) for how to update youtube\-dl.
+See above for how to update youtube\-dl.
 .SS Video URL contains an ampersand and I\[aq]m getting some strange
 output \f[C][1]\ 2839\f[] or
 \f[C]\[aq]v\[aq]\ is\ not\ recognized\ as\ an\ internal\ or\ external\ command\f[]
@@ -1640,15 +1673,15 @@ For Windows you have to use the double quotes:
 .PP
 In February 2015, the new YouTube player contained a character sequence
 in a string that was misinterpreted by old versions of youtube\-dl.
-See above (#how-do-i-update-youtube-dl) for how to update youtube\-dl.
+See above for how to update youtube\-dl.
 .SS HTTP Error 429: Too Many Requests or 402: Payment Required
 .PP
 These two error codes indicate that the service is blocking your IP
 address because of overuse.
 Contact the service and ask them to unblock your IP address, or \- if
 you have acquired a whitelisted IP address already \- use the
-\f[C]\-\-proxy\f[] or \f[C]\-\-source\-address\f[]
-options (#network-options) to select another IP address.
+\f[C]\-\-proxy\f[] or \f[C]\-\-source\-address\f[] options to select
+another IP address.
 .SS SyntaxError: Non\-ASCII character
 .PP
 The error
@@ -1696,10 +1729,10 @@ ffmpeg) by simply typing \f[C]youtube\-dl\f[] or \f[C]ffmpeg\f[], no
 matter what directory you\[aq]re in.
 .SS How do I put downloads into a specific folder?
 .PP
-Use the \f[C]\-o\f[] to specify an output template (#output-template),
-for example \f[C]\-o\ "/home/user/videos/%(title)s\-%(id)s.%(ext)s"\f[].
+Use the \f[C]\-o\f[] to specify an output template, for example
+\f[C]\-o\ "/home/user/videos/%(title)s\-%(id)s.%(ext)s"\f[].
 If you want this for all of your downloads, put the option into your
-configuration file (#configuration).
+configuration file.
 .SS How do I download a video starting with a \f[C]\-\f[]?
 .PP
 Either prepend \f[C]https://www.youtube.com/watch?v=\f[] or separate the
@@ -1732,7 +1765,7 @@ Make sure you have correct newline
 format (https://en.wikipedia.org/wiki/Newline) in the cookies file and
 convert newlines if necessary to correspond with your OS, namely
 \f[C]CRLF\f[] (\f[C]\\r\\n\f[]) for Windows and \f[C]LF\f[]
-(\f[C]\\n\f[]) for Unix and Unix\-like systems (Linux, Mac OS, etc.).
+(\f[C]\\n\f[]) for Unix and Unix\-like systems (Linux, macOS, etc.).
 \f[C]HTTP\ Error\ 400:\ Bad\ Request\f[] when using \f[C]\-\-cookies\f[]
 is a good sign of invalid newline format.
 .PP
@@ -1847,7 +1880,7 @@ serves as a unified point.
 Unfortunately, the youtube\-dl project has grown too large to use
 personal email as an effective communication channel.
 .PP
-Please read the bug reporting instructions (#bugs) below.
+Please read the bug reporting instructions below.
 A lot of bugs lack all the necessary information.
 If you can, offer proxy, VPN, or shell access to the youtube\-dl
 developers.
@@ -1893,15 +1926,14 @@ you run it from a Python program.
 .SH Why do I need to go through that much red tape when filing bugs?
 .PP
 Before we had the issue template, despite our extensive bug reporting
-instructions (#bugs), about 80% of the issue reports we got were
-useless, for instance because people used ancient versions hundreds of
-releases old, because of simple syntactic errors (not in youtube\-dl but
-in general shell usage), because the problem was already reported
-multiple times before, because people did not actually read an error
-message, even if it said "please install ffmpeg", because people did not
-mention the URL they were trying to download and many more simple,
-easy\-to\-avoid problems, many of whom were totally unrelated to
-youtube\-dl.
+instructions, about 80% of the issue reports we got were useless, for
+instance because people used ancient versions hundreds of releases old,
+because of simple syntactic errors (not in youtube\-dl but in general
+shell usage), because the problem was already reported multiple times
+before, because people did not actually read an error message, even if
+it said "please install ffmpeg", because people did not mention the URL
+they were trying to download and many more simple, easy\-to\-avoid
+problems, many of whom were totally unrelated to youtube\-dl.
 .PP
 youtube\-dl is an open\-source project manned by too few volunteers, so
 we\[aq]d rather spend time fixing bugs where we are certain none of
@@ -1938,8 +1970,8 @@ nosetests
 \f[]
 .fi
 .PP
-See item 6 of new extractor tutorial (#adding-support-for-a-new-site)
-for how to run extractor specific test cases.
+See item 6 of new extractor tutorial for how to run extractor specific
+test cases.
 .PP
 If you want to create a build of youtube\-dl yourself, you\[aq]ll need
 .IP \[bu] 2
@@ -1971,7 +2003,7 @@ Check out the source code with:
 .IP
 .nf
 \f[C]
-git\ clone\ git\@github.com:YOUR_GITHUB_USERNAME/youtube\-dl.git
+\ git\ clone\ git\@github.com:YOUR_GITHUB_USERNAME/youtube\-dl.git
 \f[]
 .fi
 .RE
@@ -1981,8 +2013,8 @@ Start a new git branch with
 .IP
 .nf
 \f[C]
-cd\ youtube\-dl
-git\ checkout\ \-b\ yourextractor
+\ cd\ youtube\-dl
+\ git\ checkout\ \-b\ yourextractor
 \f[]
 .fi
 .RE
@@ -2057,9 +2089,8 @@ extractor should and may
 return (https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L74-L252).
 Add tests and code for as many as you want.
 .IP " 8." 4
-Make sure your code follows youtube\-dl coding
-conventions (#youtube-dl-coding-conventions) and check the code with
-flake8 (https://pypi.python.org/pypi/flake8).
+Make sure your code follows youtube\-dl coding conventions and check the
+code with flake8 (https://pypi.python.org/pypi/flake8).
 Also make sure your code works under all
 Python (https://www.python.org/) versions claimed supported by
 youtube\-dl, namely 2.6, 2.7, and 3.2+.
@@ -2071,10 +2102,10 @@ push (https://git-scm.com/docs/git-push) the result, like this:
 .IP
 .nf
 \f[C]
-$\ git\ add\ youtube_dl/extractor/extractors.py
-$\ git\ add\ youtube_dl/extractor/yourextractor.py
-$\ git\ commit\ \-m\ \[aq][yourextractor]\ Add\ new\ extractor\[aq]
-$\ git\ push\ origin\ yourextractor
+\ $\ git\ add\ youtube_dl/extractor/extractors.py
+\ $\ git\ add\ youtube_dl/extractor/yourextractor.py
+\ $\ git\ commit\ \-m\ \[aq][yourextractor]\ Add\ new\ extractor\[aq]
+\ $\ git\ push\ origin\ yourextractor
 \f[]
 .fi
 .RE
@@ -2323,7 +2354,7 @@ with\ youtube_dl.YoutubeDL(ydl_opts)\ as\ ydl:
 .PP
 Most likely, you\[aq]ll want to use various options.
 For a list of options available, have a look at
-\f[C]youtube_dl/YoutubeDL.py\f[] (https://github.com/rg3/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L129-L279).
+\f[C]youtube_dl/YoutubeDL.py\f[] (https://github.com/rg3/youtube-dl/blob/3e4cedf9e8cd3157df2457df7274d0c842421945/youtube_dl/YoutubeDL.py#L137-L312).
 For a start, if you want to intercept youtube\-dl\[aq]s output, set a
 \f[C]logger\f[] object.
 .PP
@@ -2379,7 +2410,7 @@ For discussions, join us in the IRC channel
 (webchat (https://webchat.freenode.net/?randomnick=1&channels=youtube-dl)).
 .PP
 \f[B]Please include the full output of youtube\-dl when run with
-\f[C]\-v\f[]\f[], i.e.
+\f[BC]\-v\f[B]\f[], i.e.
 \f[B]add\f[] \f[C]\-v\f[] flag to \f[B]your command line\f[], copy the
 \f[B]whole\f[] output and post it in the issue body wrapped in ``` for
 better formatting.