slightly expand docs for keyfinder

This commit is contained in:
Adrian Sampson 2014-04-12 11:18:34 -07:00
parent 650b49795b
commit cbbf084d8e

View file

@ -15,11 +15,14 @@ the plugin. By default they are::
auto: yes
overwrite: no
* ``bin`` This is the name of the `KeyFinder` program on your system or
a path to the binary.
* ``auto`` If set to `yes`, the plugin will analyze every file on
import.
* ``overwrite`` If set to `no` the import hook and the command will skip
* ``bin``: The name of the `KeyFinder` program on your system or
a path to the binary. If you installed the `KeyFinder`_ GUI on a Mac, for
example, you want something like
``/Applications/KeyFinder.app/Contents/MacOS/KeyFinder``.
* ``auto``: If set to `yes`, the plugin will analyze every file on
import. Otherwise, you need to use the ``beet keyfinder`` command
explicitly.
* ``overwrite``: If set to `no`, the import hook and the command will skip
any file that already has an `initial_key` in the database.
.. _KeyFinder: http://www.ibrahimshaath.co.uk/keyfinder/