diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration.rst | 55 | ||||
| -rw-r--r-- | docs/gallery-dl.conf | 2 | ||||
| -rw-r--r-- | docs/supportedsites.rst | 8 |
3 files changed, 58 insertions, 7 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. diff --git a/docs/gallery-dl.conf b/docs/gallery-dl.conf index 835ed17..a4a9ee0 100644 --- a/docs/gallery-dl.conf +++ b/docs/gallery-dl.conf @@ -9,6 +9,7 @@ "skip": true, "sleep": 0, "user-agent": "Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Firefox/68.0", + "restrict-filenames": "auto", "artstation": { @@ -163,6 +164,7 @@ "ytdl": { "format": null, + "forward-cookies": true, "mtime": true, "rate": null, "retries": 4, diff --git a/docs/supportedsites.rst b/docs/supportedsites.rst index 2a1a1ed..d2fb4ea 100644 --- a/docs/supportedsites.rst +++ b/docs/supportedsites.rst @@ -13,6 +13,7 @@ Site URL Capabilities 8chan https://8ch.net/ Threads 8muses https://www.8muses.com/ Albums Adobe Portfolio https://www.myportfolio.com/ Galleries +Adult Empire https://www.adultempire.com/ Galleries arch.b4k.co https://arch.b4k.co/ Threads Archive of Sins https://archiveofsins.com/ Threads Archived.Moe https://archived.moe/ Threads @@ -24,9 +25,9 @@ Desuarchive https://desuarchive.org/ Threads DeviantArt https://www.deviantart.com/ |deviantart-C| Optional (OAuth) Doki Reader https://kobato.hologfx.com/reader/ Chapters, Manga Dynasty Reader https://dynasty-scans.com/ Chapters, individual Images, Search Results +E-Hentai https://e-hentai.org/ Favorites, Galleries, Search Results Optional e621 https://e621.net/ Pools, Popular Images, Posts, Tag-Searches EroLord.com http://erolord.com/ Galleries -ExHentai https://exhentai.org/ Favorites, Galleries, Search Results Optional Fallen Angels Scans https://www.fascans.com/ Chapters, Manga Fashion Nova https://www.fashionnova.com/ Collections, Products Fireden https://boards.fireden.net/ Threads @@ -46,6 +47,7 @@ Hypnohub https://hypnohub.net/ Pools, Popular Images, Idol Complex https://idol.sankakucomplex.com/ Pools, Posts, Tag-Searches Optional ImageBam http://www.imagebam.com/ Galleries, individual Images ImageFap https://imagefap.com/ Images from Users, Galleries, individual Images +ImgBB https://imgbb.com/ Images from Users, Albums Optional imgbox https://imgbox.com/ Galleries, individual Images imgth https://imgth.com/ Galleries imgur https://imgur.com/ Albums, individual Images @@ -106,7 +108,8 @@ The /b/ Archive https://thebarchive.com/ Threads Tsumino https://www.tsumino.com/ Galleries, Search Results Optional Tumblr https://www.tumblr.com/ Images from Users, Likes, Posts, Tag-Searches Optional (OAuth) Twitter https://twitter.com/ Media Timelines, Timelines, Tweets Optional -Wallhaven https://wallhaven.cc/ individual Images, Search Results +VSCO https://vsco.co/ Images from Users, Collections, individual Images +Wallhaven https://wallhaven.cc/ individual Images, Search Results |wallhaven-A| Warosu https://warosu.org/ Threads Weibo https://www.weibo.com/ Images from Users, Images from Statuses WikiArt.org https://www.wikiart.org/ Artists, Artworks @@ -137,4 +140,5 @@ Turboimagehost https://www.turboimagehost.com/ individual Images .. |pixnet-C| replace:: Images from Users, Folders, individual Images, Sets .. |pornreactor-C| replace:: Images from Users, Posts, Search Results, Tag-Searches .. |smugmug-C| replace:: Albums, individual Images, Images from Users and Folders +.. |wallhaven-A| replace:: Optional (`API Key <configuration.rst#extractorwallhavenapi-key>`__) .. |yuki-S| replace:: yuki.la 4chan archive |