diff options
Diffstat (limited to 'data/man/gallery-dl.conf.5')
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 130 |
1 files changed, 113 insertions, 17 deletions
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index 51b20cd..9651d18 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-02-14" "1.20.5" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2022-03-14" "1.21.0" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -419,8 +419,6 @@ Specifying a username and password is required for .br * \f[I]nijie\f[] -.br -* \f[I]seiga\f[] and optional for @@ -553,6 +551,28 @@ Note: All proxy URLs should include a scheme, otherwise \f[I]http://\f[] is assumed. +.SS extractor.*.source-address +.IP "Type:" 6 +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] with 1 \f[I]string\f[] and 1 \f[I]integer\f[] as elements + +.IP "Example:" 4 +.br +* "192.168.178.20" +.br +* ["192.168.178.20", 8080] + +.IP "Description:" 4 +Client-side IP address to bind to. + +Can be either a simple \f[I]string\f[] with just the local IP address +.br +or a \f[I]list\f[] with IP and explicit port number as elements. +.br + + .SS extractor.*.user-agent .IP "Type:" 6 \f[I]string\f[] @@ -1874,13 +1894,13 @@ port than the default. \f[I]list\f[] of \f[I]strings\f[] .IP "Default:" 9 -\f[I]["images", "attachments", "postfile", "content"]\f[] +\f[I]["images", "image_large", "attachments", "postfile", "content"]\f[] .IP "Description:" 4 Determines the type and order of files to be downloaded. Available types are -\f[I]postfile\f[], \f[I]images\f[], \f[I]attachments\f[], and \f[I]content\f[]. +\f[I]postfile\f[], \f[I]images\f[], \f[I]image_large\f[], \f[I]attachments\f[], and \f[I]content\f[]. .SS extractor.photobucket.subalbums @@ -2228,6 +2248,17 @@ Download video embeds from external sites. Download videos. +.SS extractor.skeb.sent-requests +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Download sent requests. + + .SS extractor.skeb.thumbnails .IP "Type:" 6 \f[I]bool\f[] @@ -2331,6 +2362,34 @@ 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.twibooru.api-key +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]null\f[] + +.IP "Description:" 4 +Your \f[I]Twibooru API Key\f[], +to use your account's browsing settings and filters. + + +.SS extractor.twibooru.filter +.IP "Type:" 6 +\f[I]integer\f[] + +.IP "Default:" 9 +\f[I]2\f[] (\f[I]Everything\f[] filter) + +.IP "Description:" 4 +The content filter ID to use. + +Setting an explicit filter ID overrides any default filters and can be used +to access 18+ content without \f[I]API Key\f[]. + +See \f[I]Filters\f[] for details. + + .SS extractor.twitter.cards .IP "Type:" 6 \f[I]bool\f[] or \f[I]string\f[] @@ -2511,18 +2570,6 @@ Control video download behavior. * \f[I]false\f[]: Skip video Tweets -.SS extractor.twitter.warnings -.IP "Type:" 6 -\f[I]bool\f[] - -.IP "Default:" 9 -\f[I]false\f[] - -.IP "Description:" 4 -Emit \f[I]logging messages\f[] -for non-fatal errors reported by Twitter's API. - - .SS extractor.unsplash.format .IP "Type:" 6 \f[I]string\f[] @@ -2912,6 +2959,20 @@ Connection timeout during file downloads. Certificate validation during file downloads. +.SS downloader.*.proxy +.IP "Type:" 6 +\f[I]string\f[] or \f[I]object\f[] + +.IP "Default:" 9 +\f[I]extractor.*.proxy\f[] + +.IP "Description:" 4 +Proxy server used for file downloads. +.br +Disable the use of a proxy by explicitly setting this option to \f[I]null\f[]. +.br + + .SS downloader.http.adjust-extensions .IP "Type:" 6 \f[I]bool\f[] @@ -3450,6 +3511,41 @@ Custom format string to build the content of metadata files with. Note: Only applies for \f[I]"mode": "custom"\f[]. +.SS metadata.mtime +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Set modification times for generated metadata files +according to the accompanying downloaded file. + +Enabling this option will only have an effect +*if* there is actual \f[I]mtime\f[] metadata available, that is + +.br +* after a file download (\f[I]"event": "file"\f[] (default), \f[I]"event": "after"\f[]) +.br +* when running *after* an \f[I]mtime\f[] post processes for the same \f[I]event\f[] + +For example, a \f[I]metadata\f[] post processor for \f[I]"event": "post"\f[] will +*not* be able to set its file's modification time unless an \f[I]mtime\f[] +post processor with \f[I]"event": "post"\f[] runs *before* it. + + +.SS mtime.event +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"file"\f[] + +.IP "Description:" 4 +See \f[I]metadata.event\f[] + + .SS mtime.key .IP "Type:" 6 \f[I]string\f[] |