diff options
Diffstat (limited to 'data/man')
| -rw-r--r-- | data/man/gallery-dl.1 | 2 | ||||
| -rw-r--r-- | data/man/gallery-dl.conf.5 | 280 |
2 files changed, 248 insertions, 34 deletions
diff --git a/data/man/gallery-dl.1 b/data/man/gallery-dl.1 index b172453..b17a8f4 100644 --- a/data/man/gallery-dl.1 +++ b/data/man/gallery-dl.1 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL" "1" "2025-01-28" "1.28.5" "gallery-dl Manual" +.TH "GALLERY-DL" "1" "2025-03-01" "1.29.0" "gallery-dl Manual" .\" disable hyphenation .nh diff --git a/data/man/gallery-dl.conf.5 b/data/man/gallery-dl.conf.5 index 343188a..847efaa 100644 --- a/data/man/gallery-dl.conf.5 +++ b/data/man/gallery-dl.conf.5 @@ -1,4 +1,4 @@ -.TH "GALLERY-DL.CONF" "5" "2025-01-28" "1.28.5" "gallery-dl Manual" +.TH "GALLERY-DL.CONF" "5" "2025-03-01" "1.29.0" "gallery-dl Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -475,6 +475,9 @@ response before \f[I]retrying\f[] the request. \f[I]xfolio\f[], \f[I]zerochan\f[] .br +* \f[I]"1.0"\f[] +\f[I]furaffinity\f[] +.br * \f[I]"1.0-2.0"\f[] \f[I]flickr\f[], \f[I]pexels\f[], @@ -601,7 +604,7 @@ the API key found in your user profile, not the actual account password. \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 +to be prompted for a password when performing a login (see \f[I]getpass()\f[]). @@ -814,11 +817,16 @@ or a \f[I]list\f[] with IP and explicit port number as elements. * \f[I]"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:LATEST) Gecko/20100101 Firefox/LATEST"\f[]: otherwise .IP "Description:" 4 -User-Agent header value to be used for HTTP requests. +User-Agent header value used for HTTP requests. Setting this value to \f[I]"browser"\f[] will try to automatically detect and use the \f[I]User-Agent\f[] header of the system's default browser. +Note: +This option has *no* effect if +\f[I]extractor.browser\f[] +is enabled. + .SS extractor.*.browser .IP "Type:" 6 @@ -841,6 +849,15 @@ by using their default HTTP headers and TLS ciphers for HTTP requests. Optionally, the operating system used in the \f[I]User-Agent\f[] header can be specified after a \f[I]:\f[] (\f[I]windows\f[], \f[I]linux\f[], or \f[I]macos\f[]). +Note: +This option overrides +\f[I]user-agent\f[] +and sets custom +\f[I]headers\f[] +and +\f[I]ciphers\f[] +defaults. + Note: \f[I]requests\f[] and \f[I]urllib3\f[] only support HTTP/1.1, while a real browser would use HTTP/2. @@ -1071,13 +1088,19 @@ Note: Any \f[I]blacklist\f[] setting will automatically include .SS extractor.*.archive .IP "Type:" 6 -\f[I]Path\f[] +.br +* \f[I]string\f[] +.br +* \f[I]Path\f[] .IP "Default:" 9 \f[I]null\f[] .IP "Example:" 4 -"$HOME/.archives/{category}.sqlite3" +.br +* "$HOME/.archives/{category}.sqlite3" +.br +* "postgresql://user:pass@host/database" .IP "Description:" 4 File to store IDs of downloaded files in. Downloads of files @@ -1089,6 +1112,11 @@ database, as either lookup operations are significantly faster or memory requirements are significantly lower when the amount of stored IDs gets reasonably large. +If this value is a +\f[I]PostgreSQL Connection URI\f[], +the archive will use this PostgreSQL database as backend (requires +\f[I]Psycopg\f[]). + Note: Archive files that do not already exist get generated automatically. Note: Archive paths support regular \f[I]format string\f[] replacements, @@ -1154,7 +1182,10 @@ and only write them after successful job completion. \f[I]string\f[] .IP "Default:" 9 -\f[I]"{category}"\f[] +.br +* \f[I]""\f[] when \f[I]archive-table\f[] is set +.br +* \f[I]"{category}"\f[] otherwise .IP "Description:" 4 Prefix for archive IDs. @@ -1174,6 +1205,20 @@ See \f[I]<https://www.sqlite.org/pragma.html#toc>\f[] for available \f[I]PRAGMA\f[] statements and further details. +.SS extractor.*.archive-table +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]"archive"\f[] + +.IP "Example:" 4 +"{category}" + +.IP "Description:" 4 +\f[I]Format string\f[] selecting the archive database table name. + + .SS extractor.*.actions .IP "Type:" 6 .br @@ -2562,6 +2607,41 @@ Leave \f[I]SIZE\f[] empty to download the regular, small avatar format. .br +.SS extractor.discord.embeds +.IP "Type:" 6 +\f[I]list\f[] of \f[I]strings\f[] + +.IP "Default:" 9 +\f[I]["image", "gifv", "video"]\f[] + +.IP "Description:" 4 +Selects which embed types to download from. + +Supported embed types are +\f[I]image\f[], \f[I]gifv\f[], \f[I]video\f[], \f[I]rich\f[], \f[I]article\f[], \f[I]link\f[]. + + +.SS extractor.discord.threads +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Extract threads from Discord text channels. + + +.SS extractor.discord.token +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Description:" 4 +Discord Bot Token for API requests. + +You can follow \f[I]this guide\f[] to get a token. + + .SS extractor.[E621].metadata .IP "Type:" 6 .br @@ -4992,6 +5072,71 @@ To generate a token, visit \f[I]/user/USERNAME/list-tokens\f[] and click \f[I]Create Token\f[]. +.SS extractor.tiktok.audio +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Download audio tracks using \f[I]ytdl\f[]. + + +.SS extractor.tiktok.videos +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Download videos using \f[I]ytdl\f[]. + + +.SS extractor.tiktok.user.avatar +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]true\f[] + +.IP "Description:" 4 +Download user avatars. + + +.SS extractor.tiktok.user.module +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]null\f[] + +.IP "Description:" 4 +Name or filesystem path of the \f[I]ytdl\f[] Python module +to extract posts from a \f[I]tiktok\f[] user profile with. + +See \f[I]extractor.ytdl.module\f[]. + + +.SS extractor.tiktok.user.tiktok-range +.IP "Type:" 6 +\f[I]string\f[] + +.IP "Default:" 9 +\f[I]null\f[] + +.IP "Example:" 4 +"1-20" + +.IP "Description:" 4 +Range or playlist indices of \f[I]tiktok\f[] user posts to extract. + +See +\f[I]ytdl/playlist_items\f[] +for details. + + .SS extractor.tumblr.avatar .IP "Type:" 6 \f[I]bool\f[] @@ -5517,7 +5662,7 @@ Selects how to handle exceeding the API rate limit. .IP "Description:" 4 When receiving a "Could not authenticate you" error while logged in with -\f[I]username & passeword\f[], +\f[I]username & password\f[], refresh the current login session and try to continue from where it left off. @@ -5716,7 +5861,7 @@ Available formats are \f[I]string\f[] .IP "Default:" 9 -\f[I]"vipergirls.to"\f[] +\f[I]"viper.click"\f[] .IP "Description:" 4 Specifies the domain used by \f[I]vipergirls\f[] extractors. @@ -5923,6 +6068,17 @@ It is possible to use \f[I]"all"\f[] instead of listing all values separately. Download \f[I]livephoto\f[] files. +.SS extractor.weibo.movies +.IP "Type:" 6 +\f[I]bool\f[] + +.IP "Default:" 9 +\f[I]false\f[] + +.IP "Description:" 4 +Download \f[I]movie\f[] videos. + + .SS extractor.weibo.retweets .IP "Type:" 6 \f[I]bool\f[] @@ -6059,13 +6215,22 @@ Note: Set \f[I]quiet\f[] and \f[I]no_warnings\f[] in .SS extractor.ytdl.module .IP "Type:" 6 -\f[I]string\f[] +.br +* \f[I]string\f[] +.br +* \f[I]Path\f[] .IP "Default:" 9 \f[I]null\f[] +.IP "Example:" 4 +.br +* "yt-dlp" +.br +* "/home/user/.local/lib/python3.13/site-packages/youtube_dl" + .IP "Description:" 4 -Name of the \f[I]ytdl\f[] Python module to import. +Name or filesystem path 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. @@ -6485,6 +6650,22 @@ regardless of this option. regardless of this option. +.SS downloader.http.sleep-429 +.IP "Type:" 6 +\f[I]Duration\f[] + +.IP "Default:" 9 +\f[I]extractor.*.sleep-429\f[] + +.IP "Description:" 4 +Number of seconds to sleep when receiving a 429 Too Many Requests +response before \f[I]retrying\f[] the request. + +Note: Requires +\f[I]retry-codes\f[] +to include \f[I]429\f[]. + + .SS downloader.http.validate .IP "Type:" 6 \f[I]bool\f[] @@ -6580,13 +6761,22 @@ Note: Set \f[I]quiet\f[] and \f[I]no_warnings\f[] in .SS downloader.ytdl.module .IP "Type:" 6 -\f[I]string\f[] +.br +* \f[I]string\f[] +.br +* \f[I]Path\f[] .IP "Default:" 9 \f[I]null\f[] +.IP "Example:" 4 +.br +* "yt-dlp" +.br +* "/home/user/.local/lib/python3.13/site-packages/youtube_dl" + .IP "Description:" 4 -Name of the \f[I]ytdl\f[] Python module to import. +Name or filesystem path 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. @@ -7047,17 +7237,25 @@ Only compare file sizes. Do not read and compare their content. .SS exec.archive .IP "Type:" 6 -\f[I]Path\f[] +.br +* \f[I]string\f[] +.br +* \f[I]Path\f[] .IP "Description:" 4 -File to store IDs of executed commands in, +Database to store IDs of executed commands 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. +The following archive options are also supported: + +.br +* \f[I]archive-format\f[] +.br +* \f[I]archive-prefix\f[] +.br +* \f[I]archive-pragma\f[] +.br +* \f[I]archive-table \f[] .SS exec.async @@ -7572,17 +7770,25 @@ Do not overwrite already existing files. .SS metadata.archive .IP "Type:" 6 -\f[I]Path\f[] +.br +* \f[I]string\f[] +.br +* \f[I]Path\f[] .IP "Description:" 4 -File to store IDs of generated metadata files in, +Database to store IDs of generated metadata files 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. +The following archive options are also supported: + +.br +* \f[I]archive-format\f[] +.br +* \f[I]archive-prefix\f[] +.br +* \f[I]archive-pragma\f[] +.br +* \f[I]archive-table \f[] .SS metadata.mtime @@ -7663,17 +7869,25 @@ The resulting value must be either a UNIX timestamp or a .SS python.archive .IP "Type:" 6 -\f[I]Path\f[] +.br +* \f[I]string\f[] +.br +* \f[I]Path\f[] .IP "Description:" 4 -File to store IDs of called Python functions in, +Database 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. +The following archive options are also supported: + +.br +* \f[I]archive-format\f[] +.br +* \f[I]archive-prefix\f[] +.br +* \f[I]archive-pragma\f[] +.br +* \f[I]archive-table \f[] .SS python.event |