Imported Debian patch 2011.01.30-2

[youtubedl] / debian / youtube-dl.1

diff --git a/debian/youtube-dl.1 b/debian/youtube-dl.1
index 7d8657af5c0e0bb55093036a520b40f9110fd9b5..d6aa91baeb3d5e91aa1d685e32ec5eea5251096b 100644 (file)
--- a/debian/youtube-dl.1
+++ b/debian/youtube-dl.1
@@ -124,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "YOUTUBE-DL 1"
 .\" ========================================================================
 .\"
 .IX Title "YOUTUBE-DL 1"

-.TH YOUTUBE-DL 1 "2010-08-09" "youtube-dl" "User Commands"
+.TH YOUTUBE-DL 1 "2011-01-31" "perl v5.10.1" "User Contributed Perl Documentation"

 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l


@@ -175,6 +175,18 @@ Limit the download speed to the specified maximum \fBL\fR (e.g., 50k or 44.6m).
 .IP "\-R \fBR\fR, \-\-retries=\fBR\fR" 4
 .IX Item "-R R, --retries=R"
 Number \fBR\fR of retries for a given download (default is 10).
 .IP "\-R \fBR\fR, \-\-retries=\fBR\fR" 4
 .IX Item "-R R, --retries=R"
 Number \fBR\fR of retries for a given download (default is 10).

+.IP "\-\-playlist\-start=\fBN\fR" 4
+.IX Item "--playlist-start=N"
+The number \fBN\fR of the video in a playlist where we should start downlading
+(default is 1).
+.IP "\-\-playlist\-end=\fBN\fR" 4
+.IX Item "--playlist-end=N"
+The number \fBN\fR of the video in a playlist where we should stop downloading
+(default is \-1, which stands for the last video in the playlist).
+.IP "\-\-dump\-user\-agent" 4
+.IX Item "--dump-user-agent"
+Display how youtube-dl will identify itself (the User-Agent string) to the
+remote server.

 .IP "\-u \fB\s-1UN\s0\fR, \-\-username=\fB\s-1UN\s0\fR" 4
 .IX Item "-u UN, --username=UN"
 Specify the youtube account username \fB\s-1UN\s0\fR. Some videos require an
 .IP "\-u \fB\s-1UN\s0\fR, \-\-username=\fB\s-1UN\s0\fR" 4
 .IX Item "-u UN, --username=UN"
 Specify the youtube account username \fB\s-1UN\s0\fR. Some videos require an


@@ -189,16 +201,37 @@ Get authentication data from the standard unix .netrc file on the user's
 home directory. The machine name is youtube regarding this usage.
 .IP "\-f \fB\s-1FMT\s0\fR, \-\-format=\fB\s-1FMT\s0\fR" 4
 .IX Item "-f FMT, --format=FMT"
 home directory. The machine name is youtube regarding this usage.
 .IP "\-f \fB\s-1FMT\s0\fR, \-\-format=\fB\s-1FMT\s0\fR" 4
 .IX Item "-f FMT, --format=FMT"

