Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2025-12-06 08:39:17 +01:00
Code Issues Projects Releases Wiki Activity

Update ui configuration docs

Browse source
This commit is contained in:
Šarūnas Nejus 2025-08-20 13:09:13 +01:00
parent f816f894d3
commit 841c49d494
No known key found for this signature in database
GPG key ID: DD28F6704DBE3435
1 changed files with 24 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
docs/reference/config.rst
View file

@ -429,20 +429,11 @@ UI Options
The options that allow for customization of the visual appearance of the console
interface.
These options are available in this section:
color
~~~~~
Either ``yes`` or ``no``; whether to use color in console output (currently only
in the ``import`` command). Turn this off if your terminal doesn't support ANSI
colors.
.. note::
The ``color`` option was previously a top-level configuration. This is still
respected, but a deprecation message will be shown until your top-level
``color`` configuration has been nested under ``ui``.
Either ``yes`` or ``no``; whether to use color in console output. Turn this off
if your terminal doesn't support ANSI colors.
.. _colors:
@ -450,10 +441,9 @@ colors
~~~~~~
The colors that are used throughout the user interface. These are only used if
the ``color`` option is set to ``yes``. For example, you might have a section in
your configuration file that looks like this:
the ``color`` option is set to ``yes``. See the default configuration:
::
.. code-block:: yaml
ui:
colors:
@ -473,13 +463,18 @@ your configuration file that looks like this:
text_diff_removed: ['bold', 'red']
action_description: ['white']
Available colors: black, darkred, darkgreen, brown (darkyellow), darkblue,
purple (darkmagenta), teal (darkcyan), lightgray, darkgray, red, green, yellow,
blue, fuchsia (magenta), turquoise (cyan), white
Available attributes:
Legacy UI colors config directive used strings. If any colors value is still a
string instead of a list, it will be translated to list automatically. For
example ``blue`` will become ``['blue']``.
Foreground colors
``black``, ``red``, ``green``, ``yellow``, ``blue``, ``magenta``, ``cyan``,
``white``
Background colors
``bg_black``, ``bg_red``, ``bg_green``, ``bg_yellow``, ``bg_blue``,
``bg_magenta``, ``bg_cyan``, ``bg_white``
Text styles
``normal``, ``bold``, ``faint``, ``underline``, ``reverse``
terminal_width
~~~~~~~~~~~~~~
@ -488,7 +483,7 @@ Controls line wrapping on non-Unix systems. On Unix systems, the width of the
terminal is detected automatically. If this fails, or on non-Unix systems, the
specified value is used as a fallback. Defaults to ``80`` characters:
::
.. code-block:: yaml
ui:
terminal_width: 80
@ -504,7 +499,7 @@ different track lengths are colored with ``text_highlight_minor``.
matching or distance score calculation (see :ref:`match-config`,
``distance_weights`` and :ref:`colors`):
::
.. code-block:: yaml
ui:
length_diff_thresh: 10.0
@ -516,18 +511,18 @@ When importing, beets will read several options to configure the visuals of the
import dialogue. There are two layouts controlling how horizontal space and line
wrapping is dealt with: ``column`` and ``newline``. The indentation of the
respective elements of the import UI can also be configured. For example setting
``4`` for ``match_header`` will indent the very first block of a proposed match
by five characters in the terminal:
``2`` for ``match_header`` will indent the very first block of a proposed match
by two characters in the terminal:
::
.. code-block:: yaml
ui:
import:
indentation:
match_header: 4
match_details: 4
match_tracklist: 7
layout: newline
match_header: 2
match_details: 2
match_tracklist: 5
layout: column
Importer Options
----------------