mirror of
https://github.com/beetbox/beets.git
synced 2026-02-09 17:01:55 +01:00
Finish the pass over all plugin docs
This commit is contained in:
parent
918afbed42
commit
930581ac99
19 changed files with 219 additions and 228 deletions
|
|
@ -14,10 +14,11 @@ You'll then be able to use the ``~`` prefix to use fuzzy matching::
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
To configure the plugin, make a ``fuzzy:`` section in your configuration
|
||||
file. The available options are:
|
||||
|
||||
- ``threshold``: a value of 1.0 will show only perfect matches and a value of
|
||||
0.0 will match everything.
|
||||
Default: ``0.7``
|
||||
- ``prefix``: character to use to designate fuzzy queries.
|
||||
Default: ``~`` (needs to be escaped or quoted in most shells)
|
||||
- ``threshold``: The "sensitivity" of the fuzzy match. A value of 1.0 will
|
||||
show only perfect matches and a value of 0.0 will match everything.
|
||||
Default: 0.7.
|
||||
- ``prefix``: The character used to designate fuzzy queries.
|
||||
Default: ``~``, which may need to be escaped in some shells.
|
||||
|
|
|
|||
|
|
@ -12,13 +12,15 @@ To use the ``ihate`` plugin, enable it in your configuration (see
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
To configure the plugin, make an ``ihate:`` section in your configuration
|
||||
file. The available options are:
|
||||
|
||||
- ``skip``: never import matches. Default: ``[]``
|
||||
- ``warn``: print a warning message for matches. Default: ``[]``
|
||||
- ``skip``: Never import items and albums that match a query in this list.
|
||||
Default: ``[]`` (empty list).
|
||||
- ``warn``: Print a warning message for matches in this list of queries.
|
||||
Default: ``[]``.
|
||||
|
||||
|
||||
Here's an example ::
|
||||
Here's an example::
|
||||
|
||||
ihate:
|
||||
warn:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
ImportAdded Plugin
|
||||
==================
|
||||
|
||||
This plugin is useful when an existing collection is imported
|
||||
The ``importadded`` plugin is useful when an existing collection is imported
|
||||
and the time when albums and items were added should be preserved.
|
||||
|
||||
To use the ``importadded`` plugin, enable it in your configuration (see
|
||||
|
|
@ -39,10 +39,12 @@ of album directories on disk aren't preserved.
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available option:
|
||||
To configure the plugin, make an ``importadded:`` section in your
|
||||
configuration file. There is one option available:
|
||||
|
||||
- ``preserve_mtimes``
|
||||
Default: ``no``
|
||||
- ``preserve_mtimes``: After writing files, re-set their mtimes to their
|
||||
original value.
|
||||
Default: ``no``.
|
||||
|
||||
Reimport
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -9,33 +9,31 @@ To use the ``importfeeds`` plugin, enable it in your configuration
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
To configure the plugin, make an ``importfeeds:`` section in your
|
||||
configuration file. The available options are:
|
||||
|
||||
- ``absolute_path`` option can be set to use absolute paths instead of relative
|
||||
paths. Some applications may need this to work properly.
|
||||
- ``absolute_path``: Use absolute paths instead of relative paths. Some
|
||||
applications may need this to work properly.
|
||||
Default: ``no``.
|
||||
- ``dir`` option can be set to specify another output folder than the default
|
||||
library directory.
|
||||
Default: ``None``.
|
||||
- ``formats`` option can be set to select desired output type(s):
|
||||
|
||||
- ``m3u``: catalog the imports in a centralized playlist.
|
||||
- ``m3u_multi``: create a new playlist for each import (uniquely named by
|
||||
appending the date and track/album name).
|
||||
- ``link``: create a symlink for each imported item. This is the
|
||||
recommended setting to propagate beets imports to your iTunes library: just
|
||||
drag and drop the ``dir`` folder on the iTunes dock icon.
|
||||
- ``echo``: do not write a playlist file at all, but echo a list of new
|
||||
file paths to the terminal.
|
||||
|
||||
Default: ``[]``.
|
||||
- ``m3u_name``: playlist name used by ``m3u`` format.
|
||||
- ``dir``: The output directory.
|
||||
Default: Your beets library directory.
|
||||
- ``formats``: Select the kind of output. Use one or more of:
|
||||
- ``m3u``: Catalog the imports in a centralized playlist.
|
||||
- ``m3u_multi``: Create a new playlist for each import (uniquely named by
|
||||
appending the date and track/album name).
|
||||
- ``link``: Create a symlink for each imported item. This is the
|
||||
recommended setting to propagate beets imports to your iTunes library:
|
||||
just drag and drop the ``dir`` folder on the iTunes dock icon.
|
||||
- ``echo``: Do not write a playlist file at all, but echo a list of new
|
||||
file paths to the terminal.
|
||||
Default: None.
|
||||
- ``m3u_name``: Playlist name used by the ``m3u`` format.
|
||||
Default: ``imported.m3u``.
|
||||
- ``relative_to`` option can be set to make the m3u paths relative to another
|
||||
- ``relative_to``: Make the m3u paths relative to another
|
||||
folder than where the playlist is being written. If you're using importfeeds
|
||||
to generate a playlist for MPD, you should set this to the root of your music
|
||||
library.
|
||||
Default: ``None``.
|
||||
Default: None.
|
||||
|
||||
Here's an example configuration for this plugin::
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ Key Finder Plugin
|
|||
|
||||
The `keyfinder` plugin uses the `KeyFinder`_ program to detect the
|
||||
musical key of track from its audio data and store it in the
|
||||
'initial_key' field of you database. It does so
|
||||
`initial_key` field of your database. It does so
|
||||
automatically when importing music or through the ``beet keyfinder
|
||||
[QUERY]`` command.
|
||||
|
||||
|
|
@ -13,18 +13,20 @@ To use the ``keyfinder`` plugin, enable it in your configuration (see
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
To configure the plugin, make a ``keyfinder:`` section in your
|
||||
configuration file. The available options are:
|
||||
|
||||
- ``bin``: the name of the `KeyFinder` program on your system or
|
||||
a path to the binary. If you installed the `KeyFinder`_ GUI on a Mac, for
|
||||
- ``bin``: The name of the `KeyFinder`_ program on your system or
|
||||
a path to the binary. If you installed the KeyFinder GUI on a Mac, for
|
||||
example, you want something like
|
||||
``/Applications/KeyFinder.app/Contents/MacOS/KeyFinder``.
|
||||
Default: ``KeyFinder``.
|
||||
- ``auto``: if set to `yes`, the plugin will analyze every file on
|
||||
Default: ``KeyFinder`` (i.e., search for the program in your ``$PATH``).
|
||||
- ``auto``: Analyze every file on
|
||||
import. Otherwise, you need to use the ``beet keyfinder`` command
|
||||
explicitly. Default: ``yes``.
|
||||
- ``overwrite``: if set to ``no``, the import hook and the command will skip
|
||||
any file that already has an 'initial_key' in the database.
|
||||
explicitly.
|
||||
Default: ``yes``.
|
||||
- ``overwrite``: Calculate a key even for files that already have an
|
||||
`initial_key` value.
|
||||
Default: ``no``.
|
||||
|
||||
.. _KeyFinder: http://www.ibrahimshaath.co.uk/keyfinder/
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ The plugin chooses genres based on a *whitelist*, meaning that only certain
|
|||
tags can be considered genres. This way, tags like "my favorite music" or "seen
|
||||
live" won't be considered genres. The plugin ships with a fairly extensive
|
||||
`internal whitelist`_, but you can set your own in the config file using the
|
||||
``whitelist`` configuration value or go for no whitelist altogether by setting
|
||||
``whitelist`` configuration value or forgo a whitelist altogether by setting
|
||||
the option to `false`.
|
||||
|
||||
The genre list file should contain one genre per line. Blank lines are ignored.
|
||||
|
|
@ -80,29 +80,34 @@ the ``min_weight`` config option.
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
To configure the plugin, make a ``lastgenre:`` section in your
|
||||
configuration file. The available options are:
|
||||
|
||||
- ``auto``: set it to ``no`` to disable automatic genre fetching during import.
|
||||
- ``auto``: Fetch genres automatically during import.
|
||||
Default: ``yes``.
|
||||
- ``canonical``: Use a canonicalization tree. Setting this to ``yes`` will use
|
||||
a built-in tree. You can also set it to a path, like the ``whitelist``
|
||||
config value, to use your own tree.
|
||||
Default: ``no`` (disabled).
|
||||
- ``count``: Number of genres to fetch.
|
||||
Default: 1
|
||||
- ``fallback``: A string if to use a fallback genre when no genre is found.
|
||||
You can use the empty string ``''`` to reset the genre.
|
||||
Default: None.
|
||||
- ``force``: By default, beets will always fetch new genres, even if the files
|
||||
already have one. To instead leave genres in place in when they pass the
|
||||
whitelist, set the ``force`` option to ``no``.
|
||||
Default: ``yes``.
|
||||
- ``min_weight``: Minimum popularity factor below which genres are discarded.
|
||||
Default: 10.
|
||||
- ``source``: Which entity to look up in Last.fm. Can be
|
||||
either ``artist``, ``album`` or ``track``.
|
||||
Default: ``album``.
|
||||
- ``separator``: A separator for multiple genres.
|
||||
Default: ``', '``.
|
||||
- ``whitelist``: The filename of a custom genre list, ``yes`` to use
|
||||
the internal whitelist, or ``no`` to consider all genres valid.
|
||||
Default: ``yes``.
|
||||
- ``canonical``: setting this value to ``true`` will use a built-in canonicalization
|
||||
tree. You can also set it to a path, just like the ``whitelist`` config value,
|
||||
to use your own tree. Default: ``no``
|
||||
- ``count``: number of genres to fetch. Default: ``1``
|
||||
- ``fallback``: by default, the file will be left unchanged when no genre is
|
||||
found. Specify a string if you prefer to use a fallback genre. You can use the
|
||||
empty string ``''` to reset the genre. Default: ``None``
|
||||
- ``force``: by default, beets will always fetch new genres, even if the files already have
|
||||
once. To instead leave genres in place in when they pass the whitelist, set
|
||||
the ``force`` option to ``no``. Default: ``yes``
|
||||
- ``min_weight``: minimum popularity factor below which genres are discarded.
|
||||
Default: ``10``
|
||||
- ``source``: defines on which entity to perform Last.fm tags lookup. Can be
|
||||
either ``artist``, ``album`` or ``track``. Default: ``album``
|
||||
- ``separator``: genres separator string
|
||||
Default: ``u', '``
|
||||
- ``whitelist``: give it a custom genre list filepath or set it to 'yes' to use
|
||||
internal whitelist. If set to 'no' then all genres are considered valids.
|
||||
Default: ``yes``
|
||||
|
||||
Running Manually
|
||||
----------------
|
||||
|
|
|
|||
|
|
@ -23,18 +23,20 @@ the files' tags.
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
To configure the plugin, make a ``lyrics:`` section in your
|
||||
configuration file. The available options are:
|
||||
|
||||
- ``auto``: set it to ``no`` to disable automatic lyrics fetching during import.
|
||||
- ``auto``: Fetch lyrics automatically during import.
|
||||
Default: ``yes``.
|
||||
- ``fallback``: by default, the file will be left unchanged when no lyrics are
|
||||
found. Use the empty string ``''`` to reset the genre in such a case.
|
||||
Default: ``None``;
|
||||
- ``google_API_key``: your Google API key.
|
||||
Default: ``None``;
|
||||
- ``google_engine_ID``: custom search engine to use.
|
||||
Default: ``009217259823014548361:lndtuqkycfu``, beets custom search engine
|
||||
that gathers list of sources known to be scrapeable.
|
||||
- ``fallback``: By default, the file will be left unchanged when no lyrics are
|
||||
found. Use the empty string ``''`` to reset the lyrics in such a case.
|
||||
Default: None.
|
||||
- ``google_API_key``: Your Google API key (to enable the Google Custom Search
|
||||
backend).
|
||||
Default: None.
|
||||
- ``google_engine_ID``: The custom search engine to use.
|
||||
Default: The beets custom search engine, which gathers a list of sources
|
||||
known to be scrapeable.
|
||||
|
||||
Here's an example of ``config.yaml``::
|
||||
|
||||
|
|
|
|||
|
|
@ -23,8 +23,9 @@ profile first.
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available option:
|
||||
To configure the plugin, make a ``mbcollection:`` section in your
|
||||
configuration file. There is one option available:
|
||||
|
||||
- ``auto``: if set to ``yes``, the plugin will automatically amend your
|
||||
MusicBrainz collection whenever you import a new album.
|
||||
Default: ``false``
|
||||
- ``auto``: Automatically amend your MusicBrainz collection whenever you
|
||||
import a new album.
|
||||
Default: ``no``.
|
||||
|
|
|
|||
|
|
@ -6,39 +6,39 @@ and lists, for every album in your collection, which or how many
|
|||
tracks are missing. Listing missing files requires one network call to
|
||||
MusicBrainz. Merely counting missing files avoids any network calls.
|
||||
|
||||
|
||||
Usage
|
||||
------
|
||||
-----
|
||||
|
||||
Add the ``missing`` plugin to your configuration (see :ref:`using-plugins`).
|
||||
By default, the ``beet missing`` command lists the names of tracks that your
|
||||
library is missing from each album.
|
||||
You can customize the output format, count
|
||||
the number of missing tracks per album, or total up the number of missing
|
||||
tracks over your whole library, using command-line switches ::
|
||||
tracks over your whole library, using command-line switches::
|
||||
|
||||
-f FORMAT, --format=FORMAT
|
||||
print with custom FORMAT
|
||||
-c, --count count missing tracks per album
|
||||
-t, --total count total of missing tracks
|
||||
|
||||
... or by editing corresponding options.
|
||||
…or by editing corresponding options.
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
To configure the plugin, make a ``missing:`` section in your
|
||||
configuration file. The available options are:
|
||||
|
||||
- ``count`` prints a count of missing tracks per album, with ``format``
|
||||
- ``count``: Print a count of missing tracks per album, with ``format``
|
||||
defaulting to ``$albumartist - $album: $missing``.
|
||||
Default: ``no``.
|
||||
- ``format`` lets you specify a specific format with which to print every
|
||||
track. This uses the same template syntax as beets’
|
||||
- ``format``: A specific format with which to print every
|
||||
track. This uses the same template syntax as beets'
|
||||
:doc:`path formats </reference/pathformat>`. The usage is inspired by, and
|
||||
therefore similar to, the :ref:`list <list-cmd>` command.
|
||||
Default: :ref:`list_format_item`.
|
||||
- ``total` prints a single count of missing tracks in all albums.
|
||||
Default: ``false``.
|
||||
- ``total``: Print a single count of missing tracks in all albums.
|
||||
Default: ``no``.
|
||||
|
||||
Here's an example ::
|
||||
|
||||
|
|
|
|||
|
|
@ -35,24 +35,23 @@ Use the ``mpdstats`` command to fire it up::
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
To configure the plugin, make an ``mpd:`` section in your
|
||||
configuration file. The available options are:
|
||||
|
||||
- ``host``: mpd server name.
|
||||
- ``host``: The MPD server hostname.
|
||||
Default: ``localhost``.
|
||||
- ``music_directory``: if your MPD library is at another location than the
|
||||
- ``port``: The MPD server port.
|
||||
Default: 6600.
|
||||
- ``password``: The MPD server password.
|
||||
Default: None.
|
||||
- ``music_directory``: If your MPD library is at a different location from the
|
||||
beets library (e.g., because one is mounted on a NFS share), specify the path
|
||||
here.
|
||||
By default it uses beets library directory.
|
||||
- ``password``: mpd server password.
|
||||
Default: ``u''``
|
||||
- ``port``: mpd server port.
|
||||
Default: ``6600``.
|
||||
- ``rating``: set it to ``no`` if you don't want the plugin to update the
|
||||
rating.
|
||||
Default: ``yes``
|
||||
- ``rating_mix``: change it to tune the way rating is calculated. See below for
|
||||
details.
|
||||
Default: ``0.75``
|
||||
Default: The beets library directory.
|
||||
- ``rating``: Enable rating updates.
|
||||
Default: ``yes``.
|
||||
- ``rating_mix``: Tune the way rating is calculated (see below).
|
||||
Default: 0.75.
|
||||
|
||||
A Word on Ratings
|
||||
-----------------
|
||||
|
|
|
|||
|
|
@ -28,11 +28,11 @@ socket.)
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
The available options under teh ``mpd:`` section are:
|
||||
|
||||
- ``host``: mpd server name.
|
||||
- ``host``: The MPD server name.
|
||||
Default: ``localhost``.
|
||||
- ``password``: mpd server password.
|
||||
Default: ``u''``
|
||||
- ``port``: mpd server port.
|
||||
Default: ``6600``.
|
||||
- ``password``: The MPD server password.
|
||||
Default: None.
|
||||
- ``port``: The MPD server port.
|
||||
Default: 6600.
|
||||
|
|
|
|||
|
|
@ -32,13 +32,15 @@ debug.
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
- ``command``: command used to open the playlist.
|
||||
To configure the plugin, make a ``play:`` section in your
|
||||
configuration file. The available options are:
|
||||
|
||||
- ``command``: The command used to open the playlist.
|
||||
Default: ``open`` on OS X, ``xdg-open`` on other Unixes and ``start`` on
|
||||
Windows.
|
||||
- ``relative_to``: set that option if you want to emit relative paths by giving
|
||||
the refefence folder (eg '/my/music/folder')
|
||||
Default: ``None``
|
||||
- ``use_folders``: when using the ``-a`` option, the m3u will have the paths to
|
||||
each track on the matched albums. Set it to ``yes`` to store paths to folders
|
||||
instead.
|
||||
Default: ``no``
|
||||
- ``relative_to``: Emit paths relative to base directory.
|
||||
Default: None.
|
||||
- ``use_folders``: When using the ``-a`` option, the m3u will contain the
|
||||
paths to each track on the matched albums. Enable this option to
|
||||
store paths to folders instead.
|
||||
Default: ``no``.
|
||||
|
|
|
|||
|
|
@ -65,34 +65,31 @@ you can configure the path explicitly like so::
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
To configure the plugin, make a ``replaygain:`` section in your
|
||||
configuration file. The available options are:
|
||||
|
||||
|
||||
- ``auto``: set it to ``no`` to disable replaygain analysis during import.
|
||||
- ``auto``: Enable ReplayGain analysis during import.
|
||||
Default: ``yes``.
|
||||
- ``backend``: which backend to use for ReplayGain analysis.
|
||||
Must be one of ``gstreamer`` or ``command``.
|
||||
Default: ``command``
|
||||
- ``overwrite``: by default, files that already have ReplayGain tags will not
|
||||
be re-analyzed. Set to ``yes`` if you want to analyze *every* file on import.
|
||||
- ``backend``: The analysis backend; either ``gstreamer`` or ``command``.
|
||||
Default: ``command``.
|
||||
- ``overwrite``: Re-analyze files that already have ReplayGain tags.
|
||||
Default: ``no``.
|
||||
- ``targetlevel``: specify a number of decibels for the target loudness level
|
||||
Default: ``89``
|
||||
- ``targetlevel``: A number of decibels for the target loudness level.
|
||||
Default: 89.
|
||||
|
||||
These options only work with the "command" backend:
|
||||
These options only work with the "command" backend:
|
||||
|
||||
- ``apply``: if you use a player that does not support ReplayGain
|
||||
- ``apply``: If you use a player that does not support ReplayGain
|
||||
specifications, you can force the volume normalization by applying the gain
|
||||
to the file via the ``apply`` option. This is a lossless and reversible
|
||||
operation with no transcoding involved.
|
||||
- ``command``: use it to explicitely enter path to ``mp3gain`` or ``aacgain``
|
||||
executable, if beets cannot find it by itself.
|
||||
For example: '/Applications/MacMP3Gain.app/Contents/Resources/aacgain'
|
||||
Default: ``u''``
|
||||
- ``noclip``: the use of ReplayGain can cause clipping if the average volume
|
||||
of a song is below the target level. By default, a "prevent clipping" option
|
||||
named ``noclip`` is enabled to reduce the amount of ReplayGain adjustment to
|
||||
whatever amount would keep clipping from occurring.
|
||||
Default: ``no``.
|
||||
- ``command``: The path to the ``mp3gain`` or ``aacgain`` executable (if beets
|
||||
cannot find it by itself).
|
||||
For example: ``/Applications/MacMP3Gain.app/Contents/Resources/aacgain``.
|
||||
Default: Search in your ``$PATH``.
|
||||
- ``noclip``: Reduce the amount of ReplayGain adjustment to whatever amount
|
||||
would keep clipping from occurring.
|
||||
Default: ``yes``.
|
||||
|
||||
Manual Analysis
|
||||
|
|
|
|||
|
|
@ -34,7 +34,8 @@ whatsoever.
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available option :
|
||||
To configure the plugin, make a ``scrub:`` section in your
|
||||
configuration file. There is one option:
|
||||
|
||||
- ``auto``: set it to ``no`` to disable metadata stripping during import.
|
||||
- ``auto``: Enable metadata stripping during import.
|
||||
Default: ``yes``.
|
||||
|
|
|
|||
|
|
@ -69,14 +69,15 @@ plugin.
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
To configure the plugin, make a ``smartplaylist:`` section in your
|
||||
configuration file. In addition to the ``playlists`` described above, the
|
||||
other configuration options are:
|
||||
|
||||
- ``auto``: set it to ``no`` to tell beets to stop regenerate the playlist
|
||||
after every database change.
|
||||
Default: ``yes``
|
||||
- ``playlist_dir``: where the generated playlist files will be put.
|
||||
Default: ``u'.'``
|
||||
- ``relative_to``: if you intend to use this plugin to generate playlists for
|
||||
MPD, make it points to your MPD music directory.
|
||||
Default: ``None``, which means that absolute paths to your music files will
|
||||
be generated.
|
||||
- ``auto``: Regenerate the playlist after every database change.
|
||||
Default: ``yes``.
|
||||
- ``playlist_dir``: Where to put the generated playlist files.
|
||||
Default: The current working directory (i.e., ``'.'``).
|
||||
- ``relative_to``: Generate paths in the playlist files relative to a base
|
||||
directory. If you intend to use this plugin to generate playlists for MPD,
|
||||
point this to your MPD music directory.
|
||||
Default: Use absolute paths.
|
||||
|
|
|
|||
|
|
@ -40,61 +40,39 @@ Command-line options include:
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
The default options should work as-is, but there are some options you can put in config.yaml:
|
||||
|
||||
* ``mode``: one of the following :
|
||||
|
||||
- "list": the default mode is to print out the playlist as a list of links.
|
||||
This list can then be pasted in to a new or existing Spotify playlist.
|
||||
- "open": This mode actually sends a link to your default browser with
|
||||
instructions to open Spotify with the playlist you created. Until this
|
||||
has been tested on all platforms, it will remain optional.
|
||||
The default options should work as-is, but there are some options you can put
|
||||
in config.yaml under the ``spotify:`` section:
|
||||
|
||||
* ``mode``: One of the following:
|
||||
- ``list``: Print out the playlist as a list of links. This list can then
|
||||
be pasted in to a new or existing Spotify playlist.
|
||||
- ``open``: This mode actually sends a link to your default browser with
|
||||
instructions to open Spotify with the playlist you created. Until this
|
||||
has been tested on all platforms, it will remain optional.
|
||||
Default: ``list``.
|
||||
* ``region_filter``: use the 2-character country abbreviation to limit results
|
||||
* ``region_filter``: A two-character country abbreviation, to limit results
|
||||
to that market.
|
||||
Default: ``None``
|
||||
* ``show_failures``: show the artist/album/track for each lookup that does not
|
||||
return a Spotify ID (and therefore cannot be added to a playlist).
|
||||
Default: ``no``
|
||||
* ``tiebreak``: how to choose the track if there is more than one identical
|
||||
result. For example, there might be multiple releases of the same album.
|
||||
Currently, this defaults to "popularity", "first" simply chooses the first
|
||||
in the list returned by Spotify.
|
||||
Default: ``popularity``
|
||||
* ``regex``: an array of regex transformations to perform on the
|
||||
Default: None.
|
||||
* ``show_failures``: List each lookup that does not return a Spotify ID (and
|
||||
therefore cannot be added to a playlist).
|
||||
Default: ``no``.
|
||||
* ``tiebreak``: How to choose the track if there is more than one identical
|
||||
result. For example, there might be multiple releases of the same album.
|
||||
The options are ``popularity`` and ``first`` (to just choose the first match
|
||||
returned).
|
||||
Default: ``popularity``.
|
||||
* ``regex``: An array of regex transformations to perform on the
|
||||
track/album/artist fields before sending them to Spotify. Can be useful for
|
||||
changing certain abbreviations, like ft. -> feat. See the examples below.
|
||||
Default: ``[]``
|
||||
* ``artist_field`` / ``album_field`` / ``track_field``: these allow the user
|
||||
to choose a different field to send to Spotify when looking up the track,
|
||||
album and artist. Most users will not want to change this.
|
||||
Default: None.
|
||||
|
||||
|
||||
Example Configuration
|
||||
---------------------
|
||||
|
||||
::
|
||||
Here's an example::
|
||||
|
||||
spotify:
|
||||
# Default is list, shows the plugin output. Open attempts to open
|
||||
# directly in Spotify (only tested on Mac).
|
||||
mode: "open"
|
||||
|
||||
# Filter tracks by only that market (2-letter code)
|
||||
region_filter: "US"
|
||||
|
||||
# Display the tracks that did not match a Spotify ID.
|
||||
mode: open
|
||||
region_filter: US
|
||||
show_faiulres: on
|
||||
|
||||
# Need to break ties when then are multiple tracks. Default is
|
||||
popularity.
|
||||
tiebreak: "first"
|
||||
|
||||
# Which beets fields to use for lookups.
|
||||
artist_field: "albumartist"
|
||||
album_field: "album"
|
||||
track_field: "title"
|
||||
tiebreak: first
|
||||
|
||||
regex: [
|
||||
{
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ The Plugin
|
|||
|
||||
The ``the`` plugin allows you to move patterns in path formats. It's suitable,
|
||||
for example, for moving articles from string start to the end. This is useful
|
||||
for quick search on filesystems and generally looks good. Plugin DOES NOT
|
||||
for quick search on filesystems and generally looks good. Plugin does not
|
||||
change tags. By default plugin supports English "the, a, an", but custom
|
||||
regexp patterns can be added by user. How it works::
|
||||
|
||||
|
|
@ -11,8 +11,8 @@ regexp patterns can be added by user. How it works::
|
|||
A Band -> Band, A
|
||||
An Orchestra -> Orchestra, An
|
||||
|
||||
Enable the ``the`` plugin (see :doc:`/plugins/index`) and then make use of a
|
||||
template function called ``%the`` for use in path format expressions::
|
||||
To use the ``the`` plugin, enable it (see :doc:`/plugins/index`) and then use
|
||||
a template function called ``%the`` in path format expressions::
|
||||
|
||||
paths:
|
||||
default: %the{$albumartist}/($year) $album/$track $title
|
||||
|
|
@ -23,20 +23,21 @@ but you can override these defaults to make more complex changes.
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
To configure the plugin, make a ``the:`` section in your
|
||||
configuration file. The available options are:
|
||||
|
||||
- ``a``: handle "A/An" moves
|
||||
Default: ``yes``
|
||||
- ``format``: format string with *{0}: part w/o article* and *{1} - article*.
|
||||
Spaces are already trimmed from ends of both parts.
|
||||
Default: ``u'{0}, {1}'``
|
||||
- ``strip``:
|
||||
Default: ``no``
|
||||
- ``patterns``: custom regexp patterns, space-separated. Custom patterns are
|
||||
- ``a``: Handle "A/An" moves.
|
||||
Default: ``yes``.
|
||||
- ``the``: handle "The" moves.
|
||||
Default: ``yes``.
|
||||
- ``patterns``: Custom regexp patterns, space-separated. Custom patterns are
|
||||
case-insensitive regular expressions. Patterns can be matched anywhere in the
|
||||
string (not just the beginning), so use ``^`` if you intend to match leading
|
||||
words.
|
||||
Default: ``[]``
|
||||
- ``the``: handle "The" moves
|
||||
Default: ``yes``
|
||||
|
||||
Default: ``[]``.
|
||||
- ``strip``: Remove the article altogether instead of moving it to the end.
|
||||
Default: ``no``.
|
||||
- ``format``: A Python format string for the output. Use ``{0}`` to indicate
|
||||
the part without the article and ``{1}`` for the article.
|
||||
Spaces are already trimmed from ends of both parts.
|
||||
Default: ``'{0}, {1}'``.
|
||||
|
|
|
|||
|
|
@ -35,12 +35,8 @@ You can also specify the hostname and port number used by the Web server. These
|
|||
can be specified on the command line or in the ``[web]`` section of your
|
||||
:doc:`configuration file </reference/config>`.
|
||||
|
||||
On the command line, use ``beet web [HOSTNAME] [PORT]``. In the config file, use
|
||||
something like this::
|
||||
|
||||
web:
|
||||
host: 127.0.0.1
|
||||
port: 8888
|
||||
On the command line, use ``beet web [HOSTNAME] [PORT]``. Or the configuration
|
||||
options below.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
|
@ -53,12 +49,13 @@ Type queries into the little search box. Double-click a track to play it with
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available options:
|
||||
To configure the plugin, make a ``web:`` section in your
|
||||
configuration file. The available options are:
|
||||
|
||||
- ``host``: server hostname
|
||||
Default: ``u''``
|
||||
- ``port``: server port
|
||||
Default: `8337`
|
||||
- ``host``: The server hostname.
|
||||
Default: Bind to all interfaces.
|
||||
- ``port``: The server port.
|
||||
Default: 8337.
|
||||
|
||||
Implementation
|
||||
--------------
|
||||
|
|
|
|||
|
|
@ -12,11 +12,13 @@ To use the ``zero`` plugin, enable the plugin in your configuration
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available option :
|
||||
Make a ``zero:`` section in your configuration file. You can specify the
|
||||
fields to nullify and the conditions for nullifying them:
|
||||
|
||||
- ``fields``: whitespace-separated list of fields to change. You can get the
|
||||
list of available fields by running ``beet fields``. To conditionally filter
|
||||
a field, use ``field: [regexp, regexp]`` to specify regular expressions.
|
||||
* Set ``fields`` to a whitespace-separated list of fields to change. You can
|
||||
get the list of all available fields by running ``beet fields``.
|
||||
* To conditionally filter a field, use ``field: [regexp, regexp]`` to specify
|
||||
regular expressions.
|
||||
|
||||
For example::
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue