Makefile to recreate README
Philipp Hagemeister
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
|
||||||
69
README.md
69
README.md
|
|
@ -15,31 +15,28 @@ which means you can modify it, redistribute it or use it however you like.
|
||||||
-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
|
|
||||||
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
|
--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
|
|
||||||
video format code
|
|
||||||
--all-formats download all available video formats
|
|
||||||
--max-quality=FORMAT
|
|
||||||
highest quality format to download
|
|
||||||
|
|
||||||
### Verbosity / Simulation Options
|
|
||||||
-q, --quiet activates quiet mode
|
-q, --quiet activates quiet mode
|
||||||
-s, --simulate do not download video
|
-s, --simulate do not download video
|
||||||
-g, --get-url simulate, quiet but print URL
|
-g, --get-url simulate, quiet but print URL
|
||||||
|
|
@ -50,27 +47,20 @@ which means you can modify it, redistribute it or use it however you like.
|
||||||
--no-progress do not print progress bar
|
--no-progress do not print progress bar
|
||||||
--console-title display progress in console titlebar
|
--console-title display progress in console titlebar
|
||||||
|
|
||||||
### Filesystem Options
|
### Video Format Options:
|
||||||
-t, --title use title in file name
|
-f, --format FORMAT video format code
|
||||||
-l, --literal use literal title in file name
|
--all-formats download all available video formats
|
||||||
-A, --auto-number number downloaded files starting from 00000
|
--max-quality FORMAT highest quality format to download
|
||||||
-o TEMPLATE, --output=TEMPLATE
|
|
||||||
output filename template
|
### Authentication Options:
|
||||||
-a FILE, --batch-file=FILE
|
-u, --username USERNAME account username
|
||||||
file containing URLs to download ('-' for stdin)
|
-p, --password PASSWORD account password
|
||||||
-w, --no-overwrites
|
-n, --netrc use .netrc authentication data
|
||||||
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…
Reference in New Issue