diff options
Diffstat (limited to 'docs/configuration.rst')
| -rw-r--r-- | docs/configuration.rst | 60 |
1 files changed, 50 insertions, 10 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst index c6f757d..0e2e355 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -108,21 +108,36 @@ Description Directory path used as the base for all download destinations. =========== ===== -extractor.*.restrict-filenames ------------------------------- +extractor.*.path-restrict +------------------------- =========== ===== Type ``string`` Default ``"auto"`` -Example ``"/!? ()[]{}"`` -Description Characters to replace with underscores (``_``) when generating - directory and file names. +Example ``"/!? (){}"`` +Description Set of characters to replace with underscores (``_``) + in generated path segment names. Special values: * ``"auto"``: Use characters from ``"unix"`` or ``"windows"`` depending on the local operating system * ``"unix"``: ``"/"`` - * ``"windows"``: ``"<>:\"\\|/?*"`` + * ``"windows"``: ``"\\\\|/<>:\"?*"`` + + Note: In a set with 2 or more characters, ``[]^-\`` need to be + escaped with backslashes, e.g. ``"\\[\\]"`` +=========== ===== + + +extractor.*.path-remove +----------------------- +=========== ===== +Type ``string`` +Default ``"\\u0000-\\u001f\\u007f"`` (ASCII control characters) +Description Set of characters to remove from generated path names. + + Note: In a set with 2 or more characters, ``[]^-\`` need to be + escaped with backslashes, e.g. ``"\\[\\]"`` =========== ===== @@ -131,8 +146,11 @@ extractor.*.skip =========== ===== Type ``bool`` or ``string`` Default ``true`` -Description Controls the behavior when downloading files whose filename - already exists. +Description Controls the behavior when downloading files that have been + downloaded before, i.e. a file with the same filename already + exists or its ID is in a `download archive`__. + + __ `extractor.*.archive`_ * ``true``: Skip downloads * ``false``: Overwrite already existing files @@ -144,6 +162,9 @@ Description Controls the behavior when downloading files whose filename * ``"exit"``: Exit the program altogether * ``"exit:N"``: Skip downloads and exit the program after ``N`` consecutive skips + + * ``"enumerate"``: Append a numeric suffix to the end of the + original filename (``file.ext.1``, ``file.ext.2``, etc) =========== ===== @@ -555,6 +576,15 @@ Description Download original files if available. =========== ===== +extractor.deviantart.quality +---------------------------- +=========== ===== +Type ``integer`` +Default ``100`` +Description JPEG compression quality for newer images hosted on wixmp servers. +=========== ===== + + extractor.deviantart.refresh-token ---------------------------------- =========== ===== @@ -1098,6 +1128,16 @@ Description Certificate validation during file downloads. =========== ===== +downloader.http.adjust-extensions +--------------------------------- +=========== ===== +Type ``bool`` +Default ``true`` +Description Check the file headers of ``jpg``, ``png``, and ``gif`` files + and adjust their filename extensions if they do not match. +=========== ===== + + downloader.ytdl.format ---------------------- =========== ===== @@ -1772,7 +1812,7 @@ Description An object with the ``name`` of a post-processor and its options. .. _timeout: https://docs.python-requests.org/en/latest/user/advanced/#timeouts .. _verify: https://docs.python-requests.org/en/master/user/advanced/#ssl-cert-verification .. _Last-Modified: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.29 -.. _`Requests' proxy documentation`: http://docs.python-requests.org/en/master/user/advanced/#proxies +.. _`Requests' proxy documentation`: https://2.python-requests.org/en/master/user/advanced/#proxies .. _format string: https://docs.python.org/3/library/string.html#formatstrings .. _format strings: https://docs.python.org/3/library/string.html#formatstrings .. _strptime: https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior @@ -1780,5 +1820,5 @@ Description An object with the ``name`` of a post-processor and its options. .. _webbrowser.open(): https://docs.python.org/3/library/webbrowser.html .. _datetime: https://docs.python.org/3/library/datetime.html#datetime-objects .. _datetime.max: https://docs.python.org/3/library/datetime.html#datetime.datetime.max -.. _Authentication: https://github.com/mikf/gallery-dl#5authentication +.. _Authentication: https://github.com/mikf/gallery-dl#authentication .. _youtube-dl: https://github.com/ytdl-org/youtube-dl |