summaryrefslogtreecommitdiffstats
path: root/data
diff options
context:
space:
mode:
Diffstat (limited to 'data')
-rw-r--r--data/completion/_gallery-dl25
-rw-r--r--data/completion/gallery-dl2
-rw-r--r--data/completion/gallery-dl.fish25
-rw-r--r--data/man/gallery-dl.177
-rw-r--r--data/man/gallery-dl.conf.5346
5 files changed, 303 insertions, 172 deletions
diff --git a/data/completion/_gallery-dl b/data/completion/_gallery-dl
index 81466c9..14b7321 100644
--- a/data/completion/_gallery-dl
+++ b/data/completion/_gallery-dl
@@ -7,18 +7,19 @@ local rc=1
_arguments -s -S \
{-h,--help}'[Print this help message and exit]' \
--version'[Print program version and exit]' \
-{-U,--update-check}'[Check if a newer version is available]' \
{-f,--filename}'[Filename format string for downloaded files ('\''/O'\'' for "original" filenames)]':'<format>' \
{-d,--destination}'[Target location for file downloads]':'<path>' \
{-D,--directory}'[Exact location for file downloads]':'<path>' \
{-X,--extractors}'[Load external extractors from PATH]':'<path>' \
---proxy'[Use the specified proxy]':'<url>' \
---source-address'[Client-side IP address to bind to]':'<ip>' \
--user-agent'[User-Agent request header]':'<ua>' \
--clear-cache'[Delete cached login sessions, cookies, etc. for MODULE (ALL to delete everything)]':'<module>' \
+{-U,--update}'[Update to the latest version]' \
+--update-to'[Switch to a dfferent release channel (stable or dev) or upgrade/downgrade to a specific version]':'<channel[@tag]>' \
+--update-check'[Check if a newer version is available]' \
{-i,--input-file}'[Download URLs found in FILE ('\''-'\'' for stdin). More than one --input-file can be specified]':'<file>':_files \
{-I,--input-file-comment}'[Download URLs found in FILE. Comment them out after they were downloaded successfully.]':'<file>':_files \
{-x,--input-file-delete}'[Download URLs found in FILE. Delete them after they were downloaded successfully.]':'<file>':_files \
+--no-input'[Do not prompt for passwords/tokens]' \
{-q,--quiet}'[Activate quiet mode]' \
{-w,--warning}'[Print only warnings and errors]' \
{-v,--verbose}'[Print various debugging information]' \
@@ -35,26 +36,27 @@ _arguments -s -S \
--write-unsupported'[Write URLs, which get emitted by other extractors but cannot be handled, to FILE]':'<file>':_files \
--write-pages'[Write downloaded intermediary pages to files in the current directory to debug problems]' \
--no-colors'[Do not emit ANSI color codes in output]' \
-{-r,--limit-rate}'[Maximum download rate (e.g. 500k or 2.5M)]':'<rate>' \
{-R,--retries}'[Maximum number of retries for failed HTTP requests or -1 for infinite retries (default: 4)]':'<n>' \
--http-timeout'[Timeout for HTTP connections (default: 30.0)]':'<seconds>' \
+--proxy'[Use the specified proxy]':'<url>' \
+--source-address'[Client-side IP address to bind to]':'<ip>' \
+--no-check-certificate'[Disable HTTPS certificate validation]' \
+{-r,--limit-rate}'[Maximum download rate (e.g. 500k or 2.5M)]':'<rate>' \
+--chunk-size'[Size of in-memory data chunks (default: 32k)]':'<size>' \
--sleep'[Number of seconds to wait before each download. This can be either a constant value or a range (e.g. 2.7 or 2.0-3.5)]':'<seconds>' \
--sleep-request'[Number of seconds to wait between HTTP requests during data extraction]':'<seconds>' \
--sleep-extractor'[Number of seconds to wait before starting data extraction for an input URL]':'<seconds>' \
---filesize-min'[Do not download files smaller than SIZE (e.g. 500k or 2.5M)]':'<size>' \
---filesize-max'[Do not download files larger than SIZE (e.g. 500k or 2.5M)]':'<size>' \
---chunk-size'[Size of in-memory data chunks (default: 32k)]':'<size>' \
--no-part'[Do not use .part files]' \
--no-skip'[Do not skip downloads; overwrite existing files]' \
--no-mtime'[Do not set file modification times according to Last-Modified HTTP response headers]' \
--no-download'[Do not download any files]' \
---no-postprocessors'[Do not run any post processors]' \
---no-check-certificate'[Disable HTTPS certificate validation]' \
{-o,--option}'[Additional options. Example: -o browser=firefox]':'<key=value>' \
{-c,--config}'[Additional configuration files]':'<file>':_files \
--config-yaml'[Additional configuration files in YAML format]':'<file>':_files \
--config-toml'[Additional configuration files in TOML format]':'<file>':_files \
--config-create'[Create a basic configuration file]' \
+--config-status'[Show configuration file status]' \
+--config-open'[Open configuration file in external application]' \
--config-ignore'[Do not read default configuration files]' \
{-u,--username}'[Username to login with]':'<user>' \
{-p,--password}'[Password belonging to the given username]':'<pass>' \
@@ -62,14 +64,17 @@ _arguments -s -S \
{-C,--cookies}'[File to load additional cookies from]':'<file>':_files \
--cookies-export'[Export session cookies to FILE]':'<file>':_files \
--cookies-from-browser'[Name of the browser to load cookies from, with optional domain prefixed with '\''/'\'', keyring name prefixed with '\''+'\'', profile prefixed with '\'':'\'', and container prefixed with '\''::'\'' ('\''none'\'' for no container)]':'<browser[/domain][+keyring][:profile][::container]>' \
---download-archive'[Record all downloaded or skipped files in FILE and skip downloading any file already in it]':'<file>':_files \
{-A,--abort}'[Stop current extractor run after N consecutive file downloads were skipped]':'<n>' \
{-T,--terminate}'[Stop current and parent extractor runs after N consecutive file downloads were skipped]':'<n>' \
+--filesize-min'[Do not download files smaller than SIZE (e.g. 500k or 2.5M)]':'<size>' \
+--filesize-max'[Do not download files larger than SIZE (e.g. 500k or 2.5M)]':'<size>' \
+--download-archive'[Record all downloaded or skipped files in FILE and skip downloading any file already in it]':'<file>':_files \
--range'[Index range(s) specifying which files to download. These can be either a constant value, range, or slice (e.g. '\''5'\'', '\''8-20'\'', or '\''1:24:3'\'')]':'<range>' \
--chapter-range'[Like '\''--range'\'', but applies to manga chapters and other delegated URLs]':'<range>' \
--filter'[Python expression controlling which files to download. Files for which the expression evaluates to False are ignored. Available keys are the filename-specific ones listed by '\''-K'\''. Example: --filter "image_width >= 1000 and rating in ('\''s'\'', '\''q'\'')"]':'<expr>' \
--chapter-filter'[Like '\''--filter'\'', but applies to manga chapters and other delegated URLs]':'<expr>' \
{-P,--postprocessor}'[Activate the specified post processor]':'<name>' \
+--no-postprocessors'[Do not run any post processors]' \
{-O,--postprocessor-option}'[Additional post processor options]':'<key=value>' \
--write-metadata'[Write metadata to separate JSON files]' \
--write-info-json'[Write gallery metadata to a info.json file]' \
diff --git a/data/completion/gallery-dl b/data/completion/gallery-dl
index 81a5238..625ecd6 100644
--- a/data/completion/gallery-dl
+++ b/data/completion/gallery-dl
@@ -10,7 +10,7 @@ _gallery_dl()
elif [[ "${prev}" =~ ^()$ ]]; then
COMPREPLY=( $(compgen -d -- "${cur}") )
else
- COMPREPLY=( $(compgen -W "--help --version --update-check --filename --destination --directory --extractors --proxy --source-address --user-agent --clear-cache --input-file --input-file-comment --input-file-delete --quiet --warning --verbose --get-urls --resolve-urls --dump-json --simulate --extractor-info --list-keywords --error-file --list-modules --list-extractors --write-log --write-unsupported --write-pages --no-colors --limit-rate --retries --http-timeout --sleep --sleep-request --sleep-extractor --filesize-min --filesize-max --chunk-size --no-part --no-skip --no-mtime --no-download --no-postprocessors --no-check-certificate --option --config --config-yaml --config-toml --config-create --config-ignore --ignore-config --username --password --netrc --cookies --cookies-export --cookies-from-browser --download-archive --abort --terminate --range --chapter-range --filter --chapter-filter --postprocessor --postprocessor-option --write-metadata --write-info-json --write-infojson --write-tags --zip --cbz --mtime --mtime-from-date --ugoira --ugoira-conv --ugoira-conv-lossless --ugoira-conv-copy --exec --exec-after" -- "${cur}") )
+ COMPREPLY=( $(compgen -W "--help --version --filename --destination --directory --extractors --user-agent --clear-cache --update --update-to --update-check --input-file --input-file-comment --input-file-delete --no-input --quiet --warning --verbose --get-urls --resolve-urls --dump-json --simulate --extractor-info --list-keywords --error-file --list-modules --list-extractors --write-log --write-unsupported --write-pages --no-colors --retries --http-timeout --proxy --source-address --no-check-certificate --limit-rate --chunk-size --sleep --sleep-request --sleep-extractor --no-part --no-skip --no-mtime --no-download --option --config --config-yaml --config-toml --config-create --config-status --config-open --config-ignore --ignore-config --username --password --netrc --cookies --cookies-export --cookies-from-browser --abort --terminate --filesize-min --filesize-max --download-archive --range --chapter-range --filter --chapter-filter --postprocessor --no-postprocessors --postprocessor-option --write-metadata --write-info-json --write-infojson --write-tags --zip --cbz --mtime --mtime-from-date --ugoira --ugoira-conv --ugoira-conv-lossless --ugoira-conv-copy --exec --exec-after" -- "${cur}") )
fi
}
diff --git a/data/completion/gallery-dl.fish b/data/completion/gallery-dl.fish
index 4913c6f..a67cd63 100644
--- a/data/completion/gallery-dl.fish
+++ b/data/completion/gallery-dl.fish
@@ -1,18 +1,19 @@
complete -c gallery-dl -x
complete -c gallery-dl -s 'h' -l 'help' -d 'Print this help message and exit'
complete -c gallery-dl -l 'version' -d 'Print program version and exit'
-complete -c gallery-dl -s 'U' -l 'update-check' -d 'Check if a newer version is available'
complete -c gallery-dl -x -s 'f' -l 'filename' -d 'Filename format string for downloaded files ("/O" for "original" filenames)'
complete -c gallery-dl -x -a '(__fish_complete_directories)' -s 'd' -l 'destination' -d 'Target location for file downloads'
complete -c gallery-dl -x -a '(__fish_complete_directories)' -s 'D' -l 'directory' -d 'Exact location for file downloads'
complete -c gallery-dl -x -a '(__fish_complete_directories)' -s 'X' -l 'extractors' -d 'Load external extractors from PATH'
-complete -c gallery-dl -x -l 'proxy' -d 'Use the specified proxy'
-complete -c gallery-dl -x -l 'source-address' -d 'Client-side IP address to bind to'
complete -c gallery-dl -x -l 'user-agent' -d 'User-Agent request header'
complete -c gallery-dl -x -l 'clear-cache' -d 'Delete cached login sessions, cookies, etc. for MODULE (ALL to delete everything)'
+complete -c gallery-dl -s 'U' -l 'update' -d 'Update to the latest version'
+complete -c gallery-dl -x -l 'update-to' -d 'Switch to a dfferent release channel (stable or dev) or upgrade/downgrade to a specific version'
+complete -c gallery-dl -l 'update-check' -d 'Check if a newer version is available'
complete -c gallery-dl -r -F -s 'i' -l 'input-file' -d 'Download URLs found in FILE ("-" for stdin). More than one --input-file can be specified'
complete -c gallery-dl -r -F -s 'I' -l 'input-file-comment' -d 'Download URLs found in FILE. Comment them out after they were downloaded successfully.'
complete -c gallery-dl -r -F -s 'x' -l 'input-file-delete' -d 'Download URLs found in FILE. Delete them after they were downloaded successfully.'
+complete -c gallery-dl -l 'no-input' -d 'Do not prompt for passwords/tokens'
complete -c gallery-dl -s 'q' -l 'quiet' -d 'Activate quiet mode'
complete -c gallery-dl -s 'w' -l 'warning' -d 'Print only warnings and errors'
complete -c gallery-dl -s 'v' -l 'verbose' -d 'Print various debugging information'
@@ -29,26 +30,27 @@ complete -c gallery-dl -r -F -l 'write-log' -d 'Write logging output to FILE'
complete -c gallery-dl -r -F -l 'write-unsupported' -d 'Write URLs, which get emitted by other extractors but cannot be handled, to FILE'
complete -c gallery-dl -l 'write-pages' -d 'Write downloaded intermediary pages to files in the current directory to debug problems'
complete -c gallery-dl -l 'no-colors' -d 'Do not emit ANSI color codes in output'
-complete -c gallery-dl -x -s 'r' -l 'limit-rate' -d 'Maximum download rate (e.g. 500k or 2.5M)'
complete -c gallery-dl -x -s 'R' -l 'retries' -d 'Maximum number of retries for failed HTTP requests or -1 for infinite retries (default: 4)'
complete -c gallery-dl -x -l 'http-timeout' -d 'Timeout for HTTP connections (default: 30.0)'
+complete -c gallery-dl -x -l 'proxy' -d 'Use the specified proxy'
+complete -c gallery-dl -x -l 'source-address' -d 'Client-side IP address to bind to'
+complete -c gallery-dl -l 'no-check-certificate' -d 'Disable HTTPS certificate validation'
+complete -c gallery-dl -x -s 'r' -l 'limit-rate' -d 'Maximum download rate (e.g. 500k or 2.5M)'
+complete -c gallery-dl -x -l 'chunk-size' -d 'Size of in-memory data chunks (default: 32k)'
complete -c gallery-dl -x -l 'sleep' -d 'Number of seconds to wait before each download. This can be either a constant value or a range (e.g. 2.7 or 2.0-3.5)'
complete -c gallery-dl -x -l 'sleep-request' -d 'Number of seconds to wait between HTTP requests during data extraction'
complete -c gallery-dl -x -l 'sleep-extractor' -d 'Number of seconds to wait before starting data extraction for an input URL'
-complete -c gallery-dl -x -l 'filesize-min' -d 'Do not download files smaller than SIZE (e.g. 500k or 2.5M)'
-complete -c gallery-dl -x -l 'filesize-max' -d 'Do not download files larger than SIZE (e.g. 500k or 2.5M)'
-complete -c gallery-dl -x -l 'chunk-size' -d 'Size of in-memory data chunks (default: 32k)'
complete -c gallery-dl -l 'no-part' -d 'Do not use .part files'
complete -c gallery-dl -l 'no-skip' -d 'Do not skip downloads; overwrite existing files'
complete -c gallery-dl -l 'no-mtime' -d 'Do not set file modification times according to Last-Modified HTTP response headers'
complete -c gallery-dl -l 'no-download' -d 'Do not download any files'
-complete -c gallery-dl -l 'no-postprocessors' -d 'Do not run any post processors'
-complete -c gallery-dl -l 'no-check-certificate' -d 'Disable HTTPS certificate validation'
complete -c gallery-dl -x -s 'o' -l 'option' -d 'Additional options. Example: -o browser=firefox'
complete -c gallery-dl -r -F -s 'c' -l 'config' -d 'Additional configuration files'
complete -c gallery-dl -r -F -l 'config-yaml' -d 'Additional configuration files in YAML format'
complete -c gallery-dl -r -F -l 'config-toml' -d 'Additional configuration files in TOML format'
complete -c gallery-dl -l 'config-create' -d 'Create a basic configuration file'
+complete -c gallery-dl -l 'config-status' -d 'Show configuration file status'
+complete -c gallery-dl -l 'config-open' -d 'Open configuration file in external application'
complete -c gallery-dl -l 'config-ignore' -d 'Do not read default configuration files'
complete -c gallery-dl -l 'ignore-config' -d '==SUPPRESS=='
complete -c gallery-dl -x -s 'u' -l 'username' -d 'Username to login with'
@@ -57,14 +59,17 @@ complete -c gallery-dl -l 'netrc' -d 'Enable .netrc authentication data'
complete -c gallery-dl -r -F -s 'C' -l 'cookies' -d 'File to load additional cookies from'
complete -c gallery-dl -r -F -l 'cookies-export' -d 'Export session cookies to FILE'
complete -c gallery-dl -x -l 'cookies-from-browser' -d 'Name of the browser to load cookies from, with optional domain prefixed with "/", keyring name prefixed with "+", profile prefixed with ":", and container prefixed with "::" ("none" for no container)'
-complete -c gallery-dl -r -F -l 'download-archive' -d 'Record all downloaded or skipped files in FILE and skip downloading any file already in it'
complete -c gallery-dl -x -s 'A' -l 'abort' -d 'Stop current extractor run after N consecutive file downloads were skipped'
complete -c gallery-dl -x -s 'T' -l 'terminate' -d 'Stop current and parent extractor runs after N consecutive file downloads were skipped'
+complete -c gallery-dl -x -l 'filesize-min' -d 'Do not download files smaller than SIZE (e.g. 500k or 2.5M)'
+complete -c gallery-dl -x -l 'filesize-max' -d 'Do not download files larger than SIZE (e.g. 500k or 2.5M)'
+complete -c gallery-dl -r -F -l 'download-archive' -d 'Record all downloaded or skipped files in FILE and skip downloading any file already in it'
complete -c gallery-dl -x -l 'range' -d 'Index range(s) specifying which files to download. These can be either a constant value, range, or slice (e.g. "5", "8-20", or "1:24:3")'
complete -c gallery-dl -x -l 'chapter-range' -d 'Like "--range", but applies to manga chapters and other delegated URLs'
complete -c gallery-dl -x -l 'filter' -d 'Python expression controlling which files to download. Files for which the expression evaluates to False are ignored. Available keys are the filename-specific ones listed by "-K". Example: --filter "image_width >= 1000 and rating in ("s", "q")"'
complete -c gallery-dl -x -l 'chapter-filter' -d 'Like "--filter", but applies to manga chapters and other delegated URLs'
complete -c gallery-dl -x -s 'P' -l 'postprocessor' -d 'Activate the specified post processor'
+complete -c gallery-dl -l 'no-postprocessors' -d 'Do not run any post processors'
complete -c gallery-dl -x -s 'O' -l 'postprocessor-option' -d 'Additional post processor options'
complete -c gallery-dl -l 'write-metadata' -d 'Write metadata to separate JSON files'
complete -c gallery-dl -l 'write-info-json' -d 'Write gallery metadata to a info.json file'
diff --git a/data/man/gallery-dl.1 b/data/man/gallery-dl.1
index e964a67..37529bf 100644
--- a/data/man/gallery-dl.1
+++ b/data/man/gallery-dl.1
@@ -1,4 +1,4 @@
-.TH "GALLERY-DL" "1" "2024-06-01" "1.27.0" "gallery-dl Manual"
+.TH "GALLERY-DL" "1" "2024-06-22" "1.27.1" "gallery-dl Manual"
.\" disable hyphenation
.nh
@@ -23,9 +23,6 @@ Print this help message and exit
.B "\-\-version"
Print program version and exit
.TP
-.B "\-U, \-\-update\-check"
-Check if a newer version is available
-.TP
.B "\-f, \-\-filename" \f[I]FORMAT\f[]
Filename format string for downloaded files ('/O' for "original" filenames)
.TP
@@ -38,18 +35,21 @@ Exact location for file downloads
.B "\-X, \-\-extractors" \f[I]PATH\f[]
Load external extractors from PATH
.TP
-.B "\-\-proxy" \f[I]URL\f[]
-Use the specified proxy
-.TP
-.B "\-\-source\-address" \f[I]IP\f[]
-Client-side IP address to bind to
-.TP
.B "\-\-user\-agent" \f[I]UA\f[]
User-Agent request header
.TP
.B "\-\-clear\-cache" \f[I]MODULE\f[]
Delete cached login sessions, cookies, etc. for MODULE (ALL to delete everything)
.TP
+.B "\-U, \-\-update"
+Update to the latest version
+.TP
+.B "\-\-update\-to" \f[I]CHANNEL[@TAG]\f[]
+Switch to a dfferent release channel (stable or dev) or upgrade/downgrade to a specific version
+.TP
+.B "\-\-update\-check"
+Check if a newer version is available
+.TP
.B "\-i, \-\-input\-file" \f[I]FILE\f[]
Download URLs found in FILE ('-' for stdin). More than one --input-file can be specified
.TP
@@ -59,6 +59,9 @@ Download URLs found in FILE. Comment them out after they were downloaded success
.B "\-x, \-\-input\-file\-delete" \f[I]FILE\f[]
Download URLs found in FILE. Delete them after they were downloaded successfully.
.TP
+.B "\-\-no\-input"
+Do not prompt for passwords/tokens
+.TP
.B "\-q, \-\-quiet"
Activate quiet mode
.TP
@@ -107,15 +110,27 @@ Write downloaded intermediary pages to files in the current directory to debug p
.B "\-\-no\-colors"
Do not emit ANSI color codes in output
.TP
-.B "\-r, \-\-limit\-rate" \f[I]RATE\f[]
-Maximum download rate (e.g. 500k or 2.5M)
-.TP
.B "\-R, \-\-retries" \f[I]N\f[]
Maximum number of retries for failed HTTP requests or -1 for infinite retries (default: 4)
.TP
.B "\-\-http\-timeout" \f[I]SECONDS\f[]
Timeout for HTTP connections (default: 30.0)
.TP
+.B "\-\-proxy" \f[I]URL\f[]
+Use the specified proxy
+.TP
+.B "\-\-source\-address" \f[I]IP\f[]
+Client-side IP address to bind to
+.TP
+.B "\-\-no\-check\-certificate"
+Disable HTTPS certificate validation
+.TP
+.B "\-r, \-\-limit\-rate" \f[I]RATE\f[]
+Maximum download rate (e.g. 500k or 2.5M)
+.TP
+.B "\-\-chunk\-size" \f[I]SIZE\f[]
+Size of in-memory data chunks (default: 32k)
+.TP
.B "\-\-sleep" \f[I]SECONDS\f[]
Number of seconds to wait before each download. This can be either a constant value or a range (e.g. 2.7 or 2.0-3.5)
.TP
@@ -125,15 +140,6 @@ Number of seconds to wait between HTTP requests during data extraction
.B "\-\-sleep\-extractor" \f[I]SECONDS\f[]
Number of seconds to wait before starting data extraction for an input URL
.TP
-.B "\-\-filesize\-min" \f[I]SIZE\f[]
-Do not download files smaller than SIZE (e.g. 500k or 2.5M)
-.TP
-.B "\-\-filesize\-max" \f[I]SIZE\f[]
-Do not download files larger than SIZE (e.g. 500k or 2.5M)
-.TP
-.B "\-\-chunk\-size" \f[I]SIZE\f[]
-Size of in-memory data chunks (default: 32k)
-.TP
.B "\-\-no\-part"
Do not use .part files
.TP
@@ -146,12 +152,6 @@ Do not set file modification times according to Last-Modified HTTP response head
.B "\-\-no\-download"
Do not download any files
.TP
-.B "\-\-no\-postprocessors"
-Do not run any post processors
-.TP
-.B "\-\-no\-check\-certificate"
-Disable HTTPS certificate validation
-.TP
.B "\-o, \-\-option" \f[I]KEY=VALUE\f[]
Additional options. Example: -o browser=firefox
.TP
@@ -167,6 +167,12 @@ Additional configuration files in TOML format
.B "\-\-config\-create"
Create a basic configuration file
.TP
+.B "\-\-config\-status"
+Show configuration file status
+.TP
+.B "\-\-config\-open"
+Open configuration file in external application
+.TP
.B "\-\-config\-ignore"
Do not read default configuration files
.TP
@@ -188,15 +194,21 @@ Export session cookies to FILE
.B "\-\-cookies\-from\-browser" \f[I]BROWSER[/DOMAIN][+KEYRING][:PROFILE][::CONTAINER]\f[]
Name of the browser to load cookies from, with optional domain prefixed with '/', keyring name prefixed with '+', profile prefixed with ':', and container prefixed with '::' ('none' for no container)
.TP
-.B "\-\-download\-archive" \f[I]FILE\f[]
-Record all downloaded or skipped files in FILE and skip downloading any file already in it
-.TP
.B "\-A, \-\-abort" \f[I]N\f[]
Stop current extractor run after N consecutive file downloads were skipped
.TP
.B "\-T, \-\-terminate" \f[I]N\f[]
Stop current and parent extractor runs after N consecutive file downloads were skipped
.TP
+.B "\-\-filesize\-min" \f[I]SIZE\f[]
+Do not download files smaller than SIZE (e.g. 500k or 2.5M)
+.TP
+.B "\-\-filesize\-max" \f[I]SIZE\f[]
+Do not download files larger than SIZE (e.g. 500k or 2.5M)
+.TP
+.B "\-\-download\-archive" \f[I]FILE\f[]
+Record all downloaded or skipped files in FILE and skip downloading any file already in it
+.TP
.B "\-\-range" \f[I]RANGE\f[]
Index range(s) specifying which files to download. These can be either a constant value, range, or slice (e.g. '5', '8-20', or '1:24:3')
.TP
@@ -212,6 +224,9 @@ Like '--filter', but applies to manga chapters and other delegated URLs
.B "\-P, \-\-postprocessor" \f[I]NAME\f[]
Activate the specified post processor
.TP
+.B "\-\-no\-postprocessors"
+Do not run any post processors
+.TP
.B "\-O, \-\-postprocessor\-option" \f[I]KEY=VALUE\f[]
Additional post processor options
.TP
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5
index 5db584b..e3ed58a 100644
--- a/data/man/gallery-dl.conf.5
+++ b/data/man/gallery-dl.conf.5
@@ -1,4 +1,4 @@
-.TH "GALLERY-DL.CONF" "5" "2024-06-01" "1.27.0" "gallery-dl Manual"
+.TH "GALLERY-DL.CONF" "5" "2024-06-22" "1.27.1" "gallery-dl Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -568,6 +568,18 @@ to be prompted for a passeword when performing a login
(see \f[I]getpass()\f[]).
+.SS extractor.*.input
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]true\f[] if stdin is attached to a terminal ,
+\f[I]false\f[] otherwise
+
+.IP "Description:" 4
+Allow prompting the user for interactive input.
+
+
.SS extractor.*.netrc
.IP "Type:" 6
\f[I]bool\f[]
@@ -1056,7 +1068,7 @@ Prefix for archive IDs.
.IP "Description:" 4
A list of SQLite \f[I]PRAGMA\f[] statements to run during archive initialization.
-See \f[I]<https://www.sqlite.org/pragma.html>\f[]
+See \f[I]<https://www.sqlite.org/pragma.html#toc>\f[]
for available \f[I]PRAGMA\f[] statements and further details.
@@ -1752,6 +1764,20 @@ to access 18+ content without \f[I]API Key\f[].
See \f[I]Filters\f[] for details.
+.SS extractor.derpibooru.svg
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]true\f[]
+
+.IP "Description:" 4
+Download SVG versions of images when available.
+
+Try to download the \f[I]view_url\f[] version of these posts
+when this option is disabled.
+
+
.SS extractor.deviantart.auto-watch
.IP "Type:" 6
\f[I]bool\f[]
@@ -2300,8 +2326,8 @@ Control behavior on embedded content from external sites.
* \f[I]true\f[]: Extract embed URLs and download them if supported
(videos are not downloaded).
.br
-* \f[I]"ytdl"\f[]: Like \f[I]true\f[], but let \f[I]youtube-dl\f[] handle video
-extraction and download for YouTube, Vimeo and SoundCloud embeds.
+* \f[I]"ytdl"\f[]: Like \f[I]true\f[], but let \f[I]ytdl\f[] handle video
+extraction and download for YouTube, Vimeo, and SoundCloud embeds.
.br
* \f[I]false\f[]: Ignore embeds.
@@ -3205,13 +3231,19 @@ Download original Adobe Flash animations instead of pre-rendered videos.
.SS extractor.newgrounds.format
.IP "Type:" 6
-\f[I]string\f[]
+.br
+* \f[I]string\f[]
+.br
+* \f[I]list\f[] of \f[I]string\f[]
.IP "Default:" 9
\f[I]"original"\f[]
.IP "Example:" 4
-"720p"
+.br
+* "720p"
+.br
+* ["mp4", "mov", "1080p", "720p"]
.IP "Description:" 4
Selects the preferred format for video downloads.
@@ -3219,6 +3251,10 @@ Selects the preferred format for video downloads.
If the selected format is not available,
the next smaller one gets chosen.
+If this is a \f[I]list\f[], try each given
+filename extension in original resolution or recoded format
+until an available format is found.
+
.SS extractor.newgrounds.include
.IP "Type:" 6
@@ -3304,7 +3340,7 @@ Control video download behavior.
.br
* \f[I]true\f[]: Download videos
.br
-* \f[I]"ytdl"\f[]: Download videos using \f[I]youtube-dl\f[]
+* \f[I]"ytdl"\f[]: Download videos using \f[I]ytdl\f[]
.br
* \f[I]false\f[]: Skip video Tweets
@@ -3392,17 +3428,6 @@ Available types are
\f[I]postfile\f[], \f[I]images\f[], \f[I]image_large\f[], \f[I]attachments\f[], and \f[I]content\f[].
-.SS extractor.photobucket.subalbums
-.IP "Type:" 6
-\f[I]bool\f[]
-
-.IP "Default:" 9
-\f[I]true\f[]
-
-.IP "Description:" 4
-Download subalbums.
-
-
.SS extractor.pillowfort.external
.IP "Type:" 6
\f[I]bool\f[]
@@ -3826,13 +3851,13 @@ at 600 requests every 10 minutes/600 seconds.
Control video download behavior.
.br
-* \f[I]true\f[]: Download videos and use \f[I]youtube-dl\f[] to handle
+* \f[I]true\f[]: Download videos and use \f[I]ytdl\f[] to handle
HLS and DASH manifests
.br
-* \f[I]"ytdl"\f[]: Download videos and let \f[I]youtube-dl\f[] handle all of
+* \f[I]"ytdl"\f[]: Download videos and let \f[I]ytdl\f[] handle all of
video extraction and download
.br
-* \f[I]"dash"\f[]: Extract DASH manifest URLs and use \f[I]youtube-dl\f[]
+* \f[I]"dash"\f[]: Extract DASH manifest URLs and use \f[I]ytdl\f[]
to download and merge them. (*)
.br
* \f[I]false\f[]: Ignore videos
@@ -4398,6 +4423,20 @@ to access 18+ content without \f[I]API Key\f[].
See \f[I]Filters\f[] for details.
+.SS extractor.twibooru.svg
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]true\f[]
+
+.IP "Description:" 4
+Download SVG versions of images when available.
+
+Try to download the \f[I]view_url\f[] version of these posts
+when this option is disabled.
+
+
.SS extractor.twitter.ads
.IP "Type:" 6
\f[I]bool\f[]
@@ -4427,7 +4466,8 @@ Controls how to handle \f[I]Twitter Cards\f[].
.br
* \f[I]true\f[]: Download image content from supported cards
.br
-* \f[I]"ytdl"\f[]: Additionally download video content from unsupported cards using \f[I]youtube-dl\f[]
+* \f[I]"ytdl"\f[]: Additionally download video content from unsupported cards
+using \f[I]ytdl\f[]
.SS extractor.twitter.cards-blacklist
@@ -4506,6 +4546,18 @@ for each Tweet in said timeline.
Note: This requires at least 1 additional API call per initial Tweet.
+.SS extractor.twitter.unavailable
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Try to download media marked as \f[I]Unavailable\f[],
+e.g. \f[I]Geoblocked\f[] videos.
+
+
.SS extractor.twitter.include
.IP "Type:" 6
.br
@@ -4633,6 +4685,8 @@ Selects how to handle exceeding the API rate limit.
* \f[I]"abort"\f[]: Raise an error and stop extraction
.br
* \f[I]"wait"\f[]: Wait until rate limit reset
+.br
+* \f[I]"wait:N"\f[]: Wait for \f[I]N\f[] seconds
.SS extractor.twitter.relogin
@@ -4644,10 +4698,8 @@ Selects how to handle exceeding the API rate limit.
.IP "Description:" 4
When receiving a "Could not authenticate you" error while logged in with
-.br
\f[I]username & passeword\f[],
refresh the current login session and
-.br
try to continue from where it left off.
@@ -4760,6 +4812,18 @@ Extract \f[I]TwitPic\f[] embeds.
Ignore previously seen Tweets.
+.SS extractor.twitter.username-alt
+.IP "Type:" 6
+\f[I]string\f[]
+
+.IP "Description:" 4
+Alternate Identifier (username, email, phone number)
+when \f[I]logging in\f[].
+
+When not specified and asked for by Twitter,
+this identifier will need to entered in an interactive prompt.
+
+
.SS extractor.twitter.users
.IP "Type:" 6
\f[I]string\f[]
@@ -4809,7 +4873,7 @@ Control video download behavior.
.br
* \f[I]true\f[]: Download videos
.br
-* \f[I]"ytdl"\f[]: Download videos using \f[I]youtube-dl\f[]
+* \f[I]"ytdl"\f[]: Download videos using \f[I]ytdl\f[]
.br
* \f[I]false\f[]: Skip video Tweets
@@ -5025,6 +5089,39 @@ will be taken from the original posts, not the retweeted posts.
Download video files.
+.SS extractor.ytdl.cmdline-args
+.IP "Type:" 6
+.br
+* \f[I]string\f[]
+.br
+* \f[I]list\f[] of \f[I]strings\f[]
+
+.IP "Example:" 4
+.br
+* "--quiet --write-sub --merge-output-format mkv"
+.br
+* ["--quiet", "--write-sub", "--merge-output-format", "mkv"]
+
+.IP "Description:" 4
+Additional \f[I]ytdl\f[] options specified as command-line arguments.
+
+See
+\f[I]yt-dlp options\f[]
+/
+\f[I]youtube-dl options\f[]
+
+
+.SS extractor.ytdl.config-file
+.IP "Type:" 6
+\f[I]Path\f[]
+
+.IP "Example:" 4
+"~/.config/yt-dlp/config"
+
+.IP "Description:" 4
+Location of a \f[I]ytdl\f[] configuration file to load options from.
+
+
.SS extractor.ytdl.enabled
.IP "Type:" 6
\f[I]bool\f[]
@@ -5033,7 +5130,7 @@ Download video files.
\f[I]false\f[]
.IP "Description:" 4
-Match **all** URLs, even ones without a \f[I]ytdl:\f[] prefix.
+Process URLs otherwise unsupported by gallery-dl with \f[I]ytdl\f[].
.SS extractor.ytdl.format
@@ -5041,25 +5138,35 @@ Match **all** URLs, even ones without a \f[I]ytdl:\f[] prefix.
\f[I]string\f[]
.IP "Default:" 9
-youtube-dl's default, currently \f[I]"bestvideo+bestaudio/best"\f[]
+Default of the \f[I]ytdl\f[] \f[I]module\f[] used.
+.br
+(\f[I]"bestvideo*+bestaudio/best"\f[] for \f[I]yt_dlp\f[],
+.br
+\f[I]"bestvideo+bestaudio/best"\f[] for \f[I]youtube_dl\f[])
.IP "Description:" 4
-Video \f[I]format selection
-<https://github.com/ytdl-org/youtube-dl#format-selection>\f[]
-directly passed to youtube-dl.
+\f[I]ytdl\f[] format selection string.
+
+See
+\f[I]yt-dlp format selection\f[]
+/
+\f[I]youtube-dl format selection\f[]
.SS extractor.ytdl.generic
.IP "Type:" 6
-\f[I]bool\f[]
+.br
+* \f[I]bool\f[]
+.br
+* \f[I]string\f[]
.IP "Default:" 9
\f[I]true\f[]
.IP "Description:" 4
-Controls the use of youtube-dl's generic extractor.
+Enables the use of \f[I]ytdl's\f[] \f[I]generic\f[] extractor.
-Set this option to \f[I]"force"\f[] for the same effect as youtube-dl's
+Set this option to \f[I]"force"\f[] for the same effect as
\f[I]--force-generic-extractor\f[].
@@ -5071,8 +5178,8 @@ Set this option to \f[I]"force"\f[] for the same effect as youtube-dl's
\f[I]true\f[]
.IP "Description:" 4
-Route youtube-dl's output through gallery-dl's logging system.
-Otherwise youtube-dl will write its output directly to stdout/stderr.
+Route \f[I]ytdl's\f[] output through gallery-dl's logging system.
+Otherwise it will be written directly to stdout/stderr.
Note: Set \f[I]quiet\f[] and \f[I]no_warnings\f[] in
\f[I]extractor.ytdl.raw-options\f[] to \f[I]true\f[] to suppress all output.
@@ -5086,7 +5193,7 @@ Note: Set \f[I]quiet\f[] and \f[I]no_warnings\f[] in
\f[I]null\f[]
.IP "Description:" 4
-Name of the youtube-dl Python module to import.
+Name of the \f[I]ytdl\f[] Python module to import.
Setting this to \f[I]null\f[] will try to import \f[I]"yt_dlp"\f[]
followed by \f[I]"youtube_dl"\f[] as fallback.
@@ -5109,36 +5216,10 @@ followed by \f[I]"youtube_dl"\f[] as fallback.
.IP "Description:" 4
Additional options passed directly to the \f[I]YoutubeDL\f[] constructor.
-All available options can be found in \f[I]youtube-dl's docstrings
-<https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L138-L318>\f[].
-
-
-.SS extractor.ytdl.cmdline-args
-.IP "Type:" 6
-.br
-* \f[I]string\f[]
-.br
-* \f[I]list\f[] of \f[I]strings\f[]
-
-.IP "Example:" 4
-.br
-* "--quiet --write-sub --merge-output-format mkv"
-.br
-* ["--quiet", "--write-sub", "--merge-output-format", "mkv"]
-
-.IP "Description:" 4
-Additional options specified as youtube-dl command-line arguments.
-
-
-.SS extractor.ytdl.config-file
-.IP "Type:" 6
-\f[I]Path\f[]
-
-.IP "Example:" 4
-"~/.config/youtube-dl/config"
-
-.IP "Description:" 4
-Location of a youtube-dl configuration file to load options from.
+Available options can be found in
+\f[I]yt-dlp's docstrings\f[]
+/
+\f[I]youtube-dl's docstrings\f[]
.SS extractor.zerochan.metadata
@@ -5504,17 +5585,57 @@ Fail a download when a file does not pass
instead of downloading a potentially broken file.
+.SS downloader.ytdl.cmdline-args
+.IP "Type:" 6
+.br
+* \f[I]string\f[]
+.br
+* \f[I]list\f[] of \f[I]strings\f[]
+
+.IP "Example:" 4
+.br
+* "--quiet --write-sub --merge-output-format mkv"
+.br
+* ["--quiet", "--write-sub", "--merge-output-format", "mkv"]
+
+.IP "Description:" 4
+Additional \f[I]ytdl\f[] options specified as command-line arguments.
+
+See
+\f[I]yt-dlp options\f[]
+/
+\f[I]youtube-dl options\f[]
+
+
+.SS downloader.ytdl.config-file
+.IP "Type:" 6
+\f[I]Path\f[]
+
+.IP "Example:" 4
+"~/.config/yt-dlp/config"
+
+.IP "Description:" 4
+Location of a \f[I]ytdl\f[] configuration file to load options from.
+
+
.SS downloader.ytdl.format
.IP "Type:" 6
\f[I]string\f[]
.IP "Default:" 9
-youtube-dl's default, currently \f[I]"bestvideo+bestaudio/best"\f[]
+Default of the \f[I]ytdl\f[] \f[I]module\f[] used.
+.br
+(\f[I]"bestvideo*+bestaudio/best"\f[] for \f[I]yt_dlp\f[],
+.br
+\f[I]"bestvideo+bestaudio/best"\f[] for \f[I]youtube_dl\f[])
.IP "Description:" 4
-Video \f[I]format selection
-<https://github.com/ytdl-org/youtube-dl#format-selection>\f[]
-directly passed to youtube-dl.
+\f[I]ytdl\f[] format selection string.
+
+See
+\f[I]yt-dlp format selection\f[]
+/
+\f[I]youtube-dl format selection\f[]
.SS downloader.ytdl.forward-cookies
@@ -5525,7 +5646,7 @@ directly passed to youtube-dl.
\f[I]false\f[]
.IP "Description:" 4
-Forward cookies to youtube-dl.
+Forward gallery-dl's cookies to \f[I]ytdl\f[].
.SS downloader.ytdl.logging
@@ -5536,8 +5657,8 @@ Forward cookies to youtube-dl.
\f[I]true\f[]
.IP "Description:" 4
-Route youtube-dl's output through gallery-dl's logging system.
-Otherwise youtube-dl will write its output directly to stdout/stderr.
+Route \f[I]ytdl's\f[] output through gallery-dl's logging system.
+Otherwise it will be written directly to stdout/stderr.
Note: Set \f[I]quiet\f[] and \f[I]no_warnings\f[] in
\f[I]downloader.ytdl.raw-options\f[] to \f[I]true\f[] to suppress all output.
@@ -5551,10 +5672,10 @@ Note: Set \f[I]quiet\f[] and \f[I]no_warnings\f[] in
\f[I]null\f[]
.IP "Description:" 4
-Name of the youtube-dl Python module to import.
+Name of the \f[I]ytdl\f[] Python module to import.
-Setting this to \f[I]null\f[] will first try to import \f[I]"yt_dlp"\f[]
-and use \f[I]"youtube_dl"\f[] as fallback.
+Setting this to \f[I]null\f[] will try to import \f[I]"yt_dlp"\f[]
+followed by \f[I]"youtube_dl"\f[] as fallback.
.SS downloader.ytdl.outtmpl
@@ -5565,18 +5686,25 @@ and use \f[I]"youtube_dl"\f[] as fallback.
\f[I]null\f[]
.IP "Description:" 4
-The \f[I]Output Template\f[]
-used to generate filenames for files downloaded with youtube-dl.
+The Output Template
+used to generate filenames for files downloaded with \f[I]ytdl\f[].
+
+See
+\f[I]yt-dlp output template\f[]
+/
+\f[I]youtube-dl output template\f[].
Special values:
.br
* \f[I]null\f[]: generate filenames with \f[I]extractor.*.filename\f[]
.br
-* \f[I]"default"\f[]: use youtube-dl's default, currently \f[I]"%(title)s-%(id)s.%(ext)s"\f[]
+* \f[I]"default"\f[]: use \f[I]ytdl's\f[] default, currently
+\f[I]"%(title)s [%(id)s].%(ext)s"\f[] for \f[I]yt-dlp\f[] /
+\f[I]"%(title)s-%(id)s.%(ext)s"\f[] for \f[I]youtube-dl\f[]
Note: An output template other than \f[I]null\f[] might
-cause unexpected results in combination with other options
+cause unexpected results in combination with certain options
(e.g. \f[I]"skip": "enumerate"\f[])
@@ -5597,36 +5725,10 @@ cause unexpected results in combination with other options
.IP "Description:" 4
Additional options passed directly to the \f[I]YoutubeDL\f[] constructor.
-All available options can be found in \f[I]youtube-dl's docstrings
-<https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L138-L318>\f[].
-
-
-.SS downloader.ytdl.cmdline-args
-.IP "Type:" 6
-.br
-* \f[I]string\f[]
-.br
-* \f[I]list\f[] of \f[I]strings\f[]
-
-.IP "Example:" 4
-.br
-* "--quiet --write-sub --merge-output-format mkv"
-.br
-* ["--quiet", "--write-sub", "--merge-output-format", "mkv"]
-
-.IP "Description:" 4
-Additional options specified as youtube-dl command-line arguments.
-
-
-.SS downloader.ytdl.config-file
-.IP "Type:" 6
-\f[I]Path\f[]
-
-.IP "Example:" 4
-"~/.config/youtube-dl/config"
-
-.IP "Description:" 4
-Location of a youtube-dl configuration file to load options from.
+Available options can be found in
+\f[I]yt-dlp's docstrings\f[]
+/
+\f[I]youtube-dl's docstrings\f[]
.SH OUTPUT OPTIONS
@@ -6569,7 +6671,7 @@ Filename extension for the resulting video files.
["-c:v", "libvpx-vp9", "-an", "-b:v", "2M"]
.IP "Description:" 4
-Additional FFmpeg command-line arguments.
+Additional \f[I]ffmpeg\f[] command-line arguments.
.SS ugoira.ffmpeg-demuxer
@@ -6580,7 +6682,9 @@ Additional FFmpeg command-line arguments.
\f[I]auto\f[]
.IP "Description:" 4
-FFmpeg demuxer to read and process input files with. Possible values are
+\f[I]ffmpeg\f[] demuxer to read and process input files with.
+
+Possible values are
.br
* "\f[I]concat\f[]" (inaccurate frame timecodes for non-uniform frame delays)
@@ -6626,15 +6730,15 @@ Location of the \f[I]mkvmerge\f[] executable for use with the
\f[I]"error"\f[]
.IP "Description:" 4
-Controls FFmpeg output.
+Controls \f[I]ffmpeg\f[] output.
.br
-* \f[I]true\f[]: Enable FFmpeg output
+* \f[I]true\f[]: Enable \f[I]ffmpeg\f[] output
.br
-* \f[I]false\f[]: Disable all FFmpeg output
+* \f[I]false\f[]: Disable all \f[I]ffmpeg\f[] output
.br
* any \f[I]string\f[]: Pass \f[I]-hide_banner\f[] and \f[I]-loglevel\f[]
-with this value as argument to FFmpeg
+with this value as argument to \f[I]ffmpeg\f[]
.SS ugoira.ffmpeg-twopass
@@ -6656,7 +6760,7 @@ Enable Two-Pass encoding.
\f[I]"auto"\f[]
.IP "Description:" 4
-Controls the frame rate argument (\f[I]-r\f[]) for FFmpeg
+Controls the frame rate argument (\f[I]-r\f[]) for \f[I]ffmpeg\f[]
.br
* \f[I]"auto"\f[]: Automatically assign a fitting frame rate
@@ -6697,7 +6801,7 @@ for more information.
This option, when \f[I]libx264/5\f[] is used, automatically
adds \f[I]["-vf", "crop=iw-mod(iw\\\\,2):ih-mod(ih\\\\,2)"]\f[]
-to the list of FFmpeg command-line arguments
+to the list of \f[I]ffmpeg\f[] command-line arguments
to reduce an odd width/height by 1 pixel and make them even.
@@ -6838,7 +6942,8 @@ Path to or name of an
Python module,
whose namespace,
.br
-in addition to the \f[I]GLOBALS\f[] dict in \f[I]util.py\f[],
+in addition to the \f[I]GLOBALS\f[] dict in
+\f[I]util.py\f[],
gets used as \f[I]globals parameter\f[] for compiled Python expressions.
@@ -7266,9 +7371,10 @@ Set file modification time according to its metadata
\f[I]python\f[]
Call Python functions
\f[I]ugoira\f[]
-Convert Pixiv Ugoira to WebM using \f[I]FFmpeg\f[]
+Convert Pixiv Ugoira to WebM using \f[I]ffmpeg\f[]
\f[I]zip\f[]
Store files in a ZIP archive
+\f[I]ytdl\f[]
generated by cgit v1.2.3 (git 2.46.0) at 2026-01-26 21:54:25 +0000