]> Raphaƫl G. Git Repositories - youtubedl/blob - youtube-dl.1
410fce138b3daa4ec54743527a7d1518a84840f3
[youtubedl] / youtube-dl.1
1 .TH "YOUTUBE\-DL" "1" "" "" ""
2 .SH NAME
3 .PP
4 youtube\-dl \- download videos from youtube.com or other video platforms
5 .SH SYNOPSIS
6 .PP
7 \f[B]youtube\-dl\f[] [OPTIONS] URL [URL...]
8 .SH DESCRIPTION
9 .PP
10 \f[B]youtube\-dl\f[] is a command\-line program to download videos from
11 YouTube.com and a few more sites.
12 It requires the Python interpreter, version 2.6, 2.7, or 3.2+, and it is
13 not platform specific.
14 It should work on your Unix box, on Windows or on Mac OS X.
15 It is released to the public domain, which means you can modify it,
16 redistribute it or use it however you like.
17 .SH OPTIONS
18 .TP
19 .B \-h, \-\-help
20 Print this help text and exit
21 .RS
22 .RE
23 .TP
24 .B \-\-version
25 Print program version and exit
26 .RS
27 .RE
28 .TP
29 .B \-U, \-\-update
30 Update this program to latest version.
31 Make sure that you have sufficient permissions (run with sudo if needed)
32 .RS
33 .RE
34 .TP
35 .B \-i, \-\-ignore\-errors
36 Continue on download errors, for example to skip unavailable videos in a
37 playlist
38 .RS
39 .RE
40 .TP
41 .B \-\-abort\-on\-error
42 Abort downloading of further videos (in the playlist or the command
43 line) if an error occurs
44 .RS
45 .RE
46 .TP
47 .B \-\-dump\-user\-agent
48 Display the current browser identification
49 .RS
50 .RE
51 .TP
52 .B \-\-list\-extractors
53 List all supported extractors
54 .RS
55 .RE
56 .TP
57 .B \-\-extractor\-descriptions
58 Output descriptions of all supported extractors
59 .RS
60 .RE
61 .TP
62 .B \-\-force\-generic\-extractor
63 Force extraction to use the generic extractor
64 .RS
65 .RE
66 .TP
67 .B \-\-default\-search \f[I]PREFIX\f[]
68 Use this prefix for unqualified URLs.
69 For example "gvsearch2:" downloads two videos from google videos for
70 youtube\-dl "large apple".
71 Use the value "auto" to let youtube\-dl guess ("auto_warning" to emit a
72 warning when guessing).
73 "error" just throws an error.
74 The default value "fixup_error" repairs broken URLs, but emits an error
75 if this is not possible instead of searching.
76 .RS
77 .RE
78 .TP
79 .B \-\-ignore\-config
80 Do not read configuration files.
81 When given in the global configuration file /etc/youtube\-dl.conf: Do
82 not read the user configuration in ~/.config/youtube\- dl/config
83 (%APPDATA%/youtube\-dl/config.txt on Windows)
84 .RS
85 .RE
86 .TP
87 .B \-\-config\-location \f[I]PATH\f[]
88 Location of the configuration file; either the path to the config or its
89 containing directory.
90 .RS
91 .RE
92 .TP
93 .B \-\-flat\-playlist
94 Do not extract the videos of a playlist, only list them.
95 .RS
96 .RE
97 .TP
98 .B \-\-mark\-watched
99 Mark videos watched (YouTube only)
100 .RS
101 .RE
102 .TP
103 .B \-\-no\-mark\-watched
104 Do not mark videos watched (YouTube only)
105 .RS
106 .RE
107 .TP
108 .B \-\-no\-color
109 Do not emit color codes in output
110 .RS
111 .RE
112 .SS Network Options:
113 .TP
114 .B \-\-proxy \f[I]URL\f[]
115 Use the specified HTTP/HTTPS/SOCKS proxy.
116 To enable experimental SOCKS proxy, specify a proper scheme.
117 For example socks5://127.0.0.1:1080/.
118 Pass in an empty string (\-\-proxy "") for direct connection
119 .RS
120 .RE
121 .TP
122 .B \-\-socket\-timeout \f[I]SECONDS\f[]
123 Time to wait before giving up, in seconds
124 .RS
125 .RE
126 .TP
127 .B \-\-source\-address \f[I]IP\f[]
128 Client\-side IP address to bind to
129 .RS
130 .RE
131 .TP
132 .B \-4, \-\-force\-ipv4
133 Make all connections via IPv4
134 .RS
135 .RE
136 .TP
137 .B \-6, \-\-force\-ipv6
138 Make all connections via IPv6
139 .RS
140 .RE
141 .SS Geo Restriction:
142 .TP
143 .B \-\-geo\-verification\-proxy \f[I]URL\f[]
144 Use this proxy to verify the IP address for some geo\-restricted sites.
145 The default proxy specified by \-\-proxy (or none, if the options is not
146 present) is used for the actual downloading.
147 .RS
148 .RE
149 .TP
150 .B \-\-geo\-bypass
151 Bypass geographic restriction via faking X\-Forwarded\-For HTTP header
152 (experimental)
153 .RS
154 .RE
155 .TP
156 .B \-\-no\-geo\-bypass
157 Do not bypass geographic restriction via faking X\-Forwarded\-For HTTP
158 header (experimental)
159 .RS
160 .RE
161 .TP
162 .B \-\-geo\-bypass\-country \f[I]CODE\f[]
163 Force bypass geographic restriction with explicitly provided two\-letter
164 ISO 3166\-2 country code (experimental)
165 .RS
166 .RE
167 .SS Video Selection:
168 .TP
169 .B \-\-playlist\-start \f[I]NUMBER\f[]
170 Playlist video to start at (default is 1)
171 .RS
172 .RE
173 .TP
174 .B \-\-playlist\-end \f[I]NUMBER\f[]
175 Playlist video to end at (default is last)
176 .RS
177 .RE
178 .TP
179 .B \-\-playlist\-items \f[I]ITEM_SPEC\f[]
180 Playlist video items to download.
181 Specify indices of the videos in the playlist separated by commas like:
182 "\-\-playlist\-items 1,2,5,8" if you want to download videos indexed 1,
183 2, 5, 8 in the playlist.
184 You can specify range: "\-\-playlist\-items 1\-3,7,10\-13", it will
185 download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13.
186 .RS
187 .RE
188 .TP
189 .B \-\-match\-title \f[I]REGEX\f[]
190 Download only matching titles (regex or caseless sub\-string)
191 .RS
192 .RE
193 .TP
194 .B \-\-reject\-title \f[I]REGEX\f[]
195 Skip download for matching titles (regex or caseless sub\-string)
196 .RS
197 .RE
198 .TP
199 .B \-\-max\-downloads \f[I]NUMBER\f[]
200 Abort after downloading NUMBER files
201 .RS
202 .RE
203 .TP
204 .B \-\-min\-filesize \f[I]SIZE\f[]
205 Do not download any videos smaller than SIZE (e.g.
206 50k or 44.6m)
207 .RS
208 .RE
209 .TP
210 .B \-\-max\-filesize \f[I]SIZE\f[]
211 Do not download any videos larger than SIZE (e.g.
212 50k or 44.6m)
213 .RS
214 .RE
215 .TP
216 .B \-\-date \f[I]DATE\f[]
217 Download only videos uploaded in this date
218 .RS
219 .RE
220 .TP
221 .B \-\-datebefore \f[I]DATE\f[]
222 Download only videos uploaded on or before this date (i.e.
223 inclusive)
224 .RS
225 .RE
226 .TP
227 .B \-\-dateafter \f[I]DATE\f[]
228 Download only videos uploaded on or after this date (i.e.
229 inclusive)
230 .RS
231 .RE
232 .TP
233 .B \-\-min\-views \f[I]COUNT\f[]
234 Do not download any videos with less than COUNT views
235 .RS
236 .RE
237 .TP
238 .B \-\-max\-views \f[I]COUNT\f[]
239 Do not download any videos with more than COUNT views
240 .RS
241 .RE
242 .TP
243 .B \-\-match\-filter \f[I]FILTER\f[]
244 Generic video filter.
245 Specify any key (see the "OUTPUT TEMPLATE" for a list of available keys)
246 to match if the key is present, !key to check if the key is not present,
247 key > NUMBER (like "comment_count > 12", also works with >=, <, <=, !=,
248 =) to compare against a number, key = \[aq]LITERAL\[aq] (like "uploader
249 = \[aq]Mike Smith\[aq]", also works with !=) to match against a string
250 literal and & to require multiple matches.
251 Values which are not known are excluded unless you put a question mark
252 (?) after the operator.
253 For example, to only match videos that have been liked more than 100
254 times and disliked less than 50 times (or the dislike functionality is
255 not available at the given service), but who also have a description,
256 use \-\-match\-filter "like_count > 100 & dislike_count <?
257 50 & description" .
258 .RS
259 .RE
260 .TP
261 .B \-\-no\-playlist
262 Download only the video, if the URL refers to a video and a playlist.
263 .RS
264 .RE
265 .TP
266 .B \-\-yes\-playlist
267 Download the playlist, if the URL refers to a video and a playlist.
268 .RS
269 .RE
270 .TP
271 .B \-\-age\-limit \f[I]YEARS\f[]
272 Download only videos suitable for the given age
273 .RS
274 .RE
275 .TP
276 .B \-\-download\-archive \f[I]FILE\f[]
277 Download only videos not listed in the archive file.
278 Record the IDs of all downloaded videos in it.
279 .RS
280 .RE
281 .TP
282 .B \-\-include\-ads
283 Download advertisements as well (experimental)
284 .RS
285 .RE
286 .SS Download Options:
287 .TP
288 .B \-r, \-\-limit\-rate \f[I]RATE\f[]
289 Maximum download rate in bytes per second (e.g.
290 50K or 4.2M)
291 .RS
292 .RE
293 .TP
294 .B \-R, \-\-retries \f[I]RETRIES\f[]
295 Number of retries (default is 10), or "infinite".
296 .RS
297 .RE
298 .TP
299 .B \-\-fragment\-retries \f[I]RETRIES\f[]
300 Number of retries for a fragment (default is 10), or "infinite" (DASH,
301 hlsnative and ISM)
302 .RS
303 .RE
304 .TP
305 .B \-\-skip\-unavailable\-fragments
306 Skip unavailable fragments (DASH, hlsnative and ISM)
307 .RS
308 .RE
309 .TP
310 .B \-\-abort\-on\-unavailable\-fragment
311 Abort downloading when some fragment is not available
312 .RS
313 .RE
314 .TP
315 .B \-\-keep\-fragments
316 Keep downloaded fragments on disk after downloading is finished;
317 fragments are erased by default
318 .RS
319 .RE
320 .TP
321 .B \-\-buffer\-size \f[I]SIZE\f[]
322 Size of download buffer (e.g.
323 1024 or 16K) (default is 1024)
324 .RS
325 .RE
326 .TP
327 .B \-\-no\-resize\-buffer
328 Do not automatically adjust the buffer size.
329 By default, the buffer size is automatically resized from an initial
330 value of SIZE.
331 .RS
332 .RE
333 .TP
334 .B \-\-playlist\-reverse
335 Download playlist videos in reverse order
336 .RS
337 .RE
338 .TP
339 .B \-\-playlist\-random
340 Download playlist videos in random order
341 .RS
342 .RE
343 .TP
344 .B \-\-xattr\-set\-filesize
345 Set file xattribute ytdl.filesize with expected file size (experimental)
346 .RS
347 .RE
348 .TP
349 .B \-\-hls\-prefer\-native
350 Use the native HLS downloader instead of ffmpeg
351 .RS
352 .RE
353 .TP
354 .B \-\-hls\-prefer\-ffmpeg
355 Use ffmpeg instead of the native HLS downloader
356 .RS
357 .RE
358 .TP
359 .B \-\-hls\-use\-mpegts
360 Use the mpegts container for HLS videos, allowing to play the video
361 while downloading (some players may not be able to play it)
362 .RS
363 .RE
364 .TP
365 .B \-\-external\-downloader \f[I]COMMAND\f[]
366 Use the specified external downloader.
367 Currently supports aria2c,avconv,axel,curl,ffmpeg,httpie,wget
368 .RS
369 .RE
370 .TP
371 .B \-\-external\-downloader\-args \f[I]ARGS\f[]
372 Give these arguments to the external downloader
373 .RS
374 .RE
375 .SS Filesystem Options:
376 .TP
377 .B \-a, \-\-batch\-file \f[I]FILE\f[]
378 File containing URLs to download (\[aq]\-\[aq] for stdin)
379 .RS
380 .RE
381 .TP
382 .B \-\-id
383 Use only video ID in file name
384 .RS
385 .RE
386 .TP
387 .B \-o, \-\-output \f[I]TEMPLATE\f[]
388 Output filename template, see the "OUTPUT TEMPLATE" for all the info
389 .RS
390 .RE
391 .TP
392 .B \-\-autonumber\-start \f[I]NUMBER\f[]
393 Specify the start value for %(autonumber)s (default is 1)
394 .RS
395 .RE
396 .TP
397 .B \-\-restrict\-filenames
398 Restrict filenames to only ASCII characters, and avoid "&" and spaces in
399 filenames
400 .RS
401 .RE
402 .TP
403 .B \-w, \-\-no\-overwrites
404 Do not overwrite files
405 .RS
406 .RE
407 .TP
408 .B \-c, \-\-continue
409 Force resume of partially downloaded files.
410 By default, youtube\-dl will resume downloads if possible.
411 .RS
412 .RE
413 .TP
414 .B \-\-no\-continue
415 Do not resume partially downloaded files (restart from beginning)
416 .RS
417 .RE
418 .TP
419 .B \-\-no\-part
420 Do not use .part files \- write directly into output file
421 .RS
422 .RE
423 .TP
424 .B \-\-no\-mtime
425 Do not use the Last\-modified header to set the file modification time
426 .RS
427 .RE
428 .TP
429 .B \-\-write\-description
430 Write video description to a .description file
431 .RS
432 .RE
433 .TP
434 .B \-\-write\-info\-json
435 Write video metadata to a .info.json file
436 .RS
437 .RE
438 .TP
439 .B \-\-write\-annotations
440 Write video annotations to a .annotations.xml file
441 .RS
442 .RE
443 .TP
444 .B \-\-load\-info\-json \f[I]FILE\f[]
445 JSON file containing the video information (created with the
446 "\-\-write\-info\-json" option)
447 .RS
448 .RE
449 .TP
450 .B \-\-cookies \f[I]FILE\f[]
451 File to read cookies from and dump cookie jar in
452 .RS
453 .RE
454 .TP
455 .B \-\-cache\-dir \f[I]DIR\f[]
456 Location in the filesystem where youtube\-dl can store some downloaded
457 information permanently.
458 By default $XDG_CACHE_HOME/youtube\-dl or ~/.cache/youtube\-dl .
459 At the moment, only YouTube player files (for videos with obfuscated
460 signatures) are cached, but that may change.
461 .RS
462 .RE
463 .TP
464 .B \-\-no\-cache\-dir
465 Disable filesystem caching
466 .RS
467 .RE
468 .TP
469 .B \-\-rm\-cache\-dir
470 Delete all filesystem cache files
471 .RS
472 .RE
473 .SS Thumbnail images:
474 .TP
475 .B \-\-write\-thumbnail
476 Write thumbnail image to disk
477 .RS
478 .RE
479 .TP
480 .B \-\-write\-all\-thumbnails
481 Write all thumbnail image formats to disk
482 .RS
483 .RE
484 .TP
485 .B \-\-list\-thumbnails
486 Simulate and list all available thumbnail formats
487 .RS
488 .RE
489 .SS Verbosity / Simulation Options:
490 .TP
491 .B \-q, \-\-quiet
492 Activate quiet mode
493 .RS
494 .RE
495 .TP
496 .B \-\-no\-warnings
497 Ignore warnings
498 .RS
499 .RE
500 .TP
501 .B \-s, \-\-simulate
502 Do not download the video and do not write anything to disk
503 .RS
504 .RE
505 .TP
506 .B \-\-skip\-download
507 Do not download the video
508 .RS
509 .RE
510 .TP
511 .B \-g, \-\-get\-url
512 Simulate, quiet but print URL
513 .RS
514 .RE
515 .TP
516 .B \-e, \-\-get\-title
517 Simulate, quiet but print title
518 .RS
519 .RE
520 .TP
521 .B \-\-get\-id
522 Simulate, quiet but print id
523 .RS
524 .RE
525 .TP
526 .B \-\-get\-thumbnail
527 Simulate, quiet but print thumbnail URL
528 .RS
529 .RE
530 .TP
531 .B \-\-get\-description
532 Simulate, quiet but print video description
533 .RS
534 .RE
535 .TP
536 .B \-\-get\-duration
537 Simulate, quiet but print video length
538 .RS
539 .RE
540 .TP
541 .B \-\-get\-filename
542 Simulate, quiet but print output filename
543 .RS
544 .RE
545 .TP
546 .B \-\-get\-format
547 Simulate, quiet but print output format
548 .RS
549 .RE
550 .TP
551 .B \-j, \-\-dump\-json
552 Simulate, quiet but print JSON information.
553 See the "OUTPUT TEMPLATE" for a description of available keys.
554 .RS
555 .RE
556 .TP
557 .B \-J, \-\-dump\-single\-json
558 Simulate, quiet but print JSON information for each command\-line
559 argument.
560 If the URL refers to a playlist, dump the whole playlist information in
561 a single line.
562 .RS
563 .RE
564 .TP
565 .B \-\-print\-json
566 Be quiet and print the video information as JSON (video is still being
567 downloaded).
568 .RS
569 .RE
570 .TP
571 .B \-\-newline
572 Output progress bar as new lines
573 .RS
574 .RE
575 .TP
576 .B \-\-no\-progress
577 Do not print progress bar
578 .RS
579 .RE
580 .TP
581 .B \-\-console\-title
582 Display progress in console titlebar
583 .RS
584 .RE
585 .TP
586 .B \-v, \-\-verbose
587 Print various debugging information
588 .RS
589 .RE
590 .TP
591 .B \-\-dump\-pages
592 Print downloaded pages encoded using base64 to debug problems (very
593 verbose)
594 .RS
595 .RE
596 .TP
597 .B \-\-write\-pages
598 Write downloaded intermediary pages to files in the current directory to
599 debug problems
600 .RS
601 .RE
602 .TP
603 .B \-\-print\-traffic
604 Display sent and read HTTP traffic
605 .RS
606 .RE
607 .TP
608 .B \-C, \-\-call\-home
609 Contact the youtube\-dl server for debugging
610 .RS
611 .RE
612 .TP
613 .B \-\-no\-call\-home
614 Do NOT contact the youtube\-dl server for debugging
615 .RS
616 .RE
617 .SS Workarounds:
618 .TP
619 .B \-\-encoding \f[I]ENCODING\f[]
620 Force the specified encoding (experimental)
621 .RS
622 .RE
623 .TP
624 .B \-\-no\-check\-certificate
625 Suppress HTTPS certificate validation
626 .RS
627 .RE
628 .TP
629 .B \-\-prefer\-insecure
630 Use an unencrypted connection to retrieve information about the video.
631 (Currently supported only for YouTube)
632 .RS
633 .RE
634 .TP
635 .B \-\-user\-agent \f[I]UA\f[]
636 Specify a custom user agent
637 .RS
638 .RE
639 .TP
640 .B \-\-referer \f[I]URL\f[]
641 Specify a custom referer, use if the video access is restricted to one
642 domain
643 .RS
644 .RE
645 .TP
646 .B \-\-add\-header \f[I]FIELD:VALUE\f[]
647 Specify a custom HTTP header and its value, separated by a colon
648 \[aq]:\[aq].
649 You can use this option multiple times
650 .RS
651 .RE
652 .TP
653 .B \-\-bidi\-workaround
654 Work around terminals that lack bidirectional text support.
655 Requires bidiv or fribidi executable in PATH
656 .RS
657 .RE
658 .TP
659 .B \-\-sleep\-interval \f[I]SECONDS\f[]
660 Number of seconds to sleep before each download when used alone or a
661 lower bound of a range for randomized sleep before each download
662 (minimum possible number of seconds to sleep) when used along with
663 \-\-max\-sleep\-interval.
664 .RS
665 .RE
666 .TP
667 .B \-\-max\-sleep\-interval \f[I]SECONDS\f[]
668 Upper bound of a range for randomized sleep before each download
669 (maximum possible number of seconds to sleep).
670 Must only be used along with \-\-min\-sleep\-interval.
671 .RS
672 .RE
673 .SS Video Format Options:
674 .TP
675 .B \-f, \-\-format \f[I]FORMAT\f[]
676 Video format code, see the "FORMAT SELECTION" for all the info
677 .RS
678 .RE
679 .TP
680 .B \-\-all\-formats
681 Download all available video formats
682 .RS
683 .RE
684 .TP
685 .B \-\-prefer\-free\-formats
686 Prefer free video formats unless a specific one is requested
687 .RS
688 .RE
689 .TP
690 .B \-F, \-\-list\-formats
691 List all available formats of requested videos
692 .RS
693 .RE
694 .TP
695 .B \-\-youtube\-skip\-dash\-manifest
696 Do not download the DASH manifests and related data on YouTube videos
697 .RS
698 .RE
699 .TP
700 .B \-\-merge\-output\-format \f[I]FORMAT\f[]
701 If a merge is required (e.g.
702 bestvideo+bestaudio), output to given container format.
703 One of mkv, mp4, ogg, webm, flv.
704 Ignored if no merge is required
705 .RS
706 .RE
707 .SS Subtitle Options:
708 .TP
709 .B \-\-write\-sub
710 Write subtitle file
711 .RS
712 .RE
713 .TP
714 .B \-\-write\-auto\-sub
715 Write automatically generated subtitle file (YouTube only)
716 .RS
717 .RE
718 .TP
719 .B \-\-all\-subs
720 Download all the available subtitles of the video
721 .RS
722 .RE
723 .TP
724 .B \-\-list\-subs
725 List all available subtitles for the video
726 .RS
727 .RE
728 .TP
729 .B \-\-sub\-format \f[I]FORMAT\f[]
730 Subtitle format, accepts formats preference, for example: "srt" or
731 "ass/srt/best"
732 .RS
733 .RE
734 .TP
735 .B \-\-sub\-lang \f[I]LANGS\f[]
736 Languages of the subtitles to download (optional) separated by commas,
737 use \-\-list\- subs for available language tags
738 .RS
739 .RE
740 .SS Authentication Options:
741 .TP
742 .B \-u, \-\-username \f[I]USERNAME\f[]
743 Login with this account ID
744 .RS
745 .RE
746 .TP
747 .B \-p, \-\-password \f[I]PASSWORD\f[]
748 Account password.
749 If this option is left out, youtube\-dl will ask interactively.
750 .RS
751 .RE
752 .TP
753 .B \-2, \-\-twofactor \f[I]TWOFACTOR\f[]
754 Two\-factor authentication code
755 .RS
756 .RE
757 .TP
758 .B \-n, \-\-netrc
759 Use .netrc authentication data
760 .RS
761 .RE
762 .TP
763 .B \-\-video\-password \f[I]PASSWORD\f[]
764 Video password (vimeo, smotri, youku)
765 .RS
766 .RE
767 .SS Adobe Pass Options:
768 .TP
769 .B \-\-ap\-mso \f[I]MSO\f[]
770 Adobe Pass multiple\-system operator (TV provider) identifier, use
771 \-\-ap\-list\-mso for a list of available MSOs
772 .RS
773 .RE
774 .TP
775 .B \-\-ap\-username \f[I]USERNAME\f[]
776 Multiple\-system operator account login
777 .RS
778 .RE
779 .TP
780 .B \-\-ap\-password \f[I]PASSWORD\f[]
781 Multiple\-system operator account password.
782 If this option is left out, youtube\-dl will ask interactively.
783 .RS
784 .RE
785 .TP
786 .B \-\-ap\-list\-mso
787 List all supported multiple\-system operators
788 .RS
789 .RE
790 .SS Post\-processing Options:
791 .TP
792 .B \-x, \-\-extract\-audio
793 Convert video files to audio\-only files (requires ffmpeg or avconv and
794 ffprobe or avprobe)
795 .RS
796 .RE
797 .TP
798 .B \-\-audio\-format \f[I]FORMAT\f[]
799 Specify audio format: "best", "aac", "flac", "mp3", "m4a", "opus",
800 "vorbis", or "wav"; "best" by default; No effect without \-x
801 .RS
802 .RE
803 .TP
804 .B \-\-audio\-quality \f[I]QUALITY\f[]
805 Specify ffmpeg/avconv audio quality, insert a value between 0 (better)
806 and 9 (worse) for VBR or a specific bitrate like 128K (default 5)
807 .RS
808 .RE
809 .TP
810 .B \-\-recode\-video \f[I]FORMAT\f[]
811 Encode the video to another format if necessary (currently supported:
812 mp4|flv|ogg|webm|mkv|avi)
813 .RS
814 .RE
815 .TP
816 .B \-\-postprocessor\-args \f[I]ARGS\f[]
817 Give these arguments to the postprocessor
818 .RS
819 .RE
820 .TP
821 .B \-k, \-\-keep\-video
822 Keep the video file on disk after the post\- processing; the video is
823 erased by default
824 .RS
825 .RE
826 .TP
827 .B \-\-no\-post\-overwrites
828 Do not overwrite post\-processed files; the post\-processed files are
829 overwritten by default
830 .RS
831 .RE
832 .TP
833 .B \-\-embed\-subs
834 Embed subtitles in the video (only for mp4, webm and mkv videos)
835 .RS
836 .RE
837 .TP
838 .B \-\-embed\-thumbnail
839 Embed thumbnail in the audio as cover art
840 .RS
841 .RE
842 .TP
843 .B \-\-add\-metadata
844 Write metadata to the video file
845 .RS
846 .RE
847 .TP
848 .B \-\-metadata\-from\-title \f[I]FORMAT\f[]
849 Parse additional metadata like song title / artist from the video title.
850 The format syntax is the same as \-\-output.
851 Regular expression with named capture groups may also be used.
852 The parsed parameters replace existing values.
853 Example: \-\-metadata\-from\- title "%(artist)s \- %(title)s" matches a
854 title like "Coldplay \- Paradise".
855 Example (regex): \-\-metadata\-from\-title "(?P.+?) \- (?P
856 .RS
857 \&.+)"
858 .RE
859 .TP
860 .B \-\-xattrs
861 Write metadata to the video file\[aq]s xattrs (using dublin core and xdg
862 standards)
863 .RS
864 .RE
865 .TP
866 .B \-\-fixup \f[I]POLICY\f[]
867 Automatically correct known faults of the file.
868 One of never (do nothing), warn (only emit a warning), detect_or_warn
869 (the default; fix file if we can, warn otherwise)
870 .RS
871 .RE
872 .TP
873 .B \-\-prefer\-avconv
874 Prefer avconv over ffmpeg for running the postprocessors (default)
875 .RS
876 .RE
877 .TP
878 .B \-\-prefer\-ffmpeg
879 Prefer ffmpeg over avconv for running the postprocessors
880 .RS
881 .RE
882 .TP
883 .B \-\-ffmpeg\-location \f[I]PATH\f[]
884 Location of the ffmpeg/avconv binary; either the path to the binary or
885 its containing directory.
886 .RS
887 .RE
888 .TP
889 .B \-\-exec \f[I]CMD\f[]
890 Execute a command on the file after downloading, similar to find\[aq]s
891 \-exec syntax.
892 Example: \-\-exec \[aq]adb push {} /sdcard/Music/ && rm {}\[aq]
893 .RS
894 .RE
895 .TP
896 .B \-\-convert\-subs \f[I]FORMAT\f[]
897 Convert the subtitles to other format (currently supported:
898 srt|ass|vtt|lrc)
899 .RS
900 .RE
901 .SH CONFIGURATION
902 .PP
903 You can configure youtube\-dl by placing any supported command line
904 option to a configuration file.
905 On Linux and OS X, the system wide configuration file is located at
906 \f[C]/etc/youtube\-dl.conf\f[] and the user wide configuration file at
907 \f[C]~/.config/youtube\-dl/config\f[].
908 On Windows, the user wide configuration file locations are
909 \f[C]%APPDATA%\\youtube\-dl\\config.txt\f[] or
910 \f[C]C:\\Users\\<user\ name>\\youtube\-dl.conf\f[].
911 Note that by default configuration file may not exist so you may need to
912 create it yourself.
913 .PP
914 For example, with the following configuration file youtube\-dl will
915 always extract the audio, not copy the mtime, use a proxy and save all
916 videos under \f[C]Movies\f[] directory in your home directory:
917 .IP
918 .nf
919 \f[C]
920 #\ Lines\ starting\ with\ #\ are\ comments
921
922 #\ Always\ extract\ audio
923 \-x
924
925 #\ Do\ not\ copy\ the\ mtime
926 \-\-no\-mtime
927
928 #\ Use\ this\ proxy
929 \-\-proxy\ 127.0.0.1:3128
930
931 #\ Save\ all\ videos\ under\ Movies\ directory\ in\ your\ home\ directory
932 \-o\ ~/Movies/%(title)s.%(ext)s
933 \f[]
934 .fi
935 .PP
936 Note that options in configuration file are just the same options aka
937 switches used in regular command line calls thus there \f[B]must be no
938 whitespace\f[] after \f[C]\-\f[] or \f[C]\-\-\f[], e.g.
939 \f[C]\-o\f[] or \f[C]\-\-proxy\f[] but not \f[C]\-\ o\f[] or
940 \f[C]\-\-\ proxy\f[].
941 .PP
942 You can use \f[C]\-\-ignore\-config\f[] if you want to disable the
943 configuration file for a particular youtube\-dl run.
944 .PP
945 You can also use \f[C]\-\-config\-location\f[] if you want to use custom
946 configuration file for a particular youtube\-dl run.
947 .SS Authentication with \f[C]\&.netrc\f[] file
948 .PP
949 You may also want to configure automatic credentials storage for
950 extractors that support authentication (by providing login and password
951 with \f[C]\-\-username\f[] and \f[C]\-\-password\f[]) in order not to
952 pass credentials as command line arguments on every youtube\-dl
953 execution and prevent tracking plain text passwords in the shell command
954 history.
955 You can achieve this using a \f[C]\&.netrc\f[]
956 file (https://stackoverflow.com/tags/.netrc/info) on a per extractor
957 basis.
958 For that you will need to create a \f[C]\&.netrc\f[] file in your
959 \f[C]$HOME\f[] and restrict permissions to read/write by only you:
960 .IP
961 .nf
962 \f[C]
963 touch\ $HOME/.netrc
964 chmod\ a\-rwx,u+rw\ $HOME/.netrc
965 \f[]
966 .fi
967 .PP
968 After that you can add credentials for an extractor in the following
969 format, where \f[I]extractor\f[] is the name of the extractor in
970 lowercase:
971 .IP
972 .nf
973 \f[C]
974 machine\ <extractor>\ login\ <login>\ password\ <password>
975 \f[]
976 .fi
977 .PP
978 For example:
979 .IP
980 .nf
981 \f[C]
982 machine\ youtube\ login\ myaccount\@gmail.com\ password\ my_youtube_password
983 machine\ twitch\ login\ my_twitch_account_name\ password\ my_twitch_password
984 \f[]
985 .fi
986 .PP
987 To activate authentication with the \f[C]\&.netrc\f[] file you should
988 pass \f[C]\-\-netrc\f[] to youtube\-dl or place it in the configuration
989 file (#configuration).
990 .PP
991 On Windows you may also need to setup the \f[C]%HOME%\f[] environment
992 variable manually.
993 For example:
994 .IP
995 .nf
996 \f[C]
997 set\ HOME=%USERPROFILE%
998 \f[]
999 .fi
1000 .SH OUTPUT TEMPLATE
1001 .PP
1002 The \f[C]\-o\f[] option allows users to indicate a template for the
1003 output file names.
1004 .PP
1005 \f[B]tl;dr:\f[] navigate me to examples (#output-template-examples).
1006 .PP
1007 The basic usage is not to set any template arguments when downloading a
1008 single file, like in
1009 \f[C]youtube\-dl\ \-o\ funny_video.flv\ "https://some/video"\f[].
1010 However, it may contain special sequences that will be replaced when
1011 downloading each video.
1012 The special sequences may be formatted according to python string
1013 formatting
1014 operations (https://docs.python.org/2/library/stdtypes.html#string-formatting).
1015 For example, \f[C]%(NAME)s\f[] or \f[C]%(NAME)05d\f[].
1016 To clarify, that is a percent symbol followed by a name in parentheses,
1017 followed by a formatting operations.
1018 Allowed names along with sequence type are:
1019 .IP \[bu] 2
1020 \f[C]id\f[] (string): Video identifier
1021 .IP \[bu] 2
1022 \f[C]title\f[] (string): Video title
1023 .IP \[bu] 2
1024 \f[C]url\f[] (string): Video URL
1025 .IP \[bu] 2
1026 \f[C]ext\f[] (string): Video filename extension
1027 .IP \[bu] 2
1028 \f[C]alt_title\f[] (string): A secondary title of the video
1029 .IP \[bu] 2
1030 \f[C]display_id\f[] (string): An alternative identifier for the video
1031 .IP \[bu] 2
1032 \f[C]uploader\f[] (string): Full name of the video uploader
1033 .IP \[bu] 2
1034 \f[C]license\f[] (string): License name the video is licensed under
1035 .IP \[bu] 2
1036 \f[C]creator\f[] (string): The creator of the video
1037 .IP \[bu] 2
1038 \f[C]release_date\f[] (string): The date (YYYYMMDD) when the video was
1039 released
1040 .IP \[bu] 2
1041 \f[C]timestamp\f[] (numeric): UNIX timestamp of the moment the video
1042 became available
1043 .IP \[bu] 2
1044 \f[C]upload_date\f[] (string): Video upload date (YYYYMMDD)
1045 .IP \[bu] 2
1046 \f[C]uploader_id\f[] (string): Nickname or id of the video uploader
1047 .IP \[bu] 2
1048 \f[C]location\f[] (string): Physical location where the video was filmed
1049 .IP \[bu] 2
1050 \f[C]duration\f[] (numeric): Length of the video in seconds
1051 .IP \[bu] 2
1052 \f[C]view_count\f[] (numeric): How many users have watched the video on
1053 the platform
1054 .IP \[bu] 2
1055 \f[C]like_count\f[] (numeric): Number of positive ratings of the video
1056 .IP \[bu] 2
1057 \f[C]dislike_count\f[] (numeric): Number of negative ratings of the
1058 video
1059 .IP \[bu] 2
1060 \f[C]repost_count\f[] (numeric): Number of reposts of the video
1061 .IP \[bu] 2
1062 \f[C]average_rating\f[] (numeric): Average rating give by users, the
1063 scale used depends on the webpage
1064 .IP \[bu] 2
1065 \f[C]comment_count\f[] (numeric): Number of comments on the video
1066 .IP \[bu] 2
1067 \f[C]age_limit\f[] (numeric): Age restriction for the video (years)
1068 .IP \[bu] 2
1069 \f[C]is_live\f[] (boolean): Whether this video is a live stream or a
1070 fixed\-length video
1071 .IP \[bu] 2
1072 \f[C]start_time\f[] (numeric): Time in seconds where the reproduction
1073 should start, as specified in the URL
1074 .IP \[bu] 2
1075 \f[C]end_time\f[] (numeric): Time in seconds where the reproduction
1076 should end, as specified in the URL
1077 .IP \[bu] 2
1078 \f[C]format\f[] (string): A human\-readable description of the format
1079 .IP \[bu] 2
1080 \f[C]format_id\f[] (string): Format code specified by
1081 \f[C]\-\-format\f[]
1082 .IP \[bu] 2
1083 \f[C]format_note\f[] (string): Additional info about the format
1084 .IP \[bu] 2
1085 \f[C]width\f[] (numeric): Width of the video
1086 .IP \[bu] 2
1087 \f[C]height\f[] (numeric): Height of the video
1088 .IP \[bu] 2
1089 \f[C]resolution\f[] (string): Textual description of width and height
1090 .IP \[bu] 2
1091 \f[C]tbr\f[] (numeric): Average bitrate of audio and video in KBit/s
1092 .IP \[bu] 2
1093 \f[C]abr\f[] (numeric): Average audio bitrate in KBit/s
1094 .IP \[bu] 2
1095 \f[C]acodec\f[] (string): Name of the audio codec in use
1096 .IP \[bu] 2
1097 \f[C]asr\f[] (numeric): Audio sampling rate in Hertz
1098 .IP \[bu] 2
1099 \f[C]vbr\f[] (numeric): Average video bitrate in KBit/s
1100 .IP \[bu] 2
1101 \f[C]fps\f[] (numeric): Frame rate
1102 .IP \[bu] 2
1103 \f[C]vcodec\f[] (string): Name of the video codec in use
1104 .IP \[bu] 2
1105 \f[C]container\f[] (string): Name of the container format
1106 .IP \[bu] 2
1107 \f[C]filesize\f[] (numeric): The number of bytes, if known in advance
1108 .IP \[bu] 2
1109 \f[C]filesize_approx\f[] (numeric): An estimate for the number of bytes
1110 .IP \[bu] 2
1111 \f[C]protocol\f[] (string): The protocol that will be used for the
1112 actual download
1113 .IP \[bu] 2
1114 \f[C]extractor\f[] (string): Name of the extractor
1115 .IP \[bu] 2
1116 \f[C]extractor_key\f[] (string): Key name of the extractor
1117 .IP \[bu] 2
1118 \f[C]epoch\f[] (numeric): Unix epoch when creating the file
1119 .IP \[bu] 2
1120 \f[C]autonumber\f[] (numeric): Five\-digit number that will be increased
1121 with each download, starting at zero
1122 .IP \[bu] 2
1123 \f[C]playlist\f[] (string): Name or id of the playlist that contains the
1124 video
1125 .IP \[bu] 2
1126 \f[C]playlist_index\f[] (numeric): Index of the video in the playlist
1127 padded with leading zeros according to the total length of the playlist
1128 .IP \[bu] 2
1129 \f[C]playlist_id\f[] (string): Playlist identifier
1130 .IP \[bu] 2
1131 \f[C]playlist_title\f[] (string): Playlist title
1132 .IP \[bu] 2
1133 \f[C]playlist_uploader\f[] (string): Full name of the playlist uploader
1134 .IP \[bu] 2
1135 \f[C]playlist_uploader_id\f[] (string): Nickname or id of the playlist
1136 uploader
1137 .PP
1138 Available for the video that belongs to some logical chapter or section:
1139 .IP \[bu] 2
1140 \f[C]chapter\f[] (string): Name or title of the chapter the video
1141 belongs to
1142 .IP \[bu] 2
1143 \f[C]chapter_number\f[] (numeric): Number of the chapter the video
1144 belongs to
1145 .IP \[bu] 2
1146 \f[C]chapter_id\f[] (string): Id of the chapter the video belongs to
1147 .PP
1148 Available for the video that is an episode of some series or programme:
1149 .IP \[bu] 2
1150 \f[C]series\f[] (string): Title of the series or programme the video
1151 episode belongs to
1152 .IP \[bu] 2
1153 \f[C]season\f[] (string): Title of the season the video episode belongs
1154 to
1155 .IP \[bu] 2
1156 \f[C]season_number\f[] (numeric): Number of the season the video episode
1157 belongs to
1158 .IP \[bu] 2
1159 \f[C]season_id\f[] (string): Id of the season the video episode belongs
1160 to
1161 .IP \[bu] 2
1162 \f[C]episode\f[] (string): Title of the video episode
1163 .IP \[bu] 2
1164 \f[C]episode_number\f[] (numeric): Number of the video episode within a
1165 season
1166 .IP \[bu] 2
1167 \f[C]episode_id\f[] (string): Id of the video episode
1168 .PP
1169 Available for the media that is a track or a part of a music album:
1170 .IP \[bu] 2
1171 \f[C]track\f[] (string): Title of the track
1172 .IP \[bu] 2
1173 \f[C]track_number\f[] (numeric): Number of the track within an album or
1174 a disc
1175 .IP \[bu] 2
1176 \f[C]track_id\f[] (string): Id of the track
1177 .IP \[bu] 2
1178 \f[C]artist\f[] (string): Artist(s) of the track
1179 .IP \[bu] 2
1180 \f[C]genre\f[] (string): Genre(s) of the track
1181 .IP \[bu] 2
1182 \f[C]album\f[] (string): Title of the album the track belongs to
1183 .IP \[bu] 2
1184 \f[C]album_type\f[] (string): Type of the album
1185 .IP \[bu] 2
1186 \f[C]album_artist\f[] (string): List of all artists appeared on the
1187 album
1188 .IP \[bu] 2
1189 \f[C]disc_number\f[] (numeric): Number of the disc or other physical
1190 medium the track belongs to
1191 .IP \[bu] 2
1192 \f[C]release_year\f[] (numeric): Year (YYYY) when the album was released
1193 .PP
1194 Each aforementioned sequence when referenced in an output template will
1195 be replaced by the actual value corresponding to the sequence name.
1196 Note that some of the sequences are not guaranteed to be present since
1197 they depend on the metadata obtained by a particular extractor.
1198 Such sequences will be replaced with \f[C]NA\f[].
1199 .PP
1200 For example for \f[C]\-o\ %(title)s\-%(id)s.%(ext)s\f[] and an mp4 video
1201 with title \f[C]youtube\-dl\ test\ video\f[] and id
1202 \f[C]BaW_jenozKcj\f[], this will result in a
1203 \f[C]youtube\-dl\ test\ video\-BaW_jenozKcj.mp4\f[] file created in the
1204 current directory.
1205 .PP
1206 For numeric sequences you can use numeric related formatting, for
1207 example, \f[C]%(view_count)05d\f[] will result in a string with view
1208 count padded with zeros up to 5 characters, like in \f[C]00042\f[].
1209 .PP
1210 Output templates can also contain arbitrary hierarchical path, e.g.
1211 \f[C]\-o\ \[aq]%(playlist)s/%(playlist_index)s\ \-\ %(title)s.%(ext)s\[aq]\f[]
1212 which will result in downloading each video in a directory corresponding
1213 to this path template.
1214 Any missing directory will be automatically created for you.
1215 .PP
1216 To use percent literals in an output template use \f[C]%%\f[].
1217 To output to stdout use \f[C]\-o\ \-\f[].
1218 .PP
1219 The current default template is \f[C]%(title)s\-%(id)s.%(ext)s\f[].
1220 .PP
1221 In some cases, you don\[aq]t want special characters such as äø­, spaces,
1222 or &, such as when transferring the downloaded filename to a Windows
1223 system or the filename through an 8bit\-unsafe channel.
1224 In these cases, add the \f[C]\-\-restrict\-filenames\f[] flag to get a
1225 shorter title:
1226 .SS Output template and Windows batch files
1227 .PP
1228 If you are using an output template inside a Windows batch file then you
1229 must escape plain percent characters (\f[C]%\f[]) by doubling, so that
1230 \f[C]\-o\ "%(title)s\-%(id)s.%(ext)s"\f[] should become
1231 \f[C]\-o\ "%%(title)s\-%%(id)s.%%(ext)s"\f[].
1232 However you should not touch \f[C]%\f[]\[aq]s that are not plain
1233 characters, e.g.
1234 environment variables for expansion should stay intact:
1235 \f[C]\-o\ "C:\\%HOMEPATH%\\Desktop\\%%(title)s.%%(ext)s"\f[].
1236 .SS Output template examples
1237 .PP
1238 Note that on Windows you may need to use double quotes instead of
1239 single.
1240 .IP
1241 .nf
1242 \f[C]
1243 $\ youtube\-dl\ \-\-get\-filename\ \-o\ \[aq]%(title)s.%(ext)s\[aq]\ BaW_jenozKc
1244 youtube\-dl\ test\ video\ \[aq]\[aq]_Ƥā†­š•.mp4\ \ \ \ #\ All\ kinds\ of\ weird\ characters
1245
1246 $\ youtube\-dl\ \-\-get\-filename\ \-o\ \[aq]%(title)s.%(ext)s\[aq]\ BaW_jenozKc\ \-\-restrict\-filenames
1247 youtube\-dl_test_video_.mp4\ \ \ \ \ \ \ \ \ \ #\ A\ simple\ file\ name
1248
1249 #\ Download\ YouTube\ playlist\ videos\ in\ separate\ directory\ indexed\ by\ video\ order\ in\ a\ playlist
1250 $\ youtube\-dl\ \-o\ \[aq]%(playlist)s/%(playlist_index)s\ \-\ %(title)s.%(ext)s\[aq]\ https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
1251
1252 #\ Download\ all\ playlists\ of\ YouTube\ channel/user\ keeping\ each\ playlist\ in\ separate\ directory:
1253 $\ youtube\-dl\ \-o\ \[aq]%(uploader)s/%(playlist)s/%(playlist_index)s\ \-\ %(title)s.%(ext)s\[aq]\ https://www.youtube.com/user/TheLinuxFoundation/playlists
1254
1255 #\ Download\ Udemy\ course\ keeping\ each\ chapter\ in\ separate\ directory\ under\ MyVideos\ directory\ in\ your\ home
1256 $\ youtube\-dl\ \-u\ user\ \-p\ password\ \-o\ \[aq]~/MyVideos/%(playlist)s/%(chapter_number)s\ \-\ %(chapter)s/%(title)s.%(ext)s\[aq]\ https://www.udemy.com/java\-tutorial/
1257
1258 #\ Download\ entire\ series\ season\ keeping\ each\ series\ and\ each\ season\ in\ separate\ directory\ under\ C:/MyVideos
1259 $\ youtube\-dl\ \-o\ "C:/MyVideos/%(series)s/%(season_number)s\ \-\ %(season)s/%(episode_number)s\ \-\ %(episode)s.%(ext)s"\ https://videomore.ru/kino_v_detalayah/5_sezon/367617
1260
1261 #\ Stream\ the\ video\ being\ downloaded\ to\ stdout
1262 $\ youtube\-dl\ \-o\ \-\ BaW_jenozKc
1263 \f[]
1264 .fi
1265 .SH FORMAT SELECTION
1266 .PP
1267 By default youtube\-dl tries to download the best available quality,
1268 i.e.
1269 if you want the best quality you \f[B]don\[aq]t need\f[] to pass any
1270 special options, youtube\-dl will guess it for you by \f[B]default\f[].
1271 .PP
1272 But sometimes you may want to download in a different format, for
1273 example when you are on a slow or intermittent connection.
1274 The key mechanism for achieving this is so\-called \f[I]format
1275 selection\f[] based on which you can explicitly specify desired format,
1276 select formats based on some criterion or criteria, setup precedence and
1277 much more.
1278 .PP
1279 The general syntax for format selection is \f[C]\-\-format\ FORMAT\f[]
1280 or shorter \f[C]\-f\ FORMAT\f[] where \f[C]FORMAT\f[] is a \f[I]selector
1281 expression\f[], i.e.
1282 an expression that describes format or formats you would like to
1283 download.
1284 .PP
1285 \f[B]tl;dr:\f[] navigate me to examples (#format-selection-examples).
1286 .PP
1287 The simplest case is requesting a specific format, for example with
1288 \f[C]\-f\ 22\f[] you can download the format with format code equal to
1289 22.
1290 You can get the list of available format codes for particular video
1291 using \f[C]\-\-list\-formats\f[] or \f[C]\-F\f[].
1292 Note that these format codes are extractor specific.
1293 .PP
1294 You can also use a file extension (currently \f[C]3gp\f[], \f[C]aac\f[],
1295 \f[C]flv\f[], \f[C]m4a\f[], \f[C]mp3\f[], \f[C]mp4\f[], \f[C]ogg\f[],
1296 \f[C]wav\f[], \f[C]webm\f[] are supported) to download the best quality
1297 format of a particular file extension served as a single file, e.g.
1298 \f[C]\-f\ webm\f[] will download the best quality format with the
1299 \f[C]webm\f[] extension served as a single file.
1300 .PP
1301 You can also use special names to select particular edge case formats:
1302 \- \f[C]best\f[]: Select the best quality format represented by a single
1303 file with video and audio.
1304 \- \f[C]worst\f[]: Select the worst quality format represented by a
1305 single file with video and audio.
1306 \- \f[C]bestvideo\f[]: Select the best quality video\-only format (e.g.
1307 DASH video).
1308 May not be available.
1309 \- \f[C]worstvideo\f[]: Select the worst quality video\-only format.
1310 May not be available.
1311 \- \f[C]bestaudio\f[]: Select the best quality audio only\-format.
1312 May not be available.
1313 \- \f[C]worstaudio\f[]: Select the worst quality audio only\-format.
1314 May not be available.
1315 .PP
1316 For example, to download the worst quality video\-only format you can
1317 use \f[C]\-f\ worstvideo\f[].
1318 .PP
1319 If you want to download multiple videos and they don\[aq]t have the same
1320 formats available, you can specify the order of preference using
1321 slashes.
1322 Note that slash is left\-associative, i.e.
1323 formats on the left hand side are preferred, for example
1324 \f[C]\-f\ 22/17/18\f[] will download format 22 if it\[aq]s available,
1325 otherwise it will download format 17 if it\[aq]s available, otherwise it
1326 will download format 18 if it\[aq]s available, otherwise it will
1327 complain that no suitable formats are available for download.
1328 .PP
1329 If you want to download several formats of the same video use a comma as
1330 a separator, e.g.
1331 \f[C]\-f\ 22,17,18\f[] will download all these three formats, of course
1332 if they are available.
1333 Or a more sophisticated example combined with the precedence feature:
1334 \f[C]\-f\ 136/137/mp4/bestvideo,140/m4a/bestaudio\f[].
1335 .PP
1336 You can also filter the video formats by putting a condition in
1337 brackets, as in \f[C]\-f\ "best[height=720]"\f[] (or
1338 \f[C]\-f\ "[filesize>10M]"\f[]).
1339 .PP
1340 The following numeric meta fields can be used with comparisons
1341 \f[C]<\f[], \f[C]<=\f[], \f[C]>\f[], \f[C]>=\f[], \f[C]=\f[] (equals),
1342 \f[C]!=\f[] (not equals): \- \f[C]filesize\f[]: The number of bytes, if
1343 known in advance \- \f[C]width\f[]: Width of the video, if known \-
1344 \f[C]height\f[]: Height of the video, if known \- \f[C]tbr\f[]: Average
1345 bitrate of audio and video in KBit/s \- \f[C]abr\f[]: Average audio
1346 bitrate in KBit/s \- \f[C]vbr\f[]: Average video bitrate in KBit/s \-
1347 \f[C]asr\f[]: Audio sampling rate in Hertz \- \f[C]fps\f[]: Frame rate
1348 .PP
1349 Also filtering work for comparisons \f[C]=\f[] (equals), \f[C]!=\f[]
1350 (not equals), \f[C]^=\f[] (begins with), \f[C]$=\f[] (ends with),
1351 \f[C]*=\f[] (contains) and following string meta fields: \-
1352 \f[C]ext\f[]: File extension \- \f[C]acodec\f[]: Name of the audio codec
1353 in use \- \f[C]vcodec\f[]: Name of the video codec in use \-
1354 \f[C]container\f[]: Name of the container format \- \f[C]protocol\f[]:
1355 The protocol that will be used for the actual download, lower\-case
1356 (\f[C]http\f[], \f[C]https\f[], \f[C]rtsp\f[], \f[C]rtmp\f[],
1357 \f[C]rtmpe\f[], \f[C]mms\f[], \f[C]f4m\f[], \f[C]ism\f[],
1358 \f[C]http_dash_segments\f[], \f[C]m3u8\f[], or \f[C]m3u8_native\f[]) \-
1359 \f[C]format_id\f[]: A short description of the format
1360 .PP
1361 Note that none of the aforementioned meta fields are guaranteed to be
1362 present since this solely depends on the metadata obtained by particular
1363 extractor, i.e.
1364 the metadata offered by the video hoster.
1365 .PP
1366 Formats for which the value is not known are excluded unless you put a
1367 question mark (\f[C]?\f[]) after the operator.
1368 You can combine format filters, so
1369 \f[C]\-f\ "[height\ <=?\ 720][tbr>500]"\f[] selects up to 720p videos
1370 (or videos where the height is not known) with a bitrate of at least 500
1371 KBit/s.
1372 .PP
1373 You can merge the video and audio of two formats into a single file
1374 using \f[C]\-f\ <video\-format>+<audio\-format>\f[] (requires ffmpeg or
1375 avconv installed), for example \f[C]\-f\ bestvideo+bestaudio\f[] will
1376 download the best video\-only format, the best audio\-only format and
1377 mux them together with ffmpeg/avconv.
1378 .PP
1379 Format selectors can also be grouped using parentheses, for example if
1380 you want to download the best mp4 and webm formats with a height lower
1381 than 480 you can use \f[C]\-f\ \[aq](mp4,webm)[height<480]\[aq]\f[].
1382 .PP
1383 Since the end of April 2015 and version 2015.04.26, youtube\-dl uses
1384 \f[C]\-f\ bestvideo+bestaudio/best\f[] as the default format selection
1385 (see #5447 (https://github.com/rg3/youtube-dl/issues/5447),
1386 #5456 (https://github.com/rg3/youtube-dl/issues/5456)).
1387 If ffmpeg or avconv are installed this results in downloading
1388 \f[C]bestvideo\f[] and \f[C]bestaudio\f[] separately and muxing them
1389 together into a single file giving the best overall quality available.
1390 Otherwise it falls back to \f[C]best\f[] and results in downloading the
1391 best available quality served as a single file.
1392 \f[C]best\f[] is also needed for videos that don\[aq]t come from YouTube
1393 because they don\[aq]t provide the audio and video in two different
1394 files.
1395 If you want to only download some DASH formats (for example if you are
1396 not interested in getting videos with a resolution higher than 1080p),
1397 you can add \f[C]\-f\ bestvideo[height<=?1080]+bestaudio/best\f[] to
1398 your configuration file.
1399 Note that if you use youtube\-dl to stream to \f[C]stdout\f[] (and most
1400 likely to pipe it to your media player then), i.e.
1401 you explicitly specify output template as \f[C]\-o\ \-\f[], youtube\-dl
1402 still uses \f[C]\-f\ best\f[] format selection in order to start content
1403 delivery immediately to your player and not to wait until
1404 \f[C]bestvideo\f[] and \f[C]bestaudio\f[] are downloaded and muxed.
1405 .PP
1406 If you want to preserve the old format selection behavior (prior to
1407 youtube\-dl 2015.04.26), i.e.
1408 you want to download the best available quality media served as a single
1409 file, you should explicitly specify your choice with \f[C]\-f\ best\f[].
1410 You may want to add it to the configuration file (#configuration) in
1411 order not to type it every time you run youtube\-dl.
1412 .SS Format selection examples
1413 .PP
1414 Note that on Windows you may need to use double quotes instead of
1415 single.
1416 .IP
1417 .nf
1418 \f[C]
1419 #\ Download\ best\ mp4\ format\ available\ or\ any\ other\ best\ if\ no\ mp4\ available
1420 $\ youtube\-dl\ \-f\ \[aq]bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best\[aq]
1421
1422 #\ Download\ best\ format\ available\ but\ not\ better\ that\ 480p
1423 $\ youtube\-dl\ \-f\ \[aq]bestvideo[height<=480]+bestaudio/best[height<=480]\[aq]
1424
1425 #\ Download\ best\ video\ only\ format\ but\ no\ bigger\ than\ 50\ MB
1426 $\ youtube\-dl\ \-f\ \[aq]best[filesize<50M]\[aq]
1427
1428 #\ Download\ best\ format\ available\ via\ direct\ link\ over\ HTTP/HTTPS\ protocol
1429 $\ youtube\-dl\ \-f\ \[aq](bestvideo+bestaudio/best)[protocol^=http]\[aq]
1430
1431 #\ Download\ the\ best\ video\ format\ and\ the\ best\ audio\ format\ without\ merging\ them
1432 $\ youtube\-dl\ \-f\ \[aq]bestvideo,bestaudio\[aq]\ \-o\ \[aq]%(title)s.f%(format_id)s.%(ext)s\[aq]
1433 \f[]
1434 .fi
1435 .PP
1436 Note that in the last example, an output template is recommended as
1437 bestvideo and bestaudio may have the same file name.
1438 .SH VIDEO SELECTION
1439 .PP
1440 Videos can be filtered by their upload date using the options
1441 \f[C]\-\-date\f[], \f[C]\-\-datebefore\f[] or \f[C]\-\-dateafter\f[].
1442 They accept dates in two formats:
1443 .IP \[bu] 2
1444 Absolute dates: Dates in the format \f[C]YYYYMMDD\f[].
1445 .IP \[bu] 2
1446 Relative dates: Dates in the format
1447 \f[C](now|today)[+\-][0\-9](day|week|month|year)(s)?\f[]
1448 .PP
1449 Examples:
1450 .IP
1451 .nf
1452 \f[C]
1453 #\ Download\ only\ the\ videos\ uploaded\ in\ the\ last\ 6\ months
1454 $\ youtube\-dl\ \-\-dateafter\ now\-6months
1455
1456 #\ Download\ only\ the\ videos\ uploaded\ on\ January\ 1,\ 1970
1457 $\ youtube\-dl\ \-\-date\ 19700101
1458
1459 $\ #\ Download\ only\ the\ videos\ uploaded\ in\ the\ 200x\ decade
1460 $\ youtube\-dl\ \-\-dateafter\ 20000101\ \-\-datebefore\ 20091231
1461 \f[]
1462 .fi
1463 .SH FAQ
1464 .SS How do I update youtube\-dl?
1465 .PP
1466 If you\[aq]ve followed our manual installation
1467 instructions (https://rg3.github.io/youtube-dl/download.html), you can
1468 simply run \f[C]youtube\-dl\ \-U\f[] (or, on Linux,
1469 \f[C]sudo\ youtube\-dl\ \-U\f[]).
1470 .PP
1471 If you have used pip, a simple
1472 \f[C]sudo\ pip\ install\ \-U\ youtube\-dl\f[] is sufficient to update.
1473 .PP
1474 If you have installed youtube\-dl using a package manager like
1475 \f[I]apt\-get\f[] or \f[I]yum\f[], use the standard system update
1476 mechanism to update.
1477 Note that distribution packages are often outdated.
1478 As a rule of thumb, youtube\-dl releases at least once a month, and
1479 often weekly or even daily.
1480 Simply go to https://yt\-dl.org to find out the current version.
1481 Unfortunately, there is nothing we youtube\-dl developers can do if your
1482 distribution serves a really outdated version.
1483 You can (and should) complain to your distribution in their bugtracker
1484 or support forum.
1485 .PP
1486 As a last resort, you can also uninstall the version installed by your
1487 package manager and follow our manual installation instructions.
1488 For that, remove the distribution\[aq]s package, with a line like
1489 .IP
1490 .nf
1491 \f[C]
1492 sudo\ apt\-get\ remove\ \-y\ youtube\-dl
1493 \f[]
1494 .fi
1495 .PP
1496 Afterwards, simply follow our manual installation
1497 instructions (https://rg3.github.io/youtube-dl/download.html):
1498 .IP
1499 .nf
1500 \f[C]
1501 sudo\ wget\ https://yt\-dl.org/latest/youtube\-dl\ \-O\ /usr/local/bin/youtube\-dl
1502 sudo\ chmod\ a+x\ /usr/local/bin/youtube\-dl
1503 hash\ \-r
1504 \f[]
1505 .fi
1506 .PP
1507 Again, from then on you\[aq]ll be able to update with
1508 \f[C]sudo\ youtube\-dl\ \-U\f[].
1509 .SS youtube\-dl is extremely slow to start on Windows
1510 .PP
1511 Add a file exclusion for \f[C]youtube\-dl.exe\f[] in Windows Defender
1512 settings.
1513 .SS I\[aq]m getting an error
1514 \f[C]Unable\ to\ extract\ OpenGraph\ title\f[] on YouTube playlists
1515 .PP
1516 YouTube changed their playlist format in March 2014 and later on, so
1517 you\[aq]ll need at least youtube\-dl 2014.07.25 to download all YouTube
1518 videos.
1519 .PP
1520 If you have installed youtube\-dl with a package manager, pip, setup.py
1521 or a tarball, please use that to update.
1522 Note that Ubuntu packages do not seem to get updated anymore.
1523 Since we are not affiliated with Ubuntu, there is little we can do.
1524 Feel free to report
1525 bugs (https://bugs.launchpad.net/ubuntu/+source/youtube-dl/+filebug) to
1526 the Ubuntu packaging
1527 people (mailto:ubuntu-motu@lists.ubuntu.com?subject=outdated%20version%20of%20youtube-dl)
1528 \- all they have to do is update the package to a somewhat recent
1529 version.
1530 See above for a way to update.
1531 .SS I\[aq]m getting an error when trying to use output template:
1532 \f[C]error:\ using\ output\ template\ conflicts\ with\ using\ title,\ video\ ID\ or\ auto\ number\f[]
1533 .PP
1534 Make sure you are not using \f[C]\-o\f[] with any of these options
1535 \f[C]\-t\f[], \f[C]\-\-title\f[], \f[C]\-\-id\f[], \f[C]\-A\f[] or
1536 \f[C]\-\-auto\-number\f[] set in command line or in a configuration
1537 file.
1538 Remove the latter if any.
1539 .SS Do I always have to pass \f[C]\-citw\f[]?
1540 .PP
1541 By default, youtube\-dl intends to have the best options (incidentally,
1542 if you have a convincing case that these should be different, please
1543 file an issue where you explain that (https://yt-dl.org/bug)).
1544 Therefore, it is unnecessary and sometimes harmful to copy long option
1545 strings from webpages.
1546 In particular, the only option out of \f[C]\-citw\f[] that is regularly
1547 useful is \f[C]\-i\f[].
1548 .SS Can you please put the \f[C]\-b\f[] option back?
1549 .PP
1550 Most people asking this question are not aware that youtube\-dl now
1551 defaults to downloading the highest available quality as reported by
1552 YouTube, which will be 1080p or 720p in some cases, so you no longer
1553 need the \f[C]\-b\f[] option.
1554 For some specific videos, maybe YouTube does not report them to be
1555 available in a specific high quality format you\[aq]re interested in.
1556 In that case, simply request it with the \f[C]\-f\f[] option and
1557 youtube\-dl will try to download it.
1558 .SS I get HTTP error 402 when trying to download a video. What\[aq]s
1559 this?
1560 .PP
1561 Apparently YouTube requires you to pass a CAPTCHA test if you download
1562 too much.
1563 We\[aq]re considering to provide a way to let you solve the
1564 CAPTCHA (https://github.com/rg3/youtube-dl/issues/154), but at the
1565 moment, your best course of action is pointing a web browser to the
1566 youtube URL, solving the CAPTCHA, and restart youtube\-dl.
1567 .SS Do I need any other programs?
1568 .PP
1569 youtube\-dl works fine on its own on most sites.
1570 However, if you want to convert video/audio, you\[aq]ll need
1571 avconv (https://libav.org/) or ffmpeg (https://www.ffmpeg.org/).
1572 On some sites \- most notably YouTube \- videos can be retrieved in a
1573 higher quality format without sound.
1574 youtube\-dl will detect whether avconv/ffmpeg is present and
1575 automatically pick the best option.
1576 .PP
1577 Videos or video formats streamed via RTMP protocol can only be
1578 downloaded when rtmpdump (https://rtmpdump.mplayerhq.hu/) is installed.
1579 Downloading MMS and RTSP videos requires either
1580 mplayer (https://mplayerhq.hu/) or mpv (https://mpv.io/) to be
1581 installed.
1582 .SS I have downloaded a video but how can I play it?
1583 .PP
1584 Once the video is fully downloaded, use any video player, such as
1585 mpv (https://mpv.io/), vlc (https://www.videolan.org/) or
1586 mplayer (https://www.mplayerhq.hu/).
1587 .SS I extracted a video URL with \f[C]\-g\f[], but it does not play on
1588 another machine / in my web browser.
1589 .PP
1590 It depends a lot on the service.
1591 In many cases, requests for the video (to download/play it) must come
1592 from the same IP address and with the same cookies and/or HTTP headers.
1593 Use the \f[C]\-\-cookies\f[] option to write the required cookies into a
1594 file, and advise your downloader to read cookies from that file.
1595 Some sites also require a common user agent to be used, use
1596 \f[C]\-\-dump\-user\-agent\f[] to see the one in use by youtube\-dl.
1597 You can also get necessary cookies and HTTP headers from JSON output
1598 obtained with \f[C]\-\-dump\-json\f[].
1599 .PP
1600 It may be beneficial to use IPv6; in some cases, the restrictions are
1601 only applied to IPv4.
1602 Some services (sometimes only for a subset of videos) do not restrict
1603 the video URL by IP address, cookie, or user\-agent, but these are the
1604 exception rather than the rule.
1605 .PP
1606 Please bear in mind that some URL protocols are \f[B]not\f[] supported
1607 by browsers out of the box, including RTMP.
1608 If you are using \f[C]\-g\f[], your own downloader must support these as
1609 well.
1610 .PP
1611 If you want to play the video on a machine that is not running
1612 youtube\-dl, you can relay the video content from the machine that runs
1613 youtube\-dl.
1614 You can use \f[C]\-o\ \-\f[] to let youtube\-dl stream a video to
1615 stdout, or simply allow the player to download the files written by
1616 youtube\-dl in turn.
1617 .SS ERROR: no fmt_url_map or conn information found in video info
1618 .PP
1619 YouTube has switched to a new video info format in July 2011 which is
1620 not supported by old versions of youtube\-dl.
1621 See above (#how-do-i-update-youtube-dl) for how to update youtube\-dl.
1622 .SS ERROR: unable to download video
1623 .PP
1624 YouTube requires an additional signature since September 2012 which is
1625 not supported by old versions of youtube\-dl.
1626 See above (#how-do-i-update-youtube-dl) for how to update youtube\-dl.
1627 .SS Video URL contains an ampersand and I\[aq]m getting some strange
1628 output \f[C][1]\ 2839\f[] or
1629 \f[C]\[aq]v\[aq]\ is\ not\ recognized\ as\ an\ internal\ or\ external\ command\f[]
1630 .PP
1631 That\[aq]s actually the output from your shell.
1632 Since ampersand is one of the special shell characters it\[aq]s
1633 interpreted by the shell preventing you from passing the whole URL to
1634 youtube\-dl.
1635 To disable your shell from interpreting the ampersands (or any other
1636 special characters) you have to either put the whole URL in quotes or
1637 escape them with a backslash (which approach will work depends on your
1638 shell).
1639 .PP
1640 For example if your URL is
1641 https://www.youtube.com/watch?t=4&v=BaW_jenozKc you should end up with
1642 following command:
1643 .PP
1644 \f[C]youtube\-dl\ \[aq]https://www.youtube.com/watch?t=4&v=BaW_jenozKc\[aq]\f[]
1645 .PP
1646 or
1647 .PP
1648 \f[C]youtube\-dl\ https://www.youtube.com/watch?t=4\\&v=BaW_jenozKc\f[]
1649 .PP
1650 For Windows you have to use the double quotes:
1651 .PP
1652 \f[C]youtube\-dl\ "https://www.youtube.com/watch?t=4&v=BaW_jenozKc"\f[]
1653 .SS ExtractorError: Could not find JS function u\[aq]OF\[aq]
1654 .PP
1655 In February 2015, the new YouTube player contained a character sequence
1656 in a string that was misinterpreted by old versions of youtube\-dl.
1657 See above (#how-do-i-update-youtube-dl) for how to update youtube\-dl.
1658 .SS HTTP Error 429: Too Many Requests or 402: Payment Required
1659 .PP
1660 These two error codes indicate that the service is blocking your IP
1661 address because of overuse.
1662 Contact the service and ask them to unblock your IP address, or \- if
1663 you have acquired a whitelisted IP address already \- use the
1664 \f[C]\-\-proxy\f[] or \f[C]\-\-source\-address\f[]
1665 options (#network-options) to select another IP address.
1666 .SS SyntaxError: Non\-ASCII character
1667 .PP
1668 The error
1669 .IP
1670 .nf
1671 \f[C]
1672 File\ "youtube\-dl",\ line\ 2
1673 SyntaxError:\ Non\-ASCII\ character\ \[aq]\\x93\[aq]\ ...
1674 \f[]
1675 .fi
1676 .PP
1677 means you\[aq]re using an outdated version of Python.
1678 Please update to Python 2.6 or 2.7.
1679 .SS What is this binary file? Where has the code gone?
1680 .PP
1681 Since June 2012 (#342 (https://github.com/rg3/youtube-dl/issues/342))
1682 youtube\-dl is packed as an executable zipfile, simply unzip it (might
1683 need renaming to \f[C]youtube\-dl.zip\f[] first on some systems) or
1684 clone the git repository, as laid out above.
1685 If you modify the code, you can run it by executing the
1686 \f[C]__main__.py\f[] file.
1687 To recompile the executable, run \f[C]make\ youtube\-dl\f[].
1688 .SS The exe throws an error due to missing \f[C]MSVCR100.dll\f[]
1689 .PP
1690 To run the exe you need to install first the Microsoft Visual C++ 2010
1691 Redistributable Package
1692 (x86) (https://www.microsoft.com/en-US/download/details.aspx?id=5555).
1693 .SS On Windows, how should I set up ffmpeg and youtube\-dl? Where should
1694 I put the exe files?
1695 .PP
1696 If you put youtube\-dl and ffmpeg in the same directory that you\[aq]re
1697 running the command from, it will work, but that\[aq]s rather
1698 cumbersome.
1699 .PP
1700 To make a different directory work \- either for ffmpeg, or for
1701 youtube\-dl, or for both \- simply create the directory (say,
1702 \f[C]C:\\bin\f[], or \f[C]C:\\Users\\<User\ name>\\bin\f[]), put all the
1703 executables directly in there, and then set your PATH environment
1704 variable (https://www.java.com/en/download/help/path.xml) to include
1705 that directory.
1706 .PP
1707 From then on, after restarting your shell, you will be able to access
1708 both youtube\-dl and ffmpeg (and youtube\-dl will be able to find
1709 ffmpeg) by simply typing \f[C]youtube\-dl\f[] or \f[C]ffmpeg\f[], no
1710 matter what directory you\[aq]re in.
1711 .SS How do I put downloads into a specific folder?
1712 .PP
1713 Use the \f[C]\-o\f[] to specify an output template (#output-template),
1714 for example \f[C]\-o\ "/home/user/videos/%(title)s\-%(id)s.%(ext)s"\f[].
1715 If you want this for all of your downloads, put the option into your
1716 configuration file (#configuration).
1717 .SS How do I download a video starting with a \f[C]\-\f[]?
1718 .PP
1719 Either prepend \f[C]https://www.youtube.com/watch?v=\f[] or separate the
1720 ID from the options with \f[C]\-\-\f[]:
1721 .IP
1722 .nf
1723 \f[C]
1724 youtube\-dl\ \-\-\ \-wNyEUrxzFU
1725 youtube\-dl\ "https://www.youtube.com/watch?v=\-wNyEUrxzFU"
1726 \f[]
1727 .fi
1728 .SS How do I pass cookies to youtube\-dl?
1729 .PP
1730 Use the \f[C]\-\-cookies\f[] option, for example
1731 \f[C]\-\-cookies\ /path/to/cookies/file.txt\f[].
1732 .PP
1733 In order to extract cookies from browser use any conforming browser
1734 extension for exporting cookies.
1735 For example,
1736 cookies.txt (https://chrome.google.com/webstore/detail/cookiestxt/njabckikapfpffapmjgojcnbfjonfjfg)
1737 (for Chrome) or Export
1738 Cookies (https://addons.mozilla.org/en-US/firefox/addon/export-cookies/)
1739 (for Firefox).
1740 .PP
1741 Note that the cookies file must be in Mozilla/Netscape format and the
1742 first line of the cookies file must be either
1743 \f[C]#\ HTTP\ Cookie\ File\f[] or
1744 \f[C]#\ Netscape\ HTTP\ Cookie\ File\f[].
1745 Make sure you have correct newline
1746 format (https://en.wikipedia.org/wiki/Newline) in the cookies file and
1747 convert newlines if necessary to correspond with your OS, namely
1748 \f[C]CRLF\f[] (\f[C]\\r\\n\f[]) for Windows and \f[C]LF\f[]
1749 (\f[C]\\n\f[]) for Unix and Unix\-like systems (Linux, Mac OS, etc.).
1750 \f[C]HTTP\ Error\ 400:\ Bad\ Request\f[] when using \f[C]\-\-cookies\f[]
1751 is a good sign of invalid newline format.
1752 .PP
1753 Passing cookies to youtube\-dl is a good way to workaround login when a
1754 particular extractor does not implement it explicitly.
1755 Another use case is working around
1756 CAPTCHA (https://en.wikipedia.org/wiki/CAPTCHA) some websites require
1757 you to solve in particular cases in order to get access (e.g.
1758 YouTube, CloudFlare).
1759 .SS How do I stream directly to media player?
1760 .PP
1761 You will first need to tell youtube\-dl to stream media to stdout with
1762 \f[C]\-o\ \-\f[], and also tell your media player to read from stdin (it
1763 must be capable of this for streaming) and then pipe former to latter.
1764 For example, streaming to vlc (https://www.videolan.org/) can be
1765 achieved with:
1766 .IP
1767 .nf
1768 \f[C]
1769 youtube\-dl\ \-o\ \-\ "https://www.youtube.com/watch?v=BaW_jenozKcj"\ |\ vlc\ \-
1770 \f[]
1771 .fi
1772 .SS How do I download only new videos from a playlist?
1773 .PP
1774 Use download\-archive feature.
1775 With this feature you should initially download the complete playlist
1776 with \f[C]\-\-download\-archive\ /path/to/download/archive/file.txt\f[]
1777 that will record identifiers of all the videos in a special file.
1778 Each subsequent run with the same \f[C]\-\-download\-archive\f[] will
1779 download only new videos and skip all videos that have been downloaded
1780 before.
1781 Note that only successful downloads are recorded in the file.
1782 .PP
1783 For example, at first,
1784 .IP
1785 .nf
1786 \f[C]
1787 youtube\-dl\ \-\-download\-archive\ archive.txt\ "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
1788 \f[]
1789 .fi
1790 .PP
1791 will download the complete \f[C]PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re\f[]
1792 playlist and create a file \f[C]archive.txt\f[].
1793 Each subsequent run will only download new videos if any:
1794 .IP
1795 .nf
1796 \f[C]
1797 youtube\-dl\ \-\-download\-archive\ archive.txt\ "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
1798 \f[]
1799 .fi
1800 .SS Should I add \f[C]\-\-hls\-prefer\-native\f[] into my config?
1801 .PP
1802 When youtube\-dl detects an HLS video, it can download it either with
1803 the built\-in downloader or ffmpeg.
1804 Since many HLS streams are slightly invalid and ffmpeg/youtube\-dl each
1805 handle some invalid cases better than the other, there is an option to
1806 switch the downloader if needed.
1807 .PP
1808 When youtube\-dl knows that one particular downloader works better for a
1809 given website, that downloader will be picked.
1810 Otherwise, youtube\-dl will pick the best downloader for general
1811 compatibility, which at the moment happens to be ffmpeg.
1812 This choice may change in future versions of youtube\-dl, with
1813 improvements of the built\-in downloader and/or ffmpeg.
1814 .PP
1815 In particular, the generic extractor (used when your website is not in
1816 the list of supported sites by
1817 youtube\-dl (https://rg3.github.io/youtube-dl/supportedsites.html)
1818 cannot mandate one specific downloader.
1819 .PP
1820 If you put either \f[C]\-\-hls\-prefer\-native\f[] or
1821 \f[C]\-\-hls\-prefer\-ffmpeg\f[] into your configuration, a different
1822 subset of videos will fail to download correctly.
1823 Instead, it is much better to file an issue (https://yt-dl.org/bug) or a
1824 pull request which details why the native or the ffmpeg HLS downloader
1825 is a better choice for your use case.
1826 .SS Can you add support for this anime video site, or site which shows
1827 current movies for free?
1828 .PP
1829 As a matter of policy (as well as legality), youtube\-dl does not
1830 include support for services that specialize in infringing copyright.
1831 As a rule of thumb, if you cannot easily find a video that the service
1832 is quite obviously allowed to distribute (i.e.
1833 that has been uploaded by the creator, the creator\[aq]s distributor, or
1834 is published under a free license), the service is probably unfit for
1835 inclusion to youtube\-dl.
1836 .PP
1837 A note on the service that they don\[aq]t host the infringing content,
1838 but just link to those who do, is evidence that the service should
1839 \f[B]not\f[] be included into youtube\-dl.
1840 The same goes for any DMCA note when the whole front page of the service
1841 is filled with videos they are not allowed to distribute.
1842 A "fair use" note is equally unconvincing if the service shows
1843 copyright\-protected videos in full without authorization.
1844 .PP
1845 Support requests for services that \f[B]do\f[] purchase the rights to
1846 distribute their content are perfectly fine though.
1847 If in doubt, you can simply include a source that mentions the
1848 legitimate purchase of content.
1849 .SS How can I speed up work on my issue?
1850 .PP
1851 (Also known as: Help, my important issue not being solved!) The
1852 youtube\-dl core developer team is quite small.
1853 While we do our best to solve as many issues as possible, sometimes that
1854 can take quite a while.
1855 To speed up your issue, here\[aq]s what you can do:
1856 .PP
1857 First of all, please do report the issue at our issue
1858 tracker (https://yt-dl.org/bugs).
1859 That allows us to coordinate all efforts by users and developers, and
1860 serves as a unified point.
1861 Unfortunately, the youtube\-dl project has grown too large to use
1862 personal email as an effective communication channel.
1863 .PP
1864 Please read the bug reporting instructions (#bugs) below.
1865 A lot of bugs lack all the necessary information.
1866 If you can, offer proxy, VPN, or shell access to the youtube\-dl
1867 developers.
1868 If you are able to, test the issue from multiple computers in multiple
1869 countries to exclude local censorship or misconfiguration issues.
1870 .PP
1871 If nobody is interested in solving your issue, you are welcome to take
1872 matters into your own hands and submit a pull request (or coerce/pay
1873 somebody else to do so).
1874 .PP
1875 Feel free to bump the issue from time to time by writing a small comment
1876 ("Issue is still present in youtube\-dl version ...from France, but
1877 fixed from Belgium"), but please not more than once a month.
1878 Please do not declare your issue as \f[C]important\f[] or
1879 \f[C]urgent\f[].
1880 .SS How can I detect whether a given URL is supported by youtube\-dl?
1881 .PP
1882 For one, have a look at the list of supported
1883 sites (docs/supportedsites.md).
1884 Note that it can sometimes happen that the site changes its URL scheme
1885 (say, from https://example.com/video/1234567 to
1886 https://example.com/v/1234567 ) and youtube\-dl reports an URL of a
1887 service in that list as unsupported.
1888 In that case, simply report a bug.
1889 .PP
1890 It is \f[I]not\f[] possible to detect whether a URL is supported or not.
1891 That\[aq]s because youtube\-dl contains a generic extractor which
1892 matches \f[B]all\f[] URLs.
1893 You may be tempted to disable, exclude, or remove the generic extractor,
1894 but the generic extractor not only allows users to extract videos from
1895 lots of websites that embed a video from another service, but may also
1896 be used to extract video from a service that it\[aq]s hosting itself.
1897 Therefore, we neither recommend nor support disabling, excluding, or
1898 removing the generic extractor.
1899 .PP
1900 If you want to find out whether a given URL is supported, simply call
1901 youtube\-dl with it.
1902 If you get no videos back, chances are the URL is either not referring
1903 to a video or unsupported.
1904 You can find out which by examining the output (if you run youtube\-dl
1905 on the console) or catching an \f[C]UnsupportedError\f[] exception if
1906 you run it from a Python program.
1907 .SH Why do I need to go through that much red tape when filing bugs?
1908 .PP
1909 Before we had the issue template, despite our extensive bug reporting
1910 instructions (#bugs), about 80% of the issue reports we got were
1911 useless, for instance because people used ancient versions hundreds of
1912 releases old, because of simple syntactic errors (not in youtube\-dl but
1913 in general shell usage), because the problem was already reported
1914 multiple times before, because people did not actually read an error
1915 message, even if it said "please install ffmpeg", because people did not
1916 mention the URL they were trying to download and many more simple,
1917 easy\-to\-avoid problems, many of whom were totally unrelated to
1918 youtube\-dl.
1919 .PP
1920 youtube\-dl is an open\-source project manned by too few volunteers, so
1921 we\[aq]d rather spend time fixing bugs where we are certain none of
1922 those simple problems apply, and where we can be reasonably confident to
1923 be able to reproduce the issue without asking the reporter repeatedly.
1924 As such, the output of \f[C]youtube\-dl\ \-v\ YOUR_URL_HERE\f[] is
1925 really all that\[aq]s required to file an issue.
1926 The issue template also guides you through some basic steps you can do,
1927 such as checking that your version of youtube\-dl is current.
1928 .SH DEVELOPER INSTRUCTIONS
1929 .PP
1930 Most users do not need to build youtube\-dl and can download the
1931 builds (https://rg3.github.io/youtube-dl/download.html) or get them from
1932 their distribution.
1933 .PP
1934 To run youtube\-dl as a developer, you don\[aq]t need to build anything
1935 either.
1936 Simply execute
1937 .IP
1938 .nf
1939 \f[C]
1940 python\ \-m\ youtube_dl
1941 \f[]
1942 .fi
1943 .PP
1944 To run the test, simply invoke your favorite test runner, or execute a
1945 test file directly; any of the following work:
1946 .IP
1947 .nf
1948 \f[C]
1949 python\ \-m\ unittest\ discover
1950 python\ test/test_download.py
1951 nosetests
1952 \f[]
1953 .fi
1954 .PP
1955 See item 6 of new extractor tutorial (#adding-support-for-a-new-site)
1956 for how to run extractor specific test cases.
1957 .PP
1958 If you want to create a build of youtube\-dl yourself, you\[aq]ll need
1959 .IP \[bu] 2
1960 python
1961 .IP \[bu] 2
1962 make (only GNU make is supported)
1963 .IP \[bu] 2
1964 pandoc
1965 .IP \[bu] 2
1966 zip
1967 .IP \[bu] 2
1968 nosetests
1969 .SS Adding support for a new site
1970 .PP
1971 If you want to add support for a new site, first of all \f[B]make
1972 sure\f[] this site is \f[B]not dedicated to copyright
1973 infringement (README.md#can-you-add-support-for-this-anime-video-site-or-site-which-shows-current-movies-for-free)\f[].
1974 youtube\-dl does \f[B]not support\f[] such sites thus pull requests
1975 adding support for them \f[B]will be rejected\f[].
1976 .PP
1977 After you have ensured this site is distributing its content legally,
1978 you can follow this quick list (assuming your service is called
1979 \f[C]yourextractor\f[]):
1980 .IP " 1." 4
1981 Fork this repository (https://github.com/rg3/youtube-dl/fork)
1982 .IP " 2." 4
1983 Check out the source code with:
1984 .RS 4
1985 .IP
1986 .nf
1987 \f[C]
1988 git\ clone\ git\@github.com:YOUR_GITHUB_USERNAME/youtube\-dl.git
1989 \f[]
1990 .fi
1991 .RE
1992 .IP " 3." 4
1993 Start a new git branch with
1994 .RS 4
1995 .IP
1996 .nf
1997 \f[C]
1998 cd\ youtube\-dl
1999 git\ checkout\ \-b\ yourextractor
2000 \f[]
2001 .fi
2002 .RE
2003 .IP " 4." 4
2004 Start with this simple template and save it to
2005 \f[C]youtube_dl/extractor/yourextractor.py\f[]:
2006 .RS 4
2007 .IP
2008 .nf
2009 \f[C]
2010 #\ coding:\ utf\-8
2011 from\ __future__\ import\ unicode_literals
2012
2013 from\ .common\ import\ InfoExtractor
2014
2015
2016 class\ YourExtractorIE(InfoExtractor):
2017 \ \ \ \ _VALID_URL\ =\ r\[aq]https?://(?:www\\.)?yourextractor\\.com/watch/(?P<id>[0\-9]+)\[aq]
2018 \ \ \ \ _TEST\ =\ {
2019 \ \ \ \ \ \ \ \ \[aq]url\[aq]:\ \[aq]https://yourextractor.com/watch/42\[aq],
2020 \ \ \ \ \ \ \ \ \[aq]md5\[aq]:\ \[aq]TODO:\ md5\ sum\ of\ the\ first\ 10241\ bytes\ of\ the\ video\ file\ (use\ \-\-test)\[aq],
2021 \ \ \ \ \ \ \ \ \[aq]info_dict\[aq]:\ {
2022 \ \ \ \ \ \ \ \ \ \ \ \ \[aq]id\[aq]:\ \[aq]42\[aq],
2023 \ \ \ \ \ \ \ \ \ \ \ \ \[aq]ext\[aq]:\ \[aq]mp4\[aq],
2024 \ \ \ \ \ \ \ \ \ \ \ \ \[aq]title\[aq]:\ \[aq]Video\ title\ goes\ here\[aq],
2025 \ \ \ \ \ \ \ \ \ \ \ \ \[aq]thumbnail\[aq]:\ r\[aq]re:^https?://.*\\.jpg$\[aq],
2026 \ \ \ \ \ \ \ \ \ \ \ \ #\ TODO\ more\ properties,\ either\ as:
2027 \ \ \ \ \ \ \ \ \ \ \ \ #\ *\ A\ value
2028 \ \ \ \ \ \ \ \ \ \ \ \ #\ *\ MD5\ checksum;\ start\ the\ string\ with\ md5:
2029 \ \ \ \ \ \ \ \ \ \ \ \ #\ *\ A\ regular\ expression;\ start\ the\ string\ with\ re:
2030 \ \ \ \ \ \ \ \ \ \ \ \ #\ *\ Any\ Python\ type\ (for\ example\ int\ or\ float)
2031 \ \ \ \ \ \ \ \ }
2032 \ \ \ \ }
2033
2034 \ \ \ \ def\ _real_extract(self,\ url):
2035 \ \ \ \ \ \ \ \ video_id\ =\ self._match_id(url)
2036 \ \ \ \ \ \ \ \ webpage\ =\ self._download_webpage(url,\ video_id)
2037
2038 \ \ \ \ \ \ \ \ #\ TODO\ more\ code\ goes\ here,\ for\ example\ ...
2039 \ \ \ \ \ \ \ \ title\ =\ self._html_search_regex(r\[aq]<h1>(.+?)</h1>\[aq],\ webpage,\ \[aq]title\[aq])
2040
2041 \ \ \ \ \ \ \ \ return\ {
2042 \ \ \ \ \ \ \ \ \ \ \ \ \[aq]id\[aq]:\ video_id,
2043 \ \ \ \ \ \ \ \ \ \ \ \ \[aq]title\[aq]:\ title,
2044 \ \ \ \ \ \ \ \ \ \ \ \ \[aq]description\[aq]:\ self._og_search_description(webpage),
2045 \ \ \ \ \ \ \ \ \ \ \ \ \[aq]uploader\[aq]:\ self._search_regex(r\[aq]<div[^>]+id="uploader"[^>]*>([^<]+)<\[aq],\ webpage,\ \[aq]uploader\[aq],\ fatal=False),
2046 \ \ \ \ \ \ \ \ \ \ \ \ #\ TODO\ more\ properties\ (see\ youtube_dl/extractor/common.py)
2047 \ \ \ \ \ \ \ \ }
2048 \f[]
2049 .fi
2050 .RE
2051 .IP " 5." 4
2052 Add an import in
2053 \f[C]youtube_dl/extractor/extractors.py\f[] (https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/extractors.py).
2054 .IP " 6." 4
2055 Run
2056 \f[C]python\ test/test_download.py\ TestDownload.test_YourExtractor\f[].
2057 This \f[I]should fail\f[] at first, but you can continually re\-run it
2058 until you\[aq]re done.
2059 If you decide to add more than one test, then rename \f[C]_TEST\f[] to
2060 \f[C]_TESTS\f[] and make it into a list of dictionaries.
2061 The tests will then be named \f[C]TestDownload.test_YourExtractor\f[],
2062 \f[C]TestDownload.test_YourExtractor_1\f[],
2063 \f[C]TestDownload.test_YourExtractor_2\f[], etc.
2064 Note that tests with \f[C]only_matching\f[] key in test\[aq]s dict are
2065 not counted in.
2066 .IP " 7." 4
2067 Have a look at
2068 \f[C]youtube_dl/extractor/common.py\f[] (https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py)
2069 for possible helper methods and a detailed description of what your
2070 extractor should and may
2071 return (https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L74-L252).
2072 Add tests and code for as many as you want.
2073 .IP " 8." 4
2074 Make sure your code follows youtube\-dl coding
2075 conventions (#youtube-dl-coding-conventions) and check the code with
2076 flake8 (https://pypi.python.org/pypi/flake8).
2077 Also make sure your code works under all
2078 Python (https://www.python.org/) versions claimed supported by
2079 youtube\-dl, namely 2.6, 2.7, and 3.2+.
2080 .IP " 9." 4
2081 When the tests pass, add (https://git-scm.com/docs/git-add) the new
2082 files and commit (https://git-scm.com/docs/git-commit) them and
2083 push (https://git-scm.com/docs/git-push) the result, like this:
2084 .RS 4
2085 .IP
2086 .nf
2087 \f[C]
2088 $\ git\ add\ youtube_dl/extractor/extractors.py
2089 $\ git\ add\ youtube_dl/extractor/yourextractor.py
2090 $\ git\ commit\ \-m\ \[aq][yourextractor]\ Add\ new\ extractor\[aq]
2091 $\ git\ push\ origin\ yourextractor
2092 \f[]
2093 .fi
2094 .RE
2095 .IP "10." 4
2096 Finally, create a pull
2097 request (https://help.github.com/articles/creating-a-pull-request).
2098 We\[aq]ll then review and merge it.
2099 .PP
2100 In any case, thank you very much for your contributions!
2101 .SS youtube\-dl coding conventions
2102 .PP
2103 This section introduces a guide lines for writing idiomatic, robust and
2104 future\-proof extractor code.
2105 .PP
2106 Extractors are very fragile by nature since they depend on the layout of
2107 the source data provided by 3rd party media hosters out of your control
2108 and this layout tends to change.
2109 As an extractor implementer your task is not only to write code that
2110 will extract media links and metadata correctly but also to minimize
2111 dependency on the source\[aq]s layout and even to make the code foresee
2112 potential future changes and be ready for that.
2113 This is important because it will allow the extractor not to break on
2114 minor layout changes thus keeping old youtube\-dl versions working.
2115 Even though this breakage issue is easily fixed by emitting a new
2116 version of youtube\-dl with a fix incorporated, all the previous
2117 versions become broken in all repositories and distros\[aq] packages
2118 that may not be so prompt in fetching the update from us.
2119 Needless to say, some non rolling release distros may never receive an
2120 update at all.
2121 .SS Mandatory and optional metafields
2122 .PP
2123 For extraction to work youtube\-dl relies on metadata your extractor
2124 extracts and provides to youtube\-dl expressed by an information
2125 dictionary (https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L75-L257)
2126 or simply \f[I]info dict\f[].
2127 Only the following meta fields in the \f[I]info dict\f[] are considered
2128 mandatory for a successful extraction process by youtube\-dl:
2129 .IP \[bu] 2
2130 \f[C]id\f[] (media identifier)
2131 .IP \[bu] 2
2132 \f[C]title\f[] (media title)
2133 .IP \[bu] 2
2134 \f[C]url\f[] (media download URL) or \f[C]formats\f[]
2135 .PP
2136 In fact only the last option is technically mandatory (i.e.
2137 if you can\[aq]t figure out the download location of the media the
2138 extraction does not make any sense).
2139 But by convention youtube\-dl also treats \f[C]id\f[] and \f[C]title\f[]
2140 as mandatory.
2141 Thus the aforementioned metafields are the critical data that the
2142 extraction does not make any sense without and if any of them fail to be
2143 extracted then the extractor is considered completely broken.
2144 .PP
2145 Any
2146 field (https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L149-L257)
2147 apart from the aforementioned ones are considered \f[B]optional\f[].
2148 That means that extraction should be \f[B]tolerant\f[] to situations
2149 when sources for these fields can potentially be unavailable (even if
2150 they are always available at the moment) and \f[B]future\-proof\f[] in
2151 order not to break the extraction of general purpose mandatory fields.
2152 .SS Example
2153 .PP
2154 Say you have some source dictionary \f[C]meta\f[] that you\[aq]ve
2155 fetched as JSON with HTTP request and it has a key \f[C]summary\f[]:
2156 .IP
2157 .nf
2158 \f[C]
2159 meta\ =\ self._download_json(url,\ video_id)
2160 \f[]
2161 .fi
2162 .PP
2163 Assume at this point \f[C]meta\f[]\[aq]s layout is:
2164 .IP
2165 .nf
2166 \f[C]
2167 {
2168 \ \ \ \ ...
2169 \ \ \ \ "summary":\ "some\ fancy\ summary\ text",
2170 \ \ \ \ ...
2171 }
2172 \f[]
2173 .fi
2174 .PP
2175 Assume you want to extract \f[C]summary\f[] and put it into the
2176 resulting info dict as \f[C]description\f[].
2177 Since \f[C]description\f[] is an optional meta field you should be ready
2178 that this key may be missing from the \f[C]meta\f[] dict, so that you
2179 should extract it like:
2180 .IP
2181 .nf
2182 \f[C]
2183 description\ =\ meta.get(\[aq]summary\[aq])\ \ #\ correct
2184 \f[]
2185 .fi
2186 .PP
2187 and not like:
2188 .IP
2189 .nf
2190 \f[C]
2191 description\ =\ meta[\[aq]summary\[aq]]\ \ #\ incorrect
2192 \f[]
2193 .fi
2194 .PP
2195 The latter will break extraction process with \f[C]KeyError\f[] if
2196 \f[C]summary\f[] disappears from \f[C]meta\f[] at some later time but
2197 with the former approach extraction will just go ahead with
2198 \f[C]description\f[] set to \f[C]None\f[] which is perfectly fine
2199 (remember \f[C]None\f[] is equivalent to the absence of data).
2200 .PP
2201 Similarly, you should pass \f[C]fatal=False\f[] when extracting optional
2202 data from a webpage with \f[C]_search_regex\f[],
2203 \f[C]_html_search_regex\f[] or similar methods, for instance:
2204 .IP
2205 .nf
2206 \f[C]
2207 description\ =\ self._search_regex(
2208 \ \ \ \ r\[aq]<span[^>]+id="title"[^>]*>([^<]+)<\[aq],
2209 \ \ \ \ webpage,\ \[aq]description\[aq],\ fatal=False)
2210 \f[]
2211 .fi
2212 .PP
2213 With \f[C]fatal\f[] set to \f[C]False\f[] if \f[C]_search_regex\f[]
2214 fails to extract \f[C]description\f[] it will emit a warning and
2215 continue extraction.
2216 .PP
2217 You can also pass \f[C]default=<some\ fallback\ value>\f[], for example:
2218 .IP
2219 .nf
2220 \f[C]
2221 description\ =\ self._search_regex(
2222 \ \ \ \ r\[aq]<span[^>]+id="title"[^>]*>([^<]+)<\[aq],
2223 \ \ \ \ webpage,\ \[aq]description\[aq],\ default=None)
2224 \f[]
2225 .fi
2226 .PP
2227 On failure this code will silently continue the extraction with
2228 \f[C]description\f[] set to \f[C]None\f[].
2229 That is useful for metafields that may or may not be present.
2230 .SS Provide fallbacks
2231 .PP
2232 When extracting metadata try to do so from multiple sources.
2233 For example if \f[C]title\f[] is present in several places, try
2234 extracting from at least some of them.
2235 This makes it more future\-proof in case some of the sources become
2236 unavailable.
2237 .SS Example
2238 .PP
2239 Say \f[C]meta\f[] from the previous example has a \f[C]title\f[] and you
2240 are about to extract it.
2241 Since \f[C]title\f[] is a mandatory meta field you should end up with
2242 something like:
2243 .IP
2244 .nf
2245 \f[C]
2246 title\ =\ meta[\[aq]title\[aq]]
2247 \f[]
2248 .fi
2249 .PP
2250 If \f[C]title\f[] disappears from \f[C]meta\f[] in future due to some
2251 changes on the hoster\[aq]s side the extraction would fail since
2252 \f[C]title\f[] is mandatory.
2253 That\[aq]s expected.
2254 .PP
2255 Assume that you have some another source you can extract \f[C]title\f[]
2256 from, for example \f[C]og:title\f[] HTML meta of a \f[C]webpage\f[].
2257 In this case you can provide a fallback scenario:
2258 .IP
2259 .nf
2260 \f[C]
2261 title\ =\ meta.get(\[aq]title\[aq])\ or\ self._og_search_title(webpage)
2262 \f[]
2263 .fi
2264 .PP
2265 This code will try to extract from \f[C]meta\f[] first and if it fails
2266 it will try extracting \f[C]og:title\f[] from a \f[C]webpage\f[].
2267 .SS Make regular expressions flexible
2268 .PP
2269 When using regular expressions try to write them fuzzy and flexible.
2270 .SS Example
2271 .PP
2272 Say you need to extract \f[C]title\f[] from the following HTML code:
2273 .IP
2274 .nf
2275 \f[C]
2276 <span\ style="position:\ absolute;\ left:\ 910px;\ width:\ 90px;\ float:\ right;\ z\-index:\ 9999;"\ class="title">some\ fancy\ title</span>
2277 \f[]
2278 .fi
2279 .PP
2280 The code for that task should look similar to:
2281 .IP
2282 .nf
2283 \f[C]
2284 title\ =\ self._search_regex(
2285 \ \ \ \ r\[aq]<span[^>]+class="title"[^>]*>([^<]+)\[aq],\ webpage,\ \[aq]title\[aq])
2286 \f[]
2287 .fi
2288 .PP
2289 Or even better:
2290 .IP
2291 .nf
2292 \f[C]
2293 title\ =\ self._search_regex(
2294 \ \ \ \ r\[aq]<span[^>]+class=(["\\\[aq]])title\\1[^>]*>(?P<title>[^<]+)\[aq],
2295 \ \ \ \ webpage,\ \[aq]title\[aq],\ group=\[aq]title\[aq])
2296 \f[]
2297 .fi
2298 .PP
2299 Note how you tolerate potential changes in the \f[C]style\f[]
2300 attribute\[aq]s value or switch from using double quotes to single for
2301 \f[C]class\f[] attribute:
2302 .PP
2303 The code definitely should not look like:
2304 .IP
2305 .nf
2306 \f[C]
2307 title\ =\ self._search_regex(
2308 \ \ \ \ r\[aq]<span\ style="position:\ absolute;\ left:\ 910px;\ width:\ 90px;\ float:\ right;\ z\-index:\ 9999;"\ class="title">(.*?)</span>\[aq],
2309 \ \ \ \ webpage,\ \[aq]title\[aq],\ group=\[aq]title\[aq])
2310 \f[]
2311 .fi
2312 .SS Use safe conversion functions
2313 .PP
2314 Wrap all extracted numeric data into safe functions from \f[C]utils\f[]:
2315 \f[C]int_or_none\f[], \f[C]float_or_none\f[].
2316 Use them for string to number conversions as well.
2317 .SH EMBEDDING YOUTUBE\-DL
2318 .PP
2319 youtube\-dl makes the best effort to be a good command\-line program,
2320 and thus should be callable from any programming language.
2321 If you encounter any problems parsing its output, feel free to create a
2322 report (https://github.com/rg3/youtube-dl/issues/new).
2323 .PP
2324 From a Python program, you can embed youtube\-dl in a more powerful
2325 fashion, like this:
2326 .IP
2327 .nf
2328 \f[C]
2329 from\ __future__\ import\ unicode_literals
2330 import\ youtube_dl
2331
2332 ydl_opts\ =\ {}
2333 with\ youtube_dl.YoutubeDL(ydl_opts)\ as\ ydl:
2334 \ \ \ \ ydl.download([\[aq]https://www.youtube.com/watch?v=BaW_jenozKc\[aq]])
2335 \f[]
2336 .fi
2337 .PP
2338 Most likely, you\[aq]ll want to use various options.
2339 For a list of options available, have a look at
2340 \f[C]youtube_dl/YoutubeDL.py\f[] (https://github.com/rg3/youtube-dl/blob/3e4cedf9e8cd3157df2457df7274d0c842421945/youtube_dl/YoutubeDL.py#L137-L312).
2341 For a start, if you want to intercept youtube\-dl\[aq]s output, set a
2342 \f[C]logger\f[] object.
2343 .PP
2344 Here\[aq]s a more complete example of a program that outputs only errors
2345 (and a short message after the download is finished), and
2346 downloads/converts the video to an mp3 file:
2347 .IP
2348 .nf
2349 \f[C]
2350 from\ __future__\ import\ unicode_literals
2351 import\ youtube_dl
2352
2353
2354 class\ MyLogger(object):
2355 \ \ \ \ def\ debug(self,\ msg):
2356 \ \ \ \ \ \ \ \ pass
2357
2358 \ \ \ \ def\ warning(self,\ msg):
2359 \ \ \ \ \ \ \ \ pass
2360
2361 \ \ \ \ def\ error(self,\ msg):
2362 \ \ \ \ \ \ \ \ print(msg)
2363
2364
2365 def\ my_hook(d):
2366 \ \ \ \ if\ d[\[aq]status\[aq]]\ ==\ \[aq]finished\[aq]:
2367 \ \ \ \ \ \ \ \ print(\[aq]Done\ downloading,\ now\ converting\ ...\[aq])
2368
2369
2370 ydl_opts\ =\ {
2371 \ \ \ \ \[aq]format\[aq]:\ \[aq]bestaudio/best\[aq],
2372 \ \ \ \ \[aq]postprocessors\[aq]:\ [{
2373 \ \ \ \ \ \ \ \ \[aq]key\[aq]:\ \[aq]FFmpegExtractAudio\[aq],
2374 \ \ \ \ \ \ \ \ \[aq]preferredcodec\[aq]:\ \[aq]mp3\[aq],
2375 \ \ \ \ \ \ \ \ \[aq]preferredquality\[aq]:\ \[aq]192\[aq],
2376 \ \ \ \ }],
2377 \ \ \ \ \[aq]logger\[aq]:\ MyLogger(),
2378 \ \ \ \ \[aq]progress_hooks\[aq]:\ [my_hook],
2379 }
2380 with\ youtube_dl.YoutubeDL(ydl_opts)\ as\ ydl:
2381 \ \ \ \ ydl.download([\[aq]https://www.youtube.com/watch?v=BaW_jenozKc\[aq]])
2382 \f[]
2383 .fi
2384 .SH BUGS
2385 .PP
2386 Bugs and suggestions should be reported at:
2387 <https://github.com/rg3/youtube-dl/issues>.
2388 Unless you were prompted to or there is another pertinent reason (e.g.
2389 GitHub fails to accept the bug report), please do not send bug reports
2390 via personal email.
2391 For discussions, join us in the IRC channel
2392 #youtube\-dl (irc://chat.freenode.net/#youtube-dl) on freenode
2393 (webchat (https://webchat.freenode.net/?randomnick=1&channels=youtube-dl)).
2394 .PP
2395 \f[B]Please include the full output of youtube\-dl when run with
2396 \f[C]\-v\f[]\f[], i.e.
2397 \f[B]add\f[] \f[C]\-v\f[] flag to \f[B]your command line\f[], copy the
2398 \f[B]whole\f[] output and post it in the issue body wrapped in ``` for
2399 better formatting.
2400 It should look similar to this:
2401 .IP
2402 .nf
2403 \f[C]
2404 $\ youtube\-dl\ \-v\ <your\ command\ line>
2405 [debug]\ System\ config:\ []
2406 [debug]\ User\ config:\ []
2407 [debug]\ Command\-line\ args:\ [u\[aq]\-v\[aq],\ u\[aq]https://www.youtube.com/watch?v=BaW_jenozKcj\[aq]]
2408 [debug]\ Encodings:\ locale\ cp1251,\ fs\ mbcs,\ out\ cp866,\ pref\ cp1251
2409 [debug]\ youtube\-dl\ version\ 2015.12.06
2410 [debug]\ Git\ HEAD:\ 135392e
2411 [debug]\ Python\ version\ 2.6.6\ \-\ Windows\-2003Server\-5.2.3790\-SP2
2412 [debug]\ exe\ versions:\ ffmpeg\ N\-75573\-g1d0487f,\ ffprobe\ N\-75573\-g1d0487f,\ rtmpdump\ 2.4
2413 [debug]\ Proxy\ map:\ {}
2414 \&...
2415 \f[]
2416 .fi
2417 .PP
2418 \f[B]Do not post screenshots of verbose logs; only plain text is
2419 acceptable.\f[]
2420 .PP
2421 The output (including the first lines) contains important debugging
2422 information.
2423 Issues without the full output are often not reproducible and therefore
2424 do not get solved in short order, if ever.
2425 .PP
2426 Please re\-read your issue once again to avoid a couple of common
2427 mistakes (you can and should use this as a checklist):
2428 .SS Is the description of the issue itself sufficient?
2429 .PP
2430 We often get issue reports that we cannot really decipher.
2431 While in most cases we eventually get the required information after
2432 asking back multiple times, this poses an unnecessary drain on our
2433 resources.
2434 Many contributors, including myself, are also not native speakers, so we
2435 may misread some parts.
2436 .PP
2437 So please elaborate on what feature you are requesting, or what bug you
2438 want to be fixed.
2439 Make sure that it\[aq]s obvious
2440 .IP \[bu] 2
2441 What the problem is
2442 .IP \[bu] 2
2443 How it could be fixed
2444 .IP \[bu] 2
2445 How your proposed solution would look like
2446 .PP
2447 If your report is shorter than two lines, it is almost certainly missing
2448 some of these, which makes it hard for us to respond to it.
2449 We\[aq]re often too polite to close the issue outright, but the missing
2450 info makes misinterpretation likely.
2451 As a committer myself, I often get frustrated by these issues, since the
2452 only possible way for me to move forward on them is to ask for
2453 clarification over and over.
2454 .PP
2455 For bug reports, this means that your report should contain the
2456 \f[I]complete\f[] output of youtube\-dl when called with the
2457 \f[C]\-v\f[] flag.
2458 The error message you get for (most) bugs even says so, but you would
2459 not believe how many of our bug reports do not contain this information.
2460 .PP
2461 If your server has multiple IPs or you suspect censorship, adding
2462 \f[C]\-\-call\-home\f[] may be a good idea to get more diagnostics.
2463 If the error is \f[C]ERROR:\ Unable\ to\ extract\ ...\f[] and you cannot
2464 reproduce it from multiple countries, add \f[C]\-\-dump\-pages\f[]
2465 (warning: this will yield a rather large output, redirect it to the file
2466 \f[C]log.txt\f[] by adding \f[C]>log.txt\ 2>&1\f[] to your
2467 command\-line) or upload the \f[C]\&.dump\f[] files you get when you add
2468 \f[C]\-\-write\-pages\f[] somewhere (https://gist.github.com/).
2469 .PP
2470 \f[B]Site support requests must contain an example URL\f[].
2471 An example URL is a URL you might want to download, like
2472 \f[C]https://www.youtube.com/watch?v=BaW_jenozKc\f[].
2473 There should be an obvious video present.
2474 Except under very special circumstances, the main page of a video
2475 service (e.g.
2476 \f[C]https://www.youtube.com/\f[]) is \f[I]not\f[] an example URL.
2477 .SS Are you using the latest version?
2478 .PP
2479 Before reporting any issue, type \f[C]youtube\-dl\ \-U\f[].
2480 This should report that you\[aq]re up\-to\-date.
2481 About 20% of the reports we receive are already fixed, but people are
2482 using outdated versions.
2483 This goes for feature requests as well.
2484 .SS Is the issue already documented?
2485 .PP
2486 Make sure that someone has not already opened the issue you\[aq]re
2487 trying to open.
2488 Search at the top of the window or browse the GitHub
2489 Issues (https://github.com/rg3/youtube-dl/search?type=Issues) of this
2490 repository.
2491 If there is an issue, feel free to write something along the lines of
2492 "This affects me as well, with version 2015.01.01.
2493 Here is some more information on the issue: ...".
2494 While some issues may be old, a new post into them often spurs rapid
2495 activity.
2496 .SS Why are existing options not enough?
2497 .PP
2498 Before requesting a new feature, please have a quick peek at the list of
2499 supported
2500 options (https://github.com/rg3/youtube-dl/blob/master/README.md#options).
2501 Many feature requests are for features that actually exist already!
2502 Please, absolutely do show off your work in the issue report and detail
2503 how the existing similar options do \f[I]not\f[] solve your problem.
2504 .SS Is there enough context in your bug report?
2505 .PP
2506 People want to solve problems, and often think they do us a favor by
2507 breaking down their larger problems (e.g.
2508 wanting to skip already downloaded files) to a specific request (e.g.
2509 requesting us to look whether the file exists before downloading the
2510 info page).
2511 However, what often happens is that they break down the problem into two
2512 steps: One simple, and one impossible (or extremely complicated one).
2513 .PP
2514 We are then presented with a very complicated request when the original
2515 problem could be solved far easier, e.g.
2516 by recording the downloaded video IDs in a separate file.
2517 To avoid this, you must include the greater context where it is
2518 non\-obvious.
2519 In particular, every feature request that does not consist of adding
2520 support for a new site should contain a use case scenario that explains
2521 in what situation the missing feature would be useful.
2522 .SS Does the issue involve one problem, and one problem only?
2523 .PP
2524 Some of our users seem to think there is a limit of issues they can or
2525 should open.
2526 There is no limit of issues they can or should open.
2527 While it may seem appealing to be able to dump all your issues into one
2528 ticket, that means that someone who solves one of your issues cannot
2529 mark the issue as closed.
2530 Typically, reporting a bunch of issues leads to the ticket lingering
2531 since nobody wants to attack that behemoth, until someone mercifully
2532 splits the issue into multiple ones.
2533 .PP
2534 In particular, every site support request issue should only pertain to
2535 services at one site (generally under a common domain, but always using
2536 the same backend technology).
2537 Do not request support for vimeo user videos, White house podcasts, and
2538 Google Plus pages in the same issue.
2539 Also, make sure that you don\[aq]t post bug reports alongside feature
2540 requests.
2541 As a rule of thumb, a feature request does not include outputs of
2542 youtube\-dl that are not immediately related to the feature at hand.
2543 Do not post reports of a network error alongside the request for a new
2544 video service.
2545 .SS Is anyone going to need the feature?
2546 .PP
2547 Only post features that you (or an incapacitated friend you can
2548 personally talk to) require.
2549 Do not post features because they seem like a good idea.
2550 If they are really useful, they will be requested by someone who
2551 requires them.
2552 .SS Is your question about youtube\-dl?
2553 .PP
2554 It may sound strange, but some bug reports we receive are completely
2555 unrelated to youtube\-dl and relate to a different, or even the
2556 reporter\[aq]s own, application.
2557 Please make sure that you are actually using youtube\-dl.
2558 If you are using a UI for youtube\-dl, report the bug to the maintainer
2559 of the actual application providing the UI.
2560 On the other hand, if your UI for youtube\-dl fails in some way you
2561 believe is related to youtube\-dl, by all means, go ahead and report the
2562 bug.
2563 .SH COPYRIGHT
2564 .PP
2565 youtube\-dl is released into the public domain by the copyright holders.
2566 .PP
2567 This README file was originally written by Daniel
2568 Bolton (https://github.com/dbbolton) and is likewise released into the
2569 public domain.