diff options
Diffstat (limited to 'data/man/gallery-dl.conf.5')
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 329 |
1 files changed, 251 insertions, 78 deletions
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index 5fa271b..19a5812 100644 --- a/data/man/gallery-dl.conf.5 +++ b/data/man/gallery-dl.conf.5 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL.CONF" "5" "2023-07-15" "1.25.8" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2023-10-03" "1.26.0" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -243,7 +243,7 @@ Share number of skipped downloads between parent and child extractors. .br * "/!? (){}" .br -* {" ": "_", "/": "-", "|": "-", ":": "-", "*": "+"} +* {" ": "_", "/": "-", "|": "-", ":": "_-_", "*": "_+_"} .IP "Description:" 4 A string of characters to be replaced with the value of @@ -264,10 +264,22 @@ depending on the local operating system .br * \f[I]"windows"\f[]: \f[I]"\\\\\\\\|/<>:\\"?*"\f[] .br -* \f[I]"ascii"\f[]: \f[I]"^0-9A-Za-z_."\f[] +* \f[I]"ascii"\f[]: \f[I]"^0-9A-Za-z_."\f[] (only ASCII digits, letters, underscores, and dots) +.br +* \f[I]"ascii+"\f[]: \f[I]"^0-9@-[\\\\]-{ #-)+-.;=!}~"\f[] (all ASCII characters except the ones not allowed by Windows) -Note: In a string with 2 or more characters, \f[I][]^-\\\f[] need to be -escaped with backslashes, e.g. \f[I]"\\\\[\\\\]"\f[] +Implementation Detail: For \f[I]strings\f[] with length >= 2, this option uses a +\f[I]Regular Expression Character Set\f[], +meaning that: + +.br +* using a caret \f[I]^\f[] as first character inverts the set +.br +* character ranges are supported (\f[I]0-9a-z\f[]) +.br +* \f[I]]\f[], \f[I]-\f[], and \f[I]\\\f[] need to be escaped as +\f[I]\\\\]\f[], \f[I]\\\\-\f[], and \f[I]\\\\\\\\\f[] respectively +to use them as literal characters .SS extractor.*.path-replace @@ -460,8 +472,6 @@ and optional for .br * \f[I]exhentai\f[] .br -* \f[I]gfycat\f[] -.br * \f[I]idolcomplex\f[] .br * \f[I]imgbb\f[] @@ -542,7 +552,7 @@ Source to read additional cookies from. This can be } .br -* A \f[I]list\f[] with up to 4 entries specifying a browser profile. +* A \f[I]list\f[] with up to 5 entries specifying a browser profile. .br * The first entry is the browser name @@ -648,7 +658,7 @@ or a \f[I]list\f[] with IP and explicit port number as elements. \f[I]string\f[] .IP "Default:" 9 -\f[I]"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:115.0) Gecko/20100101 Firefox/115.0"\f[] +\f[I]"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/115.0"\f[] .IP "Description:" 4 User-Agent header value to be used for HTTP requests. @@ -686,6 +696,24 @@ Note: \f[I]requests\f[] and \f[I]urllib3\f[] only support HTTP/1.1, while a real browser would use HTTP/2. +.SS extractor.*.referer +.IP "Type:" 6 +.br +* \f[I]bool\f[] +.br +* \f[I]string\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Send \f[I]Referer\f[] +headers with all outgoing HTTP requests. + +If this is a \f[I]string\f[], send it as Referer +instead of the extractor's \f[I]root\f[] domain. + + .SS extractor.*.headers .IP "Type:" 6 \f[I]object\f[] (name -> value) @@ -697,7 +725,8 @@ browser would use HTTP/2. "User-Agent" : "<extractor.*.user-agent>", "Accept" : "*/*", "Accept-Language": "en-US,en;q=0.5", -"Accept-Encoding": "gzip, deflate" +"Accept-Encoding": "gzip, deflate", +"Referer" : "<extractor.*.referer>" } @@ -844,7 +873,7 @@ config options. \f[I]["oauth", "recursive", "test"]\f[] + current extractor category .IP "Example:" 4 -["imgur", "gfycat:user", "*:image"] +["imgur", "redgifs:user", "*:image"] .IP "Description:" 4 A list of extractor identifiers to ignore (or allow) @@ -856,7 +885,7 @@ Each identifier can be .br * A category or basecategory name (\f[I]"imgur"\f[], \f[I]"mastodon"\f[]) .br -* | A (base)category-subcategory pair, where both names are separated by a colon (\f[I]"gfycat:user"\f[]). +* | A (base)category-subcategory pair, where both names are separated by a colon (\f[I]"redgifs:user"\f[]). Both names can be a * or left empty, matching all possible names (\f[I]"*:image"\f[], \f[I]":user"\f[]). .br @@ -1363,7 +1392,7 @@ for possible field names. \f[I]aibooru\f[] also supports \f[I]ai_metadata\f[]. Note: This requires 1 additional HTTP request per 200-post batch. -.SS extractor.{Danbooru].threshold +.SS extractor.[Danbooru].threshold .IP "Type:" 6 .br * \f[I]string\f[] @@ -1555,6 +1584,19 @@ literature and status updates. * \f[I]"none"\f[]: Don't download textual content. +.SS extractor.deviantart.jwt +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Update \f[I]JSON Web Tokens\f[] (the \f[I]token\f[] URL parameter) +of otherwise non-downloadable, low-resolution images +to be able to download them in full resolution. + + .SS extractor.deviantart.mature .IP "Type:" 6 \f[I]bool\f[] @@ -1630,6 +1672,20 @@ Disable this option to *force* using a private token for all requests when a \f[I]refresh token\f[] is provided. +.SS extractor.deviantart.quality +.IP "Type:" 6 +\f[I]integer\f[] + +.IP "Default:" 9 +\f[I]100\f[] + +.IP "Description:" 4 +JPEG quality level of newer images for which +an original file download is not available. + +Note: Only has an effect when \f[I]deviantart.jwt\f[] is disabled. + + .SS extractor.deviantart.refresh-token .IP "Type:" 6 \f[I]string\f[] @@ -1721,6 +1777,23 @@ depending on the input URL * \f[I]"exhentai.org"\f[]: Use \f[I]exhentai.org\f[] for all URLs +.SS extractor.exhentai.fav +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Example:" 4 +"4" + +.IP "Description:" 4 +After downloading a gallery, +add it to your account's favorites as the given category number. + +Note: Set this to "favdel" to remove galleries from your favorites. + +Note: This will remove any Favorite Notes when applied +to already favorited galleries. + + .SS extractor.exhentai.limits .IP "Type:" 6 \f[I]integer\f[] @@ -1978,32 +2051,6 @@ Match **all** URLs not otherwise supported by gallery-dl, even ones without a \f[I]generic:\f[] prefix. -.SS extractor.gfycat.format -.IP "Type:" 6 -.br -* \f[I]string\f[] -.br -* \f[I]list\f[] of \f[I]strings\f[] - -.IP "Default:" 9 -\f[I]["mp4", "webm", "mobile", "gif"]\f[] - -.IP "Description:" 4 -List of names of the preferred animation format, which can be -\f[I]"mp4"\f[], -\f[I]"webm"\f[], -\f[I]"mobile"\f[], -\f[I]"gif"\f[], or -\f[I]"webp"\f[]. - -If a selected format is not available, the next one in the list will be -tried until an available format is found. - -If the format is given as \f[I]string\f[], it will be extended with -\f[I]["mp4", "webm", "mobile", "gif"]\f[]. Use a list with one element to -restrict it to only one possible format. - - .SS extractor.gofile.api-token .IP "Type:" 6 \f[I]string\f[] @@ -2444,13 +2491,21 @@ and \f[I]/user/follows/manga/feed\f[]) .SS extractor.mangadex.lang .IP "Type:" 6 -\f[I]string\f[] +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] .IP "Example:" 4 -"en" +.br +* "en" +.br +* "fr,it" +.br +* ["fr", "it"] .IP "Description:" 4 -\f[I]ISO 639-1\f[] language code +\f[I]ISO 639-1\f[] language codes to filter chapters by. @@ -3110,6 +3165,18 @@ Ignore all submissions posted before/after this date. Ignore all submissions posted before/after the submission with this ID. +.SS extractor.reddit.previews +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +For failed downloads from external URLs / child extractors, +download Reddit's preview image/video if available. + + .SS extractor.reddit.recursion .IP "Type:" 6 \f[I]integer\f[] @@ -3596,6 +3663,38 @@ Age-restricted replies cannot be expanded when using the \f[I]syndication\f[] API. +.SS extractor.twitter.include +.IP "Type:" 6 +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] + +.IP "Default:" 9 +\f[I]"timeline"\f[] + +.IP "Example:" 4 +.br +* "avatar,background,media" +.br +* ["avatar", "background", "media"] + +.IP "Description:" 4 +A (comma-separated) list of subcategories to include +when processing a user profile. + +Possible values are +\f[I]"avatar"\f[], +\f[I]"background"\f[], +\f[I]"timeline"\f[], +\f[I]"tweets"\f[], +\f[I]"media"\f[], +\f[I]"replies"\f[], +\f[I]"likes"\f[]. + +It is possible to use \f[I]"all"\f[] instead of listing all values separately. + + .SS extractor.twitter.transform .IP "Type:" 6 \f[I]bool\f[] @@ -3607,6 +3706,24 @@ Age-restricted replies cannot be expanded when using the Transform Tweet and User metadata into a simpler, uniform format. +.SS extractor.twitter.tweet-endpoint +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"auto"\f[] + +.IP "Description:" 4 +Selects the API endpoint used to retrieve single Tweets. + +.br +* \f[I]"restid"\f[]: \f[I]/TweetResultByRestId\f[] - accessible to guest users +.br +* \f[I]"detail"\f[]: \f[I]/TweetDetail\f[] - more stable +.br +* \f[I]"auto"\f[]: \f[I]"detail"\f[] when logged in, \f[I]"restid"\f[] otherwise + + .SS extractor.twitter.size .IP "Type:" 6 \f[I]list\f[] of \f[I]strings\f[] @@ -3740,22 +3857,6 @@ 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.search-endpoint -.IP "Type:" 6 -\f[I]string\f[] - -.IP "Default:" 9 -\f[I]"graphql"\f[] - -.IP "Description:" 4 -Selects the API endpoint used to retrieve search results. - -.br -* \f[I]"graphql"\f[]: GraphQL endpoint -.br -* \f[I]"rest"\f[]: Legacy REST endpoint - - .SS extractor.twitter.timeline.strategy .IP "Type:" 6 \f[I]string\f[] @@ -3764,8 +3865,8 @@ Selects the API endpoint used to retrieve search results. \f[I]"auto"\f[] .IP "Description:" 4 -Controls the strategy / tweet source used for user URLs -(\f[I]https://twitter.com/USER\f[]). +Controls the strategy / tweet source used for timeline URLs +(\f[I]https://twitter.com/USER/timeline\f[]). .br * \f[I]"tweets"\f[]: \f[I]/tweets\f[] timeline + search @@ -3819,7 +3920,7 @@ Ignore previously seen Tweets. \f[I]string\f[] .IP "Default:" 9 -\f[I]"timeline"\f[] +\f[I]"user"\f[] .IP "Example:" 4 "https://twitter.com/search?q=from:{legacy[screen_name]}" @@ -3835,7 +3936,9 @@ whose replacement field values come from Twitter \f[I]user\f[] objects Special values: .br -* \f[I]"timeline"\f[]: \f[I]https://twitter.com/i/user/{rest_id}\f[] +* \f[I]"user"\f[]: \f[I]https://twitter.com/i/user/{rest_id}\f[] +.br +* \f[I]"timeline"\f[]: \f[I]https://twitter.com/id:{rest_id}/timeline\f[] .br * \f[I]"tweets"\f[]: \f[I]https://twitter.com/id:{rest_id}/tweets\f[] .br @@ -5145,8 +5248,15 @@ After post processor initialization and before the first file download \f[I]finalize\f[] On extractor shutdown, e.g. after all files were downloaded +\f[I]finalize-success\f[] +On extractor shutdown when no error occurred +\f[I]finalize-error\f[] +On extractor shutdown when at least one error occurred \f[I]prepare\f[] Before a file download +\f[I]prepare-after\f[] +Before a file download, +but after building and checking file paths \f[I]file\f[] When completing a file download, but before it gets moved to its target location @@ -5388,7 +5498,7 @@ See \f[I]metadata.event\f[] .IP "Description:" 4 Name of the metadata field whose value should be used. -This value must either be a UNIX timestamp or a +This value must be either a UNIX timestamp or a \f[I]datetime\f[] object. Note: This option gets ignored if \f[I]mtime.value\f[] is set. @@ -5410,10 +5520,58 @@ Note: This option gets ignored if \f[I]mtime.value\f[] is set. .IP "Description:" 4 A \f[I]format string\f[] whose value should be used. -The resulting value must either be a UNIX timestamp or a +The resulting value must be either a UNIX timestamp or a \f[I]datetime\f[] object. +.SS python.archive +.IP "Type:" 6 +\f[I]Path\f[] + +.IP "Description:" 4 +File to store IDs of called Python functions in, +similar to \f[I]extractor.*.archive\f[]. + +\f[I]archive-format\f[], \f[I]archive-prefix\f[], and \f[I]archive-pragma\f[] options, +akin to +\f[I]extractor.*.archive-format\f[], +\f[I]extractor.*.archive-prefix\f[], and +\f[I]extractor.*.archive-pragma\f[], are supported as well. + + +.SS python.event +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"file"\f[] + +.IP "Description:" 4 +The event for which \f[I]python.function\f[] gets called. + +See \f[I]metadata.event\f[] for a list of available events. + + +.SS python.function +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Example:" 4 +.br +* "my_module:generate_text" +.br +* "~/.local/share/gdl-utils.py:resize" + +.IP "Description:" 4 +The Python function to call. + +This function gets specified as \f[I]<module>:<function name>\f[] +and gets called with the current metadata dict as argument. + +\f[I]module\f[] is either an importable Python module name +or the \f[I]Path\f[] to a .py file, + + .SS ugoira.extension .IP "Type:" 6 \f[I]string\f[] @@ -5484,13 +5642,24 @@ Location of the \f[I]mkvmerge\f[] executable for use with the .SS ugoira.ffmpeg-output .IP "Type:" 6 -\f[I]bool\f[] +.br +* \f[I]bool\f[] +.br +* \f[I]string\f[] .IP "Default:" 9 -\f[I]true\f[] +\f[I]"error"\f[] .IP "Description:" 4 -Show FFmpeg output. +Controls FFmpeg output. + +.br +* \f[I]true\f[]: Enable FFmpeg output +.br +* \f[I]false\f[]: Disable all FFmpeg output +.br +* any \f[I]string\f[]: Pass \f[I]-hide_banner\f[] and \f[I]-loglevel\f[] +with this value as argument to FFmpeg .SS ugoira.ffmpeg-twopass @@ -5518,6 +5687,9 @@ Controls the frame rate argument (\f[I]-r\f[]) for FFmpeg * \f[I]"auto"\f[]: Automatically assign a fitting frame rate based on delays between frames. .br +* \f[I]"uniform"\f[]: Like \f[I]auto\f[], but assign an explicit frame rate +only to Ugoira with uniform frame delays. +.br * any other \f[I]string\f[]: Use this value as argument for \f[I]-r\f[]. .br * \f[I]null\f[] or an empty \f[I]string\f[]: Don't set an explicit frame rate. @@ -5741,28 +5913,27 @@ The list of signal names to ignore, i.e. set as signal handler for. -.SS warnings +.SS subconfigs .IP "Type:" 6 -\f[I]string\f[] +\f[I]list\f[] of \f[I]Path\f[] -.IP "Default:" 9 -\f[I]"default"\f[] +.IP "Example:" 4 +["~/cfg-twitter.json", "~/cfg-reddit.json"] .IP "Description:" 4 -The \f[I]Warnings Filter action\f[] -used for (urllib3) warnings. +Additional configuration files to load. -.SS pyopenssl +.SS warnings .IP "Type:" 6 -\f[I]bool\f[] +\f[I]string\f[] .IP "Default:" 9 -\f[I]false\f[] +\f[I]"default"\f[] .IP "Description:" 4 -Use \f[I]pyOpenSSL\f[]-backed -SSL-support. +The \f[I]Warnings Filter action\f[] +used for (urllib3) warnings. .SH API TOKENS & IDS @@ -6107,6 +6278,8 @@ Execute external commands Write metadata to separate files \f[I]mtime\f[] Set file modification time according to its metadata +\f[I]python\f[] +Call Python functions \f[I]ugoira\f[] Convert Pixiv Ugoira to WebM using \f[I]FFmpeg\f[] \f[I]zip\f[] |