From cef96f1abf97057d64e67c32b443ef41ef93231a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jaime=20Marqui=CC=81nez=20Ferra=CC=81ndiz?=
 <jaime.marquinez.ferrandiz@gmail.com>
Date: Mon, 24 Mar 2014 19:51:49 +0100
Subject: [PATCH 1/8] docs: generate a page with the command line options

---
 devscripts/docs/make_options.py |  29 ++
 docs/cli_options.rst            |   4 +
 docs/index.rst                  |   8 +
 docs/options.rst.inc            | 465 ++++++++++++++++++++++++++++++++
 4 files changed, 506 insertions(+)
 create mode 100644 devscripts/docs/make_options.py
 create mode 100644 docs/cli_options.rst
 create mode 100644 docs/options.rst.inc

diff --git a/devscripts/docs/make_options.py b/devscripts/docs/make_options.py
new file mode 100644
index 000000000..cc30e5d28
--- /dev/null
+++ b/devscripts/docs/make_options.py
@@ -0,0 +1,29 @@
+from __future__ import unicode_literals
+import io
+import os
+import sys
+
+sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))))
+
+import youtube_dl
+from youtube_dl.utils import compat_str
+
+OPTONS_FILE = 'docs/options.rst.inc'
+parser,_ ,_ = youtube_dl.parseOpts()
+
+with io.open(OPTONS_FILE, 'wt', encoding='utf-8') as f:
+    f.write('.. program:: youtube-dl\n\n')
+    for group in parser.option_groups:
+        title = compat_str(group.title)
+        f.write(title + '\n')
+        f.write('-' * len(title) + '\n')
+        for option in group.option_list:
+            f.write('.. option:: ')
+            f.write(compat_str(option).replace('/', ', '))
+            if option.metavar:
+                f.write(' <%s>' % option.metavar)
+            f.write('\n\n')
+            f.write(' ' * 4 + option.help)
+            f.write('\n\n')
+        f.write('\n')
+
diff --git a/docs/cli_options.rst b/docs/cli_options.rst
new file mode 100644
index 000000000..067599301
--- /dev/null
+++ b/docs/cli_options.rst
@@ -0,0 +1,4 @@
+youtube-dl options
+==================
+
+.. include:: options.rst.inc
diff --git a/docs/index.rst b/docs/index.rst
index b746ff95b..61fc5834b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,6 +4,14 @@ Welcome to youtube-dl's documentation!
 *youtube-dl* is a command-line program to download videos from YouTube.com and more sites.
 It can also be used in Python code.
 
+User guide
+----------
+
+.. toctree::
+    :maxdepth: 2
+
+    cli_options
+
 Developer guide
 ---------------
 
