From 3aed99f051eae1d5b127f285b65d77b781d4ac80 Mon Sep 17 00:00:00 2001 From: Yuriy Gabuev Date: Fri, 22 Oct 2021 22:40:26 +0200 Subject: [PATCH] Update config.rst This PR adds documentation for `path_sep_replace` configuration option, which is not yet present in the official docs. --- docs/reference/config.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/reference/config.rst b/docs/reference/config.rst index f041be625..636a018ed 100644 --- a/docs/reference/config.rst +++ b/docs/reference/config.rst @@ -151,6 +151,19 @@ 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 value that replaces the path separator in the filenames created by beets. +On most systems, the path separator is the forward slash (``/``). + +Note that you should never use the actual path separator as the value for this option, +otherwise it's very easy to mess up the structure of your music directory. + +Default: `_`. + .. _asciify-paths: asciify_paths