Merge tag 'upstream/2012.02.27+gita171dbf'

[youtubedl] / debian / youtube-dl.pod

diff --git a/debian/youtube-dl.pod b/debian/youtube-dl.pod
index 0f0fdaf6371e8d01fc80c77ff878da42cfaae742..78f44eb7920e7fb7a85047b05a1936800b971417 100644 (file)
--- a/debian/youtube-dl.pod
+++ b/debian/youtube-dl.pod
@@ -1,7 +1,7 @@
 # -*- pod -*-
 =head1 NAME
 
-youtube-dl - download videos from youtube.com
+youtube-dl - download videos from youtube.com or other video platforms
 
 =head1 SYNOPSIS
 
@@ -9,7 +9,13 @@ youtube-dl - download videos from youtube.com
 
 =head1 DESCRIPTION
 
-youtube-dl is a script to download videos from youtube.com.
+youtube-dl is a script to download videos from youtube.com or any other of
+the supported video platforms.
+
+Currently supported sites are: CollegeHumor, Comedy Central, Dailymotion,
+Facebook, Metacafe, MyVideo, Photobucket, The Escapist, Vimeo, Yahoo!,
+YouTube, blip.tv, depositfiles.com, video.google.com, xvideos, Soundcloud,
+InfoQ, Mixcloud, OpenClassRoom.
 
 Once it is installed in your system, you should be able to call it from
 the command line. Usage instructions are easy. Use youtube-dl followed
@@ -112,7 +118,12 @@ For youtube.com, in particular, the meaning of the format codes is given as:
 
 =back
 
-Note that not all videos are available in all formats.
+Note that not all videos are available in all formats and that other
+sites supported by B<youtube-dl> may have different conventions for
+their video formats.
+
+By default, youtube-dl will download the best available format; if you want
+to download the worst format to save bandwidth and time, use C<-f> I<worst>.
 
 =item --all-formats
 
@@ -214,6 +225,16 @@ Do not append the I<.part> suffix do files that have not yet been completed.
 
 Do not use the I<Last-modified> header to set the file modification time.
 
+=item --extract-audio
+
+Create an audio-only file extracted from the video downloaded. Requires that
+ffmpeg and ffprobe be installed.
+
+=item --audio-format=B<FORMAT>
+
+Set the audio format to be used for the extraction. Possible values are
+I<best>, I<aac>, I<mp3>, with I<best> being the default.
+
 =back
 
 =head1 OUTPUT TEMPLATE