diff --git a/docs/options.rst.inc b/docs/options.rst.inc
new file mode 100644
index 000000000..2ac9901a0
--- /dev/null
+++ b/docs/options.rst.inc
@@ -0,0 +1,465 @@
+.. program:: youtube-dl
+
+General Options
+---------------
+.. option:: -h, --help
+
+    print this help text and exit
+
+.. option:: --version
+
+    print program version and exit
+
+.. option:: -U, --update
+
+    update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)
+
+.. option:: -i, --ignore-errors
+
+    continue on download errors, for example to skip unavailable videos in a playlist
+
+.. option:: --abort-on-error
+
+    Abort downloading of further videos (in the playlist or the command line) if an error occurs
+
+.. option:: --dump-user-agent
+
+    display the current browser identification
+
+.. option:: --user-agent <UA>
+
+    specify a custom user agent
+
+.. option:: --referer <REF>
+
+    specify a custom referer, use if the video access is restricted to one domain
+
+.. option:: --add-header <FIELD:VALUE>
+
+    specify a custom HTTP header and its value, separated by a colon ':'. You can use this option multiple times
+
+.. option:: --list-extractors
+
+    List all supported extractors and the URLs they would handle
+
+.. option:: --extractor-descriptions
+
+    Output descriptions of all supported extractors
+
+.. option:: --proxy <URL>
+
+    Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection
+
+.. option:: --no-check-certificate
+
+    Suppress HTTPS certificate validation.
+
+.. option:: --prefer-insecure, --prefer-unsecure
+
+    Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)
+
+.. option:: --cache-dir <DIR>
+
+    Location in the filesystem where youtube-dl can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl or ~/.cache/youtube-dl . At the moment, only YouTube player files (for videos with obfuscated signatures) are cached, but that may change.
+
+.. option:: --no-cache-dir
+
+    Disable filesystem caching
+
+.. option:: --socket-timeout
+
+    Time to wait before giving up, in seconds
+
+.. option:: --bidi-workaround
+
+    Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH
+
+.. option:: --default-search <PREFIX>
+
+    Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for  youtube-dl "large apple". By default (with value "auto") youtube-dl guesses.
+
+.. option:: --ignore-config
+
+    Do not read configuration files. When given in the global configuration file /etc/youtube-dl.conf: do not read the user configuration in ~/.config/youtube-dl.conf (%APPDATA%/youtube-dl/config.txt on Windows)
+
+.. option:: --encoding <ENCODING>
+
+    Force the specified encoding (experimental)
+
+
+Video Selection
+---------------
+.. option:: --playlist-start <NUMBER>
+
+    playlist video to start at (default is %default)
+
+.. option:: --playlist-end <NUMBER>
+
+    playlist video to end at (default is last)
+
+.. option:: --match-title <REGEX>
+
+    download only matching titles (regex or caseless sub-string)
+
+.. option:: --reject-title <REGEX>
+
+    skip download for matching titles (regex or caseless sub-string)
+
+.. option:: --max-downloads <NUMBER>
+
+    Abort after downloading NUMBER files
+
+.. option:: --min-filesize <SIZE>
+
+    Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)
+
+.. option:: --max-filesize <SIZE>
+
+    Do not download any videos larger than SIZE (e.g. 50k or 44.6m)
+
+.. option:: --date <DATE>
+
+    download only videos uploaded in this date
+
+.. option:: --datebefore <DATE>
+
+    download only videos uploaded on or before this date (i.e. inclusive)
+
+.. option:: --dateafter <DATE>
+
+    download only videos uploaded on or after this date (i.e. inclusive)
+
+.. option:: --min-views <COUNT>
+
+    Do not download any videos with less than COUNT views
+
+.. option:: --max-views <COUNT>
+
+    Do not download any videos with more than COUNT views
+
+.. option:: --no-playlist
+
+    download only the currently playing video
+
+.. option:: --age-limit <YEARS>
+
+    download only videos suitable for the given age
+
+.. option:: --download-archive <FILE>
+
+    Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.
+
+.. option:: --include-ads
+
+    Download advertisements as well (experimental)
+
+.. option:: --youtube-include-dash-manifest
+
+    Try to download the DASH manifest on YouTube videos (experimental)
+
+
+Download Options
+----------------
+.. option:: -r, --rate-limit <LIMIT>
+
+    maximum download rate in bytes per second (e.g. 50K or 4.2M)
+
+.. option:: -R, --retries <RETRIES>
+
+    number of retries (default is %default)
+
+.. option:: --buffer-size <SIZE>
+
+    size of download buffer (e.g. 1024 or 16K) (default is %default)
+
+.. option:: --no-resize-buffer
+
+    do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.
+
+.. option:: --test
+
+    SUPPRESSHELP
+
+
+Filesystem Options
+------------------
+.. option:: -t, --title
+
+    use title in file name (default)
+
+.. option:: --id
+
+    use only video ID in file name
+
+.. option:: -l, --literal
+
+    [deprecated] alias of --title
+
+.. option:: -A, --auto-number
+
+    number downloaded files starting from 00000
+
+.. option:: -o, --output <TEMPLATE>
+
+    output filename template. Use %(title)s to get the title, %(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, %(autonumber)s to get an automatically incremented number, %(ext)s for the filename extension, %(format)s for the format description (like "22 - 1280x720" or "HD"), %(format_id)s for the unique id of the format (like Youtube's itags: "137"), %(upload_date)s for the upload date (YYYYMMDD), %(extractor)s for the provider (youtube, metacafe, etc), %(id)s for the video id, %(playlist)s for the playlist the video is in, %(playlist_index)s for the position in the playlist and %% for a literal percent. %(height)s and %(width)s for the width and height of the video format. %(resolution)s for a textual description of the resolution of the video format. Use - to output to stdout. Can also be used to download to a different directory, for example with -o '/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s' .
+
+.. option:: --autonumber-size <NUMBER>
+
+    Specifies the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given
+
+.. option:: --restrict-filenames
+
+    Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames
+
+.. option:: -a, --batch-file <FILE>
+
+    file containing URLs to download ('-' for stdin)
+
+.. option:: --load-info <FILE>
+
+    json file containing the video information (created with the "--write-json" option)
+
+.. option:: -w, --no-overwrites
+
+    do not overwrite files
+
+.. option:: -c, --continue
+
+    force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.
+
+.. option:: --no-continue
+
+    do not resume partially downloaded files (restart from beginning)
+
+.. option:: --cookies <FILE>
+
+    file to read cookies from and dump cookie jar in
+
+.. option:: --no-part
+
+    do not use .part files
+
+.. option:: --no-mtime
+
+    do not use the Last-modified header to set the file modification time
+
+.. option:: --write-description
+
+    write video description to a .description file
+
+.. option:: --write-info-json
+
+    write video metadata to a .info.json file
+
+.. option:: --write-annotations
+
+    write video annotations to a .annotation file
+
+.. option:: --write-thumbnail
+
+    write thumbnail image to disk
+
+
+Verbosity / Simulation Options
+------------------------------
+.. option:: -q, --quiet
+
+    activates quiet mode
+
+.. option:: --no-warnings
+
+    Ignore warnings
+
+.. option:: -s, --simulate
+
+    do not download the video and do not write anything to disk
+
+.. option:: --skip-download
+
+    do not download the video
+
+.. option:: -g, --get-url
+
+    simulate, quiet but print URL
+
+.. option:: -e, --get-title
+
+    simulate, quiet but print title
+
+.. option:: --get-id
+
+    simulate, quiet but print id
+
+.. option:: --get-thumbnail
+
+    simulate, quiet but print thumbnail URL
+
+.. option:: --get-description
+
+    simulate, quiet but print video description
+
+.. option:: --get-duration
+
+    simulate, quiet but print video length
+
+.. option:: --get-filename
+
+    simulate, quiet but print output filename
+
+.. option:: --get-format
+
+    simulate, quiet but print output format
+
+.. option:: -j, --dump-json
+
+    simulate, quiet but print JSON information. See --output for a description of available keys.
+
+.. option:: --newline
+
+    output progress bar as new lines
+
+.. option:: --no-progress
+
+    do not print progress bar
+
+.. option:: --console-title
+
+    display progress in console titlebar
+
+.. option:: -v, --verbose
+
+    print various debugging information
+
+.. option:: --dump-intermediate-pages
+
+    print downloaded pages to debug problems (very verbose)
+
+.. option:: --write-pages
+
+    Write downloaded intermediary pages to files in the current directory to debug problems
+
+.. option:: --youtube-print-sig-code
+
+    SUPPRESSHELP
+
+.. option:: --print-traffic
+
+    Display sent and read HTTP traffic
+
+
+Video Format Options
+--------------------
+.. option:: -f, --format <FORMAT>
+
+    video format code, specify the order of preference using slashes: "-f 22/17/18". "-f mp4" and "-f flv" are also supported. You can also use the special names "best", "bestvideo", "bestaudio", "worst", "worstvideo" and "worstaudio". By default, youtube-dl will pick the best quality.
+
+.. option:: --all-formats
+
+    download all available video formats
+
+.. option:: --prefer-free-formats
+
+    prefer free video formats unless a specific one is requested
+
+.. option:: --max-quality <FORMAT>
+
+    highest quality format to download
+
+.. option:: -F, --list-formats
+
+    list all available formats
+
+
+Subtitle Options
+----------------
+.. option:: --write-sub, --write-srt
+
+    write subtitle file
+
+.. option:: --write-auto-sub, --write-automatic-sub
+
+    write automatic subtitle file (youtube only)
+
+.. option:: --all-subs
+
+    downloads all the available subtitles of the video
+
+.. option:: --list-subs
+
+    lists all available subtitles for the video
+
+.. option:: --sub-format <FORMAT>
+
+    subtitle format (default=srt) ([sbv/vtt] youtube only)
+
+.. option:: --sub-lang, --sub-langs, --srt-lang <LANGS>
+
+    languages of the subtitles to download (optional) separated by commas, use IETF language tags like 'en,pt'
+
+
+Authentication Options
+----------------------
+.. option:: -u, --username <USERNAME>
+
+    account username
+
+.. option:: -p, --password <PASSWORD>
+
+    account password
+
+.. option:: -n, --netrc
+
+    use .netrc authentication data
+
+.. option:: --video-password <PASSWORD>
+
+    video password (vimeo, smotri)
+
+
+Post-processing Options
+-----------------------
+.. option:: -x, --extract-audio
+
+    convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)
+
+.. option:: --audio-format <FORMAT>
+
+    "best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; best by default
+
+.. option:: --audio-quality <QUALITY>
+
+    ffmpeg/avconv audio quality specification, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default 5)
+
+.. option:: --recode-video <FORMAT>
+
+    Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm)
+
+.. option:: -k, --keep-video
+
+    keeps the video file on disk after the post-processing; the video is erased by default
+
+.. option:: --no-post-overwrites
+
+    do not overwrite post-processed files; the post-processed files are overwritten by default
+
+.. option:: --embed-subs
+
+    embed subtitles in the video (only for mp4 videos)
+
+.. option:: --add-metadata
+
+    write metadata to the video file
+
+.. option:: --xattrs
+
+    write metadata to the video file's xattrs (using dublin core and xdg standards)
+
+.. option:: --prefer-avconv
+
+    Prefer avconv over ffmpeg for running the postprocessors (default)
+
+.. option:: --prefer-ffmpeg
+
+    Prefer ffmpeg over avconv for running the postprocessors
+
+

