aboutsummaryrefslogtreecommitdiffstats
path: root/data
diff options
context:
space:
mode:
Diffstat (limited to 'data')
-rw-r--r--data/completion/_gallery-dl23
-rw-r--r--data/completion/gallery-dl4
-rw-r--r--data/completion/gallery-dl.fish23
-rw-r--r--data/man/gallery-dl.149
-rw-r--r--data/man/gallery-dl.conf.577
5 files changed, 119 insertions, 57 deletions
diff --git a/data/completion/_gallery-dl b/data/completion/_gallery-dl
index c1425bb..f3b17a2 100644
--- a/data/completion/_gallery-dl
+++ b/data/completion/_gallery-dl
@@ -7,7 +7,6 @@ local rc=1
_arguments -C -S \
{-h,--help}'[Print this help message and exit]' \
--version'[Print program version and exit]' \
-{-i,--input-file}'[Download URLs found in FILE ("-" for stdin). More than one --input-file can be specified]':'<file>':_files \
{-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>' \
@@ -16,6 +15,9 @@ _arguments -C -S \
--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>' \
+{-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 \
{-q,--quiet}'[Activate quiet mode]' \
{-v,--verbose}'[Print various debugging information]' \
{-g,--get-urls}'[Print URLs instead of downloading]' \
@@ -64,18 +66,21 @@ _arguments -C -S \
--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>' \
---zip'[Store downloaded files in a ZIP archive]' \
---ugoira-conv'[Convert Pixiv Ugoira to WebM (requires FFmpeg)]' \
---ugoira-conv-lossless'[Convert Pixiv Ugoira to WebM in VP9 lossless mode]' \
---ugoira-conv-copy'[Convert Pixiv Ugoira to MKV without re-encoding any frames]' \
+{-P,--postprocessor}'[Activate the specified post processor]':'<name>' \
+{-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]' \
--write-infojson'[==SUPPRESS==]' \
--write-tags'[Write image tags to separate text files]' \
---mtime-from-date'[Set file modification times according to "date" metadata]' \
+--zip'[Store downloaded files in a ZIP archive]' \
+--cbz'[Store downloaded files in a CBZ archive]' \
+--mtime'[Set file modification times according to metadata selected by NAME. Examples: "date" or "status[date]"]':'<name>' \
+--mtime-from-date'[==SUPPRESS==]' \
+--ugoira'[Convert Pixiv Ugoira to FORMAT using FFmpeg. Supported formats are "webm", "mp4", "gif", "vp8", "vp9", "vp9-lossless", "copy".]':'<format>' \
+--ugoira-conv'[==SUPPRESS==]' \
+--ugoira-conv-lossless'[==SUPPRESS==]' \
+--ugoira-conv-copy'[==SUPPRESS==]' \
--exec'[Execute CMD for each downloaded file. Supported replacement fields are {} or {_path}, {_directory}, {_filename}. Example: --exec "convert {} {}.png && rm {}"]':'<cmd>' \
---exec-after'[Execute CMD after all files were downloaded successfully. Example: --exec-after "cd {_directory} && convert * ../doc.pdf"]':'<cmd>' \
-{-P,--postprocessor}'[Activate the specified post processor]':'<name>' \
-{-O,--postprocessor-option}'[Additional "<key>=<value>" post processor options]':'<opt>' && rc=0
+--exec-after'[Execute CMD after all files were downloaded. Example: --exec-after "cd {_directory} && convert * ../doc.pdf"]':'<cmd>' && rc=0
return rc
diff --git a/data/completion/gallery-dl b/data/completion/gallery-dl
index 02fc847..e5bc6c1 100644
--- a/data/completion/gallery-dl
+++ b/data/completion/gallery-dl
@@ -5,12 +5,12 @@ _gallery_dl()
cur="${COMP_WORDS[COMP_CWORD]}"
prev="${COMP_WORDS[COMP_CWORD-1]}"
- if [[ "${prev}" =~ ^(-i|--input-file|--write-log|--write-unsupported|-c|--config|--config-yaml|--config-toml|-C|--cookies|--cookies-export|--download-archive)$ ]]; then
+ if [[ "${prev}" =~ ^(-i|--input-file|-I|--input-file-comment|-x|--input-file-delete|--write-log|--write-unsupported|-c|--config|--config-yaml|--config-toml|-C|--cookies|--cookies-export|--download-archive)$ ]]; then
COMPREPLY=( $(compgen -f -- "${cur}") )
elif [[ "${prev}" =~ ^()$ ]]; then
COMPREPLY=( $(compgen -d -- "${cur}") )
else
- COMPREPLY=( $(compgen -W "--help --version --input-file --filename --destination --directory --extractors --proxy --source-address --user-agent --clear-cache --quiet --verbose --get-urls --resolve-urls --dump-json --simulate --extractor-info --list-keywords --list-modules --list-extractors --write-log --write-unsupported --write-pages --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 --zip --ugoira-conv --ugoira-conv-lossless --ugoira-conv-copy --write-metadata --write-info-json --write-infojson --write-tags --mtime-from-date --exec --exec-after --postprocessor --postprocessor-option" -- "${cur}") )
+ COMPREPLY=( $(compgen -W "--help --version --filename --destination --directory --extractors --proxy --source-address --user-agent --clear-cache --input-file --input-file-comment --input-file-delete --quiet --verbose --get-urls --resolve-urls --dump-json --simulate --extractor-info --list-keywords --list-modules --list-extractors --write-log --write-unsupported --write-pages --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}") )
fi
}
diff --git a/data/completion/gallery-dl.fish b/data/completion/gallery-dl.fish
index 593ab89..5cb60d4 100644
--- a/data/completion/gallery-dl.fish
+++ b/data/completion/gallery-dl.fish
@@ -1,7 +1,6 @@
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 -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 -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'
@@ -10,6 +9,9 @@ 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 -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 -s 'q' -l 'quiet' -d 'Activate quiet mode'
complete -c gallery-dl -s 'v' -l 'verbose' -d 'Print various debugging information'
complete -c gallery-dl -s 'g' -l 'get-urls' -d 'Print URLs instead of downloading'
@@ -58,16 +60,19 @@ complete -c gallery-dl -x -l 'range' -d 'Index range(s) specifying which files t
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 -l 'zip' -d 'Store downloaded files in a ZIP archive'
-complete -c gallery-dl -l 'ugoira-conv' -d 'Convert Pixiv Ugoira to WebM (requires FFmpeg)'
-complete -c gallery-dl -l 'ugoira-conv-lossless' -d 'Convert Pixiv Ugoira to WebM in VP9 lossless mode'
-complete -c gallery-dl -l 'ugoira-conv-copy' -d 'Convert Pixiv Ugoira to MKV without re-encoding any frames'
+complete -c gallery-dl -x -s 'P' -l 'postprocessor' -d 'Activate the specified post processor'
+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'
complete -c gallery-dl -l 'write-infojson' -d '==SUPPRESS=='
complete -c gallery-dl -l 'write-tags' -d 'Write image tags to separate text files'
-complete -c gallery-dl -l 'mtime-from-date' -d 'Set file modification times according to "date" metadata'
+complete -c gallery-dl -l 'zip' -d 'Store downloaded files in a ZIP archive'
+complete -c gallery-dl -l 'cbz' -d 'Store downloaded files in a CBZ archive'
+complete -c gallery-dl -x -l 'mtime' -d 'Set file modification times according to metadata selected by NAME. Examples: "date" or "status[date]"'
+complete -c gallery-dl -l 'mtime-from-date' -d '==SUPPRESS=='
+complete -c gallery-dl -x -l 'ugoira' -d 'Convert Pixiv Ugoira to FORMAT using FFmpeg. Supported formats are "webm", "mp4", "gif", "vp8", "vp9", "vp9-lossless", "copy".'
+complete -c gallery-dl -l 'ugoira-conv' -d '==SUPPRESS=='
+complete -c gallery-dl -l 'ugoira-conv-lossless' -d '==SUPPRESS=='
+complete -c gallery-dl -l 'ugoira-conv-copy' -d '==SUPPRESS=='
complete -c gallery-dl -x -l 'exec' -d 'Execute CMD for each downloaded file. Supported replacement fields are {} or {_path}, {_directory}, {_filename}. Example: --exec "convert {} {}.png && rm {}"'
-complete -c gallery-dl -x -l 'exec-after' -d 'Execute CMD after all files were downloaded successfully. Example: --exec-after "cd {_directory} && convert * ../doc.pdf"'
-complete -c gallery-dl -x -s 'P' -l 'postprocessor' -d 'Activate the specified post processor'
-complete -c gallery-dl -x -s 'O' -l 'postprocessor-option' -d 'Additional "<key>=<value>" post processor options'
+complete -c gallery-dl -x -l 'exec-after' -d 'Execute CMD after all files were downloaded. Example: --exec-after "cd {_directory} && convert * ../doc.pdf"'
diff --git a/data/man/gallery-dl.1 b/data/man/gallery-dl.1
index 5a9ec79..2789154 100644
--- a/data/man/gallery-dl.1
+++ b/data/man/gallery-dl.1
@@ -1,4 +1,4 @@
-.TH "GALLERY-DL" "1" "2023-11-04" "1.26.2" "gallery-dl Manual"
+.TH "GALLERY-DL" "1" "2023-11-27" "1.26.3" "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 "\-i, \-\-input\-file" \f[I]FILE\f[]
-Download URLs found in FILE ('-' for stdin). More than one --input-file can be specified
-.TP
.B "\-f, \-\-filename" \f[I]FORMAT\f[]
Filename format string for downloaded files ('/O' for "original" filenames)
.TP
@@ -50,6 +47,15 @@ User-Agent request header
.B "\-\-clear\-cache" \f[I]MODULE\f[]
Delete cached login sessions, cookies, etc. for MODULE (ALL to delete everything)
.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
+.B "\-I, \-\-input\-file\-comment" \f[I]FILE\f[]
+Download URLs found in FILE. Comment them out after they were downloaded successfully.
+.TP
+.B "\-x, \-\-input\-file\-delete" \f[I]FILE\f[]
+Download URLs found in FILE. Delete them after they were downloaded successfully.
+.TP
.B "\-q, \-\-quiet"
Activate quiet mode
.TP
@@ -191,17 +197,11 @@ Python expression controlling which files to download. Files for which the expre
.B "\-\-chapter\-filter" \f[I]EXPR\f[]
Like '--filter', but applies to manga chapters and other delegated URLs
.TP
-.B "\-\-zip"
-Store downloaded files in a ZIP archive
-.TP
-.B "\-\-ugoira\-conv"
-Convert Pixiv Ugoira to WebM (requires FFmpeg)
-.TP
-.B "\-\-ugoira\-conv\-lossless"
-Convert Pixiv Ugoira to WebM in VP9 lossless mode
+.B "\-P, \-\-postprocessor" \f[I]NAME\f[]
+Activate the specified post processor
.TP
-.B "\-\-ugoira\-conv\-copy"
-Convert Pixiv Ugoira to MKV without re-encoding any frames
+.B "\-O, \-\-postprocessor\-option" \f[I]KEY=VALUE\f[]
+Additional post processor options
.TP
.B "\-\-write\-metadata"
Write metadata to separate JSON files
@@ -212,20 +212,23 @@ Write gallery metadata to a info.json file
.B "\-\-write\-tags"
Write image tags to separate text files
.TP
-.B "\-\-mtime\-from\-date"
-Set file modification times according to 'date' metadata
+.B "\-\-zip"
+Store downloaded files in a ZIP archive
+.TP
+.B "\-\-cbz"
+Store downloaded files in a CBZ archive
+.TP
+.B "\-\-mtime" \f[I]NAME\f[]
+Set file modification times according to metadata selected by NAME. Examples: 'date' or 'status[date]'
+.TP
+.B "\-\-ugoira" \f[I]FORMAT\f[]
+Convert Pixiv Ugoira to FORMAT using FFmpeg. Supported formats are 'webm', 'mp4', 'gif', 'vp8', 'vp9', 'vp9-lossless', 'copy'.
.TP
.B "\-\-exec" \f[I]CMD\f[]
Execute CMD for each downloaded file. Supported replacement fields are {} or {_path}, {_directory}, {_filename}. Example: --exec "convert {} {}.png && rm {}"
.TP
.B "\-\-exec\-after" \f[I]CMD\f[]
-Execute CMD after all files were downloaded successfully. Example: --exec-after "cd {_directory} && convert * ../doc.pdf"
-.TP
-.B "\-P, \-\-postprocessor" \f[I]NAME\f[]
-Activate the specified post processor
-.TP
-.B "\-O, \-\-postprocessor\-option" \f[I]OPT\f[]
-Additional '<key>=<value>' post processor options
+Execute CMD after all files were downloaded. Example: --exec-after "cd {_directory} && convert * ../doc.pdf"
.SH EXAMPLES
.TP
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5
index 46a8ea6..adf9885 100644
--- a/data/man/gallery-dl.conf.5
+++ b/data/man/gallery-dl.conf.5
@@ -1,4 +1,4 @@
-.TH "GALLERY-DL.CONF" "5" "2023-11-04" "1.26.2" "gallery-dl Manual"
+.TH "GALLERY-DL.CONF" "5" "2023-11-27" "1.26.3" "gallery-dl Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -190,7 +190,7 @@ Use an extractor's current target directory as
for any spawned child extractors.
-.SS extractor.*.parent-metadata
+.SS extractor.*.metadata-parent
.IP "Type:" 6
.br
* \f[I]bool\f[]
@@ -784,9 +784,6 @@ Default value used for missing or undefined keyword names in
.IP "Type:" 6
\f[I]string\f[]
-.IP "Default:" 9
-\f[I]null\f[]
-
.IP "Description:" 4
Insert a file's download URL into its metadata dictionary as the given name.
@@ -801,9 +798,6 @@ with a \f[I]metadata\f[] post processor, etc.
.IP "Type:" 6
\f[I]string\f[]
-.IP "Default:" 9
-\f[I]null\f[]
-
.IP "Description:" 4
Insert a reference to the current
\f[I]PathFormat\f[]
@@ -813,12 +807,19 @@ For example, setting this option to \f[I]"gdl_path"\f[] would make it possible
to access the current file's filename as \f[I]"{gdl_path.filename}"\f[].
-.SS extractor.*.http-metadata
+.SS extractor.*.extractor-metadata
.IP "Type:" 6
\f[I]string\f[]
-.IP "Default:" 9
-\f[I]null\f[]
+.IP "Description:" 4
+Insert a reference to the current
+\f[I]Extractor\f[]
+object into metadata dictionaries as the given name.
+
+
+.SS extractor.*.http-metadata
+.IP "Type:" 6
+\f[I]string\f[]
.IP "Description:" 4
Insert an \f[I]object\f[] containing a file's HTTP headers and
@@ -834,9 +835,6 @@ and its parsed form as \f[I]"{gdl_http[date]}"\f[].
.IP "Type:" 6
\f[I]string\f[]
-.IP "Default:" 9
-\f[I]null\f[]
-
.IP "Description:" 4
Insert an \f[I]object\f[] containing gallery-dl's version info into
metadata dictionaries as the given name.
@@ -1307,6 +1305,20 @@ This value must be divisble by 16 and gets rounded down otherwise.
The maximum possible value appears to be \f[I]1920\f[].
+.SS extractor.behance.modules
+.IP "Type:" 6
+\f[I]list\f[] of \f[I]strings\f[]
+
+.IP "Default:" 9
+\f[I]["image", "video", "mediacollection", "embed"]\f[]
+
+.IP "Description:" 4
+Selects which gallery modules to download from.
+
+Supported module types are
+\f[I]image\f[], \f[I]video\f[], \f[I]mediacollection\f[], \f[I]embed\f[], \f[I]text\f[].
+
+
.SS extractor.blogger.videos
.IP "Type:" 6
\f[I]bool\f[]
@@ -1807,6 +1819,24 @@ Note: This will remove any Favorite Notes when applied
to already favorited galleries.
+.SS extractor.exhentai.gp
+.IP "Type:" 6
+\f[I]string\f[]
+
+.IP "Default:" 9
+\f[I]"resized"\f[]
+
+.IP "Description:" 4
+Selects how to handle "you do not have enough GP" errors.
+
+.br
+* "resized": Continue downloading \f[I]non-original\f[] images.
+.br
+* "stop": Stop the current extractor run.
+.br
+* "wait": Wait for user input before retrying the current image.
+
+
.SS extractor.exhentai.limits
.IP "Type:" 6
\f[I]integer\f[]
@@ -2944,6 +2974,14 @@ Include pins from board sections.
Download from video pins.
+.SS extractor.pixeldrain.api-key
+.IP "Type:" 6
+\f[I]string\f[]
+
+.IP "Description:" 4
+Your account's \f[I]API key\f[]
+
+
.SS extractor.pixiv.include
.IP "Type:" 6
.br
@@ -3603,6 +3641,17 @@ to access 18+ content without \f[I]API Key\f[].
See \f[I]Filters\f[] for details.
+.SS extractor.twitter.ads
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Fetch media from promoted Tweets.
+
+
.SS extractor.twitter.cards
.IP "Type:" 6
.br