diff options
Diffstat (limited to 'data/man')
| -rw-r--r-- | data/man/gallery-dl.1 | 6 | ||||
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 287 |
2 files changed, 271 insertions, 22 deletions
diff --git a/data/man/gallery-dl.1 b/data/man/gallery-dl.1 index 591daae..06effd6 100644 --- a/data/man/gallery-dl.1 +++ b/data/man/gallery-dl.1 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL" "1" "2024-09-06" "1.27.4" "gallery-dl Manual" +.TH "GALLERY-DL" "1" "2024-09-28" "1.27.5" "gallery-dl Manual" .\" disable hyphenation .nh @@ -92,7 +92,7 @@ Add input URLs which returned an error to FILE .B "\-\-list\-modules" Print a list of available extractor modules .TP -.B "\-\-list\-extractors" +.B "\-\-list\-extractors" \f[I]CATEGORIES\f[] Print a list of extractor classes with description, (sub)category and example URL .TP .B "\-\-write\-log" \f[I]FILE\f[] @@ -255,7 +255,7 @@ Rename previously downloaded files from FORMAT to the current filename format Rename previously downloaded files from the current filename format to FORMAT .TP .B "\-\-ugoira" \f[I]FMT\f[] -Convert Pixiv Ugoira to FMT using FFmpeg. Supported formats are 'webm', 'mp4', 'gif', 'vp8', 'vp9', 'vp9-lossless', 'copy'. +Convert Pixiv Ugoira to FMT using FFmpeg. Supported formats are 'webm', 'mp4', 'gif', 'vp8', 'vp9', 'vp9-lossless', 'copy', 'zip'. .TP .B "\-\-exec" \f[I]CMD\f[] Execute CMD for each downloaded file. Supported replacement fields are {} or {_path}, {_directory}, {_filename}. Example: --exec "convert {} {}.png && rm {}" diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index e0d75ac..a36e108 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-09-06" "1.27.4" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2024-09-28" "1.27.5" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -454,6 +454,7 @@ response before \f[I]retrying\f[] the request. .IP "Default:" 9 .br * \f[I]"0.5-1.5"\f[] +\f[I]ao3\f[], \f[I]civitai\f[], \f[I][Danbooru]\f[], \f[I][E621]\f[], \f[I][foolfuuka]:search\f[], \f[I]itaku\f[], \f[I]koharu\f[], \f[I]newgrounds\f[], \f[I][philomena]\f[], \f[I]pixiv:novel\f[], \f[I]plurk\f[], @@ -494,18 +495,13 @@ during data extraction. The username and password to use when attempting to log in to another site. -Specifying username and password is required for - -.br -* \f[I]nijie\f[] -.br -* \f[I]horne\f[] - -and optional for +This is supported for .br * \f[I]aibooru\f[] (*) .br +* \f[I]ao3\f[] +.br * \f[I]aryion\f[] .br * \f[I]atfbooru\f[] (*) @@ -528,6 +524,8 @@ and optional for .br * \f[I]exhentai\f[] .br +* \f[I]horne\f[] (R) +.br * \f[I]idolcomplex\f[] .br * \f[I]imgbb\f[] @@ -542,10 +540,16 @@ and optional for .br * \f[I]mangoxo\f[] .br +* \f[I]newgrounds\f[] +.br +* \f[I]nijie\f[] (R) +.br * \f[I]pillowfort\f[] .br * \f[I]sankaku\f[] .br +* \f[I]seiga\f[] +.br * \f[I]subscribestar\f[] .br * \f[I]tapas\f[] @@ -565,6 +569,9 @@ by using a \f[I].netrc\f[] file. (see Authentication_) (*) The password value for these sites should be the API key found in your user profile, not the actual account password. +(R) Login with username & password or supplying logged-in +\f[I]cookies\f[] is required + Note: Leave the \f[I]password\f[] value empty or undefined to be prompted for a passeword when performing a login (see \f[I]getpass()\f[]). @@ -575,7 +582,7 @@ to be prompted for a passeword when performing a login \f[I]bool\f[] .IP "Default:" 9 -\f[I]true\f[] if stdin is attached to a terminal , +\f[I]true\f[] if stdin is attached to a terminal, \f[I]false\f[] otherwise .IP "Description:" 4 @@ -633,9 +640,9 @@ Source to read additional cookies from. This can be .br * The optional third entry is the keyring to retrieve passwords for decrypting cookies from .br -* The optional fourth entry is a (Firefox) container name (\f[I]"none"\f[] for only cookies with no container) +* The optional fourth entry is a (Firefox) container name (\f[I]"none"\f[] for only cookies with no container (default)) .br -* The optional fifth entry is the domain to extract cookies for. Prefix it with a dot \f[I].\f[] to include cookies for subdomains. Has no effect when also specifying a container. +* The optional fifth entry is the domain to extract cookies for. Prefix it with a dot \f[I].\f[] to include cookies for subdomains. .. code:: json @@ -644,6 +651,32 @@ Source to read additional cookies from. This can be ["chromium", "Private", "kwallet", null, ".twitter.com"] +.SS extractor.*.cookies-select +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"random"\f[] + +.IP "Description:" 4 +Interpret \f[I]extractor.cookies\f[] +as a list of cookie sources and select one of them for each extractor run. + +.br +* \f[I]"random"\f[]: Select cookies \f[I]randomly\f[] +.br +* \f[I]"rotate"\f[]: Select cookies in sequence. Start over from the beginning after reaching the end of the list. + +.. code:: json + +[ +"~/.local/share/cookies-instagram-com-1.txt", +"~/.local/share/cookies-instagram-com-2.txt", +"~/.local/share/cookies-instagram-com-3.txt", +["firefox", null, null, "c1", ".instagram-com"], +] + + .SS extractor.*.cookies-update .IP "Type:" 6 .br @@ -1492,6 +1525,26 @@ Special values: .SH EXTRACTOR-SPECIFIC OPTIONS +.SS extractor.ao3.formats +.IP "Type:" 6 +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] + +.IP "Default:" 9 +\f[I]"pdf"\f[] + +.IP "Example:" 4 +.br +* "azw3,epub,mobi,pdf,html" +.br +* ["azw3", "epub", "mobi", "pdf", "html"] + +.IP "Description:" 4 +Format(s) to download. + + .SS extractor.artstation.external .IP "Type:" 6 \f[I]bool\f[] @@ -1697,6 +1750,17 @@ Sets the maximum depth of returned reply posts. Process reposts. +.SS extractor.bluesky.videos +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Download videos. + + .SS extractor.bunkr.tlds .IP "Type:" 6 \f[I]bool\f[] @@ -1721,7 +1785,7 @@ Controls which \f[I]bunkr\f[] TLDs to accept. \f[I]["image", "video", "download", "gallery"]\f[] .IP "Description:" 4 -Determines the type and order of files to be downloaded. +Determines the type and order of files to download. Available types are \f[I]image\f[], @@ -1730,6 +1794,151 @@ Available types are \f[I]gallery\f[]. +.SS extractor.civitai.api +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"rest"\f[] + +.IP "Description:" 4 +Selects which API endpoints to use. + +.br +* \f[I]"rest"\f[]: \f[I]Public REST API\f[] +.br +* \f[I]"trpc"\f[]: Internal TRPC API + + +.SS extractor.civitai.api-key +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Description:" 4 +The API Key value generated in your +\f[I]User Account Settings\f[] +to make authorized API requests. + +See \f[I]API/Authorization\f[] +for details. + + +.SS extractor.civitai.files +.IP "Type:" 6 +\f[I]list\f[] of \f[I]strings\f[] + +.IP "Default:" 9 +\f[I]["image"]\f[] + +.IP "Description:" 4 +Determines the type and order of files to download when processing models. + +Available types are +\f[I]model\f[], +\f[I]image\f[], +\f[I]gallery\f[]. + + +.SS extractor.civitai.nsfw +.IP "Type:" 6 +.br +* \f[I]bool\f[] +.br +* \f[I]string\f[] (\f[I]"api": "rest"\f[]) +.br +* \f[I]integer\f[] (\f[I]"api": "trpc"\f[]) + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Download images rated NSFW. + +.br +* For \f[I]"api": "rest"\f[], this can be one of +\f[I]"None"\f[], \f[I]"Soft"\f[], \f[I]"Mature"\f[], \f[I]"X"\f[] +to set the highest returned mature content flag. + +.br +* For \f[I]"api": "trpc"\f[], this can be an \f[I]integer\f[] +whose bits select the returned mature content flags. + +For example, \f[I]12\f[] (\f[I]4\f[I]8\f[]) would return only +\f[I]Mature\f[] and \f[I]X\f[] rated images, +while \f[I]3\f[] (\f[I]1\f[]2\f[]) would return only +\f[I]None\f[] and \f[I]Soft\f[] rated images, + + +.SS extractor.civitai.quality +.IP "Type:" 6 +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] + +.IP "Default:" 9 +\f[I]"original=true"\f[] + +.IP "Example:" 4 +.br +* "width=1280,quality=90" +.br +* ["width=1280", "quality=90"] + +.IP "Description:" 4 +A (comma-separated) list of image quality options +to pass with every image URL. + +Known available options include \f[I]original\f[], \f[I]quality\f[], \f[I]width\f[] + +Note: Set this option to an arbitrary letter, e.g., \f[I]"w"\f[], +to download images in JPEG format at their original resolution. + + +.SS extractor.cohost.asks +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Extract \f[I]ask\f[] posts. + + +.SS extractor.cohost.pinned +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Extract pinned posts. + + +.SS extractor.cohost.replies +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Extract reply posts. + + +.SS extractor.cohost.shares +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Extract shared posts. + + .SS extractor.cyberdrop.domain .IP "Type:" 6 \f[I]string\f[] @@ -2141,7 +2350,7 @@ Download original files if available. Setting this option to \f[I]"images"\f[] only downloads original files if they are images and falls back to preview versions for -everything else (archives, etc.). +everything else (archives, videos, etc.). .SS extractor.deviantart.pagination @@ -2160,6 +2369,20 @@ Controls when to stop paginating over API results. * \f[I]"manual"\f[]: Disregard \f[I]has_more\f[] and only stop when a batch of results is empty. +.SS extractor.deviantart.previews +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +For non-image files (archives, videos, etc.), +also download the file's preview image. + +Set this option to \f[I]"all"\f[] to download previews for all files. + + .SS extractor.deviantart.public .IP "Type:" 6 \f[I]bool\f[] @@ -3798,19 +4021,25 @@ Controls the \f[I]tags\f[] metadata field. .SS extractor.pixiv.ugoira .IP "Type:" 6 -\f[I]bool\f[] +.br +* \f[I]bool\f[] +.br +* \f[I]string\f[] .IP "Default:" 9 \f[I]true\f[] .IP "Description:" 4 -Download Pixiv's Ugoira animations or ignore them. +Download Pixiv's Ugoira animations. + +These animations come as a \f[I].zip\f[] archive containing all +animation frames in JPEG format by default. -These animations come as a \f[I].zip\f[] file containing all -animation frames in JPEG format. +Set this option to \f[I]"original"\f[] +to download them as individual, higher-quality frames. Use an ugoira post processor to convert them -to watchable videos. (Example__) +to watchable animations. (Example__) .SS extractor.pixiv.max-posts @@ -7137,6 +7366,8 @@ Possible values are * "\f[I]image2\f[]" (accurate timecodes, requires nanosecond file timestamps, i.e. no Windows or macOS) .br * "mkvmerge" (accurate timecodes, only WebM or MKV, requires \f[I]mkvmerge\f[]) +.br +* "archive" (store "original" frames in a \f[I].zip\f[] archive) "auto" will select mkvmerge if available and fall back to concat otherwise. @@ -7250,6 +7481,24 @@ to the list of \f[I]ffmpeg\f[] command-line arguments to reduce an odd width/height by 1 pixel and make them even. +.SS ugoira.metadata +.IP "Type:" 6 +.br +* \f[I]bool\f[] +.br +* \f[I]string\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +When using \f[I]"mode": "archive"\f[], save Ugoira frame delay data as +\f[I]animation.json\f[] within the archive file. + +If this is a \f[I]string\f[], +use it as alternate filename for frame delay files. + + .SS ugoira.mtime .IP "Type:" 6 \f[I]bool\f[] |