if there is no selected items, treat the current one as selected
[ncmpcpp.git] / doc / config
blob4f7d671b8e98a47df28d1a7826b3ebadd5376265
1 ####################################################
2 ## this is example configuration file, copy it to ##
3 ## ~/.ncmpcpp/config and set up your preferences  ##
4 ####################################################
6 ##### connection settings #####
8 ## set it in order to make tag editor and renaming files work properly
10 #mpd_host = "localhost"
12 #mpd_port = "6600"
14 #mpd_music_dir = ""
16 #mpd_connection_timeout = "5"
18 #mpd_crossfade_time = "5"
20 ##### music visualizer #####
22 ## Note: In order to make music visualizer work you'll
23 ## need to use mpd fifo output, whose format parameter
24 ## has to be set to 44100:16:1. Example configuration:
25 ## (it has to be put into mpd.conf)
27 ## audio_output {
28 ##        type            "fifo"
29 ##        name            "My FIFO"
30 ##        path            "/tmp/mpd.fifo"
31 ##        format          "44100:16:1"
32 ## }
35 #visualizer_fifo_path = ""
38 ## Note: Below parameter is needed for ncmpcpp
39 ## to determine which output provides data for
40 ## visualizer and thus allow syncing between
41 ## visualization and sound as currently there
42 ## are some problems with it.
45 #visualizer_output_name = ""
48 ## Note: To enable spectrum frequency visualization
49 ## you need to compile ncmpcpp with fftw3 support.
52 #visualizer_type = "wave" (spectrum/wave)
54 ##### system encoding #####
56 ## ncmpcpp should detect your charset encoding
57 ## but if it failed to do so, you can specify
58 ## charset encoding you are using here.
60 ## Note: You can see whether your ncmpcpp build
61 ## supports charset detection by checking output
62 ## of `ncmpcpp --version`.
64 ## Note: Since MPD uses utf8 by default, setting
65 ## this option makes sense only if your encoding
66 ## is different.
69 #system_encoding = ""
71 ##### delays #####
73 ## delay after playlist highlighting will be disabled (0 = don't disable)
75 #playlist_disable_highlight_delay = "5"
77 ## defines how long various messages are supposed to be visible
79 #message_delay_time = "4"
81 ##### song format #####
83 ## for song format you can use:
85 ## %l - length
86 ## %f - filename
87 ## %D - directory
88 ## %a - artist
89 ## %t - title
90 ## %b - album
91 ## %y - year
92 ## %n - track number (01/12 -> 01)
93 ## %N - full track info (01/12 -> 01/12)
94 ## %g - genre
95 ## %c - composer
96 ## %p - performer
97 ## %d - disc
98 ## %C - comment
99 ## $R - begin right alignment
101 ## you can also put them in { } and then it will be displayed
102 ## only if all requested values are available and/or define alternate
103 ## value with { }|{ } eg. {%a - %t}|{%f}
105 ## Note: Format that is similar to "%a - %t" (i.e. without any additional
106 ## braces) is equal to "{%a - %t}", so if one of the tags is missing,
107 ## you'll get nothing.
109 ## text can also have different color than the main window has,
110 ## eg. if you want length to be green, write $3%l$9
112 ## available values:
114 ## - 0 - default window color (discards all other colors)
115 ## - 1 - black
116 ## - 2 - red
117 ## - 3 - green
118 ## - 4 - yellow
119 ## - 5 - blue
120 ## - 6 - magenta
121 ## - 7 - cyan
122 ## - 8 - white
123 ## - 9 - end of current color
125 ## Note: colors can be nested.
128 #song_list_format = "{%a - }{%t}|{$8%f$9}$R{$3(%l)$9}"
130 #song_status_format = "{{%a{ \"%b\"{ (%y)}} - }{%t}}|{%f}"
132 #song_library_format = "{%n - }{%t}|{%f}"
134 #tag_editor_album_format = "{(%y) }%b"
137 ## Note: Below variables are for alternative version of user's interface.
138 ## Their syntax supports all tags and colors listed above plus some extra
139 ## markers used for text attributes. They are followed by character '$'.
140 ## After that you can put:
142 ## - b - bold text
143 ## - u - underline text
144 ## - r - reverse colors
145 ## - a - use alternative character set
147 ## If you don't want to use an attribute anymore, just put it again, but
148 ## this time insert character '/' between '$' and attribute character,
149 ## e.g. {$b%t$/b}|{$r%f$/r} will display bolded title tag or filename
150 ## with reversed colors.
153 #alternative_header_first_line_format = "$b$1$aqqu$/a$9 {%t}|{%f} $1$atqq$/a$9$/b"
155 #alternative_header_second_line_format = "{{$4$b%a$/b$9}{ - $7%b$9}{ ($4%y$9)}}|{%D}"
158 ## Note: Below variables also supports
159 ## text attributes listed above.
162 #now_playing_prefix = "$b"
164 #now_playing_suffix = "$/b"
166 #browser_playlist_prefix = "$2playlist$9 "
168 #selected_item_prefix = "$6"
170 #selected_item_suffix = "$9"
172 ## colors are not supported for below variable
174 #song_window_title_format = "{%a - }{%t}|{%f}"
176 ##### columns settings #####
178 ## syntax of song columns list format is "column column etc."
180 ## - syntax for each column is:
182 ## (width of column)[column's color]{displayed tag}
184 ## Note: Width is by default in %, if you want a column to
185 ## have fixed size, add 'f' after the value, e.g. (10)[white]{a}
186 ## will be the column that take 10% of screen (so the real column's
187 ## width will depend on actual screen size), whereas (10f)[white]{a}
188 ## will take 10 terminal cells, no matter how wide the screen is.
190 ## - color is optional (if you want the default one, type [])
192 ## Note: You can give a column additional attributes by putting appropriate
193 ## character after displayed tag character. Available attributes are:
195 ## - r - column will be right aligned
196 ## - E - if tag is empty, empty tag marker won't be displayed
198 ## E.g. {lr} will give you right aligned column of lengths.
201 #song_columns_list_format = "(7f)[green]{l} (25)[cyan]{a} (40)[]{t} (30)[red]{b}"
203 ##### various settings #####
206 ## Note: Custom command that will be executed each
207 ## time song changes. Useful for notifications etc.
209 ## Attention: It doesn't support song format anymore.
210 ## Use `ncmpcpp --now-playing SONG_FORMAT` instead.
212 #execute_on_song_change = ""
214 #playlist_show_remaining_time = "no"
216 #playlist_display_mode = "classic" (classic/columns)
218 #browser_display_mode = "classic" (classic/columns)
220 #search_engine_display_mode = "classic" (classic/columns)
222 #incremental_seeking = "yes"
224 #seek_time = "1"
226 #autocenter_mode = "no"
228 #centered_cursor = "no"
230 #progressbar_look = "=>"
232 #default_place_to_search_in = "database" (database/playlist)
234 #user_interface = "classic" (classic/alternative)
236 #media_library_left_column = "a" (possible values: a,y,g,c,p, legend above)
238 #default_find_mode = "wrapped" (wrapped/normal)
240 #default_space_mode = "add" (add/select)
242 #default_tag_editor_left_col = "albums" (albums/dirs)
244 #default_tag_editor_pattern = "%n - %t"
246 #header_visibility = "yes"
248 #statusbar_visibility = "yes"
250 #header_text_scrolling = "yes"
252 #fancy_scrolling = "yes"
254 #cyclic_scrolling = "no"
256 #lines_scrolled = "2"
258 #follow_now_playing_lyrics = "no"
260 #ncmpc_like_songs_adding = "no" (enabled - add/remove, disabled - always add)
262 #show_hidden_files_in_local_browser = "no"
264 #display_screens_numbers_on_start = "yes"
266 #jump_to_now_playing_song_at_start = "yes"
268 #ask_before_clearing_main_playlist = "no"
270 #clock_display_seconds = "no"
272 #display_bitrate = "no"
274 #display_remaining_time = "no"
276 #regular_expressions = "basic" (basic/extended)
279 ## Note: If below is enabled, ncmpcpp will ignore leading
280 ## "The" word while sorting items in browser, tags in
281 ## media library, etc.
283 #ignore_leading_the = "no"
285 #block_search_constraints_change_if_items_found = "yes"
287 #mouse_support = "yes"
289 #mouse_list_scroll_whole_page = "yes"
291 #empty_tag_marker = "<empty>"
293 #tag_editor_extended_numeration = "no"
295 #enable_window_title = "yes"
298 ## Note: These triggers will allow you to phisically remove
299 ## files and directories from your hdd in using ncmpcpp's
300 ## browser screen.
303 #allow_physical_files_deletion = "no"
305 #allow_physical_directories_deletion = "no"
307 ##### lyrics support #####
309 ## supported lyrics databases:
311 ## - 1 - lyricsplugin.com
314 #lyrics_database = "1"
316 #external_editor = ""
318 #use_console_editor = "no" (set to yes, if your editor is console app)
320 ##### colors definitions #####
322 #colors_enabled = "yes"
324 #empty_tag_color = "cyan"
326 #header_window_color = "default"
328 #volume_color = "default"
330 #state_line_color = "default"
332 #state_flags_color = "default"
334 #main_window_color = "yellow"
336 #color1 = "white"
338 #color2 = "green"
340 #main_window_highlight_color = "yellow"
342 #progressbar_color = "default"
344 #statusbar_color = "default"
346 #alternative_ui_separator_color = "black"
348 #active_column_color = "red"
350 #window_border_color = "green"
352 #active_window_border = "red"