diff options
Diffstat (limited to 'data/man/gallery-dl.conf.5')
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 148 |
1 files changed, 139 insertions, 9 deletions
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index a36e108..ba4bb3e 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-09-28" "1.27.5" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2024-10-11" "1.27.6" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -772,7 +772,7 @@ Setting this value to \f[I]"browser"\f[] will try to automatically detect and use the User-Agent used by the system's default browser. Note: This option has no effect on -pixiv, e621, and mangadex +pixiv, e621, mangadex, and patreon extractors, as these need specific values to function correctly. @@ -782,7 +782,7 @@ extractors, as these need specific values to function correctly. .IP "Default:" 9 .br -* \f[I]"firefox"\f[]: \f[I]artstation\f[], \f[I]mangasee\f[], \f[I]patreon\f[], \f[I]pixiv:series\f[], \f[I]twitter\f[] +* \f[I]"firefox"\f[]: \f[I]artstation\f[], \f[I]mangasee\f[], \f[I]twitter\f[] .br * \f[I]null\f[]: otherwise @@ -868,7 +868,7 @@ to be passed to .IP "Default:" 9 .br -* \f[I]false\f[]: \f[I]artstation\f[], \f[I]patreon\f[], \f[I]pixiv:series\f[] +* \f[I]false\f[]: \f[I]artstation\f[] .br * \f[I]true\f[]: otherwise @@ -1761,6 +1761,63 @@ Process reposts. Download videos. +.SS extractor.boosty.allowed +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Request only available posts. + + +.SS extractor.boosty.bought +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Request only purchased posts for \f[I]feed\f[] results. + + +.SS extractor.boosty.metadata +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Provide detailed \f[I]user\f[] metadata. + + +.SS extractor.boosty.videos +.IP "Type:" 6 +.br +* \f[I]bool\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Example:" 4 +["full_hd", "high", "medium"] + +.IP "Description:" 4 +Download videos. + +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[] + + .SS extractor.bunkr.tlds .IP "Type:" 6 \f[I]bool\f[] @@ -1799,7 +1856,7 @@ Available types are \f[I]string\f[] .IP "Default:" 9 -\f[I]"rest"\f[] +\f[I]"trpc"\f[] .IP "Description:" 4 Selects which API endpoints to use. @@ -1807,7 +1864,7 @@ Selects which API endpoints to use. .br * \f[I]"rest"\f[]: \f[I]Public REST API\f[] .br -* \f[I]"trpc"\f[]: Internal TRPC API +* \f[I]"trpc"\f[]: Internal tRPC API .SS extractor.civitai.api-key @@ -1839,6 +1896,28 @@ Available types are \f[I]gallery\f[]. +.SS extractor.civitai.include +.IP "Type:" 6 +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] + +.IP "Default:" 9 +\f[I]["user-models", "user-posts"]\f[] + +.IP "Description:" 4 +A (comma-separated) list of subcategories to include +when processing a user profile. + +Possible values are +\f[I]"user-models"\f[], +\f[I]"user-posts"\f[], +\f[I]"user-images"\f[]. + +It is possible to use \f[I]"all"\f[] instead of listing all values separately. + + .SS extractor.civitai.nsfw .IP "Type:" 6 .br @@ -2620,6 +2699,20 @@ Selects an alternative source to download files from. * \f[I]"hitomi"\f[]: Download the corresponding gallery from \f[I]hitomi.la\f[] +.SS extractor.fanbox.comments +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Extract \f[I]comments\f[] metadata. + +Note: This requires 1 or more additional API requests per post, +depending on the number of comments. + + .SS extractor.fanbox.embeds .IP "Type:" 6 .br @@ -2657,13 +2750,25 @@ extraction and download for YouTube, Vimeo, and SoundCloud embeds. .IP "Example:" 4 .br -* user,plan +* user,plan,comments .br -* ["user", "plan"] +* ["user", "plan", "comments"] .IP "Description:" 4 Extract \f[I]plan\f[] and extended \f[I]user\f[] metadata. +Supported fields when selecting which data to extract are + +.br +* \f[I]comments\f[] +.br +* \f[I]plan\f[] +.br +* \f[I]user\f[] + +Note: \f[I]comments\f[] can also be enabled via +\f[I]fanbox.comments\f[] + .SS extractor.flickr.access-token & .access-token-secret .IP "Type:" 6 @@ -3987,7 +4092,21 @@ For works bookmarked by \f[I]your own account\f[], fetch bookmark tags as \f[I]tags_bookmark\f[] metadata. -Note: This requires 1 additional API call per bookmarked post. +Note: This requires 1 additional API request per bookmarked post. + + +.SS extractor.pixiv.comments +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Fetch \f[I]comments\f[] metadata. + +Note: This requires 1 or more additional API requests per post, +depending on the number of comments. .SS extractor.pixiv.work.related @@ -4054,6 +4173,17 @@ When downloading galleries, this sets the maximum number of posts to get. A value of \f[I]0\f[] means no limit. +.SS extractor.pixiv.sanity +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Try to fetch \f[I]limit_sanity_level\f[] works via web API. + + .SS extractor.plurk.comments .IP "Type:" 6 \f[I]bool\f[] |
