Make the list of lyrics fetchers customizable
[ncmpcpp.git] / doc / config
blobc41d4729fe4fcb960e0bc0685c7b08d6110f2e3d
1 ##############################################################
2 ## This is the example configuration file. Copy it to       ##
3 ## $HOME/.ncmpcpp/config or $XDG_CONFIG_HOME/ncmpcpp/config ##
4 ## and set up your preferences.                             ##
5 ##############################################################
7 ##### directories ######
8 ##
9 ## Directory for storing ncmpcpp related files.
10 ## Changing it is useful if you want to store
11 ## everything somewhere else and provide command
12 ## line setting for alternative location to config
13 ## file which defines that while launching ncmpcpp.
16 #ncmpcpp_directory = ~/.ncmpcpp
19 ## Directory for storing downloaded lyrics. It
20 ## defaults to ~/.lyrics since other MPD clients
21 ## (eg. ncmpc) also use that location.
24 #lyrics_directory = ~/.lyrics
26 ##### connection settings #####
28 #mpd_host = localhost
30 #mpd_port = 6600
32 #mpd_connection_timeout = 5
34 ## Needed for tag editor and file operations to work.
36 #mpd_music_dir = ~/music
38 #mpd_crossfade_time = 5
40 ##### music visualizer #####
42 ## Note: In order to make music visualizer work you'll
43 ## need to use mpd fifo output, whose format parameter
44 ## has to be set to 44100:16:1 for mono visualization
45 ## or 44100:16:2 for stereo visualization. Example
46 ## configuration (it has to be put into mpd.conf):
48 ## audio_output {
49 ##        type            "fifo"
50 ##        name            "Visualizer feed"
51 ##        path            "/tmp/mpd.fifo"
52 ##        format          "44100:16:2"
53 ## }
56 #visualizer_fifo_path = /tmp/mpd.fifo
59 ## Note: Below parameter is needed for ncmpcpp
60 ## to determine which output provides data for
61 ## visualizer and thus allow syncing between
62 ## visualization and sound as currently there
63 ## are some problems with it.
66 #visualizer_output_name = Visualizer feed
69 ## If you set format to 44100:16:2, make it 'yes'.
71 #visualizer_in_stereo = yes
74 ## Multiply received samples by given value. Very
75 ## useful for proper visualization of quiet music.
77 #visualizer_sample_multiplier = 1
80 ## Note: Below parameter defines how often ncmpcpp
81 ## has to "synchronize" visualizer and audio outputs.
82 ## 30 seconds is optimal value, but if you experience
83 ## synchronization problems, set it to lower value.
84 ## Keep in mind that sane values start with >=10.
87 #visualizer_sync_interval = 30
90 ## Note: To enable spectrum frequency visualization
91 ## you need to compile ncmpcpp with fftw3 support.
94 ## Available values: spectrum, wave, wave_filled, ellipse.
96 #visualizer_type = wave
98 #visualizer_look = ●▮
100 #visualizer_color = blue, cyan, green, yellow, magenta, red
102 ## Alternative subset of 256 colors for terminals that support it.
104 #visualizer_color = 41, 83, 119, 155, 185, 215, 209, 203, 197, 161
106 ##### system encoding #####
108 ## ncmpcpp should detect your charset encoding
109 ## but if it failed to do so, you can specify
110 ## charset encoding you are using here.
112 ## Note: You can see whether your ncmpcpp build
113 ## supports charset detection by checking output
114 ## of `ncmpcpp --version`.
116 ## Note: Since MPD uses UTF-8 by default, setting
117 ## this option makes sense only if your encoding
118 ## is different.
121 #system_encoding = ""
123 ##### delays #####
125 ## Time of inactivity (in seconds) after playlist
126 ## highlighting will be disabled (0 = always on).
128 #playlist_disable_highlight_delay = 5
130 ## Defines how long messages are supposed to be visible.
132 #message_delay_time = 5
134 ##### song format #####
136 ## For a song format you can use:
138 ## %l - length
139 ## %f - filename
140 ## %D - directory
141 ## %a - artist
142 ## %A - album artist
143 ## %t - title
144 ## %b - album
145 ## %y - date
146 ## %n - track number (01/12 -> 01)
147 ## %N - full track info (01/12 -> 01/12)
148 ## %g - genre
149 ## %c - composer
150 ## %p - performer
151 ## %d - disc
152 ## %C - comment
153 ## %P - priority
154 ## $R - begin right alignment
156 ## If you want to make sure that a part of the format is displayed
157 ## only when certain tags are present, you can archieve it by
158 ## grouping them with brackets, e.g. '{%a - %t}' will be evaluated
159 ## to 'ARTIST - TITLE' if both tags are present or '' otherwise.
160 ## It is also possible to define a list of alternatives by providing
161 ## several groups and separating them with '|', e.g. '{%t}|{%f}'
162 ## will be evaluated to 'TITLE' or 'FILENAME' if the former is not
163 ## present.
165 ## Note: If you want to set limit on maximal length of a tag, just
166 ## put the appropriate number between % and character that defines
167 ## tag type, e.g. to make album take max. 20 terminal cells, use '%20b'.
169 ## In addition, formats support markers used for text attributes.
170 ## They are followed by character '$'. After that you can put:
172 ## - 0 - default window color (discards all other colors)
173 ## - 1 - black
174 ## - 2 - red
175 ## - 3 - green
176 ## - 4 - yellow
177 ## - 5 - blue
178 ## - 6 - magenta
179 ## - 7 - cyan
180 ## - 8 - white
181 ## - 9 - end of current color
182 ## - b - bold text
183 ## - u - underline text
184 ## - r - reverse colors
185 ## - a - use alternative character set
187 ## If you don't want to use a non-color attribute anymore, just put it
188 ## again, but this time insert character '/' between '$' and attribute
189 ## character, e.g. {$b%t$/b}|{$r%f$/r} will display bolded title tag
190 ## or filename with reversed colors.
192 ## If you want to use 256 colors and/or background colors in formats
193 ## (the naming scheme is described below in section about color
194 ## definitions), it can be done with the syntax $(COLOR), e.g. to set
195 ## the artist tag to one of the non-standard colors and make it have
196 ## yellow background, you need to write $(197_yellow)%a$(end). Note
197 ## that for standard colors this is interchangable with attributes
198 ## listed above.
200 ## Note: colors can be nested.
203 #song_list_format = {%a - }{%t}|{$8%f$9}$R{$3(%l)$9}
205 #song_status_format = {{%a{ "%b"{ (%y)}} - }{%t}}|{%f}
207 #song_library_format = {%n - }{%t}|{%f}
210 #alternative_header_first_line_format = $b$1$aqqu$/a$9 {%t}|{%f} $1$atqq$/a$9$/b
212 #alternative_header_second_line_format = {{$4$b%a$/b$9}{ - $7%b$9}{ ($4%y$9)}}|{%D}
214 #now_playing_prefix = $b
216 #now_playing_suffix = $/b
218 #browser_playlist_prefix = "$2playlist$9 "
220 #selected_item_prefix = $6
222 #selected_item_suffix = $9
224 #modified_item_prefix = $3> $9
227 ## Note: attributes are not supported for the following variables.
229 #song_window_title_format = {%a - }{%t}|{%f}
231 ## Note: Below variables are used for sorting songs in browser.
232 ## The sort mode determines how songs are sorted, and can be used
233 ## in combination with a sort format to specify a custom sorting format.
234 ## Available values for browser_sort_mode are "name", "mtime", "format"
235 ## and "noop".
238 #browser_sort_mode = name
240 #browser_sort_format = {%a - }{%t}|{%f} {(%l)}
242 ##### columns settings #####
244 ## syntax of song columns list format is "column column etc."
246 ## - syntax for each column is:
248 ## (width of the column)[color of the column]{displayed tag}
250 ## Note: Width is by default in %, if you want a column to
251 ## have fixed size, add 'f' after the value, e.g. (10)[white]{a}
252 ## will be the column that take 10% of screen (so the real width
253 ## will depend on actual screen size), whereas (10f)[white]{a}
254 ## will take 10 terminal cells, no matter how wide the screen is.
256 ## - color is optional (if you want the default one,
257 ##   leave the field empty).
259 ## Note: You can give a column additional attributes by putting appropriate
260 ## character after displayed tag character. Available attributes are:
262 ## - r - column will be right aligned
263 ## - E - if tag is empty, empty tag marker won't be displayed
265 ## You can also:
267 ## - give a column custom name by putting it after attributes,
268 ##   separated with character ':', e.g. {lr:Length} gives you
269 ##   right aligned column of lengths named "Length".
271 ## - define sequence of tags, that have to be displayed in case
272 ##   predecessor is empty in a way similar to the one in classic
273 ##   song format, i.e. using '|' character, e.g. {a|c|p:Owner}
274 ##   creates column named "Owner" that tries to display artist
275 ##   tag and then composer and performer if previous ones are
276 ##   not available.
279 #song_columns_list_format = (20)[]{a} (6f)[green]{NE} (50)[white]{t|f:Title} (20)[cyan]{b} (7f)[magenta]{l}
281 ##### various settings #####
284 ## Note: Custom command that will be executed each
285 ## time song changes. Useful for notifications etc.
287 #execute_on_song_change = ""
290 ## Note: Custom command that will be executed each
291 ## time player state changes. The environment variable
292 ## MPD_PLAYER_STATE is set to the current state (either
293 ## unknown, play, pause, or stop) for its duration.
296 #execute_on_player_state_change = ""
298 #playlist_show_mpd_host = no
300 #playlist_show_remaining_time = no
302 #playlist_shorten_total_times = no
304 #playlist_separate_albums = no
307 ## Note: Possible display modes: classic, columns.
309 #playlist_display_mode = columns
311 #browser_display_mode = classic
313 #search_engine_display_mode = classic
315 #playlist_editor_display_mode = classic
317 #discard_colors_if_item_is_selected = yes
319 #show_duplicate_tags = true
321 #incremental_seeking = yes
323 #seek_time = 1
325 #volume_change_step = 2
327 #autocenter_mode = no
329 #centered_cursor = no
332 ## Note: You can specify third character which will
333 ## be used to build 'empty' part of progressbar.
335 #progressbar_look = =>
337 #progressbar_boldness = yes
339 ## Available values: database, playlist.
341 #default_place_to_search_in = database
343 ## Available values: classic, alternative.
345 #user_interface = classic
347 #data_fetching_delay = yes
349 ## Available values: artist, album_artist, date, genre, composer, performer.
351 #media_library_primary_tag = artist
353 ## Available values: wrapped, normal.
355 #default_find_mode = wrapped
357 #default_tag_editor_pattern = %n - %t
359 #header_visibility = yes
361 #statusbar_visibility = yes
363 #titles_visibility = yes
365 #header_text_scrolling = yes
367 #cyclic_scrolling = no
369 #lines_scrolled = 2
371 #lyrics_fetchers = lyricwiki, azlyrics, genius, sing365, lyricsmania, metrolyrics, justsomelyrics, tekstowo, internet
373 #follow_now_playing_lyrics = no
375 #fetch_lyrics_for_current_song_in_background = no
377 #store_lyrics_in_song_dir = no
379 #generate_win32_compatible_filenames = yes
381 #allow_for_physical_item_deletion = no
384 ## Note: If you set this variable, ncmpcpp will try to
385 ## get info from last.fm in language you set and if it
386 ## fails, it will fall back to english. Otherwise it will
387 ## use english the first time.
389 ## Note: Language has to be expressed as an ISO 639 alpha-2 code.
391 #lastfm_preferred_language = en
393 #show_hidden_files_in_local_browser = no
396 ## How shall screen switcher work?
398 ## - "previous" - switch between the current and previous screen.
399 ## - "screen1,...,screenN" - switch between given sequence of screens.
401 ## Screens available for use: help, playlist, browser, search_engine,
402 ## media_library, playlist_editor, tag_editor, outputs, visualizer, clock.
404 #screen_switcher_mode = playlist, browser
407 ## Note: You can define startup screen
408 ## by choosing screen from the list above.
410 #startup_screen = playlist
413 ## Note: You can define startup slave screen
414 ## by choosing screen from the list above or
415 ## an empty value for no slave screen.
417 #startup_slave_screen = ""
419 #startup_slave_screen_focus = no
422 ## Default width of locked screen (in %).
423 ## Acceptable values are from 20 to 80.
426 #locked_screen_width_part = 50
428 #ask_for_locked_screen_width_part = yes
430 #jump_to_now_playing_song_at_start = yes
432 #ask_before_clearing_playlists = yes
434 #clock_display_seconds = no
436 #display_volume_level = yes
438 #display_bitrate = no
440 #display_remaining_time = no
442 ## Available values: none, basic, extended, perl.
444 #regular_expressions = perl
447 ## Note: If below is enabled, ncmpcpp will ignore leading
448 ## "The" word while sorting items in browser, tags in
449 ## media library, etc.
451 #ignore_leading_the = no
453 #block_search_constraints_change_if_items_found = yes
455 #mouse_support = yes
457 #mouse_list_scroll_whole_page = yes
459 #empty_tag_marker = <empty>
461 #tags_separator = " | "
463 #tag_editor_extended_numeration = no
465 #media_library_sort_by_mtime = no
467 #enable_window_title = yes
470 ## Note: You can choose default search mode for search
471 ## engine. Available modes are:
473 ## - 1 - use mpd built-in searching (no regexes, pattern matching)
474 ## - 2 - use ncmpcpp searching (pattern matching with support for regexes,
475 ##       but if your mpd is on a remote machine, downloading big database
476 ##       to process it can take a while
477 ## - 3 - match only exact values (this mode uses mpd function for searching
478 ##       in database and local one for searching in current playlist)
481 #search_engine_default_search_mode = 1
483 #external_editor = nano
485 ## Note: set to yes if external editor is a console application.
487 #use_console_editor = yes
489 ##### colors definitions #####
491 ## It is possible to set a background color by setting a color
492 ## value "<foreground>_<background>", e.g. red_black will set
493 ## foregound color to red and background color to black.
495 ## In addition, for terminals that support 256 colors it
496 ## is possible to set one of them by using a number in range
497 ## [1, 256] instead of color name, e.g. numerical value
498 ## corresponding to red_black is 2_1. To find out if the
499 ## terminal supports 256 colors, run ncmpcpp and check out
500 ## the bottom of the help screen for list of available colors
501 ## and their numerical values.
503 ## Note: due to technical limitations of ncurses, if 256 colors
504 ## are used, it is possible to either use only the colors with
505 ## default background color, or all pairs from 1_1 up to 254_127,
506 ## depending on the ncurses version used.
509 #colors_enabled = yes
511 #empty_tag_color = cyan
513 #header_window_color = default
515 #volume_color = default
517 #state_line_color = default
519 #state_flags_color = default
521 #main_window_color = yellow
523 #color1 = white
525 #color2 = green
527 #main_window_highlight_color = yellow
529 #progressbar_color = black
531 #progressbar_elapsed_color = green
533 #statusbar_color = default
535 #alternative_ui_separator_color = black
537 #active_column_color = red
539 #window_border_color = green
541 #active_window_border = red