File: thumbnails.rst

package info (click to toggle)
beets 2.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,536 kB
  • sloc: python: 45,608; javascript: 7,997; xml: 334; sh: 261; makefile: 119
file content (42 lines) | stat: -rw-r--r-- 1,441 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
Thumbnails Plugin
==================

The ``thumbnails`` plugin creates thumbnails for your album folders with the
album cover. This works on freedesktop.org-compliant file managers such as
Nautilus or Thunar, and is therefore POSIX-only.

To use the ``thumbnails`` plugin, enable ``thumbnails`` and
:doc:`/plugins/fetchart` in your configuration (see :ref:`using-plugins`) and
install ``beets`` with ``thumbnails`` and ``fetchart`` extras

.. code-block:: bash

    pip install "beets[fetchart,thumbnails]"

``thumbnails`` need to resize the covers, and therefore requires either
`ImageMagick`_ or `Pillow`_.

.. _Pillow: https://github.com/python-pillow/Pillow
.. _ImageMagick: https://www.imagemagick.org/

Configuration
-------------

To configure the plugin, make a ``thumbnails`` section in your configuration
file. The available options are

- **auto**: Whether the thumbnail should be automatically set on import.
  Default: ``yes``.
- **force**: Generate the thumbnail even when there's one that seems fine (more
  recent than the cover art).
  Default: ``no``.
- **dolphin**: Generate dolphin-compatible thumbnails. Dolphin (KDE file
  explorer) does not respect freedesktop.org's standard on thumbnails. This
  functionality replaces the :doc:`/plugins/freedesktop`
  Default: ``no``

Usage
-----

The ``thumbnails`` command provided by this plugin creates a thumbnail for
albums that match a query (see :doc:`/reference/query`).