From 904954f1a092dda7d435a3a0ccfade40e158a297 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jaime=20Marqui=CC=81nez=20Ferra=CC=81ndiz?=
 <jaime.marquinez.ferrandiz@gmail.com>
Date: Mon, 24 Mar 2014 19:52:53 +0100
Subject: [PATCH 2/8] docs: Add a manpage

---
 MANIFEST.in           |  2 +-
 docs/conf.py          |  4 ++++
 docs/youtube-dl.1.rst | 22 ++++++++++++++++++++++
 3 files changed, 27 insertions(+), 1 deletion(-)
 create mode 100644 docs/youtube-dl.1.rst

diff --git a/MANIFEST.in b/MANIFEST.in
index d43cc1f3b..1943a75b5 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -3,4 +3,4 @@ include test/*.py
 include test/*.json
 include youtube-dl.bash-completion
 include youtube-dl.1
-recursive-include docs Makefile conf.py *.rst
+recursive-include docs Makefile conf.py *.rst *.rst.inc
diff --git a/docs/conf.py b/docs/conf.py
index 4a04ad779..678e513d9 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -69,3 +69,7 @@ html_static_path = ['_static']
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'youtube-dldoc'
+
+
+# -- Options for the man page ---------------------------------------------
+man_pages = [('youtube-dl.1', 'youtube-dl', 'download videos from youtube.com or other video platforms', 'Ricardo Garcia Gonzalez', 1)]
diff --git a/docs/youtube-dl.1.rst b/docs/youtube-dl.1.rst
new file mode 100644
index 000000000..d3308118e
--- /dev/null
+++ b/docs/youtube-dl.1.rst
@@ -0,0 +1,22 @@
+:orphan:
+
+YOUTUBE-DL(1)
+*************
+
+SYNOPSIS
+========
+
+**youtube-dl** [OPTIONS] URL [URL...]
+
+DESCRIPTION
+===========
+
+**youtube-dl** is a small command-line program to download videos from
+YouTube.com and a few more sites. It requires the Python interpreter, version
+2.6, 2.7, or 3.3+, and it is not platform specific. It should work on
+your Unix box, on Windows or on Mac OS X. It is released to the public domain,
+which means you can modify it, redistribute it or use it however you like.
+
+OPTIONS
+=======
+.. include:: options.rst.inc

From 8d4a2e62bd40075416450fea5db0fae3dd696672 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jaime=20Marqui=CC=81nez=20Ferra=CC=81ndiz?=
 <jaime.marquinez.ferrandiz@gmail.com>
Date: Mon, 24 Mar 2014 20:17:38 +0100
Subject: [PATCH 3/8] docs: Add faq

---
 docs/faq.rst          | 52 +++++++++++++++++++++++++++++++++++++++++++
 docs/index.rst        |  1 +
 docs/youtube-dl.1.rst |  2 ++
 3 files changed, 55 insertions(+)
 create mode 100644 docs/faq.rst

diff --git a/docs/faq.rst b/docs/faq.rst
new file mode 100644
index 000000000..cf9bb31a8
--- /dev/null
+++ b/docs/faq.rst
@@ -0,0 +1,52 @@
+FAQ
+===
+
+Can you please put the -b option back?
+--------------------------------------
+
+Most people asking this question are not aware that youtube-dl now defaults to downloading the highest available quality as reported by YouTube, which will be 1080p or 720p in some cases, so you no longer need the `-b` option. For some specific videos, maybe YouTube does not report them to be available in a specific high quality format you're interested in. In that case, simply request it with the `-f` option and youtube-dl will try to download it.
+
+I get HTTP error 402 when trying to download a video. What's this?
+------------------------------------------------------------------
+
+Apparently YouTube requires you to pass a CAPTCHA test if you download too much. We're [considering to provide a way to let you solve the CAPTCHA](https://github.com/rg3/youtube-dl/issues/154), but at the moment, your best course of action is pointing a webbrowser to the youtube URL, solving the CAPTCHA, and restart youtube-dl.
+
+I have downloaded a video but how can I play it?
+------------------------------------------------
+
+Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
+
+The links provided by youtube-dl -g are not working anymore
+-----------------------------------------------------------
+
+The URLs youtube-dl outputs require the downloader to have the correct cookies. Use the `--cookies` option to write the required cookies into a file, and advise your downloader to read cookies from that file. Some sites also require a common user agent to be used, use `--dump-user-agent` to see the one in use by youtube-dl.
+
+ERROR: no fmt_url_map or conn information found in video info
+-------------------------------------------------------------
+
+youtube has switched to a new video info format in July 2011 which is not supported by old versions of youtube-dl. You can update youtube-dl with `sudo youtube-dl --update`.
+
+ERROR: unable to download video
+-------------------------------
+
+youtube requires an additional signature since September 2012 which is not supported by old versions of youtube-dl. You can update youtube-dl with `sudo youtube-dl --update`.
+
+SyntaxError: Non-ASCII character
+--------------------------------
+
+The error
+
+    File "youtube-dl", line 2
+    SyntaxError: Non-ASCII character '\x93' ...
+
+means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
+
+What is this binary file? Where has the code gone?
+--------------------------------------------------
+
+Since June 2012 (#342) youtube-dl is packed as an executable zipfile, simply unzip it (might need renaming to `youtube-dl.zip` first on some systems) or clone the git repository, as laid out above. If you modify the code, you can run it by executing the `__main__.py` file. To recompile the executable, run `make youtube-dl`.
+
+The exe throws a *Runtime error from Visual C++*
+------------------------------------------------
+
+To run the exe you need to install first the [Microsoft Visual C++ 2008 Redistributable Package](http://www.microsoft.com/en-us/download/details.aspx?id=29).
diff --git a/docs/index.rst b/docs/index.rst
index 61fc5834b..731233ffe 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,6 +11,7 @@ User guide
     :maxdepth: 2
 
     cli_options
+    faq
 
 Developer guide
 ---------------
diff --git a/docs/youtube-dl.1.rst b/docs/youtube-dl.1.rst
index d3308118e..7d68a9a60 100644
--- a/docs/youtube-dl.1.rst
+++ b/docs/youtube-dl.1.rst
@@ -20,3 +20,5 @@ which means you can modify it, redistribute it or use it however you like.
 OPTIONS
 =======
 .. include:: options.rst.inc
+
+.. include:: faq.rst

From a7d8f7f53da1e668abf2a44069e1ac68ef12bbdf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jaime=20Marqui=CC=81nez=20Ferra=CC=81ndiz?=
 <jaime.marquinez.ferrandiz@gmail.com>
Date: Wed, 26 Mar 2014 13:44:12 +0100
Subject: [PATCH 4/8] Generate the manpage with sphinx

---
 Makefile              | 7 +++++--
 devscripts/release.sh | 6 +++---
 2 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/Makefile b/Makefile
index f7d917d09..e2bfe834e 100644
--- a/Makefile
+++ b/Makefile
@@ -54,8 +54,11 @@ README.md: youtube_dl/*.py youtube_dl/*/*.py
 README.txt: README.md
 	pandoc -f markdown -t plain README.md -o README.txt
 
