Remove horizontal rules from README.md
[youtube-dl] / README.md
1 # youtube-dl
2
3 ## USAGE
4 youtube-dl [OPTIONS] URL
5
6 ## DESCRIPTION
7 **youtube-dl** is a small command-line program to download videos from
8 YouTube.com and a few more sites. It requires the Python interpreter, version
9 2.x (x being at least 5), and it is not platform specific. It should work in
10 your Unix box, in Windows or in Mac OS X. It is released to the public domain,
11 which means you can modify it, redistribute it or use it however you like.
12
13 ## OPTIONS
14     -h, --help            print this help text and exit
15     -v, --version         print program version and exit
16     -U, --update          update this program to latest stable version
17     -i, --ignore-errors   continue on download errors
18     -r LIMIT, --rate-limit=LIMIT
19                           download rate limit (e.g. 50k or 44.6m)
20     -R RETRIES, --retries=RETRIES
21                           number of retries (default is 10)
22     --playlist-start=NUMBER
23                           playlist video to start at (default is 1)
24     --playlist-end=NUMBER
25                           playlist video to end at (default is last)
26     --dump-user-agent     display the current browser identification
27
28 ###  Authentication Options
29     -u USERNAME, --username=USERNAME
30                         account username
31     -p PASSWORD, --password=PASSWORD
32                         account password
33     -n, --netrc         use .netrc authentication data
34
35 ###  Video Format Options
36     -f FORMAT, --format=FORMAT
37                         video format code
38     --all-formats       download all available video formats
39     --max-quality=FORMAT
40                         highest quality format to download
41
42 ### Verbosity / Simulation Options
43     -q, --quiet         activates quiet mode
44     -s, --simulate      do not download video
45     -g, --get-url       simulate, quiet but print URL
46     -e, --get-title     simulate, quiet but print title
47     --get-thumbnail     simulate, quiet but print thumbnail URL
48     --get-description   simulate, quiet but print video description
49     --get-filename      simulate, quiet but print output filename
50     --no-progress       do not print progress bar
51     --console-title     display progress in console titlebar
52
53 ### Filesystem Options
54     -t, --title         use title in file name
55     -l, --literal       use literal title in file name
56     -A, --auto-number   number downloaded files starting from 00000
57     -o TEMPLATE, --output=TEMPLATE
58                         output filename template
59     -a FILE, --batch-file=FILE
60                         file containing URLs to download ('-' for stdin)
61     -w, --no-overwrites
62                         do not overwrite files
63     -c, --continue      resume partially downloaded files
64     --cookies=FILE      file to dump cookie jar to
65     --no-part           do not use .part files
66     --no-mtime          do not use the Last-modified header to set the file
67                         modification time
68
69 ### Post-processing Options:
70     --extract-audio     convert video files to audio-only files (requires
71                         ffmpeg and ffprobe)
72     --audio-format=FORMAT
73                         "best", "aac" or "mp3"; best by default
74
75 ## COPYRIGHT
76 **youtube-dl**: Copyright © 2006-2011 Ricardo Garcia Gonzalez. The program is
77 released into the public domain by the copyright holder. This README file was
78 originally written by Daniel Bolton (<https://github.com/dbbolton>) and is
79 likewise released into the public domain.
80
81 ## BUGS
82 Bugs should be reported at: <https://github.com/rg3/youtube-dl/issues>
83