mirror of
https://github.com/beetbox/beets.git
synced 2025-12-24 17:43:52 +01:00
cb350de2ea
Add a configuration section that lists all options for each plugin. List options in alphabetic order. Mention the default value for each option. Use same sentences to describe concepts common to different plugins eg 'auto option, install description
30 lines
1 KiB
ReStructuredText
30 lines
1 KiB
ReStructuredText
Zero Plugin
|
|
===========
|
|
|
|
The ``zero`` plugin allows you to null fields in files' metadata tags. Fields
|
|
can be nulled unconditionally or conditioned on a pattern match. For example,
|
|
the plugin can strip useless comments like "ripped by MyGreatRipper." This
|
|
plugin only affects files' tags ; the beets database is left unchanged.
|
|
|
|
To use the plugin, enable the plugin in your configuration (see :ref:`using-plugins`).
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
Available option :
|
|
|
|
- ``fields``: whitespace-separated list of fields to change. You can get the
|
|
list of available fields by running ``beet fields``. To conditionally filter
|
|
a field, use ``field: [regexp, regexp]`` to specify regular expressions.
|
|
|
|
For example::
|
|
|
|
zero:
|
|
fields: month day genre comments
|
|
comments: [EAC, LAME, from.+collection, 'ripped by']
|
|
genre: [rnb, 'power metal']
|
|
|
|
If a custom pattern is not defined for a given field, the field will be nulled
|
|
unconditionally.
|
|
|
|
Note that the plugin currently does not zero fields when importing "as-is".
|