debian/copyright: Rewrite in Copyright Format 1.0 for readability.

[youtubedl] / debian / youtube-dl.pod

diff --git a/debian/youtube-dl.pod b/debian/youtube-dl.pod
index e8588f0098a3ddadd4b48e99461943dbd9ceaf80..78f44eb7920e7fb7a85047b05a1936800b971417 100644 (file)
--- a/debian/youtube-dl.pod
+++ b/debian/youtube-dl.pod
@@ -1,7 +1,7 @@
 # -*- pod -*-
 =head1 NAME
 
 # -*- pod -*-
 =head1 NAME
 

-youtube-dl - download videos from youtube.com
+youtube-dl - download videos from youtube.com or other video platforms

 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 


@@ -9,7 +9,13 @@ youtube-dl - download videos from youtube.com
 
 =head1 DESCRIPTION
 
 
 =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
 
 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


@@ -54,6 +60,21 @@ Limit the download speed to the specified maximum B<L> (e.g., 50k or 44.6m).
 
 Number B<R> of retries for a given download (default is 10).
 
 
 Number B<R> of retries for a given download (default is 10).
 

+=item --playlist-start=B<N>
+
+The number B<N> of the video in a playlist where we should start downlading
+(default is 1).
+
+=item --playlist-end=B<N>
+
+The number B<N> of the video in a playlist where we should stop downloading
+(default is -1, which stands for the last video in the playlist).
+
+=item --dump-user-agent
+
+Display how youtube-dl will identify itself (the User-Agent string) to the
+remote server.
+

 =item -u B<UN>, --username=B<UN>
 
 Specify the youtube account username B<UN>. Some videos require an
 =item -u B<UN>, --username=B<UN>
 
 Specify the youtube account username B<UN>. Some videos require an


@@ -71,18 +92,38 @@ home directory. The machine name is youtube regarding this usage.
 
 =item -f B<FMT>, --format=B<FMT>
 
 
 =item -f B<FMT>, --format=B<FMT>
 

-Specify the video format (quality) in which to download the video. Note
-that not all videos are available in all formats.
+Specify the video format (quality) in which to download the video.
+
+For youtube.com, in particular, the meaning of the format codes is given as:
+
+=over
+
+=item WebM video at 480p: 43
+
+=item WebM video at 720p: 45
+
+=item H264 video in MP4 container at 480p: 18
+
+=item H264 video in MP4 container at 720p: 22

 
 

-=item -b, --best-quality
+=item H264 video in MP4 container at 1080p: 37

 
 

-This option is deprecated, does nothing currently, and is expected to be
-removed in a next release, as it is the current behavior of youtube-dl.
+=item H264 video in FLV container at 360p: 34

 
 

-=item -m, --mobile-version
+=item H264 video in FLV container at 480p: 35
+
+=item H263 video at 240p: 5
+
+=item 3GP video: 17
+
+=back

 
 

-Synonymous to the option "-f 17", to download videos playable on some
-mobile phones.
+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
 
 
 =item --all-formats
 


@@ -123,10 +164,19 @@ thumbnail.
 Simulate the operation, like quiet mode, but print the description of the
 video.
 
 Simulate the operation, like quiet mode, but print the description of the
 video.
 

+=item --get-filename
+
+Simulate the operation, like quiet mode, but print the output filename.
+

 =item --no-progress
 
 Do not print the progress bar during downloads.
 
 =item --no-progress
 
 Do not print the progress bar during downloads.
 

+=item --console-title
+
+If possible, set the title of the console window with the progress of the
+download.
+

 =item -t, --title
 
 Use the title of the video in the file name used to download the video.
 =item -t, --title
 
 Use the title of the video in the file name used to download the video.


@@ -137,6 +187,11 @@ Use the literal title of the video in file name used to download the
 video. Can contain "weird" characters that are not filtered like with
 the -t option.
 
 video. Can contain "weird" characters that are not filtered like with
 the -t option.
 

+=item -A, --auto-number
+
+When downloading multiple videos from a playlist, automatically number them,
+in sequence, starting from 00000.
+

 =item -o B<TPL>, --output=B<TPL>
 
 Specify a template B<TPL> for the names of the files to be created when
 =item -o B<TPL>, --output=B<TPL>
 
 Specify a template B<TPL> for the names of the files to be created when


@@ -158,6 +213,28 @@ Do no overwrite already existing files.
 
 Resume partially downloaded files.
 
 
 Resume partially downloaded files.
 

+=item --cookies=B<F>
+
+Store the received cookies to file B<F> (the "cookie jar").
+
+=item --no-part
+
+Do not append the I<.part> suffix do files that have not yet been completed.
+
+=item --no-mtime
+
+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
 =back
 
 =head1 OUTPUT TEMPLATE