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.5131
1 files changed, 108 insertions, 23 deletions
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5
index aa998ee..6ae0276 100644
--- a/data/man/gallery-dl.conf.5
+++ b/data/man/gallery-dl.conf.5
@@ -1,4 +1,4 @@
-.TH "GALLERY-DL.CONF" "5" "2022-04-27" "1.21.2" "gallery-dl Manual"
+.TH "GALLERY-DL.CONF" "5" "2022-05-25" "1.22.0" "gallery-dl Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -480,20 +480,23 @@ Enable the use of \f[I].netrc\f[] authentication data.
.SS extractor.*.cookies
.IP "Type:" 6
-\f[I]Path\f[] or \f[I]object\f[]
+\f[I]Path\f[] or \f[I]object\f[] or \f[I]list\f[]
.IP "Default:" 9
\f[I]null\f[]
.IP "Description:" 4
-Source to read additional cookies from. Either as
+Source to read additional cookies from. This can be
.br
-* the \f[I]Path\f[] to a Mozilla/Netscape format cookies.txt file or
-.br
-* a JSON \f[I]object\f[] specifying cookies as a name-to-value mapping
+* The \f[I]Path\f[] to a Mozilla/Netscape format cookies.txt file
-Example:
+.. code:: json
+
+"~/.local/share/cookies-instagram-com.txt"
+
+.br
+* An \f[I]object\f[] specifying cookies as name-value pairs
.. code:: json
@@ -503,6 +506,21 @@ Example:
"isAdult" : "1"
}
+.br
+* A \f[I]list\f[] with up to 3 entries specifying a browser profile.
+
+.br
+* The first entry is the browser name
+.br
+* The optional second entry is a profile name or an absolote path to a profile directory
+.br
+* The optional third entry is the keyring to retrieve passwords for decrypting cookies from
+
+.. code:: json
+
+["firefox"]
+["chromium", "Private", "kwallet"]
+
.SS extractor.*.cookies-update
.IP "Type:" 6
@@ -1003,6 +1021,23 @@ The maximum possible value appears to be \f[I]1920\f[].
Download embedded videos hosted on https://www.blogger.com/
+.SS extractor.cyberdrop.domain
+.IP "Type:" 6
+\f[I]string\f[]
+
+.IP "Default:" 9
+\f[I]"auto"\f[]
+
+.IP "Example:" 4
+"cyberdrop.to"
+
+.IP "Description:" 4
+Specifies the domain used by \f[I]cyberdrop\f[] regardless of input URL.
+
+Setting this option to \f[I]"auto"\f[]
+uses the same domain as a given input URL.
+
+
.SS extractor.danbooru.external
.IP "Type:" 6
\f[I]bool\f[]
@@ -1741,6 +1776,21 @@ If the selected format is not available,
the first in the list gets chosen (usually mp3).
+.SS extractor.lolisafe.domain
+.IP "Type:" 6
+\f[I]string\f[]
+
+.IP "Default:" 9
+\f[I]"auto"\f[]
+
+.IP "Description:" 4
+Specifies the domain used by a \f[I]lolisafe\f[] extractor
+regardless of input URL.
+
+Setting this option to \f[I]"auto"\f[]
+uses the same domain as a given input URL.
+
+
.SS extractor.luscious.gif
.IP "Type:" 6
\f[I]bool\f[]
@@ -1896,7 +1946,7 @@ A (comma-separated) list of subcategories to include
when processing a user profile.
Possible values are
-\f[I]"illustration"\f[], \f[I]"doujin"\f[], \f[I]"favorite"\f[].
+\f[I]"illustration"\f[], \f[I]"doujin"\f[], \f[I]"favorite"\f[], \f[I]"nuita"\f[].
You can use \f[I]"all"\f[] instead of listing all values separately.
@@ -2026,29 +2076,33 @@ Include pins from board sections.
Download from video pins.
-.SS extractor.pixiv.user.avatar
+.SS extractor.pixiv.include
.IP "Type:" 6
-\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 "Description:" 4
-Download user avatars.
+\f[I]"artworks"\f[]
+.IP "Example:" 4
+.br
+* "avatar,background,artworks"
+.br
+* ["avatar", "background", "artworks"]
-.SS extractor.pixiv.user.background
-.IP "Type:" 6
-\f[I]bool\f[]
+.IP "Description:" 4
+A (comma-separated) list of subcategories to include
+when processing a user profile.
-.IP "Default:" 9
-\f[I]false\f[]
+Possible values are
+\f[I]"artworks"\f[], \f[I]"avatar"\f[], \f[I]"background"\f[], \f[I]"favorite"\f[].
-.IP "Description:" 4
-Download user background banners.
+It is possible to use \f[I]"all"\f[] instead of listing all values separately.
-.SS extractor.pixiv.user.metadata
+.SS extractor.pixiv.artworks.metadata
.IP "Type:" 6
\f[I]bool\f[]
@@ -2477,7 +2531,7 @@ See \f[I]Filters\f[] for details.
\f[I]bool\f[] or \f[I]string\f[]
.IP "Default:" 9
-\f[I]true\f[]
+\f[I]false\f[]
.IP "Description:" 4
Controls how to handle \f[I]Twitter Cards\f[].
@@ -2639,6 +2693,8 @@ Special values:
.br
* \f[I]"timeline"\f[]: \f[I]https://twitter.com/i/user/{rest_id}\f[]
.br
+* \f[I]"tweets"\f[]: \f[I]https://twitter.com/id:{rest_id}/tweets\f[]
+.br
* \f[I]"media"\f[]: \f[I]https://twitter.com/id:{rest_id}/media\f[]
Note: To allow gallery-dl to follow custom URL formats, set the \f[I]blacklist\f[]
@@ -2714,6 +2770,23 @@ Your \f[I]Weasyl API Key\f[],
to use your account's browsing settings and filters.
+.SS extractor.weasyl.metadata
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Fetch extra submission metadata during gallery downloads.
+.br
+(\f[I]comments\f[], \f[I]description\f[], \f[I]favorites\f[], \f[I]folder_name\f[],
+.br
+\f[I]tags\f[], \f[I]views\f[])
+
+Note: This requires 1 additional HTTP request per submission.
+
+
.SS extractor.weibo.retweets
.IP "Type:" 6
\f[I]bool\f[]
@@ -3252,6 +3325,18 @@ Set this option to \f[I]"eaw"\f[] to also work with east-asian characters
with a display width greater than 1.
+.SS output.colors
+.IP "Type:" 6
+\f[I]object\f[]
+
+.IP "Default:" 9
+\f[I]{"success": "1;32", "skip": "2"}\f[]
+
+.IP "Description:" 4
+Controls the \f[I]ANSI colors\f[]
+used with \f[I]mode: color\f[] for successfully downloaded or skipped files.
+
+
.SS output.skip
.IP "Type:" 6
\f[I]bool\f[]