diff --git a/docs/configuration.rst b/docs/configuration.rst index 03ae9cfe..1d8c970d 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -383,16 +383,32 @@ Type |Duration|_ Default * ``"0.5-1.5"`` - ``ao3``, ``civitai``, - ``[Danbooru]``, ``[E621]``, ``[foolfuuka]:search``, ``itaku``, + ``ao3``, + ``civitai``, + ``[Danbooru]``, + ``[E621]``, + ``[foolfuuka]:search``, + ``itaku``, ``koharu``, - ``newgrounds``, ``[philomena]``, ``pixiv:novel``, ``plurk``, - ``poipiku`` , ``pornpics``, ``scrolller``, ``soundgasm``, - ``urlgalleries``, ``vk``, ``zerochan`` + ``newgrounds``, + ``[philomena]``, + ``pixiv:novel``, + ``plurk``, + ``poipiku`` , + ``pornpics``, + ``scrolller``, + ``soundgasm``, + ``urlgalleries``, + ``vk``, + ``zerochan`` * ``"1.0-2.0"`` - ``flickr``, ``weibo``, ``[wikimedia]`` + ``flickr``, + ``weibo``, + ``[wikimedia]`` * ``"2.0-4.0"`` - ``behance``, ``imagefap``, ``[Nijie]`` + ``behance``, + ``imagefap``, + ``[Nijie]`` * ``"3.0-6.0"`` ``bilibili``, ``exhentai``, @@ -636,16 +652,15 @@ extractor.*.user-agent Type ``string`` Default - ``"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:128.0) Gecko/20100101 Firefox/128.0"`` + * ``"gallery-dl/VERSION"``: ``[Danbooru]``, ``mangadex`` + * ``"gallery-dl/VERSION (by mikf)"``: ``[E621]`` + * ``"Patreon/72.2.28 (Android; Android 14; Scale/2.10)"``: ``patreon`` + * ``"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:LATEST) Gecko/20100101 Firefox/LATEST"``: otherwise Description User-Agent header value to be used for HTTP requests. Setting this value to ``"browser"`` will try to automatically detect - and use the User-Agent used by the system's default browser. - - Note: This option has no effect on - `pixiv`, `e621`, `mangadex`, and `patreon` - extractors, as these need specific values to function correctly. + and use the ``User-Agent`` header of the system's default browser. extractor.*.browser @@ -719,7 +734,7 @@ Example Description List of TLS/SSL cipher suites in - `OpenSSL cipher list format `__ + `OpenSSL cipher list format `__ to be passed to `ssl.SSLContext.set_ciphers() `__ @@ -1822,8 +1837,8 @@ Description uses the same domain as a given input URL. -extractor.danbooru.external ---------------------------- +extractor.[Danbooru].external +----------------------------- Type ``bool`` Default @@ -1833,8 +1848,8 @@ Description follow the ``source`` and download from there if possible. -extractor.danbooru.ugoira -------------------------- +extractor.[Danbooru].ugoira +--------------------------- Type ``bool`` Default @@ -1885,45 +1900,6 @@ Description batch. The value cannot be less than 1. -extractor.derpibooru.api-key ----------------------------- -Type - ``string`` -Default - ``null`` -Description - Your `Derpibooru API Key `__, - to use your account's browsing settings and filters. - - -extractor.derpibooru.filter ---------------------------- -Type - ``integer`` -Default - ``56027`` (`Everything `_ filter) -Description - The content filter ID to use. - - Setting an explicit filter ID overrides any default filters and can be used - to access 18+ content without `API Key `_. - - See `Filters `_ for details. - - -extractor.derpibooru.svg ------------------------- -Type - ``bool`` -Default - ``true`` -Description - Download SVG versions of images when available. - - Try to download the ``view_url`` version of these posts - when this option is disabled. - - extractor.deviantart.auto-watch ------------------------------- Type @@ -3490,16 +3466,61 @@ Description Possible formats: - * ``original`` - * ``default`` - * ``default_small`` - * ``default_blurred`` - * ``default_blurred_small`` - * ``thumbnail`` - * ``thumbnail_large`` - * ``thumbnail_small`` - * ``url`` - * ``download_url`` + * ``download_url`` (``"a":1,"p":1``) + * ``url`` (``"w":620``) + * ``original`` (``"q":100,"webp":0``) + * ``default`` (``"w":620``) + * ``default_small`` (``"w":360``) + * ``default_blurred`` (``"w":620``) + * ``default_blurred_small`` (``"w":360``) + * ``thumbnail`` (``"h":360,"w":360``) + * ``thumbnail_large`` (``"h":1080,"w":1080``) + * ``thumbnail_small`` (``"h":100,"w":100``) + + +extractor.[philomena].api-key +----------------------------- +Type + ``string`` +Default + ``null`` +Description + Your account's API Key, + to use your personal browsing settings and filters. + + +extractor.[philomena].filter +---------------------------- +Type + ``integer`` +Default + :``derpibooru``: + ``56027`` (`Everything `__ filter) + :``ponybooru``: + ``3`` (`Nah. `__ filter) + :otherwise: + ``2`` + +Description + The content filter ID to use. + + Setting an explicit filter ID overrides any default filters and can be used + to access 18+ content without `API Key `_. + + See `Filters `_ for details. + + +extractor.[philomena].svg +------------------------- +Type + ``bool`` +Default + ``true`` +Description + Download SVG versions of images when available. + + Try to download the ``view_url`` version of these posts + when this option is disabled. extractor.pillowfort.external @@ -5304,7 +5325,7 @@ Default ``"file_url"`` Example * ``"preview_url"`` - * ``["sample_url", "preview_url", "file_url"}`` + * ``["sample_url", "preview_url", "file_url"]`` Description Alternate field name to retrieve download URLs from. @@ -6006,10 +6027,13 @@ Default .. code:: json { - "Pictures": ["jpg", "jpeg", "png", "gif", "bmp", "svg", "webp"], - "Video" : ["flv", "ogv", "avi", "mp4", "mpg", "mpeg", "3gp", "mkv", "webm", "vob", "wmv"], - "Music" : ["mp3", "aac", "flac", "ogg", "wma", "m4a", "wav"], - "Archives": ["zip", "rar", "7z", "tar", "gz", "bz2"] + "Pictures" : ["jpg", "jpeg", "png", "gif", "bmp", "svg", "webp", + "avif", "heic", "heif", "ico", "psd"], + "Video" : ["flv", "ogv", "avi", "mp4", "mpg", "mpeg", "3gp", "mkv", + "webm", "vob", "wmv", "m4v", "mov"], + "Music" : ["mp3", "aac", "flac", "ogg", "wma", "m4a", "wav"], + "Archives" : ["zip", "rar", "7z", "tar", "gz", "bz2"], + "Documents": ["txt", "pdf"] } Description