-youtube-dl.1: README.md
-	pandoc -s -f markdown -t man README.md -o youtube-dl.1
+docs/options.rst.inc: youtube_dl/*.py youtube_dl/*/*.py
+	python devscripts/docs/make_options.py
+
+youtube-dl.1: docs/options.rst.inc docs/*.rst
+	sphinx-build -b man -d docs/_build/doctrees docs ./
 
 youtube-dl.bash-completion: youtube_dl/*.py youtube_dl/*/*.py devscripts/bash-completion.in
 	python devscripts/bash-completion.py
diff --git a/devscripts/release.sh b/devscripts/release.sh
index 2974a7c3e..3a2e0461e 100755
--- a/devscripts/release.sh
+++ b/devscripts/release.sh
@@ -45,9 +45,9 @@ fi
 /bin/echo -e "\n### Changing version in version.py..."
 sed -i "s/__version__ = '.*'/__version__ = '$version'/" youtube_dl/version.py
 
-/bin/echo -e "\n### Committing CHANGELOG README.md and youtube_dl/version.py..."
-make README.md
-git add CHANGELOG README.md youtube_dl/version.py
+/bin/echo -e "\n### Committing CHANGELOG README.md, youtube_dl/version.py and docs/options.rst.inc..."
+make README.md docs/options.rst.inc
+git add CHANGELOG README.md youtube_dl/version.py docs/options.rst.inc
 git commit -m "release $version"
 
 /bin/echo -e "\n### Now tagging, signing and pushing..."

From bc7149f6cf2a1617a803237648500a4d86aa7d0d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jaime=20Marqui=CC=81nez=20Ferra=CC=81ndiz?=
 <jaime.marquinez.ferrandiz@gmail.com>
Date: Wed, 26 Mar 2014 14:04:27 +0100
Subject: [PATCH 5/8] docs/manpage: Add CONFIGURATION, OUTPUT TEMPLATE and
 VIDEO SELECTION sections

---
 docs/youtube-dl.1.rst | 49 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/docs/youtube-dl.1.rst b/docs/youtube-dl.1.rst
index 7d68a9a60..1c1a5ed29 100644
--- a/docs/youtube-dl.1.rst
+++ b/docs/youtube-dl.1.rst
@@ -21,4 +21,53 @@ OPTIONS
 =======
 .. include:: options.rst.inc
 
