diff options
Diffstat (limited to 'data/man/gallery-dl.conf.5')
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 346 |
1 files changed, 226 insertions, 120 deletions
diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index 5db584b..e3ed58a 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-06-01" "1.27.0" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2024-06-22" "1.27.1" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -568,6 +568,18 @@ to be prompted for a passeword when performing a login (see \f[I]getpass()\f[]). +.SS extractor.*.input +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] if stdin is attached to a terminal , +\f[I]false\f[] otherwise + +.IP "Description:" 4 +Allow prompting the user for interactive input. + + .SS extractor.*.netrc .IP "Type:" 6 \f[I]bool\f[] @@ -1056,7 +1068,7 @@ Prefix for archive IDs. .IP "Description:" 4 A list of SQLite \f[I]PRAGMA\f[] statements to run during archive initialization. -See \f[I]<https://www.sqlite.org/pragma.html>\f[] +See \f[I]<https://www.sqlite.org/pragma.html#toc>\f[] for available \f[I]PRAGMA\f[] statements and further details. @@ -1752,6 +1764,20 @@ to access 18+ content without \f[I]API Key\f[]. See \f[I]Filters\f[] for details. +.SS extractor.derpibooru.svg +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Download SVG versions of images when available. + +Try to download the \f[I]view_url\f[] version of these posts +when this option is disabled. + + .SS extractor.deviantart.auto-watch .IP "Type:" 6 \f[I]bool\f[] @@ -2300,8 +2326,8 @@ Control behavior on embedded content from external sites. * \f[I]true\f[]: Extract embed URLs and download them if supported (videos are not downloaded). .br -* \f[I]"ytdl"\f[]: Like \f[I]true\f[], but let \f[I]youtube-dl\f[] handle video -extraction and download for YouTube, Vimeo and SoundCloud embeds. +* \f[I]"ytdl"\f[]: Like \f[I]true\f[], but let \f[I]ytdl\f[] handle video +extraction and download for YouTube, Vimeo, and SoundCloud embeds. .br * \f[I]false\f[]: Ignore embeds. @@ -3205,13 +3231,19 @@ Download original Adobe Flash animations instead of pre-rendered videos. .SS extractor.newgrounds.format .IP "Type:" 6 -\f[I]string\f[] +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]string\f[] .IP "Default:" 9 \f[I]"original"\f[] .IP "Example:" 4 -"720p" +.br +* "720p" +.br +* ["mp4", "mov", "1080p", "720p"] .IP "Description:" 4 Selects the preferred format for video downloads. @@ -3219,6 +3251,10 @@ Selects the preferred format for video downloads. If the selected format is not available, the next smaller one gets chosen. +If this is a \f[I]list\f[], try each given +filename extension in original resolution or recoded format +until an available format is found. + .SS extractor.newgrounds.include .IP "Type:" 6 @@ -3304,7 +3340,7 @@ Control video download behavior. .br * \f[I]true\f[]: Download videos .br -* \f[I]"ytdl"\f[]: Download videos using \f[I]youtube-dl\f[] +* \f[I]"ytdl"\f[]: Download videos using \f[I]ytdl\f[] .br * \f[I]false\f[]: Skip video Tweets @@ -3392,17 +3428,6 @@ Available types are \f[I]postfile\f[], \f[I]images\f[], \f[I]image_large\f[], \f[I]attachments\f[], and \f[I]content\f[]. -.SS extractor.photobucket.subalbums -.IP "Type:" 6 -\f[I]bool\f[] - -.IP "Default:" 9 -\f[I]true\f[] - -.IP "Description:" 4 -Download subalbums. - - .SS extractor.pillowfort.external .IP "Type:" 6 \f[I]bool\f[] @@ -3826,13 +3851,13 @@ at 600 requests every 10 minutes/600 seconds. Control video download behavior. .br -* \f[I]true\f[]: Download videos and use \f[I]youtube-dl\f[] to handle +* \f[I]true\f[]: Download videos and use \f[I]ytdl\f[] to handle HLS and DASH manifests .br -* \f[I]"ytdl"\f[]: Download videos and let \f[I]youtube-dl\f[] handle all of +* \f[I]"ytdl"\f[]: Download videos and let \f[I]ytdl\f[] handle all of video extraction and download .br -* \f[I]"dash"\f[]: Extract DASH manifest URLs and use \f[I]youtube-dl\f[] +* \f[I]"dash"\f[]: Extract DASH manifest URLs and use \f[I]ytdl\f[] to download and merge them. (*) .br * \f[I]false\f[]: Ignore videos @@ -4398,6 +4423,20 @@ to access 18+ content without \f[I]API Key\f[]. See \f[I]Filters\f[] for details. +.SS extractor.twibooru.svg +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Download SVG versions of images when available. + +Try to download the \f[I]view_url\f[] version of these posts +when this option is disabled. + + .SS extractor.twitter.ads .IP "Type:" 6 \f[I]bool\f[] @@ -4427,7 +4466,8 @@ Controls how to handle \f[I]Twitter Cards\f[]. .br * \f[I]true\f[]: Download image content from supported cards .br -* \f[I]"ytdl"\f[]: Additionally download video content from unsupported cards using \f[I]youtube-dl\f[] +* \f[I]"ytdl"\f[]: Additionally download video content from unsupported cards +using \f[I]ytdl\f[] .SS extractor.twitter.cards-blacklist @@ -4506,6 +4546,18 @@ for each Tweet in said timeline. Note: This requires at least 1 additional API call per initial Tweet. +.SS extractor.twitter.unavailable +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Try to download media marked as \f[I]Unavailable\f[], +e.g. \f[I]Geoblocked\f[] videos. + + .SS extractor.twitter.include .IP "Type:" 6 .br @@ -4633,6 +4685,8 @@ Selects how to handle exceeding the API rate limit. * \f[I]"abort"\f[]: Raise an error and stop extraction .br * \f[I]"wait"\f[]: Wait until rate limit reset +.br +* \f[I]"wait:N"\f[]: Wait for \f[I]N\f[] seconds .SS extractor.twitter.relogin @@ -4644,10 +4698,8 @@ Selects how to handle exceeding the API rate limit. .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. @@ -4760,6 +4812,18 @@ Extract \f[I]TwitPic\f[] embeds. Ignore previously seen Tweets. +.SS extractor.twitter.username-alt +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Description:" 4 +Alternate Identifier (username, email, phone number) +when \f[I]logging in\f[]. + +When not specified and asked for by Twitter, +this identifier will need to entered in an interactive prompt. + + .SS extractor.twitter.users .IP "Type:" 6 \f[I]string\f[] @@ -4809,7 +4873,7 @@ Control video download behavior. .br * \f[I]true\f[]: Download videos .br -* \f[I]"ytdl"\f[]: Download videos using \f[I]youtube-dl\f[] +* \f[I]"ytdl"\f[]: Download videos using \f[I]ytdl\f[] .br * \f[I]false\f[]: Skip video Tweets @@ -5025,6 +5089,39 @@ will be taken from the original posts, not the retweeted posts. Download video files. +.SS extractor.ytdl.cmdline-args +.IP "Type:" 6 +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] + +.IP "Example:" 4 +.br +* "--quiet --write-sub --merge-output-format mkv" +.br +* ["--quiet", "--write-sub", "--merge-output-format", "mkv"] + +.IP "Description:" 4 +Additional \f[I]ytdl\f[] options specified as command-line arguments. + +See +\f[I]yt-dlp options\f[] +/ +\f[I]youtube-dl options\f[] + + +.SS extractor.ytdl.config-file +.IP "Type:" 6 +\f[I]Path\f[] + +.IP "Example:" 4 +"~/.config/yt-dlp/config" + +.IP "Description:" 4 +Location of a \f[I]ytdl\f[] configuration file to load options from. + + .SS extractor.ytdl.enabled .IP "Type:" 6 \f[I]bool\f[] @@ -5033,7 +5130,7 @@ Download video files. \f[I]false\f[] .IP "Description:" 4 -Match **all** URLs, even ones without a \f[I]ytdl:\f[] prefix. +Process URLs otherwise unsupported by gallery-dl with \f[I]ytdl\f[]. .SS extractor.ytdl.format @@ -5041,25 +5138,35 @@ Match **all** URLs, even ones without a \f[I]ytdl:\f[] prefix. \f[I]string\f[] .IP "Default:" 9 -youtube-dl's default, currently \f[I]"bestvideo+bestaudio/best"\f[] +Default of the \f[I]ytdl\f[] \f[I]module\f[] used. +.br +(\f[I]"bestvideo*+bestaudio/best"\f[] for \f[I]yt_dlp\f[], +.br +\f[I]"bestvideo+bestaudio/best"\f[] for \f[I]youtube_dl\f[]) .IP "Description:" 4 -Video \f[I]format selection -<https://github.com/ytdl-org/youtube-dl#format-selection>\f[] -directly passed to youtube-dl. +\f[I]ytdl\f[] format selection string. + +See +\f[I]yt-dlp format selection\f[] +/ +\f[I]youtube-dl format selection\f[] .SS extractor.ytdl.generic .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 -Controls the use of youtube-dl's generic extractor. +Enables the use of \f[I]ytdl's\f[] \f[I]generic\f[] extractor. -Set this option to \f[I]"force"\f[] for the same effect as youtube-dl's +Set this option to \f[I]"force"\f[] for the same effect as \f[I]--force-generic-extractor\f[]. @@ -5071,8 +5178,8 @@ Set this option to \f[I]"force"\f[] for the same effect as youtube-dl's \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. +Route \f[I]ytdl's\f[] output through gallery-dl's logging system. +Otherwise it will be written 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. @@ -5086,7 +5193,7 @@ Note: Set \f[I]quiet\f[] and \f[I]no_warnings\f[] in \f[I]null\f[] .IP "Description:" 4 -Name of the youtube-dl Python module to import. +Name of the \f[I]ytdl\f[] Python module to import. Setting this to \f[I]null\f[] will try to import \f[I]"yt_dlp"\f[] followed by \f[I]"youtube_dl"\f[] as fallback. @@ -5109,36 +5216,10 @@ followed by \f[I]"youtube_dl"\f[] as fallback. .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.ytdl.cmdline-args -.IP "Type:" 6 -.br -* \f[I]string\f[] -.br -* \f[I]list\f[] of \f[I]strings\f[] - -.IP "Example:" 4 -.br -* "--quiet --write-sub --merge-output-format mkv" -.br -* ["--quiet", "--write-sub", "--merge-output-format", "mkv"] - -.IP "Description:" 4 -Additional options specified as youtube-dl command-line arguments. - - -.SS extractor.ytdl.config-file -.IP "Type:" 6 -\f[I]Path\f[] - -.IP "Example:" 4 -"~/.config/youtube-dl/config" - -.IP "Description:" 4 -Location of a youtube-dl configuration file to load options from. +Available options can be found in +\f[I]yt-dlp's docstrings\f[] +/ +\f[I]youtube-dl's docstrings\f[] .SS extractor.zerochan.metadata @@ -5504,17 +5585,57 @@ Fail a download when a file does not pass instead of downloading a potentially broken file. +.SS downloader.ytdl.cmdline-args +.IP "Type:" 6 +.br +* \f[I]string\f[] +.br +* \f[I]list\f[] of \f[I]strings\f[] + +.IP "Example:" 4 +.br +* "--quiet --write-sub --merge-output-format mkv" +.br +* ["--quiet", "--write-sub", "--merge-output-format", "mkv"] + +.IP "Description:" 4 +Additional \f[I]ytdl\f[] options specified as command-line arguments. + +See +\f[I]yt-dlp options\f[] +/ +\f[I]youtube-dl options\f[] + + +.SS downloader.ytdl.config-file +.IP "Type:" 6 +\f[I]Path\f[] + +.IP "Example:" 4 +"~/.config/yt-dlp/config" + +.IP "Description:" 4 +Location of a \f[I]ytdl\f[] configuration file to load options from. + + .SS downloader.ytdl.format .IP "Type:" 6 \f[I]string\f[] .IP "Default:" 9 -youtube-dl's default, currently \f[I]"bestvideo+bestaudio/best"\f[] +Default of the \f[I]ytdl\f[] \f[I]module\f[] used. +.br +(\f[I]"bestvideo*+bestaudio/best"\f[] for \f[I]yt_dlp\f[], +.br +\f[I]"bestvideo+bestaudio/best"\f[] for \f[I]youtube_dl\f[]) .IP "Description:" 4 -Video \f[I]format selection -<https://github.com/ytdl-org/youtube-dl#format-selection>\f[] -directly passed to youtube-dl. +\f[I]ytdl\f[] format selection string. + +See +\f[I]yt-dlp format selection\f[] +/ +\f[I]youtube-dl format selection\f[] .SS downloader.ytdl.forward-cookies @@ -5525,7 +5646,7 @@ directly passed to youtube-dl. \f[I]false\f[] .IP "Description:" 4 -Forward cookies to youtube-dl. +Forward gallery-dl's cookies to \f[I]ytdl\f[]. .SS downloader.ytdl.logging @@ -5536,8 +5657,8 @@ Forward cookies to youtube-dl. \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. +Route \f[I]ytdl's\f[] output through gallery-dl's logging system. +Otherwise it will be written directly to stdout/stderr. Note: Set \f[I]quiet\f[] and \f[I]no_warnings\f[] in \f[I]downloader.ytdl.raw-options\f[] to \f[I]true\f[] to suppress all output. @@ -5551,10 +5672,10 @@ Note: Set \f[I]quiet\f[] and \f[I]no_warnings\f[] in \f[I]null\f[] .IP "Description:" 4 -Name of the youtube-dl Python module to import. +Name of the \f[I]ytdl\f[] Python module to import. -Setting this to \f[I]null\f[] will first try to import \f[I]"yt_dlp"\f[] -and use \f[I]"youtube_dl"\f[] as fallback. +Setting this to \f[I]null\f[] will try to import \f[I]"yt_dlp"\f[] +followed by \f[I]"youtube_dl"\f[] as fallback. .SS downloader.ytdl.outtmpl @@ -5565,18 +5686,25 @@ and use \f[I]"youtube_dl"\f[] as fallback. \f[I]null\f[] .IP "Description:" 4 -The \f[I]Output Template\f[] -used to generate filenames for files downloaded with youtube-dl. +The Output Template +used to generate filenames for files downloaded with \f[I]ytdl\f[]. + +See +\f[I]yt-dlp output template\f[] +/ +\f[I]youtube-dl output template\f[]. Special values: .br * \f[I]null\f[]: generate filenames with \f[I]extractor.*.filename\f[] .br -* \f[I]"default"\f[]: use youtube-dl's default, currently \f[I]"%(title)s-%(id)s.%(ext)s"\f[] +* \f[I]"default"\f[]: use \f[I]ytdl's\f[] default, currently +\f[I]"%(title)s [%(id)s].%(ext)s"\f[] for \f[I]yt-dlp\f[] / +\f[I]"%(title)s-%(id)s.%(ext)s"\f[] for \f[I]youtube-dl\f[] Note: An output template other than \f[I]null\f[] might -cause unexpected results in combination with other options +cause unexpected results in combination with certain options (e.g. \f[I]"skip": "enumerate"\f[]) @@ -5597,36 +5725,10 @@ cause unexpected results in combination with other options .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 downloader.ytdl.cmdline-args -.IP "Type:" 6 -.br -* \f[I]string\f[] -.br -* \f[I]list\f[] of \f[I]strings\f[] - -.IP "Example:" 4 -.br -* "--quiet --write-sub --merge-output-format mkv" -.br -* ["--quiet", "--write-sub", "--merge-output-format", "mkv"] - -.IP "Description:" 4 -Additional options specified as youtube-dl command-line arguments. - - -.SS downloader.ytdl.config-file -.IP "Type:" 6 -\f[I]Path\f[] - -.IP "Example:" 4 -"~/.config/youtube-dl/config" - -.IP "Description:" 4 -Location of a youtube-dl configuration file to load options from. +Available options can be found in +\f[I]yt-dlp's docstrings\f[] +/ +\f[I]youtube-dl's docstrings\f[] .SH OUTPUT OPTIONS @@ -6569,7 +6671,7 @@ Filename extension for the resulting video files. ["-c:v", "libvpx-vp9", "-an", "-b:v", "2M"] .IP "Description:" 4 -Additional FFmpeg command-line arguments. +Additional \f[I]ffmpeg\f[] command-line arguments. .SS ugoira.ffmpeg-demuxer @@ -6580,7 +6682,9 @@ Additional FFmpeg command-line arguments. \f[I]auto\f[] .IP "Description:" 4 -FFmpeg demuxer to read and process input files with. Possible values are +\f[I]ffmpeg\f[] demuxer to read and process input files with. + +Possible values are .br * "\f[I]concat\f[]" (inaccurate frame timecodes for non-uniform frame delays) @@ -6626,15 +6730,15 @@ Location of the \f[I]mkvmerge\f[] executable for use with the \f[I]"error"\f[] .IP "Description:" 4 -Controls FFmpeg output. +Controls \f[I]ffmpeg\f[] output. .br -* \f[I]true\f[]: Enable FFmpeg output +* \f[I]true\f[]: Enable \f[I]ffmpeg\f[] output .br -* \f[I]false\f[]: Disable all FFmpeg output +* \f[I]false\f[]: Disable all \f[I]ffmpeg\f[] 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 +with this value as argument to \f[I]ffmpeg\f[] .SS ugoira.ffmpeg-twopass @@ -6656,7 +6760,7 @@ Enable Two-Pass encoding. \f[I]"auto"\f[] .IP "Description:" 4 -Controls the frame rate argument (\f[I]-r\f[]) for FFmpeg +Controls the frame rate argument (\f[I]-r\f[]) for \f[I]ffmpeg\f[] .br * \f[I]"auto"\f[]: Automatically assign a fitting frame rate @@ -6697,7 +6801,7 @@ for more information. This option, when \f[I]libx264/5\f[] is used, automatically adds \f[I]["-vf", "crop=iw-mod(iw\\\\,2):ih-mod(ih\\\\,2)"]\f[] -to the list of FFmpeg command-line arguments +to the list of \f[I]ffmpeg\f[] command-line arguments to reduce an odd width/height by 1 pixel and make them even. @@ -6838,7 +6942,8 @@ Path to or name of an Python module, whose namespace, .br -in addition to the \f[I]GLOBALS\f[] dict in \f[I]util.py\f[], +in addition to the \f[I]GLOBALS\f[] dict in +\f[I]util.py\f[], gets used as \f[I]globals parameter\f[] for compiled Python expressions. @@ -7266,9 +7371,10 @@ 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[] +Convert Pixiv Ugoira to WebM using \f[I]ffmpeg\f[] \f[I]zip\f[] Store files in a ZIP archive +\f[I]ytdl\f[] |