diff --git a/docs/plugins/zero.rst b/docs/plugins/zero.rst index 3ef241c87..6d398f2d9 100644 --- a/docs/plugins/zero.rst +++ b/docs/plugins/zero.rst @@ -5,9 +5,10 @@ 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." -The plugin can work in one of two modes. The first mode, the default, is a -blacklist, where you choose the tags you want to remove. The second mode is a -whitelist, where you instead specify the tags you want to keep. +The plugin can work in one of two modes: + +* ``fields`` - a blacklist, where you choose the tags you want to remove (used by default). +* ``keep_fields`` - a whitelist, where you instead specify the tags you want to keep. To use the ``zero`` plugin, enable the plugin in your configuration (see :ref:`using-plugins`). @@ -20,17 +21,17 @@ fields to nullify and the conditions for nullifying them: * Set ``auto`` to ``yes`` to null fields automatically on import. Default: ``yes``. -* Set ``fields`` to a whitespace-separated list of fields to change. You can +* Set ``fields`` to a whitespace-separated list of fields to remove. You can get the list of all available fields by running ``beet fields``. In addition, the ``images`` field allows you to remove any images embedded in the media file. * Set ``keep_fields`` to *invert* the logic of the plugin. Only these fields will be kept; other fields will be removed. Remember to set only - ``fields`` or ``keep_fields``---not both! + ``fields`` or ``keep_fields`` -- not both! * To conditionally filter a field, use ``field: [regexp, regexp]`` to specify regular expressions. -* By default this plugin only affects files' tags ; the beets database is left - unchanged. To update the tags in the database, set the ``update_database`` option. +* By default this plugin only affects files' tags; the beets database is left + unchanged. To update the tags in the database, set the ``update_database`` option to true. For example::