aboutsummaryrefslogtreecommitdiffstats
path: root/data/man/gallery-dl.conf.5
diff options
context:
space:
mode:
authorLibravatarUnit 193 <unit193@unit193.net>2024-12-02 00:31:59 -0500
committerLibravatarUnit 193 <unit193@unit193.net>2024-12-02 00:31:59 -0500
commit1981ccaaea6eab2cf32536ec5afe132a870914d8 (patch)
tree013f1e17d922d3a6abf7f57aa6a175c2ce5d93bc /data/man/gallery-dl.conf.5
parentfc004701f923bb954a22c7fec2ae8d607e78cb2b (diff)
New upstream version 1.28.0.upstream/1.28.0
Diffstat (limited to 'data/man/gallery-dl.conf.5')
-rw-r--r--data/man/gallery-dl.conf.5180
1 files changed, 164 insertions, 16 deletions
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5
index 0ae8c38..c441095 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-10-25" "1.27.7" "gallery-dl Manual"
+.TH "GALLERY-DL.CONF" "5" "2024-11-30" "1.28.0" "gallery-dl Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -458,8 +458,8 @@ response before \f[I]retrying\f[] the request.
\f[I][Danbooru]\f[], \f[I][E621]\f[], \f[I][foolfuuka]:search\f[], \f[I]itaku\f[],
\f[I]koharu\f[],
\f[I]newgrounds\f[], \f[I][philomena]\f[], \f[I]pixiv:novel\f[], \f[I]plurk\f[],
-\f[I]poipiku\f[] , \f[I]pornpics\f[], \f[I]soundgasm\f[], \f[I]urlgalleries\f[],
-\f[I]vk\f[], \f[I]zerochan\f[]
+\f[I]poipiku\f[] , \f[I]pornpics\f[], \f[I]scrolller\f[], \f[I]soundgasm\f[],
+\f[I]urlgalleries\f[], \f[I]vk\f[], \f[I]zerochan\f[]
.br
* \f[I]"1.0-2.0"\f[]
\f[I]flickr\f[], \f[I]weibo\f[], \f[I][wikimedia]\f[]
@@ -468,7 +468,11 @@ response before \f[I]retrying\f[] the request.
\f[I]behance\f[], \f[I]imagefap\f[], \f[I][Nijie]\f[]
.br
* \f[I]"3.0-6.0"\f[]
-\f[I]exhentai\f[], \f[I]idolcomplex\f[], \f[I][reactor]\f[], \f[I]readcomiconline\f[]
+\f[I]bilibili\f[],
+\f[I]exhentai\f[],
+\f[I]idolcomplex\f[],
+\f[I][reactor]\f[],
+\f[I]readcomiconline\f[]
.br
* \f[I]"6.0-6.1"\f[]
\f[I]twibooru\f[]
@@ -734,10 +738,23 @@ It is also possible to set a proxy for a specific host by using
\f[I]scheme://host\f[] as key.
See \f[I]Requests' proxy documentation\f[] for more details.
-Note: If a proxy URLs does not include a scheme,
+Note: If a proxy URL does not include a scheme,
\f[I]http://\f[] is assumed.
+.SS extractor.*.proxy-env
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Collect proxy configuration information from environment variables
+(\f[I]HTTP_PROXY\f[], \f[I]HTTPS_PROXY\f[], \f[I]NO_PROXY\f[])
+and Windows Registry settings.
+
+
.SS extractor.*.source-address
.IP "Type:" 6
.br
@@ -1220,7 +1237,10 @@ Exit the program with the given argument as exit status.
.SS extractor.*.postprocessors
.IP "Type:" 6
-\f[I]list\f[] of \f[I]Postprocessor Configuration\f[] objects
+.br
+* \f[I]Postprocessor Configuration\f[] object
+.br
+* \f[I]list\f[] of \f[I]Postprocessor Configuration\f[] objects
.IP "Example:" 4
.. code:: json
@@ -1827,8 +1847,23 @@ If this is a \f[I]list\f[], it selects which format to try to download.
.br
Possibly available formats are
.br
-\f[I]"quad_hd"\f[], \f[I]"ultra_hd"\f[], \f[I]"full_hd"\f[],
-\f[I]"high"\f[], \f[I]"medium"\f[], \f[I]"low"\f[]
+
+.br
+* \f[I]ultra_hd\f[] (2160p)
+.br
+* \f[I]quad_hd\f[] (1440p)
+.br
+* \f[I]full_hd\f[] (1080p)
+.br
+* \f[I]high\f[] (720p)
+.br
+* \f[I]medium\f[] (480p)
+.br
+* \f[I]low\f[] (360p)
+.br
+* \f[I]lowest\f[] (240p)
+.br
+* \f[I]tiny\f[] (144p)
.SS extractor.bunkr.tlds
@@ -1931,6 +1966,30 @@ Possible values are
It is possible to use \f[I]"all"\f[] instead of listing all values separately.
+.SS extractor.civitai.metadata
+.IP "Type:" 6
+.br
+* \f[I]bool\f[]
+.br
+* \f[I]string\f[]
+.br
+* \f[I]list\f[] of \f[I]strings\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Example:" 4
+.br
+* "generation"
+.br
+* ["generation"]
+
+.IP "Description:" 4
+Extract additional \f[I]generation\f[] metadata.
+
+Note: This requires 1 additional HTTP request per image.
+
+
.SS extractor.civitai.nsfw
.IP "Type:" 6
.br
@@ -2090,7 +2149,7 @@ Controls the download target for Ugoira posts.
.IP "Example:" 4
.br
-* replacements,comments,ai_tags
+* "replacements,comments,ai_tags"
.br
* ["replacements", "comments", "ai_tags"]
@@ -2712,6 +2771,51 @@ Selects an alternative source to download files from.
* \f[I]"hitomi"\f[]: Download the corresponding gallery from \f[I]hitomi.la\f[]
+.SS extractor.exhentai.tags
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Group \f[I]tags\f[] by type and
+provide them as \f[I]tags_<type>\f[] metadata fields,
+for example \f[I]tags_artist\f[] or \f[I]tags_character\f[].
+
+
+.SS extractor.facebook.author-followups
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "description:" 4
+Extract comments that include photo attachments made by the author of the post.
+
+
+.SS extractor.facebook.videos
+.IP "Type:" 6
+.br
+* \f[I]bool\f[]
+.br
+* \f[I]string\f[]
+
+.IP "Default:" 9
+\f[I]true\f[]
+
+.IP "Description:" 4
+Control video download behavior.
+
+.br
+* \f[I]true\f[]: Extract and download video & audio separately.
+.br
+* \f[I]"ytdl"\f[]: Let \f[I]ytdl\f[] handle video extraction and download, and merge video & audio streams.
+.br
+* \f[I]false\f[]: Ignore videos.
+
+
.SS extractor.fanbox.comments
.IP "Type:" 6
\f[I]bool\f[]
@@ -3505,6 +3609,19 @@ Possible formats are
.br
+.SS extractor.koharu.tags
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Group \f[I]tags\f[] by type and
+provide them as \f[I]tags_<type>\f[] metadata fields,
+for example \f[I]tags_artist\f[] or \f[I]tags_character\f[].
+
+
.SS extractor.lolisafe.domain
.IP "Type:" 6
\f[I]string\f[]
@@ -4461,6 +4578,25 @@ If the format is given as \f[I]string\f[], it will be extended with
restrict it to only one possible format.
+.SS extractor.rule34xyz.format
+.IP "Type:" 6
+.br
+* \f[I]string\f[]
+.br
+* \f[I]list\f[] of \f[I]strings\f[]
+
+.IP "Default:" 9
+\f[I]["10", "40", "41", "2"]\f[]
+
+.IP "Example:" 4
+"33,34,4"
+
+.IP "Description:" 4
+Selects the file format to extract.
+
+When more than one format is given, the first available one is selected.
+
+
.SS extractor.sankaku.id-format
.IP "Type:" 6
\f[I]string\f[]
@@ -5954,8 +6090,9 @@ Automatically follow tag redirects.
\f[I]false\f[]
.IP "Description:" 4
-Categorize tags by their respective types
-and provide them as \f[I]tags_<type>\f[] metadata fields.
+Group \f[I]tags\f[] by type and
+provide them as \f[I]tags_<type>\f[] metadata fields,
+for example \f[I]tags_artist\f[] or \f[I]tags_character\f[].
Note: This requires 1 additional HTTP request per post.
@@ -6344,7 +6481,7 @@ See
\f[I]bool\f[]
.IP "Default:" 9
-\f[I]false\f[]
+\f[I]true\f[]
.IP "Description:" 4
Forward gallery-dl's cookies to \f[I]ytdl\f[].
@@ -7889,15 +8026,26 @@ this cache.
.SS filters-environment
.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
-Evaluate filter expressions raising an exception as \f[I]false\f[]
-instead of aborting the current extractor run
-by wrapping them in a try/except block.
+Evaluate filter expressions in a special environment
+preventing them from raising fatal exceptions.
+
+\f[I]true\f[] or \f[I]"tryexcept"\f[]:
+Wrap expressions in a try/except block;
+Evaluate expressions raising an exception as \f[I]false\f[]
+\f[I]false\f[] or \f[I]"raw"\f[]:
+Do not wrap expressions in a special environment
+\f[I]"defaultdict"\f[]:
+Prevent exceptions when accessing undefined variables
+by using a \f[I]defaultdict\f[]
.SS format-separator