mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 16:42:42 +01:00
always a colon between the option name and the rest of the description
plus typos and case change
This commit is contained in:
parent
ff39174d92
commit
ca1d6a9899
9 changed files with 42 additions and 43 deletions
|
|
@ -76,8 +76,9 @@ Available options are pretty self-explanatory:
|
|||
Default: ``u''``
|
||||
- ``port``
|
||||
Default: ``6600``
|
||||
- ``password``: ``u'``
|
||||
- ``volume`` sets the initial volume in percent
|
||||
- ``password``
|
||||
Default: ``u''``
|
||||
- ``volume``: initial volume in percent
|
||||
Default: ``100``
|
||||
|
||||
Here's an example::
|
||||
|
|
|
|||
|
|
@ -40,14 +40,15 @@ Configuration
|
|||
|
||||
Available options:
|
||||
|
||||
- ``bucket_alpha`` defines ranges to use for all substitutions occuring on
|
||||
textual fields.
|
||||
- ``bucket_alpha``: ranges to use for all substitutions occuring on textual
|
||||
fields.
|
||||
Default: ``[]``
|
||||
- ``bucket_alpha_regex`` allows to define a regex to override a `bucket_alpha`
|
||||
range definition
|
||||
- ``bucket_alpha_regex``: list of ``key: value`` (one per line) with 'key'
|
||||
being one of the `bucket_alpha` range and 'value' a regex that override
|
||||
original range definition.
|
||||
Default: ``{}``
|
||||
- ``bucket_year`` defines ranges to use for all substitutions occuring on the
|
||||
`$year` field
|
||||
- ``bucket_year``: ranges to use for all substitutions occuring on the
|
||||
`$year` field.
|
||||
Default: ``[]``
|
||||
- ``extrapolate`` : activate it when you want to group your files into multiple
|
||||
year ranges without enumerating them all. This option will generate year
|
||||
|
|
|
|||
|
|
@ -52,33 +52,30 @@ Configuration
|
|||
|
||||
Available options:
|
||||
|
||||
- ``auto`` gives you the option to import transcoded versions of your files
|
||||
- ``auto``: set it to ``yes`` to import transcoded versions of your files
|
||||
automatically during the ``import`` command. With this option enabled, the
|
||||
importer will transcode all non-MP3 files over the maximum bitrate before
|
||||
adding them to your library.
|
||||
Default: ``no``.
|
||||
- ``dest`` sets the directory the files will be converted (or copied) to.
|
||||
A destination is required---you either have to provide it in the config file
|
||||
or on the command-line using the ``-d`` flag.
|
||||
- ``dest``: the directory where the files will be converted (or copied) to.
|
||||
Default: ``None``
|
||||
- ``embed`` indicates whether or not to 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.
|
||||
- ``never_convert_lossy_files`` means that lossy codecs, such as mp3, ogg
|
||||
vorbis, etc, are never converted, as converting lossy files to other lossy
|
||||
codecs will decrease quality further. If set to ``yes``, lossy files are
|
||||
always copied.
|
||||
- ``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`` lets you specify the directory structure and naming scheme for the
|
||||
- ``paths``: lets you specify the directory structure and naming scheme for the
|
||||
converted files. Use the same format as the top-level ``paths`` section (see
|
||||
:ref:`path-format-config`).
|
||||
By default, the plugin reuses your top-level path format settings.
|
||||
- ``quiet`` mode prevents the plugin from announcing every file it processes.
|
||||
- ``quiet``: prevents the plugin from announcing every file it processes.
|
||||
Default: ``false``.
|
||||
- ``threads`` determines the number of threads to use for parallel
|
||||
encoding.
|
||||
- ``threads``: number of threads to use for parallel encoding.
|
||||
By default, the plugin will detect the number of processors available and use
|
||||
them all.
|
||||
|
||||
|
|
|
|||
|
|
@ -38,43 +38,43 @@ Configuration
|
|||
|
||||
Available options (mirroring the CLI ones):
|
||||
|
||||
- ``album`` lists duplicate albums instead of tracks.
|
||||
- ``album``: lists duplicate albums instead of tracks.
|
||||
Default: ``no``.
|
||||
- ``checksum`` enables the use of any arbitrary command to compute a checksum
|
||||
- ``checksum``: enables the use of any arbitrary command to compute a checksum
|
||||
of items. It 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`` takes a destination base directory into which it will copy matched
|
||||
- ``copy``: takes a destination base directory into which it will copy matched
|
||||
items.
|
||||
Default: ``no``.
|
||||
- `count` prints a count of duplicate tracks or albums, with ``format``
|
||||
- ``count``: prints a count of duplicate tracks or albums, with ``format``
|
||||
hard-coded to ``$albumartist - $album - $title: $count`` or ``$albumartist -
|
||||
$album: $count`` (for the ``-a`` option).
|
||||
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` lets you specify a specific format with which to print every track
|
||||
- ``format``: lets you specify a specific format with which to print every track
|
||||
or album. 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`
|
||||
- ``full`` lists every track or album that has duplicates, not just the
|
||||
- ``full``:lists every track or album that has duplicates, not just the
|
||||
duplicates themselves.
|
||||
Default: ``no``.
|
||||
- ``keys`` defines in which track or album fields duplicates are to be
|
||||
- ``keys``: defines 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`` takes a destination base directory into which it will move matched
|
||||
- ``move``: takes a destination base directory into which it will move matched
|
||||
items.
|
||||
Default: ``no``.
|
||||
- `path` is a convenience wrapper for ``-f \$path``.
|
||||
- ``path``: convenience wrapper for ``-f \$path``.
|
||||
Default: ``no``.
|
||||
- ``tag`` takes a ``key=value`` string, and adds a new ``key`` attribute with
|
||||
- ``tag``: takes a ``key=value`` string, and adds a new ``key`` attribute with
|
||||
``value`` value as a flexattr to the database.
|
||||
Default: ``no``.
|
||||
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ Configuration
|
|||
|
||||
Available options:
|
||||
|
||||
- ``auto`` option lets you disable automatic album art embedding when set to
|
||||
- ``auto``: lets you disable automatic album art embedding when set to
|
||||
``no``.
|
||||
Default: ``true``
|
||||
- ``compare_threshold``: how similar must candidate art be regarding to
|
||||
|
|
@ -50,7 +50,7 @@ Available options:
|
|||
- ``ifempty``: set to 'yes' to avoid embedding album art for files that already
|
||||
have one.
|
||||
Default: ``no``.
|
||||
- ``maxwidth`` defines a maximum width to downscale images before embedding
|
||||
- ``maxwidth``: defines a maximum width to downscale images before embedding
|
||||
them (the original image file is not altered). The resize operation reduces
|
||||
image width to ``maxwidth`` pixels. The height is recomputed so that the
|
||||
aspect ratio is preserved. See also :ref:`image-resizing` for further caveats
|
||||
|
|
|
|||
|
|
@ -41,7 +41,8 @@ Configuration
|
|||
|
||||
Available option:
|
||||
|
||||
- ``preserve_mtimes``: Default: ``no``
|
||||
- ``preserve_mtimes``
|
||||
Default: ``no``
|
||||
|
||||
Reimport
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -15,15 +15,15 @@ Configuration
|
|||
|
||||
Available options:
|
||||
|
||||
- ``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``.
|
||||
- ``auto``: If set to `yes`, the plugin will analyze every file on
|
||||
- ``auto``: if set to `yes`, the plugin will 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
|
||||
- ``overwrite``: if set to ``no``, the import hook and the command will skip
|
||||
any file that already has an 'initial_key' in the database.
|
||||
Default: ``no``.
|
||||
|
||||
|
|
|
|||
|
|
@ -23,9 +23,8 @@ profile first.
|
|||
Configuration
|
||||
-------------
|
||||
|
||||
Available option:
|
||||
|
||||
Automatically Update on Import
|
||||
------------------------------
|
||||
|
||||
mbcollection: if set to ``yes``, the plugin will automatically amend your
|
||||
MusicBrainz collection whenever you import a new album. Default: ``false``
|
||||
- ``auto``: if set to ``yes``, the plugin will automatically amend your
|
||||
MusicBrainz collection whenever you import a new album.
|
||||
Default: ``false``
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@ The default options should work as-is, but there are some options you can put in
|
|||
* ``region_filter``: use the 2-character country abbreviation to limit results
|
||||
to that market.
|
||||
Default: ``None``
|
||||
* ``show_failures``: qhow the artist/album/track for each lookup that does not
|
||||
* ``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
|
||||
|
|
|
|||
Loading…
Reference in a new issue