diff options
Diffstat (limited to 'data/man')
| -rw-r--r-- | data/man/gallery-dl.1 | 4 | ||||
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 157 |
2 files changed, 149 insertions, 12 deletions
diff --git a/data/man/gallery-dl.1 b/data/man/gallery-dl.1 index 6a22a07..719b8b4 100644 --- a/data/man/gallery-dl.1 +++ b/data/man/gallery-dl.1 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL" "1" "2021-04-25" "1.17.3" "gallery-dl Manual" +.TH "GALLERY-DL" "1" "2021-05-30" "1.17.5" "gallery-dl Manual" .\" disable hyphenation .nh @@ -35,7 +35,7 @@ File to load additional cookies from .B "\-\-proxy" \f[I]URL\f[] Use the specified proxy .TP -.B "\-\-clear\-cache" +.B "\-\-clear\-cache" \f[I]MODULE\f[] Delete all cached login sessions, cookies, etc. .TP .B "\-q, \-\-quiet" diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index 0190b7f..f35f218 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-04-25" "1.17.3" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2021-05-30" "1.17.5" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -166,6 +166,17 @@ for any spawned child extractors. Overwrite any metadata provided by a child extractor with its parent's. +.SS extractor.*.parent-skip +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Share number of skipped downloads between parent and child extractors. + + .SS extractor.*.path-restrict .IP "Type:" 6 \f[I]string\f[] or \f[I]object\f[] @@ -267,12 +278,18 @@ exists or its ID is in a \f[I]download archive\f[]. * \f[I]false\f[]: Overwrite already existing files .br -* \f[I]"abort"\f[]: Abort the current extractor run +* \f[I]"abort"\f[]: Stop the current extractor run .br -* \f[I]"abort:N"\f[]: Skip downloads and abort extractor run +* \f[I]"abort:N"\f[]: Skip downloads and stop the current extractor run after \f[I]N\f[] consecutive skips .br +* \f[I]"terminate"\f[]: Stop the current extractor run, including parent extractors +.br +* \f[I]"terminate:N"\f[]: Skip downloads and stop the current extractor run, +including parent extractors, after \f[I]N\f[] consecutive skips + +.br * \f[I]"exit"\f[]: Exit the program altogether .br * \f[I]"exit:N"\f[]: Skip downloads and exit the program @@ -357,6 +374,8 @@ and optional for .br * \f[I]mangoxo\f[] .br +* \f[I]pillowfort\f[] +.br * \f[I]pinterest\f[] .br * \f[I]sankaku\f[] @@ -1286,7 +1305,8 @@ A (comma-separated) list of subcategories to include when processing a user profile. Possible values are -\f[I]"posts"\f[], \f[I]reels\f[], \f[I]"stories"\f[], \f[I]"highlights"\f[], \f[I]"channel"\f[]. +\f[I]"posts"\f[], \f[I]"reels"\f[], \f[I]"channel"\f[], \f[I]"tagged"\f[], +\f[I]"stories"\f[], \f[I]"highlights"\f[]. You can use \f[I]"all"\f[] instead of listing all values separately. @@ -1302,6 +1322,17 @@ You can use \f[I]"all"\f[] instead of listing all values separately. Download video files. +.SS extractor.kemonoparty.metadata +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Extract \f[I]username\f[] metadata + + .SS extractor.khinsider.format .IP "Type:" 6 \f[I]string\f[] @@ -1434,6 +1465,28 @@ port than the default. Download subalbums. +.SS extractor.pillowfort.external +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Follow links to external sites, e.g. Twitter, + + +.SS extractor.pillowfort.inline +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Extract inline images. + + .SS extractor.pillowfort.reblogs .IP "Type:" 6 \f[I]bool\f[] @@ -1478,7 +1531,7 @@ Download from video pins. Download user avatars. -.SS extractor.pixiv.work.related +.SS extractor.pixiv.user.metadata .IP "Type:" 6 \f[I]bool\f[] @@ -1486,10 +1539,10 @@ Download user avatars. \f[I]false\f[] .IP "Description:" 4 -Also download related artworks. +Fetch extended \f[I]user\f[] metadata. -.SS extractor.pixiv.translated-tags +.SS extractor.pixiv.work.related .IP "Type:" 6 \f[I]bool\f[] @@ -1497,7 +1550,25 @@ Also download related artworks. \f[I]false\f[] .IP "Description:" 4 -Provide translated ´tags`. +Also download related artworks. + + +.SS extractor.pixiv.tags +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"japanese"\f[] + +.IP "Description:" 4 +Controls the \f[I]tags\f[] metadata field. + +.br +* "japanese": List of Japanese tags +.br +* "translated": List of translated tags +.br +* "original": Unmodified list with both Japanese and translated tags .SS extractor.pixiv.ugoira @@ -1517,6 +1588,18 @@ Use an ugoira post processor to convert them to watchable videos. (Example__) +.SS extractor.pixiv.max-posts +.IP "Type:" 6 +\f[I]integer\f[] + +.IP "Default:" 9 +\f[I]0\f[] + +.IP "Description:" 4 +When downloading galleries, this sets the maximum number of posts to get. +A value of \f[I]0\f[] means no limit. + + .SS extractor.plurk.comments .IP "Type:" 6 \f[I]bool\f[] @@ -1848,6 +1931,21 @@ If this value is \f[I]"original"\f[], metadata for these files will be taken from the original Tweets, not the Retweets. +.SS extractor.twitter.text-tweets +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Also emit metadata for text-only Tweets without media content. + +This only has an effect with a \f[I]metadata\f[] (or \f[I]exec\f[]) post processor +with \f[I]"event": "post"\f[] +and appropriate \f[I]filename\f[]. + + .SS extractor.twitter.twitpic .IP "Type:" 6 \f[I]bool\f[] @@ -1965,7 +2063,10 @@ to use your account's browsing settings and filters. \f[I]true\f[] .IP "Description:" 4 -Extract media from retweeted posts. +Fetch media from retweeted posts. + +If this value is \f[I]"original"\f[], metadata for these files +will be taken from the original posts, not the retweeted posts. .SS extractor.weibo.videos @@ -2287,6 +2388,17 @@ Controls whether the output strings should be shortened to fit on one console line. +.SS output.skip +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Show skipped file downloads. + + .SS output.progress .IP "Type:" 6 \f[I]bool\f[] or \f[I]string\f[] @@ -2558,7 +2670,7 @@ The event for which metadata gets written to a file. The available events are: \f[I]init\f[] -After post procesor initialization +After post processor initialization and before the first file download \f[I]finalize\f[] On extractor shutdown, e.g. after all files were downloaded @@ -2631,6 +2743,19 @@ Filename extension for the resulting video files. Additional FFmpeg command-line arguments. +.SS ugoira.ffmpeg-demuxer +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]image2\f[] + +.IP "Description:" 4 +FFmpeg demuxer to read input files with. Possible values are +"\f[I]image2\f[]" and +"\f[I]concat\f[]". + + .SS ugoira.ffmpeg-location .IP "Type:" 6 \f[I]Path\f[] @@ -2714,6 +2839,18 @@ to the list of FFmpeg command-line arguments to reduce an odd width/height by 1 pixel and make them even. +.SS ugoira.repeat-last-frame +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Allow repeating the last frame when necessary +to prevent it from only being displayed for a very short amount of time. + + .SS zip.extension .IP "Type:" 6 \f[I]string\f[] |