Skip to content

Commit a81d0a0

Browse files
committed
Update missing plugin configuration options and formatting details
1 parent 394d78d commit a81d0a0

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

docs/plugins/missing.rst

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,26 @@ Configuration
3939
To configure the plugin, make a ``missing:`` section in your configuration file.
4040
The available options are:
4141

42-
- **count**: Print a count of missing tracks per album, with ``format``
43-
defaulting to ``$albumartist - $album: $missing``. Default: ``no``.
44-
- **format**: A specific format with which to print every track. This uses the
45-
same template syntax as beets' :doc:`path formats </reference/pathformat>`.
46-
The usage is inspired by, and therefore similar to, the :ref:`list <list-cmd>`
47-
command. Default: :ref:`format_item`.
42+
- **count**: Print a count of missing tracks per album, with the global
43+
``format_album`` used for formatting. Default: ``no``.
4844
- **total**: Print a single count of missing tracks in all albums. Default:
4945
``no``.
5046

47+
Formatting
48+
~~~~~~~~~~
49+
50+
- This plugin uses global formatting options from the main configuration; see :ref:`format_item` and :ref:`format_album`:
51+
52+
- :ref:`format_item`: Used when listing missing tracks (default item format).
53+
- :ref:`format_album`: Used when showing counts (``-c``) or missing albums (``-a``).
54+
5155
Here's an example
5256

5357
::
5458

59+
format_album: $albumartist - $album
60+
format_item: $artist - $album - $title
5561
missing:
56-
format: $albumartist - $album - $title
5762
count: no
5863
total: no
5964

0 commit comments

Comments
 (0)