diff options
| author | 2021-08-04 02:14:44 -0400 | |
|---|---|---|
| committer | 2021-08-04 02:14:44 -0400 | |
| commit | 873d9a628e9412a79bdc64cd962470749de3425b (patch) | |
| tree | 8cd421ef79a9fa784147fa888543216f0872357b /data | |
| parent | 32de2b06db501c7de81678bce8e3e0c3e63d340c (diff) | |
New upstream version 1.18.2.upstream/1.18.2
Diffstat (limited to 'data')
| -rw-r--r-- | data/man/gallery-dl.1 | 2 | ||||
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 285 |
2 files changed, 279 insertions, 8 deletions
diff --git a/data/man/gallery-dl.1 b/data/man/gallery-dl.1 index 25da021..ee57b4b 100644 --- a/data/man/gallery-dl.1 +++ b/data/man/gallery-dl.1 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL" "1" "2021-06-19" "1.18.0" "gallery-dl Manual" +.TH "GALLERY-DL" "1" "2021-07-23" "1.18.2" "gallery-dl Manual" .\" disable hyphenation .nh diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index 84e8e0e..91101d1 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-06-19" "1.18.0" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2021-07-23" "1.18.2" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -79,7 +79,7 @@ those as makeshift comments by settings their values to arbitrary strings. .IP "Example:" 4 .br -* .. code:: +* .. code:: json "{manga}_c{chapter}_{page:>03}.{extension}" @@ -135,13 +135,29 @@ a valid filename extension. .SS extractor.*.directory .IP "Type:" 6 -\f[I]list\f[] of \f[I]strings\f[] +\f[I]list\f[] of \f[I]strings\f[] or \f[I]object\f[] .IP "Example:" 4 +.br +* .. code:: json + ["{category}", "{manga}", "c{chapter} - {title}"] +.br +* .. code:: json + +{ +"'nature' in content": ["Nature Pictures"], +"retweet_id != 0" : ["{category}", "{user[name]}", "Retweets"], +"" : ["{category}", "{user[name]}"] +} + + .IP "Description:" 4 -A list of \f[I]format strings\f[] for the resulting target directory. +A list of \f[I]format strings\f[] to build target directory paths with. + +If this is an \f[I]object\f[], it must contain Python expressions mapping to the +list of format strings to use. Each individual string in such a list represents a single path segment, which will be joined together and appended to the @@ -174,13 +190,27 @@ for any spawned child extractors. .SS extractor.*.parent-metadata .IP "Type:" 6 -\f[I]bool\f[] +\f[I]bool\f[] or \f[I]string\f[] .IP "Default:" 9 \f[I]false\f[] .IP "Description:" 4 -Overwrite any metadata provided by a child extractor with its parent's. +If \f[I]true\f[], overwrite any metadata provided by a child extractor +with its parent's. + +If this is a \f[I]string\f[], add a parent's metadata to its children's +.br +to a field named after said string. +For example with \f[I]"parent-metadata": "_p_"\f[]: +.br + +.. code:: json + +{ +"id": "child-id", +"_p_": {"id": "parent-id"} +} .SS extractor.*.parent-skip @@ -194,6 +224,17 @@ Overwrite any metadata provided by a child extractor with its parent's. Share number of skipped downloads between parent and child extractors. +.SS extractor.*.url-metadata +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]null\f[] + +.IP "Description:" 4 +Insert a file's download URL into its metadata dictionary as the given name. + + .SS extractor.*.path-restrict .IP "Type:" 6 \f[I]string\f[] or \f[I]object\f[] @@ -555,7 +596,7 @@ any .IP "Description:" 4 Default value used for missing or undefined keyword names in -format strings. +\f[I]format strings\f[]. .SS extractor.*.category-transfer @@ -623,6 +664,17 @@ may pose a security risk. An alternative \f[I]format string\f[] to build archive IDs with. +.SS extractor.*.archive-prefix +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"{category}"\f[] + +.IP "Description:" 4 +Prefix for archive IDs. + + .SS extractor.*.postprocessors .IP "Type:" 6 \f[I]list\f[] of \f[I]Postprocessor Configuration\f[] objects @@ -862,6 +914,35 @@ descend into subfolders Download embedded videos hosted on https://www.blogger.com/ +.SS extractor.danbooru.ugoira +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Controls the download target for Ugoira posts. + +.br +* \f[I]true\f[]: Original ZIP archives +.br +* \f[I]false\f[]: Converted video files + + +.SS extractor.danbooru.metadata +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Extract additional metadata (notes, artist commentary, parent, children) + +Note: This requires 1 additional HTTP request for each post. + + .SS extractor.derpibooru.api-key .IP "Type:" 6 \f[I]string\f[] @@ -1341,6 +1422,17 @@ You can use \f[I]"all"\f[] instead of listing all values separately. Download video files. +.SS extractor.kemonoparty.max-posts +.IP "Type:" 6 +\f[I]integer\f[] + +.IP "Default:" 9 +\f[I]null\f[] + +.IP "Description:" 4 +Limit the number of posts to download. + + .SS extractor.kemonoparty.metadata .IP "Type:" 6 \f[I]bool\f[] @@ -1352,6 +1444,17 @@ Download video files. Extract \f[I]username\f[] metadata +.SS extractor.kemonoparty.patreon-skip-file +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Skip main files in Patreon posts to avoid duplicates. + + .SS extractor.khinsider.format .IP "Type:" 6 \f[I]string\f[] @@ -1380,6 +1483,62 @@ the first in the list gets chosen (usually mp3). The server to use for API requests. +.SS extractor.mangadex.lang +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Example:" 4 +"en" + +.IP "Description:" 4 +\f[I]ISO 639-1\f[] language code +to filter chapters by. + + +.SS extractor.mangadex.metadata +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Provide \f[I]artist\f[], \f[I]author\f[], and \f[I]group\f[] metadata fields. + + +.SS extractor.mastodon.reblogs +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Fetch media from reblogged posts. + + +.SS extractor.mastodon.replies +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Fetch media from replies to other posts. + + +.SS extractor.mastodon.text-posts +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Also emit metadata for text-only posts without media content. + + .SS extractor.newgrounds.flash .IP "Type:" 6 \f[I]bool\f[] @@ -2099,6 +2258,118 @@ will be taken from the original posts, not the retweeted posts. Download video files. +.SS extractor.ytdl.enabled +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Match **all** URLs, even ones without a \f[I]ytdl:\f[] prefix. + + +.SS extractor.ytdl.format +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +youtube-dl's default, currently \f[I]"bestvideo+bestaudio/best"\f[] + +.IP "Description:" 4 +Video \f[I]format selection +<https://github.com/ytdl-org/youtube-dl#format-selection>\f[] +directly passed to youtube-dl. + + +.SS extractor.ytdl.generic +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Controls the use of youtube-dl's generic extractor. + +Set this option to \f[I]"force"\f[] for the same effect as youtube-dl's +\f[I]--force-generic-extractor\f[]. + + +.SS extractor.ytdl.logging +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Route youtube-dl's output through gallery-dl's logging system. +Otherwise youtube-dl will write its output directly to stdout/stderr. + +Note: Set \f[I]quiet\f[] and \f[I]no_warnings\f[] in +\f[I]extractor.ytdl.raw-options\f[] to \f[I]true\f[] to suppress all output. + + +.SS extractor.ytdl.module +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"youtube_dl"\f[] + +.IP "Description:" 4 +Name of the youtube-dl Python module to import. + + +.SS extractor.ytdl.raw-options +.IP "Type:" 6 +\f[I]object\f[] + +.IP "Example:" 4 +.. code:: json + +{ +"quiet": true, +"writesubtitles": true, +"merge_output_format": "mkv" +} + + +.IP "Description:" 4 +Additional options passed directly to the \f[I]YoutubeDL\f[] constructor. + +All available options can be found in \f[I]youtube-dl's docstrings +<https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L138-L318>\f[]. + + +.SS extractor.[booru].tags +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Categorize tags by their respective types +and provide them as \f[I]tags_<type>\f[] metadata fields. + +Note: This requires 1 additional HTTP request for each post. + + +.SS extractor.[booru].notes +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Extract overlay notes (position and text). + +Note: This requires 1 additional HTTP request for each post. + + .SS extractor.[manga-extractor].chapter-reverse .IP "Type:" 6 \f[I]bool\f[] |
