From 78a99c23fa58e3fa48deb50147a15eaa3bac0fbd Mon Sep 17 00:00:00 2001 From: Jakob Schnitzer Date: Sun, 3 Mar 2013 12:25:53 +0100 Subject: [PATCH] mbsync: documentation --- docs/plugins/index.rst | 2 ++ docs/plugins/mbsync.rst | 22 ++++++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 docs/plugins/mbsync.rst diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index 2217f4d91..3c9eb4d9f 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -60,6 +60,7 @@ disabled by default, but you can turn them on as described above. convert info smartplaylist + mbsync Autotagger Extensions '''''''''''''''''''''' @@ -73,6 +74,7 @@ Metadata * :doc:`lyrics`: Automatically fetch song lyrics. * :doc:`echonest_tempo`: Automatically fetch song tempos (bpm). * :doc:`lastgenre`: Fetch genres based on Last.fm tags. +* :doc:`mbsync`: Fetch updated metadata from MusicBrainz * :doc:`fetchart`: Fetch album cover art from various sources. * :doc:`embedart`: Embed album art images into files' metadata. * :doc:`replaygain`: Calculate volume normalization for players that support it. diff --git a/docs/plugins/mbsync.rst b/docs/plugins/mbsync.rst new file mode 100644 index 000000000..47312646a --- /dev/null +++ b/docs/plugins/mbsync.rst @@ -0,0 +1,22 @@ +MBSync Plugin +============= + +The ``mbsync`` lets you fetch metadata from MusicBrainz for albums that already +have MusicBrainz IDs. This is useful for updating tags as they are fixed in the +MusicBrainz database, or when you change your mind about some config options +that change how tags are written to files. If you have a music library that is +already nicely tagged by a program that also uses MusicBrainz like Picard, this +can speed up the initial import if you just import “as-is” and then use +``mbsync`` to get up-to-date tags that are written to the files according to +your beets configuration. + + +Usage +----- + +Enable the plugin and then run ``beet mbsync QUERY`` to fetch updated metadata +for a part of your collection. This only work for album queries at the moment. +To only preview the changes that would be made, use the ``-p`` (``--pretend``) +flag. By default all the new metadata will be written to the files and the files +will be moved according to their new metadata. This behaviour can be changed +with the ``-W`` (``--nowrite``) and ``-M`` (``--nomove``) command line options.