summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJ0J0 Todos <jojo@peek-a-boo.at>2023-04-02 21:14:46 +0200
committerJ0J0 Todos <jojo@peek-a-boo.at>2023-04-02 21:14:50 +0200
commit94784c2c2939d85837349a8a27c2c5b146cb1a65 (patch)
treeaf8b27d2bfca206b0e57440faa44734ffec38988
parent86929eb6a01407e48bf511a0bc63d32508f10b59 (diff)
convert: playlist: Documentation overhaul
-rw-r--r--docs/plugins/convert.rst23
1 files changed, 10 insertions, 13 deletions
diff --git a/docs/plugins/convert.rst b/docs/plugins/convert.rst
index a68745da9..d70d354bf 100644
--- a/docs/plugins/convert.rst
+++ b/docs/plugins/convert.rst
@@ -57,19 +57,16 @@ Refer to the ``link`` and ``hardlink`` options below.
The ``-m`` (or ``--playlist``) option enables the plugin to create an m3u8
playlist file in the destination folder given by the ``-d`` (``--dest``) option
-or the ``dest`` configuration. Either a simple filename or a relative path plus
-a filename can be passed. The generated playlist will always use relative paths
-to the contained media files to ensure compatibility when read from external
-drives or on computers other than the one used for the conversion. Also refer
-to the ``playlist`` option below.
-
-Note that the classic m3u format doesn't support special characters in media
-file paths, thus the m3u8 format which requires media file paths to be unicode,
-is used. Typically a playlist file would be named `*.m3u8`. The name of the file
-can be freely chosen by the user though. Since it is always ensured that paths
-to media files are written as defined by the ``path`` configuration, a
-generated playlist potentially could contain unicode characters no matter what
-file ending was chosen.
+or the ``dest`` configuration. The path to the playlist file can either be
+absolute or relative to the ``dest`` directory. The contents will always be
+relative paths to media files, which tries to ensure compatibility when read
+from external drives or on computers other than the one used for the
+conversion. There is one caveat though: A list generated on Unix/macOS can't be
+read on Windows and vice versa.
+
+Depending on the beets user's settings a generated playlist potentially could
+contain unicode characters. This is supported, playlists are written in [m3u8
+format](https://en.wikipedia.org/wiki/M3U#M3U8).
Configuration
-------------