cleaned up edit.rst

This commit is contained in:
jmwatte 2015-11-15 12:17:50 +01:00 committed by Adrian Sampson
parent 2adf70209f
commit bb39cd509d
2 changed files with 8 additions and 24 deletions

View file

@ -29,7 +29,7 @@ import os
def edit(filename):
"""Open `filename` in a test editor.
"""Open `filename` in a text editor.
"""
cmd = util.shlex_split(util.editor_command())
cmd.append(filename)

View file

@ -2,7 +2,7 @@ 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.
simply do a query.
::
beet edit beatles
@ -11,8 +11,7 @@ you simply put in a query like you normally do.
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.
You get a list of hits to edit.``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
@ -25,24 +24,15 @@ and for albums
$album-$albumartist
You can get fields from the cmdline by adding
You can get extra fields from the cmdline by adding
::
-f '$genre $added'
-e year -e comments
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.
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 and you get a summary of your changes. Check em. Apply the changes into your library.
Configuration
-------------
@ -54,12 +44,6 @@ Make a ``edit:`` section in your config.yaml ``(beet config -e)``
albumfields: genre album
itemfields: track artist
* The ``albumfields:`` and ``itemfields:`` lets you list the fields you want to change.
* The ``albumfields:`` and ``itemfields:`` is a list of 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!
do the ``beet fields`` command. Or put in a faulty one, hit enter and you get a list of available field.