From a23e31d1b688b48defd3a50ce9c9cce0e2fded34 Mon Sep 17 00:00:00 2001 From: J0J0 Todos Date: Mon, 28 Nov 2022 16:16:08 +0100 Subject: [PATCH] Improve playlist plugin docs --- docs/plugins/playlist.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/plugins/playlist.rst b/docs/plugins/playlist.rst index 81fc60beb..ebff72da5 100644 --- a/docs/plugins/playlist.rst +++ b/docs/plugins/playlist.rst @@ -24,6 +24,16 @@ name:: $ beet ls playlist:anotherplaylist +A playlist query will use the paths found in the playlist file to match items +in the beets library. Since `playlist:` submits a regular beets query like any +other query syntax (eg. `artist:`, `year:`, ...), the sorting order of either +the configuartion setting `sort_item` or any sorting patterns submitted with +the query command will be used:: + + $ beet ls playlist:/path/to/someplaylist.m3u artist+ year+ + +Currently retaining the original sort order of the playlist is not supported. + The plugin can also update playlists in the playlist directory automatically every time an item is moved or deleted. This can be controlled by the ``auto`` configuration option.