diff options
Diffstat (limited to 'data/man/gallery-dl.conf.5')
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 84 |
1 files changed, 68 insertions, 16 deletions
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index a5b1f4d..e37135e 100644 --- a/data/man/gallery-dl.conf.5 +++ b/data/man/gallery-dl.conf.5 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL.CONF" "5" "2020-08-30" "1.14.5" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2020-09-20" "1.15.0" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -253,6 +253,28 @@ filename extension (\f[I]file.1.ext\f[], \f[I]file.2.ext\f[], etc.) .IP "Description:" 4 Number of seconds to sleep before each download. +.SS extractor.*.sleep-extractor +.IP "Type:" 6 +\f[I]float\f[] + +.IP "Default:" 9 +\f[I]0\f[] + +.IP "Description:" 4 +Number of seconds to sleep before handling an input URL, +i.e. before starting a new extractor. + +.SS extractor.*.sleep-request +.IP "Type:" 6 +\f[I]float\f[] + +.IP "Default:" 9 +\f[I]0\f[] + +.IP "Description:" 4 +Minimal time interval in seconds between each HTTP request +during data extraction. + .SS extractor.*.username & .password .IP "Type:" 6 \f[I]string\f[] @@ -436,6 +458,21 @@ Transfer an extractor's (sub)category values to all child extractors spawned by it, to let them inherit their parent's config options. +.SS extractor.*.blacklist & .whitelist +.IP "Type:" 6 +\f[I]list\f[] of \f[I]strings\f[] + +.IP "Default:" 9 +\f[I]["oauth", "recursive", "test"]\f[] + current extractor category + +.IP "Description:" 4 +A list of extractor categories to ignore (or allow) +when spawning child extractors for unknown URLs, +e.g. from \f[I]reddit\f[] or \f[I]plurk\f[]. + +Note: Any \f[I]blacklist\f[] setting will automatically include +\f[I]"oauth"\f[], \f[I]"recursive"\f[], and \f[I]"test"\f[]. + .SS extractor.*.archive .IP "Type:" 6 \f[I]Path\f[] @@ -443,15 +480,23 @@ config options. .IP "Default:" 9 \f[I]null\f[] +.IP "Example:" 4 +"$HOME/.archives/{category}.sqlite3" + .IP "Description:" 4 File to store IDs of downloaded files in. Downloads of files -already recorded in this archive file will be skipped_. +already recorded in this archive file will be +\f[I]skipped <extractor.*.skip_>\f[]. The resulting archive file is not a plain text file but an SQLite3 database, as either lookup operations are significantly faster or memory requirements are significantly lower when the amount of stored IDs gets reasonably large. +Note: archive paths support regular \f[I]format string\f[] replacements, +but be aware that using external inputs for building local paths +may pose a security risk. + .SS extractor.*.archive-format .IP "Type:" 6 \f[I]string\f[] @@ -839,9 +884,6 @@ or whenever your \f[I]cache file <cache.file_>\f[] is deleted or cleared. .IP "Description:" 4 Minimum wait time in seconds before API requests. -Note: This value will internally be rounded up -to the next power of 2. - .SS extractor.exhentai.domain .IP "Type:" 6 \f[I]string\f[] @@ -1221,17 +1263,6 @@ Controls how to handle redirects to CAPTCHA pages. .br * \f[I]"wait\f[]: Ask the user to solve the CAPTCHA and wait. -.SS extractor.recursive.blacklist -.IP "Type:" 6 -\f[I]list\f[] of \f[I]strings\f[] - -.IP "Default:" 9 -\f[I]["directlink", "oauth", "recursive", "test"]\f[] - -.IP "Description:" 4 -A list of extractor categories which should be ignored when using -the \f[I]recursive\f[] extractor. - .SS extractor.reddit.comments .IP "Type:" 6 \f[I]integer\f[] @@ -1594,6 +1625,24 @@ Reverse the order of chapter URLs extracted from manga pages. .IP "Description:" 4 Enable/Disable this downloader module. +.SS downloader.*.filesize-min & .filesize-max +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]null\f[] + +.IP "Example:" 4 +"32000", "500k", "2.5M" + +.IP "Description:" 4 +Minimum/Maximum allowed file size in bytes. +Any file smaller/larger than this limit will not be downloaded. + +Possible values are valid integer or floating-point numbers +optionally followed by one of \f[I]k\f[], \f[I]m\f[]. \f[I]g\f[], \f[I]t\f[] or \f[I]p\f[]. +These suffixes are case-insensitive. + .SS downloader.*.mtime .IP "Type:" 6 \f[I]bool\f[] @@ -2283,6 +2332,9 @@ Submission Policy, and Terms of Service. application and put them in your configuration file as \f[I]"client-id"\f[] and \f[I]"client-secret"\f[] .br +* clear your \f[I]cache <cache.file_>\f[] (\f[I]--clear-cache\f[]) to delete +the \f[I]access-token\f[] from the previous \f[I]client-id\f[] +.br * get a new \f[I]refresh-token <extractor.deviantart.refresh-token_>\f[] if necessary |