diff options
Diffstat (limited to 'data')
| -rw-r--r-- | data/man/gallery-dl.1 | 2 | ||||
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 254 |
2 files changed, 235 insertions, 21 deletions
diff --git a/data/man/gallery-dl.1 b/data/man/gallery-dl.1 index 078ff4f..863d75d 100644 --- a/data/man/gallery-dl.1 +++ b/data/man/gallery-dl.1 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL" "1" "2024-02-17" "1.26.8" "gallery-dl Manual" +.TH "GALLERY-DL" "1" "2024-03-23" "1.26.9" "gallery-dl Manual" .\" disable hyphenation .nh diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index 4b349dd..7b57923 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-02-17" "1.26.8" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2024-03-23" "1.26.9" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -1308,6 +1308,28 @@ Try to follow external URLs of embedded players. Limit the number of posts/projects to download. +.SS extractor.artstation.previews +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Download video previews. + + +.SS extractor.artstation.videos +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Download video clips. + + .SS extractor.artstation.search.pro-first .IP "Type:" 6 \f[I]bool\f[] @@ -1448,6 +1470,17 @@ Sets the maximum depth of returned reply posts. (See depth parameter of \f[I]app.bsky.feed.getPostThread\f[]) +.SS extractor.bluesky.reposts +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Process reposts. + + .SS extractor.cyberdrop.domain .IP "Type:" 6 \f[I]string\f[] @@ -1605,6 +1638,19 @@ unwatch that user at the end of the current extractor run. Extract \f[I]comments\f[] metadata. +.SS extractor.deviantart.comments-avatars +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Download the avatar of each commenting user. + +Note: Enabling this option also enables deviantart.comments_. + + .SS extractor.deviantart.extra .IP "Type:" 6 \f[I]bool\f[] @@ -1775,14 +1821,46 @@ form of content filtering. .SS extractor.deviantart.metadata .IP "Type:" 6 -\f[I]bool\f[] +.br +* \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 "Example:" 4 +.br +* "stats,submission" +.br +* ["camera", "stats", "submission"] + .IP "Description:" 4 -Request extended metadata for deviation objects to additionally provide -\f[I]description\f[], \f[I]tags\f[], \f[I]license\f[] and \f[I]is_watching\f[] fields. +Extract additional metadata for deviation objects. + +Provides +\f[I]description\f[], \f[I]tags\f[], \f[I]license\f[], and \f[I]is_watching\f[] +fields when enabled. + +It is possible to request extended metadata by specifying a list of + +.br +* \f[I]camera\f[] : EXIF information (if available) +.br +* \f[I]stats\f[] : deviation statistics +.br +* \f[I]submission\f[] : submission information +.br +* \f[I]collection\f[] : favourited folder information (requires a \f[I]refresh token\f[]) +.br +* \f[I]gallery\f[] : gallery folder information (requires a \f[I]refresh token\f[]) + +Set this option to \f[I]"all"\f[] to request all extended metadata categories. + +See \f[I]/deviation/metadata\f[] +for official documentation. .SS extractor.deviantart.original @@ -2113,6 +2191,21 @@ The \f[I]access_token\f[] and \f[I]access_token_secret\f[] values you get from \f[I]linking your Flickr account to gallery-dl\f[]. +.SS extractor.flickr.contexts +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +For each photo, return the albums and pools it belongs to +as \f[I]set\f[] and \f[I]pool\f[] metadata. + +Note: This requires 1 additional API call per photo. +See \f[I]flickr.photos.getAllContexts\f[] for details. + + .SS extractor.flickr.exif .IP "Type:" 6 \f[I]bool\f[] @@ -2121,9 +2214,11 @@ from \f[I]linking your Flickr account to gallery-dl\f[]. \f[I]false\f[] .IP "Description:" 4 -Fetch exif and camera metadata for each photo. +For each photo, return its EXIF/TIFF/GPS tags +as \f[I]exif\f[] and \f[I]camera\f[] metadata. Note: This requires 1 additional API call per photo. +See \f[I]flickr.photos.getExif\f[] for details. .SS extractor.flickr.metadata @@ -2150,7 +2245,7 @@ Extract additional metadata It is possible to specify a custom list of metadata includes. See \f[I]the extras parameter\f[] -in \f[I]Flickr API docs\f[] +in \f[I]Flickr's API docs\f[] for possible field names. @@ -2271,6 +2366,24 @@ Values from the API Access Credentials section found at the bottom of your page. +.SS extractor.gelbooru.favorite.order-posts +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"desc"\f[] + +.IP "Description:" 4 +Controls the order in which favorited posts are returned. + +.br +* \f[I]"asc"\f[]: Ascending favorite date order (oldest first) +.br +* \f[I]"desc"\f[]: Descending favorite date order (newest first) +.br +* \f[I]"reverse"\f[]: Same as \f[I]"asc"\f[] + + .SS extractor.generic.enabled .IP "Type:" 6 \f[I]bool\f[] @@ -2668,6 +2781,26 @@ Set this to \f[I]"unique"\f[] to filter out duplicate revisions. Note: This requires 1 additional HTTP request per post. +.SS extractor.kemonoparty.order-revisions +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"desc"\f[] + +.IP "Description:" 4 +Controls the order in which +\f[I]revisions\f[] +are returned. + +.br +* \f[I]"asc"\f[]: Ascending order (oldest first) +.br +* \f[I]"desc"\f[]: Descending order (newest first) +.br +* \f[I]"reverse"\f[]: Same as \f[I]"asc"\f[] + + .SS extractor.khinsider.format .IP "Type:" 6 \f[I]string\f[] @@ -3742,7 +3875,7 @@ used to specify all dimensions. Valid values are: .IP "Description:" 4 Only include assets that are in the specified file types. \f[I]all\f[] can be -used to specifiy all file types. Valid values are: +used to specify all file types. Valid values are: .br * Grids: \f[I]png\f[], \f[I]jpeg\f[], \f[I]jpg\f[], \f[I]webp\f[] @@ -3794,7 +3927,7 @@ Include assets tagged with humor when downloading from a list of assets. .IP "Description:" 4 Only include assets that are in the specified languages. \f[I]all\f[] can be -used to specifiy all languages. Valid values are \f[I]ISO 639-1\f[] +used to specify all languages. Valid values are \f[I]ISO 639-1\f[] language codes. @@ -4320,6 +4453,22 @@ Selects how to handle exceeding the API rate limit. * \f[I]"wait"\f[]: Wait until rate limit reset +.SS extractor.twitter.locked +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"abort"\f[] + +.IP "Description:" 4 +Selects how to handle "account is temporarily locked" errors. + +.br +* \f[I]"abort"\f[]: Raise an error and stop extraction +.br +* \f[I]"wait"\f[]: Wait until the account is unlocked and retry + + .SS extractor.twitter.replies .IP "Type:" 6 \f[I]bool\f[] @@ -4481,6 +4630,33 @@ Available formats are \f[I]"raw"\f[], \f[I]"full"\f[], \f[I]"regular"\f[], \f[I]"small"\f[], and \f[I]"thumb"\f[]. +.SS extractor.vipergirls.domain +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"vipergirls.to"\f[] + +.IP "Description:" 4 +Specifies the domain used by \f[I]vipergirls\f[] extractors. + +For example \f[I]"viper.click"\f[] if the main domain is blocked or to bypass Cloudflare, + + +.SS extractor.vipergirls.like +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Automatically like posts after downloading their images. + +Note: Requires \f[I]login\f[] +or \f[I]cookies\f[] + + .SS extractor.vsco.videos .IP "Type:" 6 \f[I]bool\f[] @@ -4631,7 +4807,7 @@ Download \f[I]livephoto\f[] files. \f[I]bool\f[] .IP "Default:" 9 -\f[I]true\f[] +\f[I]false\f[] .IP "Description:" 4 Fetch media from retweeted posts. @@ -4780,6 +4956,24 @@ Extract additional metadata (date, md5, tags, ...) Note: This requires 1-2 additional HTTP requests per post. +.SS extractor.zerochan.pagination +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"api"\f[] + +.IP "Description:" 4 +Controls how to paginate over tag search results. + +.br +* \f[I]"api"\f[]: Use the \f[I]JSON API\f[] +(no \f[I]extension\f[] metadata) +.br +* \f[I]"html"\f[]: Parse HTML pages +(limited to 100 pages * 24 posts) + + .SS extractor.[booru].tags .IP "Type:" 6 \f[I]bool\f[] @@ -5664,13 +5858,16 @@ and \f[I]{_filename}\f[]. .SS exec.event .IP "Type:" 6 -\f[I]string\f[] +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] .IP "Default:" 9 \f[I]"after"\f[] .IP "Description:" 4 -The event for which \f[I]exec.command\f[] is run. +The event(s) for which \f[I]exec.command\f[] is run. See \f[I]metadata.event\f[] for a list of available events. @@ -5767,15 +5964,24 @@ Note: \f[I]metadata.extension\f[] is ignored if this option is set. .SS metadata.event .IP "Type:" 6 -\f[I]string\f[] +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] .IP "Default:" 9 \f[I]"file"\f[] +.IP "Example:" 4 +.br +* "prepare,file,after" +.br +* ["prepare-after", "skip"] + .IP "Description:" 4 -The event for which metadata gets written to a file. +The event(s) for which metadata gets written to a file. -The available events are: +Available events are: \f[I]init\f[] After post processor initialization @@ -6013,13 +6219,18 @@ post processor with \f[I]"event": "post"\f[] runs *before* it. .SS mtime.event .IP "Type:" 6 -\f[I]string\f[] +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] .IP "Default:" 9 \f[I]"file"\f[] .IP "Description:" 4 -See \f[I]metadata.event\f[] +The event(s) for which \f[I]mtime.key\f[] or \f[I]mtime.value\f[] get evaluated. + +See \f[I]metadata.event\f[] for a list of available events. .SS mtime.key @@ -6075,13 +6286,16 @@ akin to .SS python.event .IP "Type:" 6 -\f[I]string\f[] +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] .IP "Default:" 9 \f[I]"file"\f[] .IP "Description:" 4 -The event for which \f[I]python.function\f[] gets called. +The event(s) for which \f[I]python.function\f[] gets called. See \f[I]metadata.event\f[] for a list of available events. @@ -6099,7 +6313,7 @@ See \f[I]metadata.event\f[] for a list of available events. .IP "Description:" 4 The Python function to call. -This function gets specified as \f[I]<module>:<function name>\f[] +This function is specified as \f[I]<module>:<function name>\f[] and gets called with the current metadata dict as argument. \f[I]module\f[] is either an importable Python module name @@ -6540,7 +6754,7 @@ section of your account's preferences .br * set \f[I]http://localhost:6414/\f[] as "redirect uri" .br -* solve the "I'm not a rebot" reCATCHA if needed +* solve the "I'm not a robot" reCAPTCHA if needed .br * click "create app" |