aboutsummaryrefslogtreecommitdiffstats
path: root/yt_dlp
diff options
context:
space:
mode:
authorpukkandan <pukkandan.ytdlp@gmail.com>2021-08-07 14:19:17 +0530
committerpukkandan <pukkandan.ytdlp@gmail.com>2021-08-07 21:41:48 +0530
commit34488702053d995aba6a0dea9995e6a8858402dd (patch)
tree0c593bb1e379dc6304ea73cdb07443ba413ac6d2 /yt_dlp
parentb868936cd6d619f0e3a2c303028c132b761e6313 (diff)
downloadhypervideo-pre-34488702053d995aba6a0dea9995e6a8858402dd.tar.lz
hypervideo-pre-34488702053d995aba6a0dea9995e6a8858402dd.tar.xz
hypervideo-pre-34488702053d995aba6a0dea9995e6a8858402dd.zip
[docs] Fix some mistakes and improve doc
Diffstat (limited to 'yt_dlp')
-rw-r--r--yt_dlp/YoutubeDL.py16
-rw-r--r--yt_dlp/downloader/common.py7
-rw-r--r--yt_dlp/options.py14
3 files changed, 19 insertions, 18 deletions
diff --git a/yt_dlp/YoutubeDL.py b/yt_dlp/YoutubeDL.py
index f4333c7e5..2791d180a 100644
--- a/yt_dlp/YoutubeDL.py
+++ b/yt_dlp/YoutubeDL.py
@@ -220,7 +220,7 @@ class YoutubeDL(object):
'temp' and the keys of OUTTMPL_TYPES (in utils.py)
outtmpl: Dictionary of templates for output names. Allowed keys
are 'default' and the keys of OUTTMPL_TYPES (in utils.py).
- A string a also accepted for backward compatibility
+ For compatibility with youtube-dl, a single string can also be used
outtmpl_na_placeholder: Placeholder for unavailable meta fields.
restrictfilenames: Do not allow "&" and spaces in file names
trim_file_name: Limit length of filename (extension excluded)
@@ -234,6 +234,8 @@ class YoutubeDL(object):
overwrites: Overwrite all video and metadata files if True,
overwrite only non-video files if None
and don't overwrite any file if False
+ For compatibility with youtube-dl,
+ "nooverwrites" may also be used instead
playliststart: Playlist item to start at.
playlistend: Playlist item to end at.
playlist_items: Specific indices of playlist to download.
@@ -246,7 +248,7 @@ class YoutubeDL(object):
writedescription: Write the video description to a .description file
writeinfojson: Write the video description to a .info.json file
clean_infojson: Remove private fields from the infojson
- writecomments: Extract video comments. This will not be written to disk
+ getcomments: Extract video comments. This will not be written to disk
unless writeinfojson is also given
writeannotations: Write the video annotations to a .annotations.xml file
writethumbnail: Write the thumbnail image to a file
@@ -420,10 +422,12 @@ class YoutubeDL(object):
ffmpeg_location: Location of the ffmpeg/avconv binary; either the path
to the binary or its containing directory.
postprocessor_args: A dictionary of postprocessor/executable keys (in lower case)
- and a list of additional command-line arguments for the
- postprocessor/executable. The dict can also have "PP+EXE" keys
- which are used when the given exe is used by the given PP.
- Use 'default' as the name for arguments to passed to all PP
+ and a list of additional command-line arguments for the
+ postprocessor/executable. The dict can also have "PP+EXE" keys
+ which are used when the given exe is used by the given PP.
+ Use 'default' as the name for arguments to passed to all PP
+ For compatibility with youtube-dl, a single list of args
+ can also be used
The following options are used by the extractors:
extractor_retries: Number of times to retry for known errors
diff --git a/yt_dlp/downloader/common.py b/yt_dlp/downloader/common.py
index 396521aa1..3846a7ee5 100644
--- a/yt_dlp/downloader/common.py
+++ b/yt_dlp/downloader/common.py
@@ -47,8 +47,11 @@ class FileDownloader(object):
min_filesize: Skip files smaller than this size
max_filesize: Skip files larger than this size
xattr_set_filesize: Set ytdl.filesize user xattribute with expected size.
- external_downloader_args: A list of additional command-line arguments for the
- external downloader.
+ external_downloader_args: A dictionary of downloader keys (in lower case)
+ and a list of additional command-line arguments for the
+ executable. Use 'default' as the name for arguments to be
+ passed to all downloaders. For compatibility with youtube-dl,
+ a single list of args can also be used
hls_use_mpegts: Use the mpegts container for HLS videos.
http_chunk_size: Size of a chunk for chunk-based HTTP downloading. May be
useful for bypassing bandwidth throttling imposed by
diff --git a/yt_dlp/options.py b/yt_dlp/options.py
index 38c99bbcb..aef2f8143 100644
--- a/yt_dlp/options.py
+++ b/yt_dlp/options.py
@@ -190,7 +190,7 @@ def parseOpts(overrideArguments=None):
general.add_option(
'--dump-user-agent',
action='store_true', dest='dump_user_agent', default=False,
- help='Display the current browser identification and exit')
+ help='Display the current user-agent and exit')
general.add_option(
'--list-extractors',
action='store_true', dest='list_extractors', default=False,
@@ -224,12 +224,6 @@ def parseOpts(overrideArguments=None):
action='store_const', dest='extract_flat', const='in_playlist', default=False,
help='Do not extract the videos of a playlist, only list them')
general.add_option(
- '--flat-videos',
- action='store_true', dest='extract_flat',
- # help='Do not resolve the video urls')
- # doesn't work
- help=optparse.SUPPRESS_HELP)
- general.add_option(
'--no-flat-playlist',
action='store_false', dest='extract_flat',
help='Extract the videos of a playlist')
@@ -781,7 +775,7 @@ def parseOpts(overrideArguments=None):
verbosity.add_option(
'-q', '--quiet',
action='store_true', dest='quiet', default=False,
- help='Activate quiet mode')
+ help='Activate quiet mode. If used with --verbose, print the log to stderr')
verbosity.add_option(
'--no-warnings',
dest='no_warnings', action='store_true', default=False,
@@ -799,7 +793,7 @@ def parseOpts(overrideArguments=None):
action='store_true', dest='ignore_no_formats_error', default=False,
help=(
'Ignore "No video formats" error. Usefull for extracting metadata '
- 'even if the video is not actually available for download (experimental)'))
+ 'even if the videos are not actually available for download (experimental)'))
verbosity.add_option(
'--no-ignore-no-formats-error',
action='store_false', dest='ignore_no_formats_error',
@@ -1282,7 +1276,7 @@ def parseOpts(overrideArguments=None):
callback=_list_from_options_callback, callback_kwargs={'delim': None},
help=(
'Execute a command on the file after downloading and post-processing. '
- 'Similar syntax to the output template can be used to pass any field as arguments to the command. '
+ 'Same syntax as the output template can be used to pass any field as arguments to the command. '
'An additional field "filepath" that contains the final path of the downloaded file is also available. '
'If no fields are passed, %(filepath)q is appended to the end of the command. '
'This option can be used multiple times'))