beets/docs/plugins/ftintitle.rst
Fabrice Laporte 155028257d fix typos
2014-10-28 23:31:15 +01:00

40 lines
1.1 KiB
ReStructuredText

FtInTitle Plugin
================
The ``ftintitle`` plugin automatically moves "featured" artists from the
``artist`` field to the ``title`` field.
According to `MusicBrainz style`_, featured artists are part of the artist
field. That means that, if you tag your music using MusicBrainz, you'll have
tracks in your library like "Tellin' Me Things" by the artist "Blakroc feat.
RZA". If you prefer to tag this as "Tellin' Me Things feat. RZA" by "Blakroc",
then this plugin is for you.
To use the ``ftintitle`` plugin, enable it in your configuration
(see :ref:`using-plugins`).
Configuration
-------------
Available options:
- ``auto``: set it to ``no`` to disable plugin during import.
Default: ``yes``.
- ``drop``: remove featured artists entirely instead of adding them to the
title field.
Default: ``no``
Running manually
----------------
From the command line, type::
$ beet ftintitle [QUERY]
The query is optional; if it's left off, the transformation will be applied to
your entire collection.
Use the ``-d``flag to remove featured artists (equivalent of the ``drop``
option).
.. _MusicBrainz style: http://musicbrainz.org/doc/Style