From a85069c4ec22744d349f01d9cd70f9b6eee7b47d Mon Sep 17 00:00:00 2001 From: kerobaros Date: Sun, 2 Nov 2014 22:16:33 -0600 Subject: [PATCH] Add doc page for freedesktop plugin. --- docs/plugins/freedesktop.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/plugins/freedesktop.rst diff --git a/docs/plugins/freedesktop.rst b/docs/plugins/freedesktop.rst new file mode 100644 index 000000000..4d7a57234 --- /dev/null +++ b/docs/plugins/freedesktop.rst @@ -0,0 +1,25 @@ +Freedesktop Plugin +================== + +The ``freedesktop`` plugin creates .directory files in your album folders. This +allows, when using a freedesktop.org compliant file manager, such as +Dolphin or Nautilus, an album to have its cover art as the folder's thumbnail. + +To use the ``freedesktop`` plugin, enable it (see :doc:`/plugins/index`). + +Configuration +------------- + +To configure the plugin, make a ``freedesktop:`` section in your configuration +file. The only available option is: + +- ``auto``: Create .directory files automatically during import. + Default: ``no`` + +Creating .directory Files Manually +---------------------------------- + +The ``freedesktop`` command provided by this plugin creates .directory files +for albums that match a query (see :doc:`/reference/query`). For example, ``beet +freedesktop man the animal cannon`` will create the .directory file for the +folder containing the album Man the Animal Cannon. \ No newline at end of file