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.5127
1 files changed, 88 insertions, 39 deletions
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5
index aeecaa0..8dd3187 100644
--- a/data/man/gallery-dl.conf.5
+++ b/data/man/gallery-dl.conf.5
@@ -1,4 +1,4 @@
-.TH "GALLERY-DL.CONF" "5" "2020-10-11" "1.15.1" "gallery-dl Manual"
+.TH "GALLERY-DL.CONF" "5" "2020-10-24" "1.15.2" "gallery-dl Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -325,6 +325,8 @@ and optional for
.br
* \f[I]luscious\f[]
.br
+* \f[I]pinterest\f[]
+.br
* \f[I]sankaku\f[]
.br
* \f[I]subscribestar\f[]
@@ -333,13 +335,12 @@ and optional for
.br
* \f[I]twitter\f[]
-These values can also be set 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_)
+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 values for \f[I]danbooru\f[] and \f[I]e621\f[] should be
-the API keys found in your user profile, not your actual account
-password.
+Note: 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.
.SS extractor.*.netrc
@@ -370,7 +371,7 @@ Source to read additional cookies from. Either as
Example:
-.. code::
+.. code:: json
{
"cookie-name": "cookie-value",
@@ -414,10 +415,10 @@ See \f[I]Requests' proxy documentation\f[] for more details.
Example:
-.. code::
+.. code:: json
{
-"http": "http://10.10.1.10:3128",
+"http" : "http://10.10.1.10:3128",
"https": "http://10.10.1.10:1080",
"http://10.20.1.128": "http://10.10.1.10:5323"
}
@@ -533,18 +534,43 @@ An alternative \f[I]format string\f[] to build archive IDs with.
\f[I]list\f[] of \f[I]Postprocessor Configuration\f[] objects
.IP "Example:" 4
-.. code::
+.. code:: json
[
-{"name": "zip", "compression": "zip"},
-{"name": "exec", "command": ["/home/foobar/script", "{category}", "{image_id}"]}
+{
+"name": "zip" ,
+"compression": "store"
+},
+{
+"name": "exec",
+"command": ["/home/foobar/script", "{category}", "{image_id}"]
+}
]
.IP "Description:" 4
-A list of \f[I]post-processors\f[]
+A list of \f[I]post processors\f[]
to be applied to each downloaded file in the specified order.
+Unlike other options, a \f[I]postprocessors\f[] setting at a deeper level
+.br
+does not override any \f[I]postprocessors\f[] setting at a lower level.
+Instead, all post processors from all applicable \f[I]postprocessors\f[]
+.br
+settings get combined into a single list.
+
+For example
+
+.br
+* an \f[I]mtime\f[] post processor at \f[I]extractor.postprocessors\f[],
+.br
+* a \f[I]zip\f[] post processor at \f[I]extractor.pixiv.postprocessors\f[],
+.br
+* and using \f[I]--exec\f[]
+
+will run all three post processors - \f[I]mtime\f[], \f[I]zip\f[], \f[I]exec\f[] -
+for each downloaded \f[I]pixiv\f[] file.
+
.SS extractor.*.retries
.IP "Type:" 6
@@ -555,7 +581,7 @@ to be applied to each downloaded file in the specified order.
.IP "Description:" 4
Maximum number of times a failed HTTP request is retried before
-giving up or \f[I]-1\f[] for infinite retries.
+giving up, or \f[I]-1\f[] for infinite retries.
.SS extractor.*.timeout
@@ -1596,6 +1622,17 @@ Possible types are \f[I]text\f[], \f[I]quote\f[], \f[I]link\f[], \f[I]answer\f[]
You can use \f[I]"all"\f[] instead of listing all types separately.
+.SS extractor.twitter.cards
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Fetch media from \f[I]Cards\f[].
+
+
.SS extractor.twitter.quoted
.IP "Type:" 6
\f[I]bool\f[]
@@ -1680,12 +1717,24 @@ Download video files.
\f[I]null\f[]
.IP "Description:" 4
-Your \f[I]API Key\f[] to use
-your account's browsing settings and default filters when searching.
+Your \f[I]Wallhaven API Key\f[],
+to use your account's browsing settings and default filters when searching.
See https://wallhaven.cc/help/api for more information.
+.SS extractor.weasyl.api-key
+.IP "Type:" 6
+\f[I]string\f[]
+
+.IP "Default:" 9
+\f[I]null\f[]
+
+.IP "Description:" 4
+Your \f[I]Weasyl API Key\f[],
+to use your account's browsing settings and filters.
+
+
.SS extractor.weibo.retweets
.IP "Type:" 6
\f[I]bool\f[]
@@ -1946,7 +1995,7 @@ cause unexpected results in combination with other options
\f[I]object\f[]
.IP "Example:" 4
-.. code::
+.. code:: json
{
"quiet": true,
@@ -2075,13 +2124,13 @@ before outputting them as JSON.
\f[I]object\f[]
.IP "Default:" 9
-.. code::
+.. code:: json
{
-"Pictures" : ["jpg", "jpeg", "png", "gif", "bmp", "svg", "webp"],
-"Video" : ["flv", "ogv", "avi", "mp4", "mpg", "mpeg", "3gp", "mkv", "webm", "vob", "wmv"],
-"Music" : ["mp3", "aac", "flac", "ogg", "wma", "m4a", "wav"],
-"Archives" : ["zip", "rar", "7z", "tar", "gz", "bz2"]
+"Pictures": ["jpg", "jpeg", "png", "gif", "bmp", "svg", "webp"],
+"Video" : ["flv", "ogv", "avi", "mp4", "mpg", "mpeg", "3gp", "mkv", "webm", "vob", "wmv"],
+"Music" : ["mp3", "aac", "flac", "ogg", "wma", "m4a", "wav"],
+"Archives": ["zip", "rar", "7z", "tar", "gz", "bz2"]
}
@@ -2489,11 +2538,11 @@ Submission Policy, and Terms of Service.
application and put them in your configuration file
as \f[I]"client-id"\f[] and \f[I]"client-secret"\f[]
.br
-* clear your \f[I]cache\f[] (\f[I]--clear-cache\f[]) to delete
-the \f[I]access-token\f[] from the previous \f[I]client-id\f[]
+* clear your \f[I]cache\f[] to delete any remaining
+\f[I]access-token\f[] entries. (\f[I]gallery-dl --clear-cache\f[])
.br
-* get a new \f[I]refresh-token\f[]
-if necessary
+* get a new \f[I]refresh-token\f[] for the
+new \f[I]client-id\f[] (\f[I]gallery-dl oauth:deviantart\f[])
.SS extractor.flickr.api-key & .api-secret
@@ -2636,19 +2685,19 @@ The path \f[I]C:\\path\\to\\file.ext\f[] has therefore to be written as
\f[I]object\f[]
.IP "Example:" 4
-.. code::
+.. code:: json
{
-"format": "{asctime} {name}: {message}",
+"format" : "{asctime} {name}: {message}",
"format-date": "%H:%M:%S",
-"path": "~/log.txt",
-"encoding": "ascii"
+"path" : "~/log.txt",
+"encoding" : "ascii"
}
-.. code::
+.. code:: json
{
-"level": "debug",
+"level" : "debug",
"format": {
"debug" : "debug: {message}",
"info" : "[{name}] {message}",
@@ -2710,7 +2759,7 @@ use \f[I]"w"\f[] to truncate or \f[I]"a"\f[] to append
.br
* Default: \f[I]"utf-8"\f[]
-Note: path, mode and encoding are only applied when configuring
+Note: path, mode, and encoding are only applied when configuring
logging output to a file.
@@ -2719,17 +2768,17 @@ logging output to a file.
\f[I]object\f[]
.IP "Example:" 4
-.. code::
+.. code:: json
{ "name": "mtime" }
-.. code::
+.. code:: json
{
-"name": "zip",
+"name" : "zip",
"compression": "store",
-"extension": "cbz",
-"whitelist": ["mangadex", "exhentai", "nhentai"]
+"extension" : "cbz",
+"whitelist" : ["mangadex", "exhentai", "nhentai"]
}
.IP "Description:" 4