diff --git a/docs/reference/config.rst b/docs/reference/config.rst index f041be625..642216c8f 100644 --- a/docs/reference/config.rst +++ b/docs/reference/config.rst @@ -151,6 +151,25 @@ replaced as they don't match the typewriter quote (``"``). To also strip these special characters, you can either add them to the replacement list or use the :ref:`asciify-paths` configuration option below. +.. _path-sep-replace: + +path_sep_replace +~~~~~~~~~~~~~~~~ + +A string that replaces the path separator (for example, the forward slash +``/`` on Linux and MacOS, and the backward slash ``\\`` on Windows) when +generating filenames with beets. +This option is related to :ref:`replace`, but is distict from it for +technical reasons. + +.. warning:: + Changing this option is potentially dangerous. For example, setting + it to the actual path separator could create directories in unexpected + locations. Use caution when changing it and always try it out on a small + number of files before applying it to your whole library. + +Default: ``_``. + .. _asciify-paths: asciify_paths