-Specify the video format (quality) in which to download the video. Note
-that not all videos are available in all formats.
-.IP "\-b, \-\-best\-quality" 4
-.IX Item "-b, --best-quality"
-This option is deprecated, does nothing currently, and is expected to be
-removed in a next release, as it is the current behavior of youtube-dl.
-.IP "\-m, \-\-mobile\-version" 4
-.IX Item "-m, --mobile-version"
-Synonymous to the option \*(L"\-f 17\*(R", to download videos playable on some
-mobile phones.
+Specify the video format (quality) in which to download the video.
+.Sp
+For youtube.com, in particular, the meaning of the format codes is given as:
+.RS 4
+.IP "WebM video at 480p: 43" 4
+.IX Item "WebM video at 480p: 43"
+.PD 0
+.IP "WebM video at 720p: 45" 4
+.IX Item "WebM video at 720p: 45"
+.IP "H264 video in \s-1MP4\s0 container at 480p: 18" 4
+.IX Item "H264 video in MP4 container at 480p: 18"
+.IP "H264 video in \s-1MP4\s0 container at 720p: 22" 4
+.IX Item "H264 video in MP4 container at 720p: 22"
+.IP "H264 video in \s-1MP4\s0 container at 1080p: 37" 4
+.IX Item "H264 video in MP4 container at 1080p: 37"
+.IP "H264 video in \s-1FLV\s0 container at 360p: 34" 4
+.IX Item "H264 video in FLV container at 360p: 34"
+.IP "H264 video in \s-1FLV\s0 container at 480p: 35" 4
+.IX Item "H264 video in FLV container at 480p: 35"
+.IP "H263 video at 240p: 5" 4
+.IX Item "H263 video at 240p: 5"
+.IP "3GP video: 17" 4
+.IX Item "3GP video: 17"
+.RE
+.RS 4
+.PD
+.Sp
+Note that not all videos are available in all formats and that other
+sites supported by \fByoutube-dl\fR may have different conventions for
+their video formats.
+.RE

 .IP "\-\-all\-formats" 4
 .IX Item "--all-formats"
 Downloads all formats for which a video may be available.
 .IP "\-\-all\-formats" 4
 .IX Item "--all-formats"
 Downloads all formats for which a video may be available.


@@ -230,9 +263,16 @@ thumbnail.
 .IX Item "--get-description"
 Simulate the operation, like quiet mode, but print the description of the
 video.
 .IX Item "--get-description"
 Simulate the operation, like quiet mode, but print the description of the
 video.

+.IP "\-\-get\-filename" 4
+.IX Item "--get-filename"
+Simulate the operation, like quiet mode, but print the output filename.

 .IP "\-\-no\-progress" 4
 .IX Item "--no-progress"
 Do not print the progress bar during downloads.
 .IP "\-\-no\-progress" 4
 .IX Item "--no-progress"
 Do not print the progress bar during downloads.

+.IP "\-\-console\-title" 4
+.IX Item "--console-title"
+If possible, set the title of the console window with the progress of the
+download.

 .IP "\-t, \-\-title" 4
 .IX Item "-t, --title"
 Use the title of the video in the file name used to download the video.
 .IP "\-t, \-\-title" 4
 .IX Item "-t, --title"
 Use the title of the video in the file name used to download the video.


@@ -241,6 +281,10 @@ Use the title of the video in the file name used to download the video.
 Use the literal title of the video in file name used to download the
 video. Can contain \*(L"weird\*(R" characters that are not filtered like with
 the \-t option.
 Use the literal title of the video in file name used to download the
 video. Can contain \*(L"weird\*(R" characters that are not filtered like with
 the \-t option.

+.IP "\-A, \-\-auto\-number" 4
+.IX Item "-A, --auto-number"
+When downloading multiple videos from a playlist, automatically number them,
+in sequence, starting from 00000.

 .IP "\-o \fB\s-1TPL\s0\fR, \-\-output=\fB\s-1TPL\s0\fR" 4
 .IX Item "-o TPL, --output=TPL"
 Specify a template \fB\s-1TPL\s0\fR for the names of the files to be created when
 .IP "\-o \fB\s-1TPL\s0\fR, \-\-output=\fB\s-1TPL\s0\fR" 4
 .IX Item "-o TPL, --output=TPL"
 Specify a template \fB\s-1TPL\s0\fR for the names of the files to be created when


@@ -258,6 +302,15 @@ Do no overwrite already existing files.
 .IP "\-c, \-\-continue" 4
 .IX Item "-c, --continue"
 Resume partially downloaded files.
 .IP "\-c, \-\-continue" 4
 .IX Item "-c, --continue"
 Resume partially downloaded files.

+.IP "\-\-cookies=\fBF\fR" 4
+.IX Item "--cookies=F"
+Store the received cookies to file \fBF\fR (the \*(L"cookie jar\*(R").
+.IP "\-\-no\-part" 4
+.IX Item "--no-part"
+Do not append the \fI.part\fR suffix do files that have not yet been completed.
+.IP "\-\-no\-mtime" 4
+.IX Item "--no-mtime"
+Do not use the \fILast-modified\fR header to set the file modification time.

 .SH "OUTPUT TEMPLATE"
 .IX Header "OUTPUT TEMPLATE"
 The \-o option allows users to indicate a template for the output file
 .SH "OUTPUT TEMPLATE"
 .IX Header "OUTPUT TEMPLATE"
 The \-o option allows users to indicate a template for the output file