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

fix some discussion of path formatting

Browse source
This commit is contained in:
Adrian Sampson 2011-12-15 11:49:22 -08:00
parent ae2f0db540
commit 0252865f61
2 changed files with 15 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/reference/config.rst
View file

@ -103,14 +103,17 @@ section header:
exception when the database lock is contended. This should almost never need
to be changed except on very slow systems. Defaults to 5.0 (5 seconds).
You can also configure the directory hierarchy beets uses to store music. That
uses the ``[paths]`` section instead of the ``[beets]`` section. Each string is
a `Python template string`_ that can refer to metadata fields (see below for
examples). The extension is added automatically to the end. At the moment, you
can specify two special paths: ``default`` (for most releases) and ``comp`` (for
"various artist" releases with no dominant artist). You can also specify a
different path format for each `MusicBrainz release type`_. The defaults look
like this::
Path Formats
------------
You can also configure the directory hierarchy beets uses to store music. These
settings appear under the ``[paths]`` section (rather than the main ``[beets]``
section we used above). Each string is a `template string`_ that can refer to
metadata fields like ``$artist`` or ``$title``. The filename extension is added
automatically. At the moment, you can specify three special paths: ``default``
for most releases, ``comp`` for "various artist" releases with no dominant
artist, and ``singleton`` for non-album tracks. You can also specify a different
path format for each `MusicBrainz release type`_. The defaults look like this::
[paths]
default: $albumartist/$album/$track $title
@ -118,10 +121,10 @@ like this::
singleton: Non-Album/$artist/$title
Note the use of ``$albumartist`` instead of ``$artist``; this ensure that albums
will be well-organized. (For more about these format strings, see
:doc:`pathformat`.)
will be well-organized. For more about these format strings, see
:doc:`pathformat`.
.. _Python template string:
.. _template string:
http://docs.python.org/library/string.html#template-strings
.. _MusicBrainz release type:
http://wiki.musicbrainz.org/ReleaseType

2
docs/reference/pathformat.rst
View file

@ -1,7 +1,7 @@
Path Formats
============
The ``[paths]`` section of the config file (read more on the [Usage] page) lets
The ``[paths]`` section of the config file (see :doc:`config`) lets
you specify the directory and file naming scheme for your music library. You
specify templates using Python template string notation---that is, prefixing
names with ``$`` characters---and beets fills in the appropriate values.