Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2025-12-07 17:16:07 +01:00
Code Issues Projects Releases Wiki Activity

Update documentation for zero plugin

Browse source
This commit is contained in:
Adrian Kowalski 2015-10-09 21:38:38 +02:00
parent 158486319f
commit 84da4b89a5
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/plugins/zero.rst
View file

@ -2,8 +2,10 @@ Zero Plugin
=========== ===========
The ``zero`` plugin allows you to null fields in files' metadata tags. Fields 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, can be nulled unconditionally or conditioned on a pattern match. It works in
the plugin can strip useless comments like "ripped by MyGreatRipper." two independent modes - blacklist and whitelist. You can only choose one option,
however blacklist is the default. For example, the plugin can strip useless
comments like "ripped by MyGreatRipper."
To use the ``zero`` plugin, enable the plugin in your configuration To use the ``zero`` plugin, enable the plugin in your configuration
(see :ref:`using-plugins`). (see :ref:`using-plugins`).
@ -18,6 +20,9 @@ fields to nullify and the conditions for nullifying them:
get the list of all available fields by running ``beet fields``. In get the list of all available fields by running ``beet fields``. In
addition, the ``images`` field allows you to remove any images addition, the ``images`` field allows you to remove any images
embedded in the media file. embedded in the media file.
* Set ``keep_fields`` respectively to list of fields that plugin should
preserve. That way ``zero`` cleans anything other than fields written in this
option.
* To conditionally filter a field, use ``field: [regexp, regexp]`` to specify * To conditionally filter a field, use ``field: [regexp, regexp]`` to specify
regular expressions. regular expressions.
* By default this plugin only affects files' tags ; the beets database is left * By default this plugin only affects files' tags ; the beets database is left