aboutsummaryrefslogtreecommitdiffstats
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.5157
1 files changed, 151 insertions, 6 deletions
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5
index ba2e048..1c2a2a0 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-05-04" "1.29.6" "gallery-dl Manual"
+.TH "GALLERY-DL.CONF" "5" "2025-05-23" "1.29.7" "gallery-dl Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -814,6 +814,8 @@ or a \f[I]list\f[] with IP and explicit port number as elements.
.br
* \f[I]"gallery-dl/VERSION (by mikf)"\f[]: \f[I][E621]\f[]
.br
+* \f[I]"net.umanle.arca.android.playstore/0.9.75"\f[]: \f[I]arcalive\f[]
+.br
* \f[I]"Patreon/72.2.28 (Android; Android 14; Scale/2.10)"\f[]: \f[I]patreon\f[]
.br
* \f[I]"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/LATEST.0.0.0 Safari/537.36"\f[]: \f[I]instagram\f[]
@@ -838,7 +840,7 @@ is enabled.
.IP "Default:" 9
.br
-* \f[I]"firefox"\f[]: \f[I]artstation\f[], \f[I]mangasee\f[], \f[I]twitter\f[]
+* \f[I]"firefox"\f[]: \f[I]artstation\f[], \f[I]fanbox\f[], \f[I]mangasee\f[], \f[I]twitter\f[]
.br
* \f[I]null\f[]: otherwise
@@ -2190,7 +2192,7 @@ Note: This requires 1 additional HTTP request per image or video.
\f[I]true\f[]
.IP "Description:" 4
-Download images rated NSFW.
+Download NSFW-rated images.
.br
* For \f[I]"api": "rest"\f[], this can be one of
@@ -2201,9 +2203,9 @@ to set the highest returned mature content flag.
* For \f[I]"api": "trpc"\f[], this can be an \f[I]integer\f[]
whose bits select the returned mature content flags.
-For example, \f[I]12\f[] (\f[I]4\f[I]8\f[]) would return only
-\f[I]Mature\f[] and \f[I]X\f[] rated images,
-while \f[I]3\f[] (\f[I]1\f[]2\f[]) would return only
+For example, \f[I]28\f[] (\f[I]4\f[I]8\f[]16\f[]) would return only
+\f[I]R\f[], \f[I]X\f[], and \f[I]XXX\f[] rated images,
+while \f[I]3\f[] (\f[I]1|2\f[]) would return only
\f[I]None\f[] and \f[I]Soft\f[] rated images,
@@ -2233,6 +2235,32 @@ Note: Set this option to an arbitrary letter, e.g., \f[I]"w"\f[],
to download images in JPEG format at their original resolution.
+.SS extractor.civitai.quality-videos
+.IP "Type:" 6
+.br
+* \f[I]string\f[]
+.br
+* \f[I]list\f[] of \f[I]strings\f[]
+
+.IP "Default:" 9
+\f[I]"quality=100"\f[]
+
+.IP "Example:" 4
+.br
+* "+transcode=true,quality=100"
+.br
+* ["+", "transcode=true", "quality=100"]
+
+.IP "Description:" 4
+A (comma-separated) list of video quality options
+to pass with every video URL.
+
+Known available options include \f[I]original\f[], \f[I]quality\f[], \f[I]transcode\f[]
+
+Use \f[I]+\f[] as first character to add the given options to the
+\f[I]quality\f[] ones.
+
+
.SS extractor.cyberdrop.domain
.IP "Type:" 6
\f[I]string\f[]
@@ -3096,6 +3124,20 @@ Note: This requires 1 additional API call per photo.
See \f[I]flickr.photos.getExif\f[] for details.
+.SS extractor.flickr.info
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+For each photo, retrieve its "full" metadata as provided by
+\f[I]flickr.photos.getInfo\f[]
+
+Note: This requires 1 additional API call per photo.
+
+
.SS extractor.flickr.metadata
.IP "Type:" 6
.br
@@ -3124,6 +3166,20 @@ in \f[I]Flickr's API docs\f[]
for possible field names.
+.SS extractor.flickr.profile
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Extract additional \f[I]user\f[] profile metadata.
+
+Note: This requires 1 additional API call per user profile.
+See \f[I]flickr.people.getInfo\f[] for details.
+
+
.SS extractor.flickr.videos
.IP "Type:" 6
\f[I]bool\f[]
@@ -3583,6 +3639,18 @@ Download pre-merged video formats
Do not download videos
+.SS extractor.instagram.stories.split
+.IP "Type:" 6
+.br
+* \f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Split \f[I]stories\f[] elements into separate posts.
+
+
.SS extractor.itaku.videos
.IP "Type:" 6
\f[I]bool\f[]
@@ -4471,6 +4539,17 @@ Download from video pins.
Your account's \f[I]API key\f[]
+.SS extractor.pixeldrain.recursive
+.IP "Type:" 6
+\f[I]bool\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Recursively download files from subfolders.
+
+
.SS extractor.pixiv.include
.IP "Type:" 6
.br
@@ -4975,6 +5054,47 @@ Format of \f[I]id\f[] metadata fields.
Refresh download URLs before they expire.
+.SS extractor.sankaku.tags
+.IP "Type:" 6
+.br
+* \f[I]bool\f[]
+.br
+* \f[I]string\f[]
+
+.IP "Default:" 9
+\f[I]false\f[]
+
+.IP "Description:" 4
+Group \f[I]tags\f[] by type and
+.br
+provide them as \f[I]tags_TYPE\f[] and \f[I]tag_string_TYPE\f[] metadata fields,
+for example \f[I]tags_artist\f[] and \f[I]tags_character\f[].
+.br
+
+\f[I]true\f[]
+Enable general \f[I]tags\f[] categories
+
+Requires:
+
+.br
+* 1 additional API request per 100 tags per post
+
+\f[I]"extended"\f[]
+Group \f[I]tags\f[] by the new, extended tag category system
+used on \f[I]chan.sankakucomplex.com\f[]
+
+Requires:
+
+.br
+* 1 additional HTTP request per post
+.br
+* logged-in \f[I]cookies\f[]
+to fetch full \f[I]tags\f[] category data
+
+\f[I]false\f[]
+Disable \f[I]tags\f[] categories
+
+
.SS extractor.sankakucomplex.embeds
.IP "Type:" 6
\f[I]bool\f[]
@@ -8804,6 +8924,31 @@ and click "SUBMIT"
as \f[I]"api-key"\f[] and \f[I]"api-secret"\f[]
+.SS extractor.mangadex.client-id & .client-secret
+.IP "Type:" 6
+\f[I]string\f[]
+
+.IP "How To:" 4
+.br
+* login and go to your \f[I]User Settings\f[]
+.br
+* open the "API Clients" section
+.br
+* click "\f[I]+ Create\f[]"
+.br
+* choose a name
+.br
+* click "\f[I]✔️ Create\f[]"
+.br
+* wait for approval / reload the page
+.br
+* copy the value after "AUTOAPPROVED ACTIVE" in the form "personal-client-..."
+and put it in your configuration file as \f[I]"client-id"\f[]
+.br
+* click "\f[I]Get Secret\f[]", then "\f[I]Copy Secret\f[]",
+and paste it into your configuration file as \f[I]"client-secret"\f[]
+
+
.SS extractor.reddit.client-id & .user-agent
.IP "Type:" 6
\f[I]string\f[]