Add script to regenerate index.html
[youtube-dl] / index.html.in
1 <!DOCTYPE html 
2      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6         <meta http-equiv="Content-type" content="text/html; charset=UTF-8" />
7         <title>youtube-dl: Download videos from YouTube.com</title>
8         <style type="text/css"><!--
9                 body {
10                         font-family: sans-serif;
11                         font-size: small;
12                 }
13                 h1 {
14                         text-align: center;
15                         text-decoration: underline;
16                         color: #006699;
17                 }
18                 h2 {
19                         color: #006699;
20                 }
21                 p {
22                         text-align: justify;
23                         margin-left: 5%;
24                         margin-right: 5%;
25                 }
26                 ul {
27                         margin-left: 5%;
28                         margin-right: 5%;
29                         list-style-type: square;
30                 }
31                 li {
32                         margin-bottom: 0.5ex;
33                 }
34                 #copyright {
35                         font-size: x-small;
36                         text-align: center;
37                 }
38                 --></style>
39 </head>
40 <body>
41 <h1>youtube-dl: Download videos from YouTube.com</h1>
42
43 <h2>What is it?</h2>
44
45 <p><em>youtube-dl</em> is a small command-line program to download videos
46 from YouTube.com. It requires the <a href="http://www.python.org/">Python
47 interpreter</a>, version 2.4 or later, and it's not platform specific.
48 It should work in your Unix box, in Windows or in Mac OS X. The latest version
49 is <strong>@PROGRAM_VERSION@</strong>. It's licensed under the MIT License, which
50 means you can modify it, redistribute it or use it however you like
51 complying with a few simple conditions.</p>
52
53 <p>I'll try to keep it updated if YouTube.com changes the way you access
54 their videos. After all, it's a simple and short program. However, I can't
55 guarantee anything. If you detect it stops working, check for new versions
56 and/or inform me about the problem, indicating the program version you
57 are using. If the program stops working and I can't solve the problem but
58 you have a solution, I'd like to know it. If that happens and you feel you
59 can maintain the program yourself, tell me. My contact information is
60 at <a href="http://freshmeat.net/~rg3/">freshmeat.net</a>.</p>
61
62 <p>Thanks for all the feedback received so far. I'm glad people find my
63 program useful.</p>
64
65 <p><strong>Related projects</strong>:
66 <a href="../metacafe-dl/">metacafe-dl</a>
67 <a href="../pornotube-dl/">pornotube-dl</a>
68 </p>
69
70 <h2>Usage instructions</h2>
71
72 <p>In Windows, once you have installed the Python interpreter, save the
73 program with the <em>.py</em> extension and put it somewhere in the PATH.
74 Try to follow the
75 <a href="http://rg03.wordpress.com/youtube-dl-under-windows-xp/">guide to
76 install youtube-dl under Windows XP</a>.</p>
77
78 <p>In Unix, download it, give it execution permission and copy it to one
79 of the PATH directories (typically, <em>/usr/local/bin</em>).</p>
80
81 <p>After that, you should be able to call it from the command line as
82 <em>youtube-dl</em> or <em>youtube-dl.py</em>. I will use <em>youtube-dl</em>
83 in the following examples. Usage instructions are easy. Use <em>youtube-dl</em>
84 followed by a video URL or identifier. Example: <em>youtube-dl
85 "http://www.youtube.com/watch?v=foobar"</em>. The video will be saved
86 to the file <em>foobar.flv</em> in that example. As YouTube.com
87 videos are in Flash Video format, their extension should be <em>flv</em>.
88 In Linux and other unices, video players using a recent version of
89 <em>ffmpeg</em> can play them. That includes MPlayer, VLC, etc. Those two
90 work under Windows and other platforms, but you could also get a
91 specific FLV player of your taste.</p>
92
93 <p>If you try to run the program and you receive an error message containing the
94 keyword <em>SyntaxError</em> near the end, it means your Python interpreter
95 is too old.</p>
96
97 <h2>More usage tips</h2>
98
99 <ul>
100
101 <li>You can change the file name of the video using the -o option, like in
102 <em>youtube-dl -o vid.flv "http://www.youtube.com/watch?v=foobar"</em>.</li>
103
104 <li>Some videos require an account to be downloaded, mostly because they're
105 flagged as mature content. You can pass the program a username and password
106 for a YouTube.com account with the -u and -p options, like <em>youtube-dl
107 -u myusername -p mypassword "http://www.youtube.com/watch?v=foobar"</em>.</li>
108
109 <li>The account data can also be read from the user .netrc file by indicating
110 the -n or --netrc option. The machine name is <em>youtube</em> in that
111 case.</li>
112
113 <li>The <em>simulate mode</em> (activated with -s or --simulate) can be used
114 to just get the real video URL and use it with a download manager if you
115 prefer that option.</li>
116
117 <li>The <em>quiet mode</em> (activated with -q or --quiet) can be used to
118 supress all output messages. This allows, in systems featuring /dev/stdout
119 and other similar special files, outputting the video data to standard output
120 in order to pipe it to another program without interferences.</li>
121
122 <li>The program can be told to simply print the final video URL to standard
123 output using the -g or --get-url option.</li>
124
125 <li>Combined with the above option, the -2 or --title-too option tells the
126 program to print the video title too.</li>
127
128 <li>The default filename is <em>video_id.flv</em>. But you can also use the
129 video title in the filename with the -t or --title option, or preserve the
130 literal title in the filename with the -l or --literal option.</li>
131
132 <li>You can make the program append <em>&amp;fmt=something</em> to the URL
133 by using the -f or --format option. This makes it possible to download high
134 quality versions of the videos when available.</li>
135
136 <li><em>youtube-dl</em> can attempt to download the best quality version of
137 a video by using the -b or --best-quality option.</li>
138
139 <li><em>youtube-dl</em> honors the <em>http_proxy</em> environment variable
140 if you want to use a proxy. Set it to something like
141 <em>http://proxy.example.com:8080</em>, and do not leave the <em>http://</em>
142 prefix out.</li>
143
144 <li>You can get the program version by calling it as <em>youtube-dl
145 -v</em> or <em>youtube-dl --version</em>.</li>
146
147 <li>For usage instructions, use <em>youtube-dl -h</em> or <em>youtube-dl
148 --help.</em></li>
149
150 <li>You can cancel the program at any time pressing Ctrl+C. It may print
151 some error lines saying something about <em>KeyboardInterrupt</em>.
152 That's ok.</li>
153
154 </ul>
155
156 <h2>Download it</h2>
157
158 <p>Note that if you directly click on these hyperlinks, your web browser will
159 most likely display the program contents. It's usually better to
160 right-click on it and choose the appropriate option, normally called <em>Save
161 Target As</em> or <em>Save Link As</em>, depending on the web browser you
162 are using.</p>
163
164 <p><a href="youtube-dl">@PROGRAM_VERSION@</a></p>
165 <ul>
166         <li><strong>MD5</strong>: @PROGRAM_MD5SUM@</li>
167         <li><strong>SHA1</strong>: @PROGRAM_SHA1SUM@</li>
168         <li><strong>SHA256</strong>: @PROGRAM_SHA256SUM@</li>
169 </ul>
170
171 <p id="copyright">Copyright &copy; 2006-2007 Ricardo Garcia Gonzalez</p>
172 </body>
173 </html>