Raphaël G. Git Repositories - youtubedl/blob - debian/youtube-dl.1

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "YOUTUBE-DL 1"
 127 .TH YOUTUBE-DL 1 "2011-02-25" "perl v5.10.1" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 youtube\-dl \- download videos from youtube.com
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 1
 137 \&  youtube\-dl [options] url ...
 138 .Ve
 139 .SH "DESCRIPTION"
 140 .IX Header "DESCRIPTION"
 141 youtube-dl is a script to download videos from youtube.com.
 142 .PP
 143 Once it is installed in your system, you should be able to call it from
 144 the command line. Usage instructions are easy. Use youtube-dl followed
 145 by a video \s-1URL\s0 or identifier. As an example, consider:
 146 .PP
 147 .Vb 1
 148 \&  youtube\-dl "http://www.youtube.com/watch?v=foobar"
 149 .Ve
 150 .PP
 151 The video will be saved to the file \f(CW\*(C`foobar.flv\*(C'\fR in that example. Many
 152 YouTube.com videos are in Flash Video format and their extension would
 153 be \f(CW\*(C`flv\*(C'\fR. Other videos are encoded in H.264 and these usually have the
 154 extension \f(CW\*(C`mp4\*(C'\fR.  In Linux and other unices, video players using a
 155 recent version of ffmpeg can play them. That includes MPlayer, \s-1VLC\s0,
 156 xine, among others.
 157 .SH "OPTIONS"
 158 .IX Header "OPTIONS"
 159 \&\fByoutube-dl\fR accepts options in the following categories
 160 .IP "\-h, \-\-help" 4
 161 .IX Item "-h, --help"
 162 Print help text and exit.
 163 .IP "\-v, \-\-version" 4
 164 .IX Item "-v, --version"
 165 Print program version and exit.
 166 .IP "\-U, \-\-update" 4
 167 .IX Item "-U, --update"
 168 Update this program to the latest stable version.
 169 .IP "\-i, \-\-ignore\-errors" 4
 170 .IX Item "-i, --ignore-errors"
 171 Ignore errors during download and continue processing.
 172 .IP "\-r \fBL\fR, \-\-rate\-limit=\fBL\fR" 4
 173 .IX Item "-r L, --rate-limit=L"
 174 Limit the download speed to the specified maximum \fBL\fR (e.g., 50k or 44.6m).
 175 .IP "\-R \fBR\fR, \-\-retries=\fBR\fR" 4
 176 .IX Item "-R R, --retries=R"
 177 Number \fBR\fR of retries for a given download (default is 10).
 178 .IP "\-\-playlist\-start=\fBN\fR" 4
 179 .IX Item "--playlist-start=N"
 180 The number \fBN\fR of the video in a playlist where we should start downlading
 181 (default is 1).
 182 .IP "\-\-playlist\-end=\fBN\fR" 4
 183 .IX Item "--playlist-end=N"
 184 The number \fBN\fR of the video in a playlist where we should stop downloading
 185 (default is \-1, which stands for the last video in the playlist).
 186 .IP "\-\-dump\-user\-agent" 4
 187 .IX Item "--dump-user-agent"
 188 Display how youtube-dl will identify itself (the User-Agent string) to the
 189 remote server.
 190 .IP "\-u \fB\s-1UN\s0\fR, \-\-username=\fB\s-1UN\s0\fR" 4
 191 .IX Item "-u UN, --username=UN"
 192 Specify the youtube account username \fB\s-1UN\s0\fR. Some videos require an
 193 account to be downloaded, mostly because they're flagged as mature
 194 content.
 195 .IP "\-p \fB\s-1PW\s0\fR, \-\-password=\fB\s-1PW\s0\fR" 4
 196 .IX Item "-p PW, --password=PW"
 197 Like the username, specifies the account password to be \fB\s-1PW\s0\fR.
 198 .IP "\-n, \-\-netrc" 4
 199 .IX Item "-n, --netrc"
 200 Get authentication data from the standard unix .netrc file on the user's
 201 home directory. The machine name is youtube regarding this usage.
 202 .IP "\-f \fB\s-1FMT\s0\fR, \-\-format=\fB\s-1FMT\s0\fR" 4
 203 .IX Item "-f FMT, --format=FMT"
 204 Specify the video format (quality) in which to download the video.
 205 .Sp
 206 For youtube.com, in particular, the meaning of the format codes is given as:
 207 .RS 4
 208 .IP "WebM video at 480p: 43" 4
 209 .IX Item "WebM video at 480p: 43"
 210 .PD 0
 211 .IP "WebM video at 720p: 45" 4
 212 .IX Item "WebM video at 720p: 45"
 213 .IP "H264 video in \s-1MP4\s0 container at 480p: 18" 4
 214 .IX Item "H264 video in MP4 container at 480p: 18"
 215 .IP "H264 video in \s-1MP4\s0 container at 720p: 22" 4
 216 .IX Item "H264 video in MP4 container at 720p: 22"
 217 .IP "H264 video in \s-1MP4\s0 container at 1080p: 37" 4
 218 .IX Item "H264 video in MP4 container at 1080p: 37"
 219 .IP "H264 video in \s-1FLV\s0 container at 360p: 34" 4
 220 .IX Item "H264 video in FLV container at 360p: 34"
 221 .IP "H264 video in \s-1FLV\s0 container at 480p: 35" 4
 222 .IX Item "H264 video in FLV container at 480p: 35"
 223 .IP "H263 video at 240p: 5" 4
 224 .IX Item "H263 video at 240p: 5"
 225 .IP "3GP video: 17" 4
 226 .IX Item "3GP video: 17"
 227 .RE
 228 .RS 4
 229 .PD
 230 .Sp
 231 Note that not all videos are available in all formats and that other
 232 sites supported by \fByoutube-dl\fR may have different conventions for
 233 their video formats.
 234 .RE
 235 .IP "\-\-all\-formats" 4
 236 .IX Item "--all-formats"
 237 Downloads all formats for which a video may be available.
 238 .IP "\-\-max\-quality=\fB\s-1FMT\s0\fR" 4
 239 .IX Item "--max-quality=FMT"
 240 Limit the maximum quality of the videos to downloads to \fB\s-1FMT\s0\fR.
 241 .IP "\-q, \-\-quiet" 4
 242 .IX Item "-q, --quiet"
 243 Activates quiet mode, avoiding many messages being written to the
 244 terminal.
 245 .IP "\-s, \-\-simulate" 4
 246 .IX Item "-s, --simulate"
 247 Simulate the operation, but do not download the video. Useful for
 248 testing.
 249 .IP "\-g, \-\-get\-url" 4
 250 .IX Item "-g, --get-url"
 251 Simulate the operation, like quiet mode, but show the \s-1URL\s0 that would be
 252 used to download the video. Can be used with other download tools like
 253 wget or aria2c.
 254 .IP "\-e, \-\-get\-title" 4
 255 .IX Item "-e, --get-title"
 256 Simulate the operation, like quiet mode, but show the title of the video
 257 that would be downloaded.
 258 .IP "\-\-get\-thumbnail" 4
 259 .IX Item "--get-thumbnail"
 260 Simulate the operation, like quiet mode, but print the \s-1URL\s0 of of the video's
 261 thumbnail.
 262 .IP "\-\-get\-description" 4
 263 .IX Item "--get-description"
 264 Simulate the operation, like quiet mode, but print the description of the
 265 video.
 266 .IP "\-\-get\-filename" 4
 267 .IX Item "--get-filename"
 268 Simulate the operation, like quiet mode, but print the output filename.
 269 .IP "\-\-no\-progress" 4
 270 .IX Item "--no-progress"
 271 Do not print the progress bar during downloads.
 272 .IP "\-\-console\-title" 4
 273 .IX Item "--console-title"
 274 If possible, set the title of the console window with the progress of the
 275 download.
 276 .IP "\-t, \-\-title" 4
 277 .IX Item "-t, --title"
 278 Use the title of the video in the file name used to download the video.
 279 .IP "\-l, \-\-literal" 4
 280 .IX Item "-l, --literal"
 281 Use the literal title of the video in file name used to download the
 282 video. Can contain \*(L"weird\*(R" characters that are not filtered like with
 283 the \-t option.
 284 .IP "\-A, \-\-auto\-number" 4
 285 .IX Item "-A, --auto-number"
 286 When downloading multiple videos from a playlist, automatically number them,
 287 in sequence, starting from 00000.
 288 .IP "\-o \fB\s-1TPL\s0\fR, \-\-output=\fB\s-1TPL\s0\fR" 4
 289 .IX Item "-o TPL, --output=TPL"
 290 Specify a template \fB\s-1TPL\s0\fR for the names of the files to be created when
 291 they are downloaded. The default filename is video_id.flv. But you can
 292 also use the video title in the filename with the \f(CW\*(C`\-t\*(C'\fR or \f(CW\*(C`\-\-title\*(C'\fR
 293 option, or preserve the literal title in the filename with the \f(CW\*(C`\-l\*(C'\fR or
 294 \&\f(CW\*(C`\-\-literal\*(C'\fR option.
 295 .IP "\-a \fBF\fR, \-\-batch\-file=\fBF\fR" 4
 296 .IX Item "-a F, --batch-file=F"
 297 Specify the name of a file containing URLs of videos to download from
 298 youtube in batch mode. The file must contain one \s-1URL\s0 per line.
 299 .IP "\-w, \-\-no\-overwrites" 4
 300 .IX Item "-w, --no-overwrites"
 301 Do no overwrite already existing files.
 302 .IP "\-c, \-\-continue" 4
 303 .IX Item "-c, --continue"
 304 Resume partially downloaded files.
 305 .IP "\-\-cookies=\fBF\fR" 4
 306 .IX Item "--cookies=F"
 307 Store the received cookies to file \fBF\fR (the \*(L"cookie jar\*(R").
 308 .IP "\-\-no\-part" 4
 309 .IX Item "--no-part"
 310 Do not append the \fI.part\fR suffix do files that have not yet been completed.
 311 .IP "\-\-no\-mtime" 4
 312 .IX Item "--no-mtime"
 313 Do not use the \fILast-modified\fR header to set the file modification time.
 314 .IP "\-\-extract\-audio" 4
 315 .IX Item "--extract-audio"
 316 Create an audio-only file extracted from the video downloaded. Requires that
 317 ffmpeg and ffprobe be installed.
 318 .IP "\-\-audio\-format=\fB\s-1FORMAT\s0\fR" 4
 319 .IX Item "--audio-format=FORMAT"
 320 Set the audio format to be used for the extraction. Possible values are
 321 \&\fIbest\fR, \fIaac\fR, \fImp3\fR, with \fIbest\fR being the default.
 322 .SH "OUTPUT TEMPLATE"
 323 .IX Header "OUTPUT TEMPLATE"
 324 The \-o option allows users to indicate a template for the output file
 325 names. The basic usage is not to set any template arguments when
 326 downloading a single file, like in youtube-dl \-o funny_video.flv
 327 \&\*(L"http://some/video\*(R". However, it may contain special sequences that will
 328 be replaced when downloading each video.
 329 .PP
 330 The special sequences have the format \f(CW\*(C`%(NAME)s\*(C'\fR. To clarify, that's a
 331 percent symbol followed by a name in parenthesis, followed by a
 332 lowercase S. Allowed names are:
 333 .IP "id" 4
 334 .IX Item "id"
 335 The sequence will be replaced by the video identifier.
 336 .IP "url" 4
 337 .IX Item "url"
 338 The sequence will be replaced by the video \s-1URL\s0.
 339 .IP "uploader" 4
 340 .IX Item "uploader"
 341 The sequence will be replaced by the nickname of the person who uploaded
 342 the video.
 343 .IP "title" 4
 344 .IX Item "title"
 345 The sequence will be replaced by the literal video title.
 346 .IP "stitle" 4
 347 .IX Item "stitle"
 348 The sequence will be replaced by a simplified video title, restricted to
 349 alphanumeric characters and dashes.
 350 .IP "ext" 4
 351 .IX Item "ext"
 352 The sequence will be replaced by the appropriate extension (like \f(CW\*(C`flv\*(C'\fR
 353 or \f(CW\*(C`mp4\*(C'\fR).
 354 .IP "epoch" 4
 355 .IX Item "epoch"
 356 The sequence will be replaced by the Unix epoch when creating the file.
 357 .PP
 358 As you may have guessed, the default template is \f(CW\*(C`%(id)s.%(ext)s\*(C'\fR. When
 359 some command line options are used, it's replaced by other templates
 360 like \f(CW\*(C`%(title)s\-%(id)s.%(ext)s\*(C'\fR. You can specify your own.
 361 .SH "AUTHOR"
 362 .IX Header "AUTHOR"
 363 youtube-dl was written by Ricardo Garcia Gonzalez and many contributors
 364 from all around the internet.  This manpage was written by Rogerio Brito
 365 <rbrito@users.sf.net>.