+CONFIGURATION
+=============
+
+You can configure youtube-dl by placing default arguments (such as ``--extract-audio --no-mtime`` to always extract the audio and not copy the mtime) into :file:`/etc/youtube-dl.conf` and/or :file:`~/.config/youtube-dl/config`. On Windows, the configuration file locations are :file:`%APPDATA%\\youtube-dl\\config.txt` and :file:`C:\Users\\<Yourname>\\youtube-dl.conf`.
+
+OUTPUT TEMPLATE
+===============
+
+The ``-o`` option allows users to indicate a template for the output file names. The basic usage is not to set any template arguments when downloading a single file, like in ``youtube-dl -o funny_video.flv "http://some/video"``. However, it may contain special sequences that will be replaced when downloading each video. The special sequences have the format ``%(NAME)s``. To clarify, that is a percent symbol followed by a name in parenthesis, followed by a lowercase S. Allowed names are:
+
+ - ``id``: The sequence will be replaced by the video identifier.
+ - ``url``: The sequence will be replaced by the video URL.
+ - ``uploader``: The sequence will be replaced by the nickname of the person who uploaded the video.
+ - ``upload_date``: The sequence will be replaced by the upload date in YYYYMMDD format.
+ - ``title``: The sequence will be replaced by the video title.
+ - ``ext``: The sequence will be replaced by the appropriate extension (like flv or mp4).
+ - ``epoch``: The sequence will be replaced by the Unix epoch when creating the file.
+ - ``autonumber``: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
+ - ``playlist``: The name or the id of the playlist that contains the video.
+ - ``playlist_index``: The index of the video in the playlist, a five-digit number.
+
+The current default template is ``%(title)s-%(id)s.%(ext)s``.
+
+In some cases, you don't want special characters such as 中, spaces, or &, such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the ``--restrict-filenames`` flag to get a shorter title::
+
+    $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
+    youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters
+    $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
+    youtube-dl_test_video_.mp4          # A simple file name
+
+VIDEO SELECTION
+===============
+
+Videos can be filtered by their upload date using the options ``--date``, ``--datebefore`` or ``--dateafter``, they accept dates in two formats:
+
+ - Absolute dates: Dates in the format ``YYYYMMDD``.
+ - Relative dates: Dates in the format ``(now|today)[+-][0-9](day|week|month|year)(s)?``
+
+Examples::
+
+    # Download only the videos uploaded in the last 6 months
+    $ youtube-dl --dateafter now-6months
+
+    # Download only the videos uploaded on January 1, 1970
+    $ youtube-dl --date 19700101
+
+    $ # will only download the videos uploaded in the 200x decade
+    $ youtube-dl --dateafter 20000101 --datebefore 20091231
+
 .. include:: faq.rst

From 94aaf831ff0c5a3260d9b4a918acf76575f6e3e3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jaime=20Marqui=CC=81nez=20Ferra=CC=81ndiz?=
 <jaime.marquinez.ferrandiz@gmail.com>
Date: Wed, 26 Mar 2014 14:11:40 +0100
Subject: [PATCH 6/8] manpage: Add BUGS section

Recommend reading the bug reporting guidelines.
---
 docs/conf.py          | 2 ++
 docs/youtube-dl.1.rst | 5 +++++
 2 files changed, 7 insertions(+)

diff --git a/docs/conf.py b/docs/conf.py
index 678e513d9..6dfcbdc15 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -73,3 +73,5 @@ htmlhelp_basename = 'youtube-dldoc'
 
 # -- Options for the man page ---------------------------------------------
 man_pages = [('youtube-dl.1', 'youtube-dl', 'download videos from youtube.com or other video platforms', 'Ricardo Garcia Gonzalez', 1)]
+
+man_show_urls = True
diff --git a/docs/youtube-dl.1.rst b/docs/youtube-dl.1.rst
index 1c1a5ed29..eec8aa634 100644
--- a/docs/youtube-dl.1.rst
+++ b/docs/youtube-dl.1.rst
@@ -71,3 +71,8 @@ Examples::
     $ youtube-dl --dateafter 20000101 --datebefore 20091231
 
 .. include:: faq.rst
+
+BUGS
+====
+
+Bugs and suggestions should be reported at: https://github.com/rg3/youtube-dl/issues. Please read the `bug reporting guidelines <https://github.com/rg3/youtube-dl/#bugs>`_ before opening a ticket.

From 6ce2ceb58b32d0ad9a51564bbd50343bd8d1317b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jaime=20Marqui=CC=81nez=20Ferra=CC=81ndiz?=
 <jaime.marquinez.ferrandiz@gmail.com>
Date: Wed, 26 Mar 2014 14:15:00 +0100
Subject: [PATCH 7/8] README: remove sections that are included in the manpage

---
 README.md                 | 343 --------------------------------------
 devscripts/make_readme.py |  24 ---
 2 files changed, 367 deletions(-)
 delete mode 100755 devscripts/make_readme.py

diff --git a/README.md b/README.md
index 1ba1486d2..da101438b 100644
--- a/README.md
+++ b/README.md
@@ -1,352 +1,9 @@
-% YOUTUBE-DL(1)
-
-# NAME
-youtube-dl - download videos from youtube.com or other video platforms
-
-# SYNOPSIS
-**youtube-dl** [OPTIONS] URL [URL...]
-
-# DESCRIPTION
 **youtube-dl** is a small command-line program to download videos from
 YouTube.com and a few more sites. It requires the Python interpreter, version
 2.6, 2.7, or 3.3+, and it is not platform specific. It should work on
 your Unix box, on Windows or on Mac OS X. It is released to the public domain,
 which means you can modify it, redistribute it or use it however you like.
 
