Makefile to recreate README

pull/8/head
Philipp Hagemeister 13 years ago
parent eb0387a848
commit 4618f3da74

@ -0,0 +1,15 @@
update-readme:
@options=$$(COLUMNS=80 ./youtube-dl --help | sed -e '1,/.*General Options.*/ d' -e 's/^\W\{2\}\(\w\)/### \1/') && \
header=$$(sed -e '/.*## OPTIONS/,$$ d' README.md) && \
footer=$$(sed -e '1,/.*## COPYRIGHT/ d' README.md) && \
echo "$${header}" > README.md && \
echo -e '\n## OPTIONS' >> README.md && \
echo "$${options}" >> README.md&& \
echo -e '\n## COPYRIGHT' >> README.md && \
echo "$${footer}" >> README.md
.PHONY: update-readme

@ -11,66 +11,56 @@ your Unix box, in Windows or in Mac OS X. It is released to the public domain,
which means you can modify it, redistribute it or use it however you like. which means you can modify it, redistribute it or use it however you like.
## OPTIONS ## OPTIONS
-h, --help print this help text and exit -h, --help print this help text and exit
-v, --version print program version and exit -v, --version print program version and exit
-U, --update update this program to latest stable version -U, --update update this program to latest stable version
-i, --ignore-errors continue on download errors -i, --ignore-errors continue on download errors
-r LIMIT, --rate-limit=LIMIT -r, --rate-limit LIMIT download rate limit (e.g. 50k or 44.6m)
download rate limit (e.g. 50k or 44.6m) -R, --retries RETRIES number of retries (default is 10)
-R RETRIES, --retries=RETRIES --playlist-start NUMBER playlist video to start at (default is 1)
number of retries (default is 10) --playlist-end NUMBER playlist video to end at (default is last)
--playlist-start=NUMBER --dump-user-agent display the current browser identification
playlist video to start at (default is 1)
--playlist-end=NUMBER
playlist video to end at (default is last)
--dump-user-agent display the current browser identification
### Authentication Options ### Filesystem Options:
-u USERNAME, --username=USERNAME -t, --title use title in file name
account username -l, --literal use literal title in file name
-p PASSWORD, --password=PASSWORD -A, --auto-number number downloaded files starting from 00000
account password -o, --output TEMPLATE output filename template
-n, --netrc use .netrc authentication data -a, --batch-file FILE file containing URLs to download ('-' for stdin)
-w, --no-overwrites do not overwrite files
-c, --continue resume partially downloaded files
--cookies FILE file to dump cookie jar to
--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
### Video Format Options ### Verbosity / Simulation Options:
-f FORMAT, --format=FORMAT -q, --quiet activates quiet mode
video format code -s, --simulate do not download video
--all-formats download all available video formats -g, --get-url simulate, quiet but print URL
--max-quality=FORMAT -e, --get-title simulate, quiet but print title
highest quality format to download --get-thumbnail simulate, quiet but print thumbnail URL
--get-description simulate, quiet but print video description
--get-filename simulate, quiet but print output filename
--no-progress do not print progress bar
--console-title display progress in console titlebar
### Verbosity / Simulation Options ### Video Format Options:
-q, --quiet activates quiet mode -f, --format FORMAT video format code
-s, --simulate do not download video --all-formats download all available video formats
-g, --get-url simulate, quiet but print URL --max-quality FORMAT highest quality format to download
-e, --get-title simulate, quiet but print title
--get-thumbnail simulate, quiet but print thumbnail URL
--get-description simulate, quiet but print video description
--get-filename simulate, quiet but print output filename
--no-progress do not print progress bar
--console-title display progress in console titlebar
### Filesystem Options ### Authentication Options:
-t, --title use title in file name -u, --username USERNAME account username
-l, --literal use literal title in file name -p, --password PASSWORD account password
-A, --auto-number number downloaded files starting from 00000 -n, --netrc use .netrc authentication data
-o TEMPLATE, --output=TEMPLATE
output filename template
-a FILE, --batch-file=FILE
file containing URLs to download ('-' for stdin)
-w, --no-overwrites
do not overwrite files
-c, --continue resume partially downloaded files
--cookies=FILE file to dump cookie jar to
--no-part do not use .part files
--no-mtime do not use the Last-modified header to set the file
modification time
### Post-processing Options: ### Post-processing Options:
--extract-audio convert video files to audio-only files (requires --extract-audio convert video files to audio-only files (requires
ffmpeg and ffprobe) ffmpeg and ffprobe)
--audio-format=FORMAT --audio-format FORMAT "best", "aac" or "mp3"; best by default
"best", "aac" or "mp3"; best by default
## COPYRIGHT ## COPYRIGHT
**youtube-dl**: Copyright © 2006-2011 Ricardo Garcia Gonzalez. The program is **youtube-dl**: Copyright © 2006-2011 Ricardo Garcia Gonzalez. The program is
@ -80,4 +70,3 @@ likewise released into the public domain.
## BUGS ## BUGS
Bugs should be reported at: <https://github.com/rg3/youtube-dl/issues> Bugs should be reported at: <https://github.com/rg3/youtube-dl/issues>

Loading…
Cancel
Save