diff options
Diffstat (limited to 'docs/configuration.rst')
| -rw-r--r-- | docs/configuration.rst | 55 |
1 files changed, 50 insertions, 5 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst index 32a529a..c6f757d 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -108,6 +108,24 @@ Description Directory path used as the base for all download destinations. =========== ===== +extractor.*.restrict-filenames +------------------------------ +=========== ===== +Type ``string`` +Default ``"auto"`` +Example ``"/!? ()[]{}"`` +Description Characters to replace with underscores (``_``) when generating + directory and file names. + + Special values: + + * ``"auto"``: Use characters from ``"unix"`` or ``"windows"`` + depending on the local operating system + * ``"unix"``: ``"/"`` + * ``"windows"``: ``"<>:\"\\|/?*"`` +=========== ===== + + extractor.*.skip ---------------- =========== ===== @@ -146,10 +164,11 @@ Default ``null`` Description The username and password to use when attempting to log in to another site. - Specifying username and password is - required for the ``pixiv``, ``nijie`` and ``seiga`` modules and - optional (but strongly recommended) for ``danbooru``, ``exhentai``, - ``sankaku`` and ``idolcomplex``. + Specifying username and password is required for the + ``pixiv``, ``nijie``, and ``seiga`` + modules and optional (but strongly recommended) for + ``danbooru``, ``exhentai``, ``idolcomplex``, ``instagram``, + ``luscious``, ``sankaku``, ``tsumino``, and ``twitter``. These values can also be set via the ``-u/--username`` and ``-p/--password`` command-line options or by using a |.netrc|_ file. @@ -1090,6 +1109,15 @@ Description Video `format selection =========== ===== +downloader.ytdl.forward-cookies +------------------------------- +=========== ===== +Type ``bool`` +Default ``true`` +Description Forward cookies to youtube-dl. +=========== ===== + + downloader.ytdl.logging ----------------------- =========== ===== @@ -1438,6 +1466,22 @@ Default ``false`` Description Keep the actual files after writing them to a ZIP archive. =========== ===== +zip.mode +-------- +=========== ===== +Type ``string`` +Default ``"default"`` +Description * ``"default"``: Write the central directory file header + once after everything is done or an exception is raised. + + * ``"safe"``: Update the central directory file header + each time a file is stored in a ZIP archive. + + This greatly reduces the chance a ZIP archive gets corrupted in + case the Python interpreter gets shut down unexpectedly + (power outage, SIGKILL) but is also a lot slower. +=========== ===== + Miscellaneous Options @@ -1448,7 +1492,8 @@ cache.file ---------- =========== ===== Type |Path|_ -Default |tempfile.gettempdir()|_ + ``".gallery-dl.cache"`` +Default * |tempfile.gettempdir()|_ + ``".gallery-dl.cache"`` on Windows + * (``$XDG_CACHE_HOME`` or ``"~/.cache"``) + ``"/gallery-dl/cache.sqlite3"`` on all other platforms Description Path of the SQLite3 database used to cache login sessions, cookies and API tokens across `gallery-dl` invocations. |