beets/docs/plugins/edit.rst
Adrian Sampson f27c486389 Remove separator and not_fields from docs
The `separator` option has already been removed. `not_fields` is an internal
detail and doesn't need to be documented (yet).
2015-11-14 13:39:30 -08:00

65 lines
1.8 KiB
ReStructuredText

Edit Plugin
============
The ``edit`` plugin lets you open the tags, fields from a group of items, edit them in a text-editor and save them back.
Add the ``edit`` plugin to your ``plugins:`` in your ``config.yaml``. Then
you simply put in a query like you normally do.
::
beet edit beatles
beet edit beatles -a
beet edit beatles -f '$title $lyrics'
You get a list of hits and then you can edit them. The ``edit`` opens your standard text-editor with a list of your hits and for each hit a bunch of fields.
Without anything specified in your ``config.yaml`` for ``edit:`` you will see
for items
::
$track-$title-$artist-$album
and for albums
::
$album-$albumartist
You can get fields from the cmdline by adding
::
-f '$genre $added'
or
::
-e '$year $comments'
If you use ``-f '$field ...'`` you get *only* what you specified.
If you use ``-e '$field ...'`` you get what you specified *extra*.
If you add ``--all`` you get all the fields.
After you edit the values in your text-editor - *and you may only edit the values, no deleting fields or adding fields!* - you save the file, answer with ``y`` on ``Done?`` and you get a summary of your changes. Check em, answer ``y`` or ``n`` and the changes are written to your library.
Configuration
-------------
Make a ``edit:`` section in your config.yaml ``(beet config -e)``
::
edit:
albumfields: genre album
itemfields: track artist
* The ``albumfields:`` and ``itemfields:`` lets you list the fields you want to change.
``albumfields:`` gets picked if you put ``-a`` in your search query, else ``itemfields:``. For a list of fields
do the ``beet fields`` command.
but you can pick anything else. With "<>" it will look like:
::
<>02<>The Night Before<>The Beatles<>Help!