[doc] Better formatting of youtube-dl.1 (closes #6510)

Makefile

@@ -1,7 +1,7 @@
 all: youtube-dl README.md CONTRIBUTING.md README.txt youtube-dl.1 youtube-dl.bash-completion youtube-dl.zsh youtube-dl.fish supportedsites
 
 clean:
-	rm -rf youtube-dl.1.temp.md youtube-dl.1 youtube-dl.bash-completion README.txt MANIFEST build/ dist/ .coverage cover/ youtube-dl.tar.gz youtube-dl.zsh youtube-dl.fish *.dump *.part *.info.json *.mp4 *.flv *.mp3 *.avi CONTRIBUTING.md.tmp youtube-dl youtube-dl.exe
+	rm -rf README-wide.md youtube-dl.1.temp.md youtube-dl.1 youtube-dl.bash-completion README.txt MANIFEST build/ dist/ .coverage cover/ youtube-dl.tar.gz youtube-dl.zsh youtube-dl.fish *.dump *.part *.info.json *.mp4 *.flv *.mp3 *.avi CONTRIBUTING.md.tmp youtube-dl youtube-dl.exe
 	find . -name "*.pyc" -delete
 
 PREFIX ?= /usr/local
@@ -61,7 +61,8 @@ youtube-dl: youtube_dl/*.py youtube_dl/*/*.py
 	chmod a+x youtube-dl
 
 README.md: youtube_dl/*.py youtube_dl/*/*.py
-	COLUMNS=80 python youtube_dl/__main__.py --help | python devscripts/make_readme.py
+	COLUMNS=80 python youtube_dl/__main__.py --help | python devscripts/make_readme.py README.md > README.new.md
+	mv -f README.new.md README.md
 
 CONTRIBUTING.md: README.md
 	python devscripts/make_contributing.py README.md CONTRIBUTING.md
@@ -72,10 +73,11 @@ supportedsites:
 README.txt: README.md
 	pandoc -f markdown -t plain README.md -o README.txt
 
-youtube-dl.1: README.md
+youtube-dl.1: youtube_dl/*.py youtube_dl/*/*.py
-	python devscripts/prepare_manpage.py >youtube-dl.1.temp.md
+	COLUMNS=65536 python youtube_dl/__main__.py --help | python devscripts/make_readme.py README.md > README-wide.md
+	python devscripts/prepare_manpage.py README-wide.md > youtube-dl.1.temp.md
 	pandoc -s -f markdown -t man youtube-dl.1.temp.md -o youtube-dl.1
-	rm -f youtube-dl.1.temp.md
+	rm -f youtube-dl.1.temp.md README-wide.md
 
 youtube-dl.bash-completion: youtube_dl/*.py youtube_dl/*/*.py devscripts/bash-completion.in
 	python devscripts/bash-completion.py

devscripts/make_readme.py

@@ -4,7 +4,7 @@ import io
 import sys
 import re
 
-README_FILE = 'README.md'
+README_FILE = sys.argv[1]
 helptext = sys.stdin.read()
 
 if isinstance(helptext, bytes):
@@ -20,7 +20,7 @@ options = helptext[helptext.index('  General Options:') + 19:]
 options = re.sub(r'(?m)^  (\w.+)$', r'## \1', options)
 options = '# OPTIONS\n' + options + '\n'
 
-with io.open(README_FILE, 'w', encoding='utf-8') as f:
+with io.open(sys.stdout.fileno(), 'w', encoding='utf-8') as f:
     f.write(header)
     f.write(options)
     f.write(footer)

devscripts/prepare_manpage.py

@@ -6,7 +6,33 @@ import sys
 import re
 
 ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-README_FILE = os.path.join(ROOT_DIR, 'README.md')
+README_FILE = os.path.join(ROOT_DIR, sys.argv[1])
+
+
+def filter_options(readme):
+    ret = ''
+    in_options = False
+    for line in readme.split('\n'):
+        if line.startswith('# '):
+            if line[2:].startswith('OPTIONS'):
+                in_options = True
+            else:
+                in_options = False
+
+        if in_options and line.lstrip().startswith('-'):
+            option, description = re.split(r'\s{2,}', line.lstrip())
+            split_option = option.split(' ')
+
+            if not split_option[-1].startswith('-'):  # metavar
+                option = ' '.join(split_option[:-1] + ['*%s*' % split_option[-1]])
+
+            # Pandoc's definition_lists. See http://pandoc.org/README.html
+            # for more information.
+            ret += '%s\n:   %s\n\n' % (option, description)
+        else:
+            ret += line + '\n'
+
+    return ret
 
 with io.open(README_FILE, encoding='utf-8') as f:
     readme = f.read()
@@ -26,6 +52,8 @@ readme = re.sub(r'(?s)^.*?(?=# DESCRIPTION)', '', readme)
 readme = re.sub(r'\s+youtube-dl \[OPTIONS\] URL \[URL\.\.\.\]', '', readme)
 readme = PREFIX + readme
 
+readme = filter_options(readme)
+
 if sys.version_info < (3, 0):
     print(readme.encode('utf-8'))
 else: