Skip to content

Commit 84da4b8

Browse files
committed
Update documentation for zero plugin
1 parent 1584863 commit 84da4b8

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/plugins/zero.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@ Zero Plugin
22
===========
33

44
The ``zero`` plugin allows you to null fields in files' metadata tags. Fields
5-
can be nulled unconditionally or conditioned on a pattern match. For example,
6-
the plugin can strip useless comments like "ripped by MyGreatRipper."
5+
can be nulled unconditionally or conditioned on a pattern match. It works in
6+
two independent modes - blacklist and whitelist. You can only choose one option,
7+
however blacklist is the default. For example, the plugin can strip useless
8+
comments like "ripped by MyGreatRipper."
79

810
To use the ``zero`` plugin, enable the plugin in your configuration
911
(see :ref:`using-plugins`).
@@ -18,6 +20,9 @@ fields to nullify and the conditions for nullifying them:
1820
get the list of all available fields by running ``beet fields``. In
1921
addition, the ``images`` field allows you to remove any images
2022
embedded in the media file.
23+
* Set ``keep_fields`` respectively to list of fields that plugin should
24+
preserve. That way ``zero`` cleans anything other than fields written in this
25+
option.
2126
* To conditionally filter a field, use ``field: [regexp, regexp]`` to specify
2227
regular expressions.
2328
* By default this plugin only affects files' tags ; the beets database is left

0 commit comments

Comments
 (0)