importfeeds: document the relative_to configuration option

This commit is contained in:
Philippe Mongeau 2013-01-22 22:50:30 -05:00
parent ddbae951c0
commit c01e06e0fe

View file

@ -8,8 +8,15 @@ To use the plugin, just put ``importfeeds`` on the ``plugins`` line in your
``importfeeds:`` section in the config file.
The ``dir`` configuration option can be set to specify another folder
than the default library directory. Three different types of outputs coexist,
specify the ones you want to use by setting the ``formats`` parameter:
than the default library directory.
the ``relative_to`` configuration option can be set to write the m3u paths
relative to another folder than where the playlist is being written. If you are
using importfeeds to genereate a playlist for mpd, you should set this to the
root of your music library.
Three different types of outputs coexist, specify the ones you want to use by
setting the ``formats`` parameter:
- ``m3u``: catalog the imports in a centralized playlist. By default, the playlist is named ``imported.m3u``. To use a different file, just set the ``m3u_name`` parameter inside the ``importfeeds`` config section.
- ``m3u_multi``: create a new playlist for each import (uniquely named by appending the date and track/album name).
@ -20,4 +27,5 @@ Here's an example configuration for this plugin::
importfeeds:
formats: m3u link
dir: ~/imports/
relative_to: ~/Music/
m3u_name: newfiles.m3u