Imported Debian patch 2011.02.25b-1

[youtubedl] / debian / youtube-dl.1

diff --git a/debian/youtube-dl.1 b/debian/youtube-dl.1
index 13af73220a8175beef58f24c349aaff818b0e442..bcbce6c489e089a12536ecdc99c4c3fd9f4828f1 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 "2009-11-19" "perl v5.10.1" "User Commands"
+.TH YOUTUBE-DL 1 "2011-02-25" "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


@@ -163,12 +163,30 @@ Print help text and exit.
 .IP "\-v, \-\-version" 4
 .IX Item "-v, --version"
 Print program version and exit.
 .IP "\-v, \-\-version" 4
 .IX Item "-v, --version"
 Print program version and exit.

+.IP "\-U, \-\-update" 4
+.IX Item "-U, --update"
+Update this program to the latest stable version.

 .IP "\-i, \-\-ignore\-errors" 4
 .IX Item "-i, --ignore-errors"
 Ignore errors during download and continue processing.
 .IP "\-r \fBL\fR, \-\-rate\-limit=\fBL\fR" 4
 .IX Item "-r L, --rate-limit=L"
 Limit the download speed to the specified maximum \fBL\fR (e.g., 50k or 44.6m).
 .IP "\-i, \-\-ignore\-errors" 4
 .IX Item "-i, --ignore-errors"
 Ignore errors during download and continue processing.
 .IP "\-r \fBL\fR, \-\-rate\-limit=\fBL\fR" 4
 .IX Item "-r L, --rate-limit=L"
 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 "\-\-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


@@ -180,23 +198,46 @@ Like the username, specifies the account password to be \fB\s-1PW\s0\fR.
 .IP "\-n, \-\-netrc" 4
 .IX Item "-n, --netrc"
 Get authentication data from the standard unix .netrc file on the user's
 .IP "\-n, \-\-netrc" 4
 .IX Item "-n, --netrc"
 Get authentication data from the standard unix .netrc file on the user's

-home directory. The machine name is youtube in regarding this usage.
-.IP "\-f \s-1FMT\s0, \-\-format=FMT" 4
+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"
 .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"
-Download the best video quality available for the video(s) specified by
-the user.
-.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.
-.IP "\-d, \-\-high\-def" 4
-.IX Item "-d, --high-def"
-Synonymous to the option \*(L"\-f 37\*(R", to download videos in \s-1HD\s0 quality
-(1080p).
+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 "\-\-max\-quality=\fB\s-1FMT\s0\fR" 4
+.IX Item "--max-quality=FMT"
+Limit the maximum quality of the videos to downloads to \fB\s-1FMT\s0\fR.

 .IP "\-q, \-\-quiet" 4
 .IX Item "-q, --quiet"
 Activates quiet mode, avoiding many messages being written to the
 .IP "\-q, \-\-quiet" 4
 .IX Item "-q, --quiet"
 Activates quiet mode, avoiding many messages being written to the


@@ -214,6 +255,24 @@ wget or aria2c.
 .IX Item "-e, --get-title"
 Simulate the operation, like quiet mode, but show the title of the video
 that would be downloaded.
 .IX Item "-e, --get-title"
 Simulate the operation, like quiet mode, but show the title of the video
 that would be downloaded.

+.IP "\-\-get\-thumbnail" 4
+.IX Item "--get-thumbnail"
+Simulate the operation, like quiet mode, but print the \s-1URL\s0 of of the video's
+thumbnail.
+.IP "\-\-get\-description" 4
+.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 "\-\-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.


@@ -222,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


@@ -239,6 +302,23 @@ 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.
+.IP "\-\-extract\-audio" 4
+.IX Item "--extract-audio"
+Create an audio-only file extracted from the video downloaded. Requires that
+ffmpeg and ffprobe be installed.
+.IP "\-\-audio\-format=\fB\s-1FORMAT\s0\fR" 4
+.IX Item "--audio-format=FORMAT"
+Set the audio format to be used for the extraction. Possible values are
+\&\fIbest\fR, \fIaac\fR, \fImp3\fR, with \fIbest\fR being the default.

 .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


@@ -281,5 +361,5 @@ like \f(CW\*(C`%(title)s\-%(id)s.%(ext)s\*(C'\fR. You can specify your own.
 .SH "AUTHOR"
 .IX Header "AUTHOR"
 youtube-dl was written by Ricardo Garcia Gonzalez and many contributors
 .SH "AUTHOR"
 .IX Header "AUTHOR"
 youtube-dl was written by Ricardo Garcia Gonzalez and many contributors

-from all around the internet.  This manpage was written by RogA\*~Xrio Brito
+from all around the internet.  This manpage was written by Rogerio Brito

 <rbrito@users.sf.net>.
 <rbrito@users.sf.net>.