add 'restrict-filenames' option (#348)

2019-07-23 17:36:07 +02:00
parent 60cf40380a
commit b1bea8aaeb
5 changed files with 42 additions and 44 deletions
--- 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
 ----------------
 =========== =====