diff options
Diffstat (limited to 'data')
| -rw-r--r-- | data/completion/_gallery-dl | 3 | ||||
| -rw-r--r-- | data/completion/gallery-dl | 2 | ||||
| -rw-r--r-- | data/completion/gallery-dl.fish | 3 | ||||
| -rw-r--r-- | data/man/gallery-dl.1 | 11 | ||||
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 259 |
5 files changed, 260 insertions, 18 deletions
diff --git a/data/completion/_gallery-dl b/data/completion/_gallery-dl index e5153f5..81466c9 100644 --- a/data/completion/_gallery-dl +++ b/data/completion/_gallery-dl @@ -7,6 +7,7 @@ local rc=1 _arguments -s -S \ {-h,--help}'[Print this help message and exit]' \ --version'[Print program version and exit]' \ +{-U,--update-check}'[Check if a newer version is available]' \ {-f,--filename}'[Filename format string for downloaded files ('\''/O'\'' for "original" filenames)]':'<format>' \ {-d,--destination}'[Target location for file downloads]':'<path>' \ {-D,--directory}'[Exact location for file downloads]':'<path>' \ @@ -19,6 +20,7 @@ _arguments -s -S \ {-I,--input-file-comment}'[Download URLs found in FILE. Comment them out after they were downloaded successfully.]':'<file>':_files \ {-x,--input-file-delete}'[Download URLs found in FILE. Delete them after they were downloaded successfully.]':'<file>':_files \ {-q,--quiet}'[Activate quiet mode]' \ +{-w,--warning}'[Print only warnings and errors]' \ {-v,--verbose}'[Print various debugging information]' \ {-g,--get-urls}'[Print URLs instead of downloading]' \ {-G,--resolve-urls}'[Print URLs instead of downloading; resolve intermediary URLs]' \ @@ -32,6 +34,7 @@ _arguments -s -S \ --write-log'[Write logging output to FILE]':'<file>':_files \ --write-unsupported'[Write URLs, which get emitted by other extractors but cannot be handled, to FILE]':'<file>':_files \ --write-pages'[Write downloaded intermediary pages to files in the current directory to debug problems]' \ +--no-colors'[Do not emit ANSI color codes in output]' \ {-r,--limit-rate}'[Maximum download rate (e.g. 500k or 2.5M)]':'<rate>' \ {-R,--retries}'[Maximum number of retries for failed HTTP requests or -1 for infinite retries (default: 4)]':'<n>' \ --http-timeout'[Timeout for HTTP connections (default: 30.0)]':'<seconds>' \ diff --git a/data/completion/gallery-dl b/data/completion/gallery-dl index d280ab4..81a5238 100644 --- a/data/completion/gallery-dl +++ b/data/completion/gallery-dl @@ -10,7 +10,7 @@ _gallery_dl() elif [[ "${prev}" =~ ^()$ ]]; then COMPREPLY=( $(compgen -d -- "${cur}") ) else - COMPREPLY=( $(compgen -W "--help --version --filename --destination --directory --extractors --proxy --source-address --user-agent --clear-cache --input-file --input-file-comment --input-file-delete --quiet --verbose --get-urls --resolve-urls --dump-json --simulate --extractor-info --list-keywords --error-file --list-modules --list-extractors --write-log --write-unsupported --write-pages --limit-rate --retries --http-timeout --sleep --sleep-request --sleep-extractor --filesize-min --filesize-max --chunk-size --no-part --no-skip --no-mtime --no-download --no-postprocessors --no-check-certificate --option --config --config-yaml --config-toml --config-create --config-ignore --ignore-config --username --password --netrc --cookies --cookies-export --cookies-from-browser --download-archive --abort --terminate --range --chapter-range --filter --chapter-filter --postprocessor --postprocessor-option --write-metadata --write-info-json --write-infojson --write-tags --zip --cbz --mtime --mtime-from-date --ugoira --ugoira-conv --ugoira-conv-lossless --ugoira-conv-copy --exec --exec-after" -- "${cur}") ) + COMPREPLY=( $(compgen -W "--help --version --update-check --filename --destination --directory --extractors --proxy --source-address --user-agent --clear-cache --input-file --input-file-comment --input-file-delete --quiet --warning --verbose --get-urls --resolve-urls --dump-json --simulate --extractor-info --list-keywords --error-file --list-modules --list-extractors --write-log --write-unsupported --write-pages --no-colors --limit-rate --retries --http-timeout --sleep --sleep-request --sleep-extractor --filesize-min --filesize-max --chunk-size --no-part --no-skip --no-mtime --no-download --no-postprocessors --no-check-certificate --option --config --config-yaml --config-toml --config-create --config-ignore --ignore-config --username --password --netrc --cookies --cookies-export --cookies-from-browser --download-archive --abort --terminate --range --chapter-range --filter --chapter-filter --postprocessor --postprocessor-option --write-metadata --write-info-json --write-infojson --write-tags --zip --cbz --mtime --mtime-from-date --ugoira --ugoira-conv --ugoira-conv-lossless --ugoira-conv-copy --exec --exec-after" -- "${cur}") ) fi } diff --git a/data/completion/gallery-dl.fish b/data/completion/gallery-dl.fish index 135dfb7..4913c6f 100644 --- a/data/completion/gallery-dl.fish +++ b/data/completion/gallery-dl.fish @@ -1,6 +1,7 @@ complete -c gallery-dl -x complete -c gallery-dl -s 'h' -l 'help' -d 'Print this help message and exit' complete -c gallery-dl -l 'version' -d 'Print program version and exit' +complete -c gallery-dl -s 'U' -l 'update-check' -d 'Check if a newer version is available' complete -c gallery-dl -x -s 'f' -l 'filename' -d 'Filename format string for downloaded files ("/O" for "original" filenames)' complete -c gallery-dl -x -a '(__fish_complete_directories)' -s 'd' -l 'destination' -d 'Target location for file downloads' complete -c gallery-dl -x -a '(__fish_complete_directories)' -s 'D' -l 'directory' -d 'Exact location for file downloads' @@ -13,6 +14,7 @@ complete -c gallery-dl -r -F -s 'i' -l 'input-file' -d 'Download URLs found in F complete -c gallery-dl -r -F -s 'I' -l 'input-file-comment' -d 'Download URLs found in FILE. Comment them out after they were downloaded successfully.' complete -c gallery-dl -r -F -s 'x' -l 'input-file-delete' -d 'Download URLs found in FILE. Delete them after they were downloaded successfully.' complete -c gallery-dl -s 'q' -l 'quiet' -d 'Activate quiet mode' +complete -c gallery-dl -s 'w' -l 'warning' -d 'Print only warnings and errors' complete -c gallery-dl -s 'v' -l 'verbose' -d 'Print various debugging information' complete -c gallery-dl -s 'g' -l 'get-urls' -d 'Print URLs instead of downloading' complete -c gallery-dl -s 'G' -l 'resolve-urls' -d 'Print URLs instead of downloading; resolve intermediary URLs' @@ -26,6 +28,7 @@ complete -c gallery-dl -l 'list-extractors' -d 'Print a list of extractor classe complete -c gallery-dl -r -F -l 'write-log' -d 'Write logging output to FILE' complete -c gallery-dl -r -F -l 'write-unsupported' -d 'Write URLs, which get emitted by other extractors but cannot be handled, to FILE' complete -c gallery-dl -l 'write-pages' -d 'Write downloaded intermediary pages to files in the current directory to debug problems' +complete -c gallery-dl -l 'no-colors' -d 'Do not emit ANSI color codes in output' complete -c gallery-dl -x -s 'r' -l 'limit-rate' -d 'Maximum download rate (e.g. 500k or 2.5M)' complete -c gallery-dl -x -s 'R' -l 'retries' -d 'Maximum number of retries for failed HTTP requests or -1 for infinite retries (default: 4)' complete -c gallery-dl -x -l 'http-timeout' -d 'Timeout for HTTP connections (default: 30.0)' diff --git a/data/man/gallery-dl.1 b/data/man/gallery-dl.1 index 863d75d..e964a67 100644 --- a/data/man/gallery-dl.1 +++ b/data/man/gallery-dl.1 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL" "1" "2024-03-23" "1.26.9" "gallery-dl Manual" +.TH "GALLERY-DL" "1" "2024-06-01" "1.27.0" "gallery-dl Manual" .\" disable hyphenation .nh @@ -23,6 +23,9 @@ Print this help message and exit .B "\-\-version" Print program version and exit .TP +.B "\-U, \-\-update\-check" +Check if a newer version is available +.TP .B "\-f, \-\-filename" \f[I]FORMAT\f[] Filename format string for downloaded files ('/O' for "original" filenames) .TP @@ -59,6 +62,9 @@ Download URLs found in FILE. Delete them after they were downloaded successfully .B "\-q, \-\-quiet" Activate quiet mode .TP +.B "\-w, \-\-warning" +Print only warnings and errors +.TP .B "\-v, \-\-verbose" Print various debugging information .TP @@ -98,6 +104,9 @@ Write URLs, which get emitted by other extractors but cannot be handled, to FILE .B "\-\-write\-pages" Write downloaded intermediary pages to files in the current directory to debug problems .TP +.B "\-\-no\-colors" +Do not emit ANSI color codes in output +.TP .B "\-r, \-\-limit\-rate" \f[I]RATE\f[] Maximum download rate (e.g. 500k or 2.5M) .TP diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index 7b57923..5db584b 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-03-23" "1.26.9" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2024-06-01" "1.27.0" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -404,6 +404,15 @@ after \f[I]N\f[] consecutive skips filename extension (\f[I]file.1.ext\f[], \f[I]file.2.ext\f[], etc.) +.SS extractor.*.skip-filter +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Description:" 4 +Python expression controlling which skipped files to count towards +\f[I]"abort"\f[] / \f[I]"terminate"\f[] / \f[I]"exit"\f[]. + + .SS extractor.*.sleep .IP "Type:" 6 \f[I]Duration\f[] @@ -427,12 +436,47 @@ Number of seconds to sleep before handling an input URL, i.e. before starting a new extractor. +.SS extractor.*.sleep-429 +.IP "Type:" 6 +\f[I]Duration\f[] + +.IP "Default:" 9 +\f[I]60\f[] + +.IP "Description:" 4 +Number of seconds to sleep when receiving a 429 Too Many Requests +response before \f[I]retrying\f[] the request. + + .SS extractor.*.sleep-request .IP "Type:" 6 \f[I]Duration\f[] .IP "Default:" 9 -\f[I]0\f[] +.br +* \f[I]"0.5-1.5"\f[] +\f[I][Danbooru]\f[], \f[I][E621]\f[], \f[I][foolfuuka]:search\f[], \f[I]itaku\f[], +\f[I]newgrounds\f[], \f[I][philomena]\f[], \f[I]pixiv:novel\f[], \f[I]plurk\f[], +\f[I]poipiku\f[] , \f[I]pornpics\f[], \f[I]soundgasm\f[], \f[I]urlgalleries\f[], +\f[I]vk\f[], \f[I]zerochan\f[] +.br +* \f[I]"1.0-2.0"\f[] +\f[I]flickr\f[], \f[I]weibo\f[], \f[I][wikimedia]\f[] +.br +* \f[I]"2.0-4.0"\f[] +\f[I]behance\f[], \f[I]imagefap\f[], \f[I][Nijie]\f[] +.br +* \f[I]"3.0-6.0"\f[] +\f[I]exhentai\f[], \f[I]idolcomplex\f[], \f[I][reactor]\f[], \f[I]readcomiconline\f[] +.br +* \f[I]"6.0-6.1"\f[] +\f[I]twibooru\f[] +.br +* \f[I]"6.0-12.0"\f[] +\f[I]instagram\f[] +.br +* \f[I]0\f[] +otherwise .IP "Description:" 4 Minimal time interval in seconds between each HTTP request @@ -454,6 +498,8 @@ Specifying username and password is required for .br * \f[I]nijie\f[] +.br +* \f[I]horne\f[] and optional for @@ -466,10 +512,18 @@ and optional for .br * \f[I]bluesky\f[] .br +* \f[I]booruvar\f[] (*) +.br +* \f[I]coomerparty\f[] +.br * \f[I]danbooru\f[] (*) .br +* \f[I]deviantart\f[] +.br * \f[I]e621\f[] (*) .br +* \f[I]e6ai\f[] (*) +.br * \f[I]e926\f[] (*) .br * \f[I]exhentai\f[] @@ -490,8 +544,6 @@ and optional for .br * \f[I]sankaku\f[] .br -* \f[I]seisoparty\f[] -.br * \f[I]subscribestar\f[] .br * \f[I]tapas\f[] @@ -512,7 +564,7 @@ by using a \f[I].netrc\f[] file. (see Authentication_) the API key found in your user profile, not the actual account password. Note: Leave the \f[I]password\f[] value empty or undefined -to get prompted for a passeword when performing a login +to be prompted for a passeword when performing a login (see \f[I]getpass()\f[]). @@ -683,9 +735,9 @@ extractors, as these need specific values to function correctly. .IP "Default:" 9 .br -* \f[I]"firefox"\f[] for \f[I]patreon\f[], \f[I]mangapark\f[], and \f[I]mangasee\f[] +* \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[] .br -* \f[I]null\f[] everywhere else +* \f[I]null\f[]: otherwise .IP "Example:" 4 .br @@ -769,9 +821,9 @@ to be passed to .IP "Default:" 9 .br -* \f[I]true\f[] +* \f[I]false\f[]: \f[I]artstation\f[], \f[I]patreon\f[], \f[I]pixiv:series\f[] .br -* \f[I]false\f[] for \f[I]patreon\f[], \f[I]pixiv:series\f[] +* \f[I]true\f[]: otherwise .IP "Description:" 4 Allow selecting TLS 1.2 cipher suites. @@ -791,6 +843,18 @@ and potentially bypass Cloudflare blocks. Additional name-value pairs to be added to each metadata dictionary. +.SS extractor.*.keywords-eval +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Evaluate each \f[I]keywords\f[] \f[I]string\f[] value +as a \f[I]format string\f[]. + + .SS extractor.*.keywords-default .IP "Type:" 6 any @@ -952,6 +1016,25 @@ may pose a security risk. An alternative \f[I]format string\f[] to build archive IDs with. +.SS extractor.*.archive-mode +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"file"\f[] + +.IP "Description:" 4 +Controls when to write \f[I]archive IDs\f[] +to the archive database. + +.br +* \f[I]"file"\f[]: Write IDs immediately +after completing or skipping a file download. +.br +* \f[I]"memory"\f[]: Keep IDs in memory +and only write them after successful job completion. + + .SS extractor.*.archive-prefix .IP "Type:" 6 \f[I]string\f[] @@ -977,6 +1060,72 @@ See \f[I]<https://www.sqlite.org/pragma.html>\f[] for available \f[I]PRAGMA\f[] statements and further details. +.SS extractor.*.actions +.IP "Type:" 6 +.br +* \f[I]object\f[] (pattern -> action) +.br +* \f[I]list\f[] of \f[I]lists\f[] with 2 \f[I]strings\f[] as elements + +.IP "Example:" 4 +.. code:: json + +{ +"error" : "status \f[I]= 1", +"warning:(?i)unable to .+": "exit 127", +"info:Logging in as .+" : "level = debug" +} + +.. code:: json + +[ +["error" , "status \f[]= 1" ], +["warning:(?i)unable to .+", "exit 127" ], +["info:Logging in as .+" , "level = debug"] +] + + +.IP "Description:" 4 +Perform an \f[I]action\f[] when logging a message matched by \f[I]pattern\f[]. + +\f[I]pattern\f[] is parsed as severity level (\f[I]debug\f[], \f[I]info\f[], \f[I]warning\f[], \f[I]error\f[], or integer value) +followed by an optional \f[I]Python Regular Expression\f[] +separated by a colon \f[I]:\f[]. +Using \f[I]*\f[] as level or leaving it empty +matches logging messages of all levels +(e.g. \f[I]*:<re>\f[] or \f[I]:<re>\f[]). + +\f[I]action\f[] is parsed as action type +followed by (optional) arguments. + +Supported Action Types: + +\f[I]status\f[]: +Modify job exit status. +.br +Expected syntax is \f[I]<operator> <value>\f[] (e.g. \f[I]= 100\f[]). +.br + +Supported operators are +\f[I]=\f[] (assignment), +\f[I]&\f[] (bitwise AND), +\f[I]|\f[] (bitwise OR), +\f[I]^\f[] (bitwise XOR). +\f[I]level\f[]: +Modify severity level of the current logging message. +.br +Can be one of \f[I]debug\f[], \f[I]info\f[], \f[I]warning\f[], \f[I]error\f[] or an integer value. +.br +\f[I]print\f[] +Write argument to stdout. +\f[I]restart\f[]: +Restart the current extractor run. +\f[I]wait\f[]: +Stop execution until Enter is pressed. +\f[I]exit\f[]: +Exit the program with the given argument as exit status. + + .SS extractor.*.postprocessors .IP "Type:" 6 \f[I]list\f[] of \f[I]Postprocessor Configuration\f[] objects @@ -2715,6 +2864,17 @@ Controls how to handle duplicate files in a post. Extract a user's direct messages as \f[I]dms\f[] metadata. +.SS extractor.kemonoparty.announcements +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Extract a user's announcements as \f[I]announcements\f[] metadata. + + .SS extractor.kemonoparty.favorites .IP "Type:" 6 \f[I]string\f[] @@ -2945,6 +3105,17 @@ Note: gallery-dl comes with built-in tokens for \f[I]mastodon.social\f[], user IDs. +.SS extractor.[mastodon].cards +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Fetch media from cards. + + .SS extractor.[mastodon].reblogs .IP "Type:" 6 \f[I]bool\f[] @@ -3351,7 +3522,18 @@ by using a third-party tool like \f[I]gppt\f[]. -.SS extractor.pixiv.embeds +.SS extractor.pixiv.novel.covers +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Download cover images. + + +.SS extractor.pixiv.novel.embeds .IP "Type:" 6 \f[I]bool\f[] @@ -3359,7 +3541,7 @@ by using a third-party tool like \f[I]false\f[] .IP "Description:" 4 -Download images embedded in novels. +Download embedded images. .SS extractor.pixiv.novel.full-series @@ -4453,6 +4635,22 @@ Selects how to handle exceeding the API rate limit. * \f[I]"wait"\f[]: Wait until rate limit reset +.SS extractor.twitter.relogin +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +When receiving a "Could not authenticate you" error while logged in with +.br +\f[I]username & passeword\f[], +refresh the current login session and +.br +try to continue from where it left off. + + .SS extractor.twitter.locked .IP "Type:" 6 \f[I]string\f[] @@ -5568,11 +5766,40 @@ with a display width greater than 1. \f[I]object\f[] (key -> ANSI color) .IP "Default:" 9 -\f[I]{"success": "1;32", "skip": "2"}\f[] +.. code:: json + +{ +"success": "1;32", +"skip" : "2", +"debug" : "0;37", +"info" : "1;37", +"warning": "1;33", +"error" : "1;31" +} + .IP "Description:" 4 -Controls the \f[I]ANSI colors\f[] -used with \f[I]mode: color\f[] for successfully downloaded or skipped files. +Controls the +\f[I]ANSI colors\f[] +used for various outputs. + +Output for \f[I]mode: color\f[] + +.br +* \f[I]success\f[]: successfully downloaded files +.br +* \f[I]skip\f[]: skipped files + +Logging Messages: + +.br +* \f[I]debug\f[]: debug logging messages +.br +* \f[I]info\f[]: info logging messages +.br +* \f[I]warning\f[]: warning logging messages +.br +* \f[I]error\f[]: error logging messages .SS output.ansi @@ -5580,7 +5807,7 @@ used with \f[I]mode: color\f[] for successfully downloaded or skipped files. \f[I]bool\f[] .IP "Default:" 9 -\f[I]false\f[] +\f[I]true\f[] .IP "Description:" 4 On Windows, enable ANSI escape sequences and colored output @@ -6941,7 +7168,7 @@ Extended logging output configuration. * format .br * General format string for logging messages -or a dictionary with format strings for each loglevel. +or an \f[I]object\f[] with format strings for each loglevel. In addition to the default \f[I]LogRecord attributes\f[], |