Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2025-12-15 21:14:19 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #4119 from ygabuev/patch-2

Browse source 
Add documentation for `path_sep_replace`
This commit is contained in:
Adrian Sampson 2021-10-26 08:29:00 -04:00 committed by GitHub
commit ee8a4de247
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/reference/config.rst
View file

@ -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