From f7ecb9cbae489ee575a00e338c13e7b1138b6320 Mon Sep 17 00:00:00 2001 From: Fabrice Laporte Date: Fri, 7 Nov 2014 22:13:25 +0100 Subject: [PATCH] doc: emphasize options names by using bold font instead of fixed width --- docs/plugins/bpd.rst | 8 ++++---- docs/plugins/bucket.rst | 8 ++++---- docs/plugins/convert.rst | 18 +++++++++--------- docs/plugins/duplicates.rst | 22 +++++++++++----------- docs/plugins/echonest.rst | 12 ++++++------ docs/plugins/embedart.rst | 8 ++++---- docs/plugins/fetchart.rst | 12 ++++++------ docs/plugins/freedesktop.rst | 2 +- docs/plugins/ftintitle.rst | 4 ++-- docs/plugins/fuzzy.rst | 4 ++-- docs/plugins/ihate.rst | 4 ++-- docs/plugins/importadded.rst | 2 +- docs/plugins/importfeeds.rst | 18 +++++++++--------- docs/plugins/keyfinder.rst | 6 +++--- docs/plugins/lastgenre.rst | 18 +++++++++--------- docs/plugins/lyrics.rst | 8 ++++---- docs/plugins/mbcollection.rst | 2 +- docs/plugins/missing.rst | 6 +++--- docs/plugins/mpdstats.rst | 12 ++++++------ docs/plugins/mpdupdate.rst | 6 +++--- docs/plugins/play.rst | 6 +++--- docs/plugins/replaygain.rst | 14 +++++++------- docs/plugins/scrub.rst | 2 +- docs/plugins/smartplaylist.rst | 6 +++--- docs/plugins/spotify.rst | 4 ++-- docs/plugins/the.rst | 10 +++++----- docs/plugins/web.rst | 4 ++-- 27 files changed, 113 insertions(+), 113 deletions(-) diff --git a/docs/plugins/bpd.rst b/docs/plugins/bpd.rst index b5082b220..eed0f2833 100644 --- a/docs/plugins/bpd.rst +++ b/docs/plugins/bpd.rst @@ -73,13 +73,13 @@ Configuration To configure the plugin, make a ``bpd:`` section in your configuration file. The available options are: -- ``host``: +- **host**: Default: Bind to all interfaces. -- ``port``: +- **port**: Default: 6600 -- ``password``: +- **password**: Default: No password. -- ``volume``: Initial volume, as a percentage. +- **volume**: Initial volume, as a percentage. Default: 100 Here's an example:: diff --git a/docs/plugins/bucket.rst b/docs/plugins/bucket.rst index 9acd86a87..627831ad3 100644 --- a/docs/plugins/bucket.rst +++ b/docs/plugins/bucket.rst @@ -41,17 +41,17 @@ Configuration To configure the plugin, make a ``bucket:`` section in your configuration file. The available options are: -- ``bucket_alpha``: Ranges to use for all substitutions occurring on textual +- **bucket_alpha**: Ranges to use for all substitutions occurring on textual fields. Default: none. -- ``bucket_alpha_regex``: A ``range: regex`` mapping (one per line) where +- **bucket_alpha_regex**: A ``range: regex`` mapping (one per line) where ``range`` is one of the `bucket_alpha` ranges and ``value`` is a regex that overrides original range definition. Default: none. -- ``bucket_year``: Ranges to use for all substitutions occurring on the +- **bucket_year**: Ranges to use for all substitutions occurring on the `$year` field. Default: none. -- ``extrapolate``: Enable this if you want to group your files into multiple +- **extrapolate**: Enable this if you want to group your files into multiple year ranges without enumerating them all. This option will generate year bucket names by reproducing characteristics of declared buckets. Default: ``no`` diff --git a/docs/plugins/convert.rst b/docs/plugins/convert.rst index 88a2d159c..62206428f 100644 --- a/docs/plugins/convert.rst +++ b/docs/plugins/convert.rst @@ -53,33 +53,33 @@ Configuration To configure the plugin, make a ``convert:`` section in your configuration file. The available options are: -- ``auto``: Import transcoded versions of your files automatically during +- **auto**: Import transcoded versions of your files automatically during imports. With this option enabled, the importer will transcode all (in the default configuration) non-MP3 files over the maximum bitrate before adding them to your library. Default: ``no``. -- ``dest``: The directory where the files will be converted (or copied) to. +- **dest**: The directory where the files will be converted (or copied) to. Default: none. -- ``embed``: Embed album art in converted items. Default: ``yes``. -- ``max_bitrate``: All lossy files with a higher bitrate will be +- **embed**: Embed album art in converted items. Default: ``yes``. +- **max_bitrate**: All lossy files with a higher bitrate will be transcoded and those with a lower bitrate will simply be copied. Note that this does not guarantee that all converted files will have a lower bitrate---that depends on the encoder and its configuration. Default: none. -- ``never_convert_lossy_files``: Cross-conversions between lossy codecs---such +- **never_convert_lossy_files**: Cross-conversions between lossy codecs---such as mp3, ogg vorbis, etc.---makes little sense as they will decrease quality even further. If set to ``yes``, lossy files are always copied. Default: ``no``. -- ``paths``: The directory structure and naming scheme for the converted +- **paths**: The directory structure and naming scheme for the converted files. Uses the same format as the top-level ``paths`` section (see :ref:`path-format-config`). Default: Reuse your top-level path format settings. -- ``quiet``: Prevent the plugin from announcing every file it processes. +- **quiet**: Prevent the plugin from announcing every file it processes. Default: ``false``. -- ``threads``: The number of threads to use for parallel encoding. +- **threads**: The number of threads to use for parallel encoding. By default, the plugin will detect the number of processors available and use them all. -- ``copy_album_art``: Copy album art when copying or transcoding albums matched +- **copy_album_art**: Copy album art when copying or transcoding albums matched using the ``-a`` option. Default: ``no``. You can also configure the format to use for transcoding. diff --git a/docs/plugins/duplicates.rst b/docs/plugins/duplicates.rst index 08379451f..18c2a8052 100644 --- a/docs/plugins/duplicates.rst +++ b/docs/plugins/duplicates.rst @@ -39,44 +39,44 @@ Configuration To configure the plugin, make a ``duplicates:`` section in your configuration file. The available options mirror the command-line options: -- ``album``: List duplicate albums instead of tracks. +- **album**: List duplicate albums instead of tracks. Default: ``no``. -- ``checksum``: Use an arbitrary command to compute a checksum +- **checksum**: Use an arbitrary command to compute a checksum of items. This overrides the ``keys`` option the first time it is run; however, because it caches the resulting checksum as ``flexattrs`` in the database, you can use ``--keys=name_of_the_checksumming_program any_other_keys`` (or set configuration ``keys`` option) the second time around. Default: ``ffmpeg -i {file} -f crc -``. -- ``copy``: A destination base directory into which to copy matched +- **copy**: A destination base directory into which to copy matched items. Default: none (disabled). -- ``count``: Print a count of duplicate tracks or albums in the format +- **count**: Print a count of duplicate tracks or albums in the format ``$albumartist - $album - $title: $count`` (for tracks) or ``$albumartist - $album: $count`` (for albums). Default: ``no``. -- ``delete``: Removes matched items from the library and from the disk. +- **delete**: Removes matched items from the library and from the disk. Default: ``no`` -- ``format``: A specific format with which to print every track +- **format**: A specific format with which to print every track or album. This uses the same template syntax as beets' :doc:`path formats`. The usage is inspired by, and therefore similar to, the :ref:`list ` command. Default: :ref:`list_format_item` -- ``full``: List every track or album that has duplicates, not just the +- **full**: List every track or album that has duplicates, not just the duplicates themselves. Default: ``no``. -- ``keys``: Define in which track or album fields duplicates are to be +- **keys**: Define in which track or album fields duplicates are to be searched. By default, the plugin uses the musicbrainz track and album IDs for this purpose. Using the ``keys`` option (as a YAML list in the configuration file, or as space-delimited strings in the command-line), you can extend this behavior to consider other attributes. Default: ``[mb_trackid, mb_albumid]`` -- ``move``: A destination base directory into which it will move matched +- **move**: A destination base directory into which it will move matched items. Default: none (disabled). -- ``path``: Output the path instead of metadata when listing duplicates. +- **path**: Output the path instead of metadata when listing duplicates. Default: ``no``. -- ``tag``: A ``key=value`` pair. The plugin will add a new ``key`` attribute +- **tag**: A ``key=value`` pair. The plugin will add a new ``key`` attribute with ``value`` value as a flexattr to the database for duplicate items. Default: ``no``. diff --git a/docs/plugins/echonest.rst b/docs/plugins/echonest.rst index dfef807e6..815ef0e40 100644 --- a/docs/plugins/echonest.rst +++ b/docs/plugins/echonest.rst @@ -56,20 +56,20 @@ Configuration To configure the plugin, make an ``echonest:`` section in your configuration file. The available options are: -- ``apikey``: A custom EchoNest API key. You can `apply for your own`_ for +- **apikey**: A custom EchoNest API key. You can `apply for your own`_ for free from the EchoNest. Default: beets' own Echo Nest API key. -- ``auto``: Enable automatic metadata fetching during import. +- **auto**: Enable automatic metadata fetching during import. Default: ``yes``. -- ``codegen``: Echoprint or ENMFP codegen binary path. +- **codegen**: Echoprint or ENMFP codegen binary path. Default: look for the executable in your ``$PATH``. -- ``upload``: Send files to the Echo Nest server if they can not be identified +- **upload**: Send files to the Echo Nest server if they can not be identified by other means. Default: ``yes``. -- ``convert``: Because the Echo Nest server only supports a limited range of +- **convert**: Because the Echo Nest server only supports a limited range of file formats, the plugin automatically converts unsupported files to ``ogg``. Default: ``yes``. -- ``truncate``: Automatically truncate large files to their first 5 minutes +- **truncate**: Automatically truncate large files to their first 5 minutes before uploading them to The Echo Nest server (as files with sizes greater than 50MB are rejected). Default: ``yes``. diff --git a/docs/plugins/embedart.rst b/docs/plugins/embedart.rst index 172ac6550..bf99c3873 100644 --- a/docs/plugins/embedart.rst +++ b/docs/plugins/embedart.rst @@ -44,15 +44,15 @@ Configuration To configure the plugin, make an ``embedart:`` section in your configuration file. The available options are: -- ``auto``: Enable automatic album art embedding. +- **auto**: Enable automatic album art embedding. Default: ``yes``. -- ``compare_threshold``: How similar candidate art must be to +- **compare_threshold**: How similar candidate art must be to existing art to be written to the file (see :ref:`image-similarity-check`). Default: 0 (disabled). -- ``ifempty``: Avoid embedding album art for files that already have art +- **ifempty**: Avoid embedding album art for files that already have art embedded. Default: ``no``. -- ``maxwidth``: A maximum width to downscale images before embedding +- **maxwidth**: A maximum width to downscale images before embedding them (the original image file is not altered). The resize operation reduces image width to at most ``maxwidth`` pixels. The height is recomputed so that the aspect ratio is preserved. See also :ref:`image-resizing` for further diff --git a/docs/plugins/fetchart.rst b/docs/plugins/fetchart.rst index c0619955e..e1acde64f 100644 --- a/docs/plugins/fetchart.rst +++ b/docs/plugins/fetchart.rst @@ -29,19 +29,19 @@ Configuration To configure the plugin, make a ``fetchart:`` section in your configuration file. The available options are: -- ``auto``: Enable automatic album art fetching during import. +- **auto**: Enable automatic album art fetching during import. Default: ``yes``. -- ``cautious``: Pick only trusted album art by ignoring filenames that do not +- **cautious**: Pick only trusted album art by ignoring filenames that do not contain one of the keywords in ``cover_names``. Default: ``no``. -- ``cover_names``: Prioritize images containing words in this list. +- **cover_names**: Prioritize images containing words in this list. Default: ``['cover', 'front', 'art', 'album', 'folder']``. -- ``google_search``: Gather images from Google Image Search. +- **google_search**: Gather images from Google Image Search. Default: ``no``. -- ``maxwidth``: A maximum image width to downscale fetched images if they are +- **maxwidth**: A maximum image width to downscale fetched images if they are too big. The resize operation reduces image width to at most ``maxwidth`` pixels. The height is recomputed so that the aspect ratio is preserved. -- ``remote_priority``: Query remote sources every time and use local image only +- **remote_priority**: Query remote sources every time and use local image only as fallback. Default: ``no``; remote (Web) art sources are only queried if no local art is found in the filesystem. diff --git a/docs/plugins/freedesktop.rst b/docs/plugins/freedesktop.rst index 9c3d1a4be..3c91d2520 100644 --- a/docs/plugins/freedesktop.rst +++ b/docs/plugins/freedesktop.rst @@ -13,7 +13,7 @@ Configuration To configure the plugin, make a ``freedesktop:`` section in your configuration file. The only available option is: -- ``auto``: Create .directory files automatically during import. +- **auto**: Create .directory files automatically during import. Default: ``no``. Creating .directory Files Manually diff --git a/docs/plugins/ftintitle.rst b/docs/plugins/ftintitle.rst index 3a378b08c..e2258942d 100644 --- a/docs/plugins/ftintitle.rst +++ b/docs/plugins/ftintitle.rst @@ -19,9 +19,9 @@ Configuration To configure the plugin, make a ``ftintitle:`` section in your configuration file. The available options are: -- ``auto``: Enable metadata rewriting during import. +- **auto**: Enable metadata rewriting during import. Default: ``yes``. -- ``drop``: Remove featured artists entirely instead of adding them to the +- **drop**: Remove featured artists entirely instead of adding them to the title field. Default: ``no``. diff --git a/docs/plugins/fuzzy.rst b/docs/plugins/fuzzy.rst index b21801544..6b013b9f5 100644 --- a/docs/plugins/fuzzy.rst +++ b/docs/plugins/fuzzy.rst @@ -17,8 +17,8 @@ Configuration To configure the plugin, make a ``fuzzy:`` section in your configuration file. The available options are: -- ``threshold``: The "sensitivity" of the fuzzy match. A value of 1.0 will +- **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. +- **prefix**: The character used to designate fuzzy queries. Default: ``~``, which may need to be escaped in some shells. diff --git a/docs/plugins/ihate.rst b/docs/plugins/ihate.rst index d4ed62a1b..f2224bf5a 100644 --- a/docs/plugins/ihate.rst +++ b/docs/plugins/ihate.rst @@ -15,9 +15,9 @@ Configuration To configure the plugin, make an ``ihate:`` section in your configuration file. The available options are: -- ``skip``: Never import items and albums that match a query in this list. +- **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. +- **warn**: Print a warning message for matches in this list of queries. Default: ``[]``. Here's an example:: diff --git a/docs/plugins/importadded.rst b/docs/plugins/importadded.rst index bfad97afd..677879da8 100644 --- a/docs/plugins/importadded.rst +++ b/docs/plugins/importadded.rst @@ -42,7 +42,7 @@ Configuration To configure the plugin, make an ``importadded:`` section in your configuration file. There is one option available: -- ``preserve_mtimes``: After writing files, re-set their mtimes to their +- **preserve_mtimes**: After writing files, re-set their mtimes to their original value. Default: ``no``. diff --git a/docs/plugins/importfeeds.rst b/docs/plugins/importfeeds.rst index 9e2fcaf40..56dcce549 100644 --- a/docs/plugins/importfeeds.rst +++ b/docs/plugins/importfeeds.rst @@ -12,26 +12,26 @@ Configuration To configure the plugin, make an ``importfeeds:`` section in your configuration file. The available options are: -- ``absolute_path``: Use absolute paths instead of relative paths. Some +- **absolute_path**: Use absolute paths instead of relative paths. Some applications may need this to work properly. Default: ``no``. -- ``dir``: The output directory. +- **dir**: The output directory. Default: Your beets library directory. -- ``formats``: Select the kind of output. Use one or more of: +- **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 + - **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 + - **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 + - **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. +- **m3u_name**: Playlist name used by the ``m3u`` format. Default: ``imported.m3u``. -- ``relative_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. diff --git a/docs/plugins/keyfinder.rst b/docs/plugins/keyfinder.rst index 04a91ac19..b81291d17 100644 --- a/docs/plugins/keyfinder.rst +++ b/docs/plugins/keyfinder.rst @@ -16,16 +16,16 @@ Configuration 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 +- **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`` (i.e., search for the program in your ``$PATH``). -- ``auto``: Analyze every file on +- **auto**: Analyze every file on import. Otherwise, you need to use the ``beet keyfinder`` command explicitly. Default: ``yes``. -- ``overwrite``: Calculate a key even for files that already have an +- **overwrite**: Calculate a key even for files that already have an `initial_key` value. Default: ``no``. diff --git a/docs/plugins/lastgenre.rst b/docs/plugins/lastgenre.rst index f6723572b..9d3242467 100644 --- a/docs/plugins/lastgenre.rst +++ b/docs/plugins/lastgenre.rst @@ -83,29 +83,29 @@ Configuration To configure the plugin, make a ``lastgenre:`` section in your configuration file. The available options are: -- ``auto``: Fetch genres automatically during import. +- **auto**: Fetch genres automatically during import. Default: ``yes``. -- ``canonical``: Use a canonicalization tree. Setting this to ``yes`` will use +- **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. +- **count**: Number of genres to fetch. Default: 1 -- ``fallback``: A string if to use a fallback genre when no genre is found. +- **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 +- **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. +- **min_weight**: Minimum popularity factor below which genres are discarded. Default: 10. -- ``source``: Which entity to look up in Last.fm. Can be +- **source**: Which entity to look up in Last.fm. Can be either ``artist``, ``album`` or ``track``. Default: ``album``. -- ``separator``: A separator for multiple genres. +- **separator**: A separator for multiple genres. Default: ``', '``. -- ``whitelist``: The filename of a custom genre list, ``yes`` to use +- **whitelist**: The filename of a custom genre list, ``yes`` to use the internal whitelist, or ``no`` to consider all genres valid. Default: ``yes``. diff --git a/docs/plugins/lyrics.rst b/docs/plugins/lyrics.rst index 138f83655..643c5e61e 100644 --- a/docs/plugins/lyrics.rst +++ b/docs/plugins/lyrics.rst @@ -26,15 +26,15 @@ Configuration To configure the plugin, make a ``lyrics:`` section in your configuration file. The available options are: -- ``auto``: Fetch lyrics automatically during import. +- **auto**: Fetch lyrics automatically during import. Default: ``yes``. -- ``fallback``: By default, the file will be left unchanged when no lyrics are +- **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 +- **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. +- **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. diff --git a/docs/plugins/mbcollection.rst b/docs/plugins/mbcollection.rst index 3c176521f..df9a5ddc8 100644 --- a/docs/plugins/mbcollection.rst +++ b/docs/plugins/mbcollection.rst @@ -26,6 +26,6 @@ Configuration To configure the plugin, make a ``mbcollection:`` section in your configuration file. There is one option available: -- ``auto``: Automatically amend your MusicBrainz collection whenever you +- **auto**: Automatically amend your MusicBrainz collection whenever you import a new album. Default: ``no``. diff --git a/docs/plugins/missing.rst b/docs/plugins/missing.rst index 1719a82a6..ffca94052 100644 --- a/docs/plugins/missing.rst +++ b/docs/plugins/missing.rst @@ -29,15 +29,15 @@ Configuration To configure the plugin, make a ``missing:`` section in your configuration file. The available options are: -- ``count``: Print 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``: A specific format with which to print every +- **format**: A specific format with which to print every track. This uses the same template syntax as beets' :doc:`path formats `. The usage is inspired by, and therefore similar to, the :ref:`list ` command. Default: :ref:`list_format_item`. -- ``total``: Print a single count of missing tracks in all albums. +- **total**: Print a single count of missing tracks in all albums. Default: ``no``. Here's an example :: diff --git a/docs/plugins/mpdstats.rst b/docs/plugins/mpdstats.rst index bfd1ef53c..a483b13bc 100644 --- a/docs/plugins/mpdstats.rst +++ b/docs/plugins/mpdstats.rst @@ -38,19 +38,19 @@ Configuration To configure the plugin, make an ``mpd:`` section in your configuration file. The available options are: -- ``host``: The MPD server hostname. +- **host**: The MPD server hostname. Default: ``localhost``. -- ``port``: The MPD server port. +- **port**: The MPD server port. Default: 6600. -- ``password``: The MPD server password. +- **password**: The MPD server password. Default: None. -- ``music_directory``: If your MPD library is at a different location from the +- **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. Default: The beets library directory. -- ``rating``: Enable rating updates. +- **rating**: Enable rating updates. Default: ``yes``. -- ``rating_mix``: Tune the way rating is calculated (see below). +- **rating_mix**: Tune the way rating is calculated (see below). Default: 0.75. A Word on Ratings diff --git a/docs/plugins/mpdupdate.rst b/docs/plugins/mpdupdate.rst index b9eac0baa..e199a0145 100644 --- a/docs/plugins/mpdupdate.rst +++ b/docs/plugins/mpdupdate.rst @@ -30,9 +30,9 @@ Configuration The available options under the ``mpd:`` section are: -- ``host``: The MPD server name. +- **host**: The MPD server name. Default: ``localhost``. -- ``password``: The MPD server password. +- **password**: The MPD server password. Default: None. -- ``port``: The MPD server port. +- **port**: The MPD server port. Default: 6600. diff --git a/docs/plugins/play.rst b/docs/plugins/play.rst index 097b650f2..325656aaa 100644 --- a/docs/plugins/play.rst +++ b/docs/plugins/play.rst @@ -35,12 +35,12 @@ Configuration To configure the plugin, make a ``play:`` section in your configuration file. The available options are: -- ``command``: The command used to open the playlist. +- **command**: The command used to open the playlist. Default: ``open`` on OS X, ``xdg-open`` on other Unixes and ``start`` on Windows. -- ``relative_to``: Emit paths relative to base directory. +- **relative_to**: Emit paths relative to base directory. Default: None. -- ``use_folders``: When using the ``-a`` option, the m3u will contain the +- **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``. diff --git a/docs/plugins/replaygain.rst b/docs/plugins/replaygain.rst index 5b5420025..889fa3a89 100644 --- a/docs/plugins/replaygain.rst +++ b/docs/plugins/replaygain.rst @@ -68,27 +68,27 @@ Configuration To configure the plugin, make a ``replaygain:`` section in your configuration file. The available options are: -- ``auto``: Enable ReplayGain analysis during import. +- **auto**: Enable ReplayGain analysis during import. Default: ``yes``. -- ``backend``: The analysis backend; either ``gstreamer`` or ``command``. +- **backend**: The analysis backend; either ``gstreamer`` or ``command``. Default: ``command``. -- ``overwrite``: Re-analyze files that already have ReplayGain tags. +- **overwrite**: Re-analyze files that already have ReplayGain tags. Default: ``no``. -- ``targetlevel``: A number of decibels for the target loudness level. +- **targetlevel**: A number of decibels for the target loudness level. Default: 89. 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. Default: ``no``. -- ``command``: The path to the ``mp3gain`` or ``aacgain`` executable (if beets +- **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 +- **noclip**: Reduce the amount of ReplayGain adjustment to whatever amount would keep clipping from occurring. Default: ``yes``. diff --git a/docs/plugins/scrub.rst b/docs/plugins/scrub.rst index 0e7cbf4bd..cb8bb81d2 100644 --- a/docs/plugins/scrub.rst +++ b/docs/plugins/scrub.rst @@ -37,5 +37,5 @@ Configuration To configure the plugin, make a ``scrub:`` section in your configuration file. There is one option: -- ``auto``: Enable metadata stripping during import. +- **auto**: Enable metadata stripping during import. Default: ``yes``. diff --git a/docs/plugins/smartplaylist.rst b/docs/plugins/smartplaylist.rst index fefc1be30..270e34def 100644 --- a/docs/plugins/smartplaylist.rst +++ b/docs/plugins/smartplaylist.rst @@ -73,11 +73,11 @@ 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``: Regenerate the playlist after every database change. +- **auto**: Regenerate the playlist after every database change. Default: ``yes``. -- ``playlist_dir``: Where to put the generated playlist files. +- **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 +- **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. diff --git a/docs/plugins/spotify.rst b/docs/plugins/spotify.rst index 8b5bb1864..7e718f1f7 100644 --- a/docs/plugins/spotify.rst +++ b/docs/plugins/spotify.rst @@ -44,9 +44,9 @@ 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 + - **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 + - **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. diff --git a/docs/plugins/the.rst b/docs/plugins/the.rst index 9f1ce95c0..5de0f5e54 100644 --- a/docs/plugins/the.rst +++ b/docs/plugins/the.rst @@ -26,18 +26,18 @@ Configuration To configure the plugin, make a ``the:`` section in your configuration file. The available options are: -- ``a``: Handle "A/An" moves. +- **a**: Handle "A/An" moves. Default: ``yes``. -- ``the``: handle "The" moves. +- **the**: handle "The" moves. Default: ``yes``. -- ``patterns``: Custom regexp patterns, space-separated. Custom patterns are +- **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: ``[]``. -- ``strip``: Remove the article altogether instead of moving it to the end. +- **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 +- **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}'``. diff --git a/docs/plugins/web.rst b/docs/plugins/web.rst index e1be24a9b..63c679e2b 100644 --- a/docs/plugins/web.rst +++ b/docs/plugins/web.rst @@ -52,9 +52,9 @@ Configuration To configure the plugin, make a ``web:`` section in your configuration file. The available options are: -- ``host``: The server hostname. +- **host**: The server hostname. Default: Bind to all interfaces. -- ``port``: The server port. +- **port**: The server port. Default: 8337. Implementation