diff options
Diffstat (limited to 'data')
| -rw-r--r-- | data/completion/_gallery-dl | 1 | ||||
| -rw-r--r-- | data/completion/gallery-dl | 2 | ||||
| -rw-r--r-- | data/man/gallery-dl.1 | 5 | ||||
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 132 |
4 files changed, 117 insertions, 23 deletions
diff --git a/data/completion/_gallery-dl b/data/completion/_gallery-dl index 15806e8..22a5f25 100644 --- a/data/completion/_gallery-dl +++ b/data/completion/_gallery-dl @@ -54,6 +54,7 @@ _arguments -C -S \ --ugoira-conv'[Convert Pixiv Ugoira to WebM (requires FFmpeg)]' \ --ugoira-conv-lossless'[Convert Pixiv Ugoira to WebM in VP9 lossless mode]' \ --write-metadata'[Write metadata to separate JSON files]' \ +--write-infojson'[Write gallery metadata to a info.json file]' \ --write-tags'[Write image tags to separate text files]' \ --mtime-from-date'[Set file modification times according to "date" metadata]' \ --exec'[Execute CMD for each downloaded file. Example: --exec "convert {} {}.png && rm {}"]':'<cmd>' \ diff --git a/data/completion/gallery-dl b/data/completion/gallery-dl index f3d1100..c2ef896 100644 --- a/data/completion/gallery-dl +++ b/data/completion/gallery-dl @@ -10,7 +10,7 @@ _gallery_dl() elif [[ "${prev}" =~ ^(-d|--dest)$ ]]; then COMPREPLY=( $(compgen -d -- "${cur}") ) else - COMPREPLY=( $(compgen -W "--help --version --dest --input-file --cookies --proxy --clear-cache --quiet --verbose --get-urls --resolve-urls --dump-json --simulate --extractor-info --list-keywords --list-modules --list-extractors --write-log --write-unsupported --write-pages --limit-rate --retries --http-timeout --sleep --filesize-min --filesize-max --no-part --no-skip --no-mtime --no-download --no-check-certificate --config --config-yaml --option --ignore-config --username --password --netrc --download-archive --abort --terminate --range --chapter-range --filter --chapter-filter --zip --ugoira-conv --ugoira-conv-lossless --write-metadata --write-tags --mtime-from-date --exec --exec-after --postprocessor" -- "${cur}") ) + COMPREPLY=( $(compgen -W "--help --version --dest --input-file --cookies --proxy --clear-cache --quiet --verbose --get-urls --resolve-urls --dump-json --simulate --extractor-info --list-keywords --list-modules --list-extractors --write-log --write-unsupported --write-pages --limit-rate --retries --http-timeout --sleep --filesize-min --filesize-max --no-part --no-skip --no-mtime --no-download --no-check-certificate --config --config-yaml --option --ignore-config --username --password --netrc --download-archive --abort --terminate --range --chapter-range --filter --chapter-filter --zip --ugoira-conv --ugoira-conv-lossless --write-metadata --write-infojson --write-tags --mtime-from-date --exec --exec-after --postprocessor" -- "${cur}") ) fi } diff --git a/data/man/gallery-dl.1 b/data/man/gallery-dl.1 index edf1068..29621b0 100644 --- a/data/man/gallery-dl.1 +++ b/data/man/gallery-dl.1 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL" "1" "2021-09-04" "1.18.4" "gallery-dl Manual" +.TH "GALLERY-DL" "1" "2021-10-01" "1.19.0" "gallery-dl Manual" .\" disable hyphenation .nh @@ -161,6 +161,9 @@ Convert Pixiv Ugoira to WebM in VP9 lossless mode .B "\-\-write\-metadata" Write metadata to separate JSON files .TP +.B "\-\-write\-infojson" +Write gallery metadata to a info.json file +.TP .B "\-\-write\-tags" Write image tags to separate text files .TP diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index 869d605..a5c0970 100644 --- a/data/man/gallery-dl.conf.5 +++ b/data/man/gallery-dl.conf.5 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL.CONF" "5" "2021-09-04" "1.18.4" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2021-10-01" "1.19.0" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -371,7 +371,7 @@ filename extension (\f[I]file.1.ext\f[], \f[I]file.2.ext\f[], etc.) .SS extractor.*.sleep .IP "Type:" 6 -\f[I]float\f[] +\f[I]Duration\f[] .IP "Default:" 9 \f[I]0\f[] @@ -382,7 +382,7 @@ Number of seconds to sleep before each download. .SS extractor.*.sleep-extractor .IP "Type:" 6 -\f[I]float\f[] +\f[I]Duration\f[] .IP "Default:" 9 \f[I]0\f[] @@ -394,7 +394,7 @@ i.e. before starting a new extractor. .SS extractor.*.sleep-request .IP "Type:" 6 -\f[I]float\f[] +\f[I]Duration\f[] .IP "Default:" 9 \f[I]0\f[] @@ -441,14 +441,14 @@ and optional for .br * \f[I]instagram\f[] .br +* \f[I]kemonoparty\f[] +.br * \f[I]mangadex\f[] .br * \f[I]mangoxo\f[] .br * \f[I]pillowfort\f[] .br -* \f[I]pinterest\f[] -.br * \f[I]sankaku\f[] .br * \f[I]subscribestar\f[] @@ -620,6 +620,12 @@ Default value used for missing or undefined keyword names in .IP "Description:" 4 Insert a file's download URL into its metadata dictionary as the given name. +For example, setting this option to \f[I]"gdl_file_url"\f[] will cause a new +metadata field with name \f[I]gdl_file_url\f[] to appear, which contains the +current file's download URL. +This can then be used in \f[I]filenames\f[], +with a \f[I]metadata\f[] post processor, etc. + .SS extractor.*.category-transfer .IP "Type:" 6 @@ -1030,6 +1036,30 @@ to access 18+ content without \f[I]API Key\f[]. See \f[I]Filters\f[] for details. +.SS extractor.deviantart.auto-watch +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Automatically watch users when encountering "Watchers-Only Deviations" +(requires a \f[I]refresh-token\f[]). + + +.SS extractor.deviantart.auto-unwatch +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +After watching a user through \f[I]auto-watch\f[], +unwatch that user at the end of the current extractor run. + + .SS extractor.deviantart.comments .IP "Type:" 6 \f[I]bool\f[] @@ -1204,18 +1234,6 @@ Note: The \f[I]refresh-token\f[] becomes invalid or whenever your \f[I]cache file\f[] is deleted or cleared. -.SS extractor.deviantart.auto-watch -.IP "Type:" 6 -\f[I]bool\f[] - -.IP "Default:" 9 -\f[I]false\f[] - -.IP "Description:" 4 -Automatically watch users when encountering "Watchers-Only Deviations" -(requires a \f[I]refresh-token\f[]). - - .SS extractor.deviantart.wait-min .IP "Type:" 6 \f[I]integer\f[] @@ -2538,6 +2556,17 @@ Reverse the order of chapter URLs extracted from manga pages. * \f[I]false\f[]: Start with the first chapter +.SS extractor.[manga-extractor].page-reverse +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Download manga chapter pages in reverse order. + + .SH DOWNLOADER OPTIONS .SS downloader.*.enabled .IP "Type:" 6 @@ -2615,6 +2644,20 @@ If this value is \f[I]null\f[], \f[I].part\f[] files are going to be stored alongside the actual output files. +.SS downloader.*.progress +.IP "Type:" 6 +\f[I]float\f[] + +.IP "Default:" 9 +\f[I]3.0\f[] + +.IP "Description:" 4 +Number of seconds until a download progress indicator +for the current download is displayed. + +Set this option to \f[I]null\f[] to disable this indicator. + + .SS downloader.*.rate .IP "Type:" 6 \f[I]string\f[] @@ -2829,6 +2872,9 @@ Controls the output string format and status indicators. Controls whether the output strings should be shortened to fit on one console line. +Set this option to \f[I]"eaw"\f[] to also work with east-asian characters +with a display width greater than 1. + .SS output.skip .IP "Type:" 6 @@ -2949,6 +2995,20 @@ The action to take when files do not compare as equal. .br * \f[I]"replace"\f[]: Replace/Overwrite the old version with the new one + +.br +* \f[I]"abort:N"\f[]: Same as \f[I]"replace"\f[] and stop the current extractor run +after \f[I]N\f[] consecutive files compared as equal. + +.br +* \f[I]"terminate:N"\f[]: Same as \f[I]"replace"\f[] +and stop the current extractor run, including parent extractors, +after \f[I]N\f[] consecutive files compared as equal. + +.br +* \f[I]"exit:N"\f[]: Same as \f[I]"replace"\f[] and exit the program +after \f[I]N\f[] consecutive files compared as equal. + .br * \f[I]"enumerate"\f[]: Add an enumeration index to the filename of the new version like \f[I]skip = "enumerate"\f[] @@ -3409,7 +3469,7 @@ 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\f[] to delete any remaining -\f[I]access-token\f[] entries. (\f[I]gallery-dl --clear-cache\f[]) +\f[I]access-token\f[] entries. (\f[I]gallery-dl --clear-cache deviantart\f[]) .br * get a new \f[I]refresh-token\f[] for the new \f[I]client-id\f[] (\f[I]gallery-dl oauth:deviantart\f[]) @@ -3501,7 +3561,10 @@ and put them in your configuration file .SH CUSTOM TYPES .SS Date .IP "Type:" 6 -\f[I]string\f[] or \f[I]integer\f[] +.br +* \f[I]string\f[] +.br +* \f[I]integer\f[] .IP "Example:" 4 .br @@ -3520,9 +3583,36 @@ A \f[I]Date\f[] value represents a specific point in time. * If given as \f[I]integer\f[], it is interpreted as UTC timestamp. +.SS Duration +.IP "Type:" 6 +.br +* \f[I]float\f[] +.br +* \f[I]list\f[] with 2 \f[I]floats\f[] + +.IP "Example:" 4 +.br +* 2.85 +.br +* [1.5, 3.0] + +.IP "Description:" 4 +A \f[I]Duration\f[] represents a span of time in seconds. + +.br +* If given as a single \f[I]float\f[], it will be used as that exact value. +.br +* If given as a \f[I]list\f[] with 2 floating-point numbers \f[I]a\f[] & \f[I]b\f[] , +it will be randomly chosen with uniform distribution such that \f[I]a <= N <=b\f[]. +(see \f[I]random.uniform()\f[]) + + .SS Path .IP "Type:" 6 -\f[I]string\f[] or \f[I]list\f[] of \f[I]strings\f[] +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] .IP "Example:" 4 .br |