summaryrefslogtreecommitdiffstats
path: root/data/man/gallery-dl.conf.5
diff options
context:
space:
mode:
Diffstat (limited to 'data/man/gallery-dl.conf.5')
-rw-r--r--data/man/gallery-dl.conf.543
1 files changed, 34 insertions, 9 deletions
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5
index f35f218..84e8e0e 100644
--- a/data/man/gallery-dl.conf.5
+++ b/data/man/gallery-dl.conf.5
@@ -1,4 +1,4 @@
-.TH "GALLERY-DL.CONF" "5" "2021-05-30" "1.17.5" "gallery-dl Manual"
+.TH "GALLERY-DL.CONF" "5" "2021-06-19" "1.18.0" "gallery-dl Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -75,14 +75,31 @@ those as makeshift comments by settings their values to arbitrary strings.
.SH EXTRACTOR OPTIONS
.SS extractor.*.filename
.IP "Type:" 6
-\f[I]string\f[]
+\f[I]string\f[] or \f[I]object\f[]
.IP "Example:" 4
+.br
+* .. code::
+
"{manga}_c{chapter}_{page:>03}.{extension}"
+.br
+* .. code:: json
+
+{
+"extension == 'mp4'": "{id}_video.{extension}",
+"'nature' in title" : "{id}_{title}.{extension}",
+"" : "{id}_default.{extension}"
+}
+
+
.IP "Description:" 4
-A \f[I]format string\f[] to build the resulting filename
-for a downloaded file.
+A \f[I]format string\f[] to build filenames for downloaded files with.
+
+If this is an \f[I]object\f[], it must contain Python expressions mapping to the
+filename format strings to use.
+These expressions are evaluated in the order as specified in Python 3.6+
+and in an undetermined order in Python 3.4 and 3.5.
The available replacement keys depend on the extractor used. A list
of keys for a specific one can be acquired by calling *gallery-dl*
@@ -358,9 +375,9 @@ and optional for
.br
* \f[I]aryion\f[]
.br
-* \f[I]danbooru\f[]
+* \f[I]danbooru\f[] (*)
.br
-* \f[I]e621\f[]
+* \f[I]e621\f[] (*)
.br
* \f[I]exhentai\f[]
.br
@@ -372,6 +389,8 @@ and optional for
.br
* \f[I]instagram\f[]
.br
+* \f[I]mangadex\f[]
+.br
* \f[I]mangoxo\f[]
.br
* \f[I]pillowfort\f[]
@@ -392,7 +411,7 @@ These values can also be specified via the
\f[I]-u/--username\f[] and \f[I]-p/--password\f[] command-line options or
by using a \f[I].netrc\f[] file. (see Authentication_)
-Note: The password value for \f[I]danbooru\f[] and \f[I]e621\f[] should be
+(*) The password value for \f[I]danbooru\f[] and \f[I]e621\f[] should be
the API key found in your user profile, not the actual account password.
@@ -1900,7 +1919,7 @@ Fetch media from all Tweets and replies in a \f[I]conversation
\f[I]bool\f[]
.IP "Default:" 9
-\f[I]true\f[]
+\f[I]false\f[]
.IP "Description:" 4
Fetch media from quoted Tweets.
@@ -1922,7 +1941,7 @@ Fetch media from replies to other Tweets.
\f[I]bool\f[]
.IP "Default:" 9
-\f[I]true\f[]
+\f[I]false\f[]
.IP "Description:" 4
Fetch media from Retweets.
@@ -3206,12 +3225,18 @@ logging output to a file.
"name" : "zip",
"compression": "store",
"extension" : "cbz",
+"filter" : "extension not in ('zip', 'rar')",
"whitelist" : ["mangadex", "exhentai", "nhentai"]
}
.IP "Description:" 4
An \f[I]object\f[] containing a \f[I]"name"\f[] attribute specifying the
post-processor type, as well as any of its \f[I]options\f[].
+
+It is possible to set a \f[I]"filter"\f[] expression similar to
+\f[I]image-filter\f[] to only run a post-processor
+conditionally.
+
It is also possible set a \f[I]"whitelist"\f[] or \f[I]"blacklist"\f[] to
only enable or disable a post-processor for the specified
extractor categories.