diff options
| author | 2025-12-20 05:49:04 -0500 | |
|---|---|---|
| committer | 2025-12-20 05:49:04 -0500 | |
| commit | a24ec1647aeac35a63b744ea856011ad6e06be3b (patch) | |
| tree | ae94416de786aeddd05d99559098f7f16bb103a6 /data | |
| parent | 33f8a8a37a9cba738ef25fb99955f0730da9eb48 (diff) | |
New upstream version 1.31.1.upstream/1.31.1
Diffstat (limited to 'data')
| -rw-r--r-- | data/completion/_gallery-dl | 6 | ||||
| -rw-r--r-- | data/completion/gallery-dl | 2 | ||||
| -rw-r--r-- | data/completion/gallery-dl.fish | 6 | ||||
| -rw-r--r-- | data/man/gallery-dl.1 | 12 | ||||
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 642 |
5 files changed, 577 insertions, 91 deletions
diff --git a/data/completion/_gallery-dl b/data/completion/_gallery-dl index 539ec1b..681b429 100644 --- a/data/completion/_gallery-dl +++ b/data/completion/_gallery-dl @@ -78,9 +78,11 @@ _arguments -s -S \ --filesize-max'[Do not download files larger than SIZE (e.g. 500k or 2.5M)]':'<size>' \ --download-archive'[Record successfully downloaded 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>' \ +--post-range'[Like '\''--range'\'', but for posts]':'<range>' \ +--chapter-range'[Like '\''--range'\'', but for child extractors handling manga chapters, external URLs, etc.]':'<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>' \ +--post-filter'[Like '\''--filter'\'', but for posts]':'<expr>' \ +--chapter-filter'[Like '\''--filter'\'', but for child extractors handling manga chapters, external URLs, etc.]':'<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>' \ diff --git a/data/completion/gallery-dl b/data/completion/gallery-dl index ae4cb0f..1f3a33d 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 --filename --destination --directory --extractors --user-agent --clear-cache --compat --update-check --input-file --input-file-comment --input-file-delete --no-input --quiet --warning --verbose --get-urls --resolve-urls --dump-json --resolve-json --simulate --extractor-info --list-keywords --error-file --print --Print --print-to-file --Print-to-file --list-modules --list-extractors --write-log --write-unsupported --write-pages --print-traffic --no-colors --retries --http-timeout --proxy --source-address --force-ipv4 --force-ipv6 --no-check-certificate --limit-rate --chunk-size --sleep --sleep-request --sleep-429 --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 --rename --rename-to --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 --compat --update-check --input-file --input-file-comment --input-file-delete --no-input --quiet --warning --verbose --get-urls --resolve-urls --dump-json --resolve-json --simulate --extractor-info --list-keywords --error-file --print --Print --print-to-file --Print-to-file --list-modules --list-extractors --write-log --write-unsupported --write-pages --print-traffic --no-colors --retries --http-timeout --proxy --source-address --force-ipv4 --force-ipv6 --no-check-certificate --limit-rate --chunk-size --sleep --sleep-request --sleep-429 --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 --post-range --chapter-range --filter --post-filter --chapter-filter --postprocessor --no-postprocessors --postprocessor-option --write-metadata --write-info-json --write-infojson --write-tags --zip --cbz --mtime --mtime-from-date --rename --rename-to --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 84ff5b5..5a3d8aa 100644 --- a/data/completion/gallery-dl.fish +++ b/data/completion/gallery-dl.fish @@ -73,9 +73,11 @@ complete -c gallery-dl -x -l 'filesize-min' -d 'Do not download files smaller th 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 successfully downloaded 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 'post-range' -d 'Like "--range", but for posts' +complete -c gallery-dl -x -l 'chapter-range' -d 'Like "--range", but for child extractors handling manga chapters, external URLs, etc.' 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 -l 'post-filter' -d 'Like "--filter", but for posts' +complete -c gallery-dl -x -l 'chapter-filter' -d 'Like "--filter", but for child extractors handling manga chapters, external URLs, etc.' 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' diff --git a/data/man/gallery-dl.1 b/data/man/gallery-dl.1 index 9751705..90a423a 100644 --- a/data/man/gallery-dl.1 +++ b/data/man/gallery-dl.1 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL" "1" "2025-10-12" "1.30.10" "gallery-dl Manual" +.TH "GALLERY-DL" "1" "2025-12-20" "1.31.1" "gallery-dl Manual" .\" disable hyphenation .nh @@ -236,14 +236,20 @@ Record successfully downloaded files in FILE and skip downloading any file alrea .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 +.B "\-\-post\-range" \f[I]RANGE\f[] +Like '--range', but for posts +.TP .B "\-\-chapter\-range" \f[I]RANGE\f[] -Like '--range', but applies to manga chapters and other delegated URLs +Like '--range', but for child extractors handling manga chapters, external URLs, etc. .TP .B "\-\-filter" \f[I]EXPR\f[] 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')" .TP +.B "\-\-post\-filter" \f[I]EXPR\f[] +Like '--filter', but for posts +.TP .B "\-\-chapter\-filter" \f[I]EXPR\f[] -Like '--filter', but applies to manga chapters and other delegated URLs +Like '--filter', but for child extractors handling manga chapters, external URLs, etc. .TP .B "\-P, \-\-postprocessor" \f[I]NAME\f[] Activate the specified post processor diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index 320963f..7729342 100644 --- a/data/man/gallery-dl.conf.5 +++ b/data/man/gallery-dl.conf.5 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL.CONF" "5" "2025-10-12" "1.30.10" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2025-12-20" "1.31.1" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -222,11 +222,14 @@ Use an extractor's current target directory as * \f[I]string\f[] .IP "Default:" 9 +\f[I]true\f[] +\f[I][chevereto]\f[] | +\f[I][imagehost]\f[] \f[I]false\f[] +otherwise .IP "Description:" 4 -If \f[I]true\f[], overwrite any metadata provided by a child extractor -with its parent's. +Forward a parent's metadata to its child extractors. If this is a \f[I]string\f[], add a parent's metadata to its children's .br @@ -650,6 +653,8 @@ This is supported for .br * \f[I]nijie\f[] (\f[I]R\f[]) .br +* \f[I]nudostarforum\f[] +.br * \f[I]pillowfort\f[] .br * \f[I]rule34xyz\f[] @@ -660,6 +665,8 @@ This is supported for .br * \f[I]seiga\f[] .br +* \f[I]simpcity\f[] +.br * \f[I]subscribestar\f[] .br * \f[I]tapas\f[] @@ -945,8 +952,9 @@ and use the \f[I]User-Agent\f[] header of this installed browser. \f[I]"firefox"\f[] \f[I]artstation\f[] \f[I] \f[I]behance\f[] \f[] -\f[I]fanbox\f[] | -\f[I]twitter\f[] +\f[I]fanbox\f[] \f[I] +\f[I]twitter\f[] \f[] +\f[I]vsco\f[] \f[I]null\f[] otherwise @@ -1090,9 +1098,8 @@ to use these browser's default ciphers. .IP "Default:" 9 \f[I]false\f[] -\f[I]artstation\f[] \f[I] -\f[I]behance\f[] \f[] -\f[I]vsco\f[] +\f[I]artstation\f[] | +\f[I]behance\f[] \f[I]true\f[] otherwise @@ -1114,6 +1121,18 @@ and potentially bypass Cloudflare blocks. Additional name-value pairs to be added to each metadata dictionary. +.SS extractor.*.keywords-default +.IP "Type:" 6 +any + +.IP "Default:" 9 +\f[I]"None"\f[] + +.IP "Description:" 4 +Default value used for missing or undefined keyword names in a +\f[I]Format String\f[]. + + .SS extractor.*.keywords-eval .IP "Type:" 6 \f[I]bool\f[] @@ -1122,20 +1141,27 @@ Additional name-value pairs to be added to each metadata dictionary. \f[I]false\f[] .IP "Description:" 4 -Evaluate each \f[I]keywords\f[] \f[I]string\f[] value -as a \f[I]Format String\f[]. +Evaluate each +\f[I]keywords\f[] +and +\f[I]keywords-global\f[] +\f[I]string\f[] value as a \f[I]Format String\f[]. -.SS extractor.*.keywords-default +.SS extractor.*.keywords-global .IP "Type:" 6 -any +\f[I]object\f[] (name → value) -.IP "Default:" 9 -\f[I]"None"\f[] +.IP "Example:" 4 +{"type": "Original", "type_id": 1, "type_category": "meta"} .IP "Description:" 4 -Default value used for missing or undefined keyword names in a -\f[I]Format String\f[]. +Global name-value pairs to be added to each metadata dictionary. + +.IP "Note:" 4 +Keywords defined here will be overwritten by keywords from +\f[I]extractor.keywords\f[] +with the same name. .SS extractor.*.url-metadata @@ -1299,17 +1325,22 @@ may pose a security risk. .IP "Example:" 4 .br -* "file,skip" +* "after,skip" .br -* ["file", "skip"] +* ["after", "skip"] .IP "Description:" 4 \f[I]Event(s)\f[] for which IDs get written to an \f[I]archive\f[]. -Available events are: -\f[I]file\f[], \f[I]skip\f[] +.IP "Available Events:" 4 +.br +* \f[I]file\f[] +.br +* \f[I]after\f[] +.br +* \f[I]skip\f[] .SS extractor.*.archive-format @@ -1647,13 +1678,22 @@ For example \f[I]5-\f[], \f[I]5:\f[], and \f[I]5::\f[] all mean "Start at file n The index of the first file is \f[I]1\f[]. +.SS extractor.*.post-range +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Description:" 4 +Like \f[I]image-range\f[], +but for posts. + + .SS extractor.*.chapter-range .IP "Type:" 6 \f[I]string\f[] .IP "Description:" 4 Like \f[I]image-range\f[], -but applies to delegated URLs like manga chapters, etc. +but for child extractors handling manga chapters, external URLs, etc. .SS extractor.*.image-filter @@ -1677,6 +1717,24 @@ A file only gets downloaded when *all* of the given \f[I]Expressions\f[] evaluat Available values are the filename-specific ones listed by \f[I]-K\f[] or \f[I]-j\f[]. +.SS extractor.*.post-filter +.IP "Type:" 6 +.br +* \f[I]Condition\f[] +.br +* \f[I]list\f[] of \f[I]Conditions\f[] + +.IP "Example:" 4 +.br +* "post['id'] > 12345" +.br +* ["date >= datetime(2025, 5, 1)", "print(post_id)"] + +.IP "Description:" 4 +Like \f[I]image-filter\f[], +but for posts. + + .SS extractor.*.chapter-filter .IP "Type:" 6 .br @@ -1692,7 +1750,7 @@ Available values are the filename-specific ones listed by \f[I]-K\f[] or \f[I]-j .IP "Description:" 4 Like \f[I]image-filter\f[], -but applies to delegated URLs like manga chapters, etc. +but for child extractors handling manga chapters, external URLs, etc. .SS extractor.*.image-unique @@ -1724,7 +1782,7 @@ but applies to delegated URLs like manga chapters, etc. \f[I]string\f[] .IP "Default:" 9 -\f[I]"%Y-%m-%dT%H:%M:%S"\f[] +\f[I]null\f[] .IP "Description:" 4 Format string used to parse \f[I]string\f[] values of @@ -1732,6 +1790,16 @@ date-min and date-max. See \f[I]strptime\f[] for a list of formatting directives. +.IP "Special Values:" 4 +\f[I]null\f[] +Parse date-min and date-max according to +.br +\f[I]ISO 8601\f[] +See +.br +\f[I]datetime.fromisoformat()\f[] +for details and examples. + .IP "Note:" 4 Despite its name, this option does **not** control how \f[I]{date}\f[] metadata fields are formatted. @@ -2018,6 +2086,25 @@ https://developers.google.com/blogger/docs/3.0/using#APIKey Download embedded videos hosted on https://www.blogger.com/ +.SS extractor.bluesky.api-server +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"https://bsky.social"\f[] if a +.br +\f[I]username\f[] +is provided +\f[I]"https://api.bsky.app"\f[] otherwise +.br + +.IP "Description:" 4 +Server address for API requests. + +Can be used when self-hosting a +\f[I]PDS\f[] + + .SS extractor.bluesky.include .IP "Type:" 6 .br @@ -2403,15 +2490,26 @@ as well as the default \f[I]user-images\f[] and \f[I]user-videos\f[]: .IP "Example:" 4 .br -* "generation,post,version" +* "generation,tags,post,version" .br * ["version", "generation"] .IP "Description:" 4 -Extract additional \f[I]generation\f[], \f[I]version\f[], and \f[I]post\f[] metadata. +Extract additional metadata. + +.IP "Supported Values:" 4 +.br +* \f[I]generation\f[] +.br +* \f[I]post\f[] +.br +* \f[I]tags\f[] +.br +* \f[I]version\f[] .IP "Note:" 4 -This requires 1 or more additional API requests per image or video. +This requires 1 additional API request +for each selected value per image or video. .SS extractor.civitai.nsfw @@ -2444,6 +2542,60 @@ while \f[I]3\f[] (\f[I]1|2\f[]) would return only \f[I]None\f[] and \f[I]Soft\f[] rated images, +.SS extractor.civitai.period +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"AllTime"\f[] + +.IP "Description:" 4 +Sets the \f[I]period\f[] parameter +when paginating over results. + +.IP "Supported Values:" 4 +.br +* \f[I]"AllTime"\f[] +.br +* \f[I]"Year"\f[] +.br +* \f[I]"Month"\f[] +.br +* \f[I]"Week"\f[] +.br +* \f[I]"Day"\f[] + + +.SS extractor.civitai.sort +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"Newest"\f[] + +.IP "Description:" 4 +Sets the \f[I]sort\f[] parameter +when paginating over results. + +.IP "Supported Values:" 4 +.br +* \f[I]"Newest"\f[] +.br +* \f[I]"Oldest"\f[] +.br +* \f[I]"Most Reactions"\f[] +.br +* \f[I]"Most Comments"\f[] +.br +* \f[I]"Most Collected"\f[] + +.IP "Special Values:" 4 +\f[I]"asc"\f[] +Ascending order (\f[I]"Oldest"\f[]) +\f[I]"desc"\f[] | \f[I]"reverse"\f[] +Descending order (\f[I]"Newest"\f[]) + + .SS extractor.civitai.quality .IP "Type:" 6 .br @@ -2559,6 +2711,17 @@ to be interactively prompted for a password when needed (see \f[I]getpass()\f[]). +.SS extractor.cyberfile.recursive +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Recursively download files from subfolders. + + .SS extractor.[Danbooru].external .IP "Type:" 6 \f[I]bool\f[] @@ -3483,6 +3646,17 @@ Extract \f[I]plan\f[] and extended \f[I]user\f[] metadata. \f[I]fanbox.comments\f[] +.SS extractor.fanbox.creator.offset +.IP "Type:" 6 +\f[I]integer\f[] + +.IP "Default:" 9 +\f[I]0\f[] + +.IP "Description:" 4 +Custom \f[I]offset\f[] starting value when paginating over posts. + + .SS extractor.fansly.formats .IP "Type:" 6 \f[I]list\f[] of \f[I]integers\f[] @@ -3799,6 +3973,21 @@ to attempt to fetch the current value used by gofile. Recursively download files from subfolders. +.SS extractor.hdoujin.cbz +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Download each gallery as a single \f[I].cbz\f[] file. + +.IP "Note:" 4 +Requires a +\f[I]token\f[] + + .SS extractor.hdoujin.crt .IP "Type:" 6 \f[I]string\f[] @@ -3878,7 +4067,10 @@ for example \f[I]tags_artist\f[] or \f[I]tags_character\f[]. .IP "Description:" 4 \f[I]Authorization\f[] header value used for requests to \f[I]https://api.hdoujin.org\f[] -to access \f[I]favorite\f[] galleries. +to access \f[I]favorite\f[] galleries +or download +\f[I].cbz\f[] +archives. .SS extractor.hentaifoundry.descriptions @@ -4277,6 +4469,25 @@ when processing a user profile. It is possible to use \f[I]"all"\f[] instead of listing all values separately. +.SS extractor.itaku.order +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"desc"\f[] + +.IP "Description:" 4 +Controls the order in which +images/posts/users are returned. + +\f[I]"asc"\f[] | \f[I]"reverse"\f[] +Ascending order (oldest first) +\f[I]"desc"\f[] +Descending order (newest first) +any other \f[I]string\f[] +Custom result order + + .SS extractor.itaku.videos .IP "Type:" 6 \f[I]bool\f[] @@ -4605,6 +4816,17 @@ Additional query parameters to send when fetching manga chapters. and \f[I]/user/follows/manga/feed\f[]) +.SS extractor.mangadex.data-saver +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Enable Data Saver mode and download lower quality versions of chapters. + + .SS extractor.mangadex.lang .IP "Type:" 6 .br @@ -4764,6 +4986,17 @@ Also emit metadata for text-only posts without media content. Your access token, necessary to fetch favorited notes. +.SS extractor.[misskey].date-min & .date-max +.IP "Type:" 6 +\f[I]Date\f[] + +.IP "Default:" 9 +\f[I]null\f[] + +.IP "Description:" 4 +Retrieve only notes posted after/before this \f[I]Date\f[] + + .SS extractor.[misskey].include .IP "Type:" 6 .br @@ -4798,6 +5031,22 @@ when processing a user profile. It is possible to use \f[I]"all"\f[] instead of listing all values separately. +.SS extractor.[misskey].order-posts +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"desc"\f[] + +.IP "Description:" 4 +Controls the order in which posts are processed. + +\f[I]"asc"\f[] | \f[I]"reverse"\f[] +Ascending order (oldest first) +\f[I]"desc"\f[] +Descending order (newest first) + + .SS extractor.[misskey].renotes .IP "Type:" 6 \f[I]bool\f[] @@ -4820,6 +5069,17 @@ Fetch media from renoted notes. Fetch media from replies to other notes. +.SS extractor.[misskey].text-posts +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Also retrieve text-only notes without media content. + + .SS extractor.[moebooru].pool.metadata .IP "Type:" 6 \f[I]bool\f[] @@ -5153,6 +5413,36 @@ Selects the format of \f[I]images\f[] \f[I]files\f[]. * \f[I]thumbnail_small\f[] (\f[I]"h":100,"w":100\f[]) +.SS extractor.patreon.order-posts +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]collection\f[] +\f[I]"asc"\f[] +otherwise +\f[I]"desc"\f[] + +.IP "Example:" 4 +.br +* "-published_at" +.br +* "collection_order" + +.IP "Description:" 4 +Controls the order in which +posts are returned and processed. + +\f[I]"asc"\f[] +Ascending order (oldest first) +\f[I]"desc"\f[] +Descending order (newest first) +\f[I]"reverse"\f[] +Reverse order +any other \f[I]string\f[] +Custom \f[I]sort\f[] order + + .SS extractor.patreon.user.date-max .IP "Type:" 6 \f[I]Date\f[] @@ -5681,7 +5971,7 @@ or \f[I]"hq"\f[] if not present. \f[I]string\f[] .IP "Default:" 9 -\f[I]"oauth"\f[] +\f[I]"rest"\f[] .IP "Description:" 4 Selects which API endpoints to use. @@ -5859,7 +6149,7 @@ Follow links in the original post's \f[I]selftext\f[]. * \f[I]string\f[] .IP "Default:" 9 -\f[I]true\f[] +\f[I]"dash"\f[] .IP "Description:" 4 Control video download behavior. @@ -6029,6 +6319,21 @@ Download video embeds from external sites. Download videos. +.SS extractor.schalenetwork.cbz +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Download each gallery as a single \f[I].cbz\f[] file. + +.IP "Note:" 4 +Requires a +\f[I]token\f[] + + .SS extractor.schalenetwork.crt .IP "Type:" 6 \f[I]string\f[] @@ -6115,7 +6420,10 @@ for example \f[I]tags_artist\f[] or \f[I]tags_character\f[]. .IP "Description:" 4 \f[I]Authorization\f[] header value used for requests to \f[I]https://api.schale.network\f[] -to access \f[I]favorite\f[] galleries. +to access \f[I]favorite\f[] galleries +or download +\f[I].cbz\f[] +archives. .SS extractor.sexcom.gifs @@ -6129,23 +6437,6 @@ to access \f[I]favorite\f[] galleries. Download animated images as \f[I].gif\f[] instead of \f[I].webp\f[] -.SS extractor.simpcity.order-posts -.IP "Type:" 6 -\f[I]string\f[] - -.IP "Default:" 9 -\f[I]"desc"\f[] - -.IP "Description:" 4 -Controls the order in which -posts of a \f[I]thread\f[] are processed. - -\f[I]"asc"\f[] -Ascending order (oldest first) -\f[I]"desc"\f[] | \f[I]"reverse"\f[] -Descending order (newest first) - - .SS extractor.sizebooru.metadata .IP "Type:" 6 \f[I]bool\f[] @@ -6558,6 +6849,17 @@ Download audio tracks using \f[I]ytdl\f[] Ignore audio tracks +.SS extractor.tiktok.covers +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Download video covers. + + .SS extractor.tiktok.videos .IP "Type:" 6 \f[I]bool\f[] @@ -7091,6 +7393,27 @@ Known available sizes are * \f[I]360x360\f[] +.SS extractor.twitter.limit +.IP "Type:" 6 +.br +* \f[I]integer\f[] +.br +* \f[I]list\f[] of \f[I]integers\f[] + +.IP "Default:" 9 +\f[I]50\f[] + +.IP "Example:" 4 +[40, 30, 20, 10, 5] + +.IP "Description:" 4 +Number of requested results per API query. + +When given as a \f[I]list\f[], +start with the first element as \f[I]count\f[] parameter +and switch to the next element whenever no results are returned. + + .SS extractor.twitter.logout .IP "Type:" 6 \f[I]bool\f[] @@ -7183,6 +7506,19 @@ It is possible to exclude unwanted Tweets using \f[I]image-filter <extractor.*.image-filter_>\f[]. +.SS extractor.twitter.retries-api +.IP "Type:" 6 +\f[I]integer\f[] + +.IP "Default:" 9 +\f[I]9\f[] + +.IP "Description:" 4 +Maximum number of retries +for API requests when encountering server \f[I]errors\f[], +or \f[I]-1\f[] for infinite retries. + + .SS extractor.twitter.retweets .IP "Type:" 6 \f[I]bool\f[] @@ -7199,14 +7535,26 @@ will be taken from the original Tweets, not the Retweets. .SS extractor.twitter.search-limit .IP "Type:" 6 -\f[I]integer\f[] +.br +* \f[I]integer\f[] +.br +* \f[I]list\f[] of \f[I]integers\f[] .IP "Default:" 9 \f[I]20\f[] +.IP "Example:" 4 +[50, 20, 10, 5, 2] + .IP "Description:" 4 Number of requested results per search query. +When given as a \f[I]list\f[], +start with the first element as \f[I]count\f[] parameter +and switch to the next element when +\f[I]search-stop\f[] +is reached. + .SS extractor.twitter.search-pagination .IP "Type:" 6 @@ -7225,15 +7573,31 @@ Update the \f[I]max_id\f[] search query parameter to the Tweet ID value of the last retrieved Tweet. -.SS extractor.twitter.search-stop +.SS extractor.twitter.search-results .IP "Type:" 6 -\f[I]integer\f[] +\f[I]string\f[] .IP "Default:" 9 +\f[I]"latest"\f[] + +.IP "Description:" 4 +Determines the target of search results. + +.IP "Supported Values:" 4 .br -* \f[I]3\f[] if \f[I]search-pagination\f[] is set to \f[I]"cursor"\f[] +* \f[I]"top"\f[] .br -* \f[I]0\f[] otherwise +* \f[I]"media"\f[] +.br +* \f[I]"latest"\f[] | \f[I]"live"\f[] + + +.SS extractor.twitter.search-stop +.IP "Type:" 6 +\f[I]integer\f[] + +.IP "Default:" 9 +\f[I]3\f[] .IP "Description:" 4 Number of empty search result batches @@ -7298,18 +7662,6 @@ 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 be entered in an interactive prompt. - - .SS extractor.twitter.users .IP "Type:" 6 \f[I]string\f[] @@ -7318,7 +7670,7 @@ this identifier will need to be entered in an interactive prompt. \f[I]"user"\f[] .IP "Example:" 4 -"https://twitter.com/search?q=from:{legacy[screen_name]}" +"https://twitter.com/search?q=from:{core[screen_name]}" .IP "Description:" 4 Basic format string for user URLs generated from @@ -7723,6 +8075,18 @@ If this value is \f[I]"original"\f[], metadata for these files will be taken from the original posts, not the retweeted posts. +.SS extractor.weibo.text +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Extract full \f[I]text\f[] & \f[I]text_raw\f[] metadata +for statuses with truncated \f[I]text\f[]. + + .SS extractor.weibo.videos .IP "Type:" 6 \f[I]bool\f[] @@ -7734,6 +8098,21 @@ will be taken from the original posts, not the retweeted posts. Download video files. +.SS extractor.wikimedia.format +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]fandom\f[] | \f[I]wikigg\f[] +\f[I]"original"\f[] +otherwise +\f[I]""\f[] + +.IP "Description:" 4 +Sets the format query parameter value +added to all download URLs. + + .SS extractor.wikimedia.image-revisions .IP "Type:" 6 \f[I]integer\f[] @@ -7777,6 +8156,23 @@ The value must be between 10 and 500. For \f[I]Category:\f[] pages, recursively descent into subcategories. +.SS extractor.[xenforo].order-posts +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"desc"\f[] + +.IP "Description:" 4 +Controls the order in which +posts of a \f[I]thread\f[] are processed. + +\f[I]"asc"\f[] +Ascending order (oldest first) +\f[I]"desc"\f[] | \f[I]"reverse"\f[] +Descending order (newest first) + + .SS extractor.ytdl.cmdline-args .IP "Type:" 6 .br @@ -8148,17 +8544,35 @@ into the actual output files. .SS downloader.*.part-directory .IP "Type:" 6 -\f[I]Path\f[] +.br +* \f[I]Path\f[] +.br +* \f[I]object\f[] (\f[I]Condition\f[] → \f[I]Path\f[]) .IP "Default:" 9 \f[I]null\f[] +.IP "Example:" 4 +.. code:: json + +"/tmp/.gdl" + +.. code:: json + +{ +"size > 100000": "~/.gdl/part", +"duration" : "/tmp/.gdl/video", +} + + .IP "Description:" 4 -Alternate location for \f[I].part\f[] files. +Alternate location(s) for \f[I].part\f[] files. + +.IP "Note:" 4 +If this value is \f[I]null\f[] or no \f[I]Conditions\f[] apply, +\f[I].part\f[] files are stored alongside the actual output files. -Missing directories will be created as needed. -If this value is \f[I]null\f[], \f[I].part\f[] files are going to be stored -alongside the actual output files. +For a single \f[I]Path\f[], missing directories will be created as needed .SS downloader.*.progress @@ -8842,8 +9256,6 @@ File to write logging output to. .IP "Description:" 4 File to write external URLs unsupported by *gallery-dl* to. -The default \f[I]Format String\f[] here is \f[I]"{message}"\f[]. - .SS output.errorfile .IP "Type:" 6 @@ -8855,8 +9267,6 @@ The default \f[I]Format String\f[] here is \f[I]"{message}"\f[]. .IP "Description:" 4 File to write input URLs which returned an error to. -The default \f[I]Format String\f[] here is also \f[I]"{message}"\f[]. - When combined with \f[I]-I\f[]/\f[I]--input-file-comment\f[] or \f[I]-x\f[]/\f[I]--input-file-delete\f[], @@ -9093,6 +9503,18 @@ On POSIX systems, this means enabling the to have it call \f[I]setsid()\f[]. +.SS exec.verbose +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Include \f[I]command\f[] +arguments in logging messages. + + .SS hash.chunk-size .IP "Type:" 6 \f[I]integer\f[] @@ -9200,9 +9622,14 @@ Write metadata using \f[I]json.dump()\f[] Write metadata in \f[I]JSON Lines\f[] format \f[I]"tags"\f[] Write \f[I]tags\f[] separated by newlines +\f[I]"print"\f[] +Write the result of applying +\f[I]content-format\f[] +to \f[I]stdout\f[] \f[I]"custom"\f[] -Write the result of applying \f[I]metadata.content-format\f[] -to a file's metadata dictionary +Write the result of applying +\f[I]content-format\f[] +to \f[I]a file\f[] \f[I]"modify"\f[] Add or modify metadata entries \f[I]"delete"\f[] @@ -9518,7 +9945,7 @@ Only applies to \f[I]"mode": "json"\f[] and \f[I]"jsonl"\f[]. .IP "Type:" 6 \f[I]string\f[] -.IP "Defsult:" 4 +.IP "Default:" 9 \f[I]"w"\f[] .IP "Description:" 4 @@ -9535,7 +9962,7 @@ See the \f[I]mode\f[] argument of \f[I]open()\f[] for further details. .IP "Type:" 6 \f[I]string\f[] -.IP "Defsult:" 4 +.IP "Default:" 9 \f[I]"utf-8"\f[] .IP "Description:" 4 @@ -9544,6 +9971,31 @@ Name of the encoding used to encode a file's content. See the \f[I]encoding\f[] argument of \f[I]open()\f[] for further details. +.SS metadata.newline +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]null\f[] + +.IP "Description:" 4 +The newline sequence used in metadata files. + +If \f[I]null\f[], any \f[I]\\n\f[] characters +written are translated to the system default line separator. + +See the \f[I]newline\f[] argument of \f[I]open()\f[] for further details. + +.IP "Supported Values:" 4 +\f[I]null\f[] +Any \f[I]\\n\f[] characters +written are translated to the system default line separator. +\f[I]""\f[] \f[I] \f[I]"\\n"\f[] +Don't replace newline characters. +\f[I]"\\r"\f[] \f[] \f[I]"\\r\\n"\f[] +Replace newline characters with the given sequence. + + .SS metadata.private .IP "Type:" 6 \f[I]bool\f[] @@ -10710,7 +11162,8 @@ in a JSON file. "format" : "{asctime} {name}: {message}", "format-date": "%H:%M:%S", "path" : "~/log.txt", -"encoding" : "ascii" +"encoding" : "ascii", +"defer" : true } .. code:: json @@ -10744,7 +11197,12 @@ it is also possible to access the current and keywords objects and their attributes, for example \f[I]"{extractor.url}"\f[], \f[I]"{path.filename}"\f[], \f[I]"{keywords.title}"\f[] .br -* Default: \f[I]"[{name}][{levelname}] {message}"\f[] +* Default: +\f[I]"[{name}][{levelname}] {message}"\f[] for +\f[I]logfile\f[], +\f[I]"{message}"\f[] for +\f[I]unsupportedfile\f[] and +\f[I]errorfile\f[] .br * format-date .br @@ -10770,17 +11228,35 @@ and keywords objects and their attributes, for example use \f[I]"w"\f[] to truncate or \f[I]"a"\f[] to append (see \f[I]open()\f[]) .br -* Default: \f[I]"w"\f[] +* Default: +\f[I]"w"\f[] for +\f[I]logfile\f[] and +\f[I]unsupportedfile\f[], +\f[I]"a"\f[] for +\f[I]errorfile\f[] .br * encoding .br * File encoding .br * Default: \f[I]"utf-8"\f[] +.br +* defer +.br +* Defer file opening/creation until writing the first logging message +.br +* Default: +\f[I]false\f[] for +\f[I]logfile\f[], +\f[I]true\f[] for +\f[I]unsupportedfile\f[] and +\f[I]errorfile\f[] + .IP "Note:" 4 -path, mode, and encoding are only applied when configuring -logging output to a file. +path, mode, encoding, and defer +are only applied when configuring logging output to a file. +(See \f[I]logging.FileHandler\f[]) .SS Postprocessor Configuration |