-# OPTIONS
-    -h, --help                       print this help text and exit
-    --version                        print program version and exit
-    -U, --update                     update this program to latest version. Make
-                                     sure that you have sufficient permissions
-                                     (run with sudo if needed)
-    -i, --ignore-errors              continue on download errors, for example to
-                                     skip unavailable videos in a playlist
-    --abort-on-error                 Abort downloading of further videos (in the
-                                     playlist or the command line) if an error
-                                     occurs
-    --dump-user-agent                display the current browser identification
-    --user-agent UA                  specify a custom user agent
-    --referer REF                    specify a custom referer, use if the video
-                                     access is restricted to one domain
-    --add-header FIELD:VALUE         specify a custom HTTP header and its value,
-                                     separated by a colon ':'. You can use this
-                                     option multiple times
-    --list-extractors                List all supported extractors and the URLs
-                                     they would handle
-    --extractor-descriptions         Output descriptions of all supported
-                                     extractors
-    --proxy URL                      Use the specified HTTP/HTTPS proxy. Pass in
-                                     an empty string (--proxy "") for direct
-                                     connection
-    --no-check-certificate           Suppress HTTPS certificate validation.
-    --prefer-insecure                Use an unencrypted connection to retrieve
-                                     information about the video. (Currently
-                                     supported only for YouTube)
-    --cache-dir DIR                  Location in the filesystem where youtube-dl
-                                     can store some downloaded information
-                                     permanently. By default $XDG_CACHE_HOME
-                                     /youtube-dl or ~/.cache/youtube-dl . At the
-                                     moment, only YouTube player files (for
-                                     videos with obfuscated signatures) are
-                                     cached, but that may change.
-    --no-cache-dir                   Disable filesystem caching
-    --socket-timeout None            Time to wait before giving up, in seconds
-    --bidi-workaround                Work around terminals that lack
-                                     bidirectional text support. Requires bidiv
-                                     or fribidi executable in PATH
-    --default-search PREFIX          Use this prefix for unqualified URLs. For
-                                     example "gvsearch2:" downloads two videos
-                                     from google videos for  youtube-dl "large
-                                     apple". By default (with value "auto")
-                                     youtube-dl guesses.
-    --ignore-config                  Do not read configuration files. When given
-                                     in the global configuration file /etc
-                                     /youtube-dl.conf: do not read the user
-                                     configuration in ~/.config/youtube-dl.conf
-                                     (%APPDATA%/youtube-dl/config.txt on
-                                     Windows)
-    --encoding ENCODING              Force the specified encoding (experimental)
-
-## Video Selection:
-    --playlist-start NUMBER          playlist video to start at (default is 1)
-    --playlist-end NUMBER            playlist video to end at (default is last)
-    --match-title REGEX              download only matching titles (regex or
-                                     caseless sub-string)
-    --reject-title REGEX             skip download for matching titles (regex or
-                                     caseless sub-string)
-    --max-downloads NUMBER           Abort after downloading NUMBER files
-    --min-filesize SIZE              Do not download any videos smaller than
-                                     SIZE (e.g. 50k or 44.6m)
-    --max-filesize SIZE              Do not download any videos larger than SIZE
-                                     (e.g. 50k or 44.6m)
-    --date DATE                      download only videos uploaded in this date
-    --datebefore DATE                download only videos uploaded on or before
-                                     this date (i.e. inclusive)
-    --dateafter DATE                 download only videos uploaded on or after
-                                     this date (i.e. inclusive)
-    --min-views COUNT                Do not download any videos with less than
-                                     COUNT views
-    --max-views COUNT                Do not download any videos with more than
-                                     COUNT views
-    --no-playlist                    download only the currently playing video
-    --age-limit YEARS                download only videos suitable for the given
-                                     age
-    --download-archive FILE          Download only videos not listed in the
-                                     archive file. Record the IDs of all
-                                     downloaded videos in it.
-    --include-ads                    Download advertisements as well
-                                     (experimental)
-    --youtube-include-dash-manifest  Try to download the DASH manifest on
-                                     YouTube videos (experimental)
-
-## Download Options:
-    -r, --rate-limit LIMIT           maximum download rate in bytes per second
-                                     (e.g. 50K or 4.2M)
-    -R, --retries RETRIES            number of retries (default is 10)
-    --buffer-size SIZE               size of download buffer (e.g. 1024 or 16K)
-                                     (default is 1024)
-    --no-resize-buffer               do not automatically adjust the buffer
-                                     size. By default, the buffer size is
-                                     automatically resized from an initial value
-                                     of SIZE.
-
-## Filesystem Options:
-    -t, --title                      use title in file name (default)
-    --id                             use only video ID in file name
-    -l, --literal                    [deprecated] alias of --title
-    -A, --auto-number                number downloaded files starting from 00000
-    -o, --output TEMPLATE            output filename template. Use %(title)s to
-                                     get the title, %(uploader)s for the
-                                     uploader name, %(uploader_id)s for the
-                                     uploader nickname if different,
-                                     %(autonumber)s to get an automatically
-                                     incremented number, %(ext)s for the
-                                     filename extension, %(format)s for the
-                                     format description (like "22 - 1280x720" or
-                                     "HD"), %(format_id)s for the unique id of
-                                     the format (like Youtube's itags: "137"),
-                                     %(upload_date)s for the upload date
-                                     (YYYYMMDD), %(extractor)s for the provider
-                                     (youtube, metacafe, etc), %(id)s for the
-                                     video id, %(playlist)s for the playlist the
-                                     video is in, %(playlist_index)s for the
-                                     position in the playlist and %% for a
-                                     literal percent. %(height)s and %(width)s
-                                     for the width and height of the video
-                                     format. %(resolution)s for a textual
-                                     description of the resolution of the video
-                                     format. Use - to output to stdout. Can also
-                                     be used to download to a different
-                                     directory, for example with -o '/my/downloa
-                                     ds/%(uploader)s/%(title)s-%(id)s.%(ext)s' .
-    --autonumber-size NUMBER         Specifies the number of digits in
-                                     %(autonumber)s when it is present in output
-                                     filename template or --auto-number option
-                                     is given
-    --restrict-filenames             Restrict filenames to only ASCII
-                                     characters, and avoid "&" and spaces in
-                                     filenames
-    -a, --batch-file FILE            file containing URLs to download ('-' for
-                                     stdin)
-    --load-info FILE                 json file containing the video information
-                                     (created with the "--write-json" option)
-    -w, --no-overwrites              do not overwrite files
-    -c, --continue                   force resume of partially downloaded files.
-                                     By default, youtube-dl will resume
-                                     downloads if possible.
-    --no-continue                    do not resume partially downloaded files
-                                     (restart from beginning)
-    --cookies FILE                   file to read cookies from and dump cookie
-                                     jar in
-    --no-part                        do not use .part files
-    --no-mtime                       do not use the Last-modified header to set
-                                     the file modification time
-    --write-description              write video description to a .description
-                                     file
-    --write-info-json                write video metadata to a .info.json file
-    --write-annotations              write video annotations to a .annotation
-                                     file
-    --write-thumbnail                write thumbnail image to disk
-
-## Verbosity / Simulation Options:
-    -q, --quiet                      activates quiet mode
-    --no-warnings                    Ignore warnings
-    -s, --simulate                   do not download the video and do not write
-                                     anything to disk
-    --skip-download                  do not download the video
-    -g, --get-url                    simulate, quiet but print URL
-    -e, --get-title                  simulate, quiet but print title
-    --get-id                         simulate, quiet but print id
-    --get-thumbnail                  simulate, quiet but print thumbnail URL
-    --get-description                simulate, quiet but print video description
-    --get-duration                   simulate, quiet but print video length
-    --get-filename                   simulate, quiet but print output filename
-    --get-format                     simulate, quiet but print output format
-    -j, --dump-json                  simulate, quiet but print JSON information.
-                                     See --output for a description of available
-                                     keys.
-    --newline                        output progress bar as new lines
-    --no-progress                    do not print progress bar
-    --console-title                  display progress in console titlebar
-    -v, --verbose                    print various debugging information
-    --dump-intermediate-pages        print downloaded pages to debug problems
-                                     (very verbose)
-    --write-pages                    Write downloaded intermediary pages to
-                                     files in the current directory to debug
-                                     problems
-    --print-traffic                  Display sent and read HTTP traffic
-
-## Video Format Options:
-    -f, --format FORMAT              video format code, specify the order of
-                                     preference using slashes: "-f 22/17/18".
-                                     "-f mp4" and "-f flv" are also supported.
-                                     You can also use the special names "best",
-                                     "bestvideo", "bestaudio", "worst",
-                                     "worstvideo" and "worstaudio". By default,
-                                     youtube-dl will pick the best quality.
-    --all-formats                    download all available video formats
-    --prefer-free-formats            prefer free video formats unless a specific
-                                     one is requested
-    --max-quality FORMAT             highest quality format to download
-    -F, --list-formats               list all available formats
-
-## Subtitle Options:
-    --write-sub                      write subtitle file
-    --write-auto-sub                 write automatic subtitle file (youtube
-                                     only)
-    --all-subs                       downloads all the available subtitles of
-                                     the video
-    --list-subs                      lists all available subtitles for the video
-    --sub-format FORMAT              subtitle format (default=srt) ([sbv/vtt]
-                                     youtube only)
-    --sub-lang LANGS                 languages of the subtitles to download
-                                     (optional) separated by commas, use IETF
-                                     language tags like 'en,pt'
-
-## Authentication Options:
-    -u, --username USERNAME          account username
-    -p, --password PASSWORD          account password
-    -n, --netrc                      use .netrc authentication data
-    --video-password PASSWORD        video password (vimeo, smotri)
-
-## Post-processing Options:
-    -x, --extract-audio              convert video files to audio-only files
-                                     (requires ffmpeg or avconv and ffprobe or
-                                     avprobe)
-    --audio-format FORMAT            "best", "aac", "vorbis", "mp3", "m4a",
-                                     "opus", or "wav"; best by default
-    --audio-quality QUALITY          ffmpeg/avconv audio quality specification,
-                                     insert a value between 0 (better) and 9
-                                     (worse) for VBR or a specific bitrate like
-                                     128K (default 5)
-    --recode-video FORMAT            Encode the video to another format if
-                                     necessary (currently supported:
-                                     mp4|flv|ogg|webm)
-    -k, --keep-video                 keeps the video file on disk after the
-                                     post-processing; the video is erased by
-                                     default
-    --no-post-overwrites             do not overwrite post-processed files; the
-                                     post-processed files are overwritten by
-                                     default
-    --embed-subs                     embed subtitles in the video (only for mp4
-                                     videos)
-    --add-metadata                   write metadata to the video file
-    --xattrs                         write metadata to the video file's xattrs
-                                     (using dublin core and xdg standards)
-    --prefer-avconv                  Prefer avconv over ffmpeg for running the
-                                     postprocessors (default)
-    --prefer-ffmpeg                  Prefer ffmpeg over avconv for running the
-                                     postprocessors
-
-# CONFIGURATION
-
-You can configure youtube-dl by placing default arguments (such as `--extract-audio --no-mtime` to always extract the audio and not copy the mtime) into `/etc/youtube-dl.conf` and/or `~/.config/youtube-dl/config`. On Windows, the configuration file locations are `%APPDATA%\youtube-dl\config.txt` and `C:\Users\<Yourname>\youtube-dl.conf`.
-
-# OUTPUT TEMPLATE
-
-The `-o` option allows users to indicate a template for the output file names. The basic usage is not to set any template arguments when downloading a single file, like in `youtube-dl -o funny_video.flv "http://some/video"`. However, it may contain special sequences that will be replaced when downloading each video. The special sequences have the format `%(NAME)s`. To clarify, that is a percent symbol followed by a name in parenthesis, followed by a lowercase S. Allowed names are:
-
- - `id`: The sequence will be replaced by the video identifier.
- - `url`: The sequence will be replaced by the video URL.
- - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video.
- - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format.
- - `title`: The sequence will be replaced by the video title.
- - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4).
- - `epoch`: The sequence will be replaced by the Unix epoch when creating the file.
- - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
- - `playlist`: The name or the id of the playlist that contains the video.
- - `playlist_index`: The index of the video in the playlist, a five-digit number.
-
-The current default template is `%(title)s-%(id)s.%(ext)s`.
-
-In some cases, you don't want special characters such as 中, spaces, or &, such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the `--restrict-filenames` flag to get a shorter title:
-
-    $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
-    youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters
-    $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
-    youtube-dl_test_video_.mp4          # A simple file name
-
-# VIDEO SELECTION
-
-Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`, they accept dates in two formats:
-
- - Absolute dates: Dates in the format `YYYYMMDD`.
- - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
- 
-Examples:
-
-    # Download only the videos uploaded in the last 6 months
-    $ youtube-dl --dateafter now-6months
-
-    # Download only the videos uploaded on January 1, 1970
-    $ youtube-dl --date 19700101
-
-    $ # will only download the videos uploaded in the 200x decade
-    $ youtube-dl --dateafter 20000101 --datebefore 20091231
-
-# FAQ
-
-### Can you please put the -b option back?
-
-Most people asking this question are not aware that youtube-dl now defaults to downloading the highest available quality as reported by YouTube, which will be 1080p or 720p in some cases, so you no longer need the `-b` option. For some specific videos, maybe YouTube does not report them to be available in a specific high quality format you're interested in. In that case, simply request it with the `-f` option and youtube-dl will try to download it.
-
-### I get HTTP error 402 when trying to download a video. What's this?
-
-Apparently YouTube requires you to pass a CAPTCHA test if you download too much. We're [considering to provide a way to let you solve the CAPTCHA](https://github.com/rg3/youtube-dl/issues/154), but at the moment, your best course of action is pointing a webbrowser to the youtube URL, solving the CAPTCHA, and restart youtube-dl.
-
-### I have downloaded a video but how can I play it?
-
-Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
-
-### The links provided by youtube-dl -g are not working anymore
-
-The URLs youtube-dl outputs require the downloader to have the correct cookies. Use the `--cookies` option to write the required cookies into a file, and advise your downloader to read cookies from that file. Some sites also require a common user agent to be used, use `--dump-user-agent` to see the one in use by youtube-dl.
-
-### ERROR: no fmt_url_map or conn information found in video info
-
-youtube has switched to a new video info format in July 2011 which is not supported by old versions of youtube-dl. You can update youtube-dl with `sudo youtube-dl --update`.
-
-### ERROR: unable to download video ###
-
-youtube requires an additional signature since September 2012 which is not supported by old versions of youtube-dl. You can update youtube-dl with `sudo youtube-dl --update`.
-
-### SyntaxError: Non-ASCII character ###
-
-The error
-
-    File "youtube-dl", line 2
-    SyntaxError: Non-ASCII character '\x93' ...
-
-means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
-
-### What is this binary file? Where has the code gone?
-
-Since June 2012 (#342) youtube-dl is packed as an executable zipfile, simply unzip it (might need renaming to `youtube-dl.zip` first on some systems) or clone the git repository, as laid out above. If you modify the code, you can run it by executing the `__main__.py` file. To recompile the executable, run `make youtube-dl`.
-
-### The exe throws a *Runtime error from Visual C++*
-
-To run the exe you need to install first the [Microsoft Visual C++ 2008 Redistributable Package](http://www.microsoft.com/en-us/download/details.aspx?id=29).
-
 # DEVELOPER INSTRUCTIONS
 
 Most users do not need to build youtube-dl and can [download the builds](http://rg3.github.io/youtube-dl/download.html) or get them from their distribution.
diff --git a/devscripts/make_readme.py b/devscripts/make_readme.py
deleted file mode 100755
index cae1fa4f2..000000000
--- a/devscripts/make_readme.py
+++ /dev/null
@@ -1,24 +0,0 @@
-import io
-import sys
-import re
-
-README_FILE = 'README.md'
-helptext = sys.stdin.read()
-
-if isinstance(helptext, bytes):
-    helptext = helptext.decode('utf-8')
-
-with io.open(README_FILE, encoding='utf-8') as f:
-    oldreadme = f.read()
-
-header = oldreadme[:oldreadme.index('# OPTIONS')]
-footer = oldreadme[oldreadme.index('# CONFIGURATION'):]
-
-options = helptext[helptext.index('  General Options:') + 19:]
-options = re.sub(r'^  (\w.+)$', r'## \1', options, flags=re.M)
-options = '# OPTIONS\n' + options + '\n'
-
-with io.open(README_FILE, 'w', encoding='utf-8') as f:
-    f.write(header)
-    f.write(options)
-    f.write(footer)

From 30adceb7bba5ffb32b0331764a8eb14d4175115c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jaime=20Marqui=CC=81nez=20Ferra=CC=81ndiz?=
 <jaime.marquinez.ferrandiz@gmail.com>
Date: Sat, 12 Apr 2014 15:16:12 +0200
Subject: [PATCH 8/8] docs: Use a different copyright in the html and man
 output

---
 docs/_templates/layout.html | 3 +++
 docs/conf.py                | 6 ++++--
 docs/youtube-dl.1.rst       | 7 +++++++
 3 files changed, 14 insertions(+), 2 deletions(-)
 create mode 100644 docs/_templates/layout.html

diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
new file mode 100644
index 000000000..6666627c0
--- /dev/null
+++ b/docs/_templates/layout.html
@@ -0,0 +1,3 @@
+{% extends "!layout.html" %}
+
+{% set copyright = "2006-2014 Ricardo Garcia Gonzalez" %}
diff --git a/docs/conf.py b/docs/conf.py
index 6dfcbdc15..91bf7ae3e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -37,7 +37,9 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'youtube-dl'
-copyright = u'2014, Ricardo Garcia Gonzalez'
+# Set it to None so that we can set different copyrights in the html and man
+# output
+copyright = None
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -72,6 +74,6 @@ htmlhelp_basename = 'youtube-dldoc'
 
 
 # -- Options for the man page ---------------------------------------------
-man_pages = [('youtube-dl.1', 'youtube-dl', 'download videos from youtube.com or other video platforms', 'Ricardo Garcia Gonzalez', 1)]
+man_pages = [('youtube-dl.1', 'youtube-dl', 'download videos from youtube.com or other video platforms', None, 1)]
 
 man_show_urls = True
diff --git a/docs/youtube-dl.1.rst b/docs/youtube-dl.1.rst
index eec8aa634..766746ba5 100644
--- a/docs/youtube-dl.1.rst
+++ b/docs/youtube-dl.1.rst
@@ -76,3 +76,10 @@ BUGS
 ====
 
 Bugs and suggestions should be reported at: https://github.com/rg3/youtube-dl/issues. Please read the `bug reporting guidelines <https://github.com/rg3/youtube-dl/#bugs>`_ before opening a ticket.
+
+COPYRIGHT
+=========
+
+youtube-dl is released into the public domain by the copyright holders.
+
+This manual page is based on the README file originally written by `Daniel Bolton <https://github.com/dbbolton>`_ and is likewise released into the public domain.