actions: support adding random album_artists
[ncmpcpp.git] / doc / ncmpcpp.1
1 .TH "ncmpcpp" "1"
2 .SH "NAME"
3 ncmpcpp \- An ncurses Music Player Daemon (MPD) client.
4 .SH "SYNOPSIS"
5 .B ncmpcpp
6 [options]
7 .SH "DESCRIPTION"
8 ncmpcpp is an ncurses client for MPD (Music Player Daemon), inspired by ncmpc.
9
10 Read more about MPD at http://www.musicpd.org
11 .SH "OPTIONS"
12 .B \-h, \-\-host
13 Connect to server at host [localhost]
14 .TP
15 .B \-p, \-\-port
16 Connect to server at port [6600]
17 .TP
18 .B \-c, \-\-config
19 Use alternative configuration file
20 .TP
21 .B \-s, \-\-screen <name>
22 Specify the startup screen (<name> may be: help, playlist, browser, search_engine, media_library, playlist_editor, tag_editor, outputs, visualizer, clock)
23 .TP
24 .B \-S, \-\-slave-screen <name>
25 Specify the startup slave screen (<name> may be: help, playlist, browser, search_engine, media_library, playlist_editor, tag_editor, outputs, visualizer, clock)
26 .TP
27 .B \-?, \-\-help
28 Display help.
29 .TP
30 .B \-v, \-\-version
31 Display version information.
32 .TP
33 .SH "CONFIGURATION"
34 When ncmpcpp starts, it tries to read user's settings from $HOME/.ncmpcpp/config and $XDG_CONFIG_HOME/ncmpcpp/config files. If no configuration is found, ncmpcpp uses its default configuration. An example configuration file containing all default values is provided with ncmpcpp and can be usually found in /usr/share/doc/ncmpcpp (exact location may depend on used distribution or configure prefix).
35
36 Note: Configuration option values can either be enclosed in quotation marks or not.
37  - If they are enclosed, the leftmost and the rightmost quotation marks are treated as delimiters, therefore it is not necessary to escape quotation marks you use within the value itself.
38  - If they are not, any whitespace characters between = and the first printable character of the value, as well as whitespace characters after the last printable character of the value are trimmed.
39
40 Therefore the rule of thumb is: if you need whitespaces at the beginning or at the end of the value, enclose it in quotation marks. Otherwise, don't.
41
42 Note: COLOR has to be the name (not a number) of one of colors 1-8 from SONG FORMAT section.
43
44 Supported configuration options:
45 .TP 
46 .B ncmpcpp_directory = PATH
47 Directory for storing ncmpcpp related files. Changing it is useful if you want to store everything somewhere else and provide command line setting for alternative location to config file which defines that while launching ncmpcpp.
48 .TP 
49 .B lyrics_directory = PATH
50 Directory for storing downloaded lyrics. It defaults to ~/.lyrics since other MPD clients (eg. ncmpc) also use that location.
51 .TP 
52 .B mpd_host = HOST
53 Connect to MPD running on specified host/unix socket. When HOST starts with a '/', it is assumed to be a unix socket.
54 .TP 
55 .B mpd_music_dir = PATH
56 Search for files in specified directory. This is needed for tag editor to work.
57 .TP 
58 .B mpd_port = PORT
59 Connect to MPD on the specified port.
60 .TP 
61 .B mpd_connection_timeout = SECONDS
62 Set connection timeout to MPD to given value.
63 .TP 
64 .B mpd_crossfade_time = SECONDS
65 Default number of seconds to crossfade, if enabled by ncmpcpp.
66 .TP
67 .B visualizer_in_stereo = yes/no
68 Should be set to 'yes', if fifo output's format was set to 44100:16:2.
69 .TP
70 .B visualizer_fifo_path = PATH
71 Path to mpd fifo output. This is needed to make music visualizer work (note that output sound format of this fifo has to be either 44100:16:1 or 44100:16:2, depending on whether you want mono or stereo visualization)
72 .TP
73 .B visualizer_output_name = NAME
74 Name of output that provides data for visualizer. Needed to keep sound and visualization in sync.
75 .TP
76 .B visualizer_sample_multiplier = NUMBER
77 Multiply received samples by given value. Very useful for proper visualization of quiet music.
78 .TP
79 .B visualizer_sync_interval = SECONDS
80 Defines interval between syncing visualizer and audio outputs.
81 .TP
82 .B visualizer_type = spectrum/wave/wave_filled/ellipse
83 Defines default visualizer type (spectrum is available only if ncmpcpp was compiled with fftw support).
84 .TP
85 .B visualizer_look = STRING
86 Defines visualizer's look (string has to be exactly 2 characters long: first one is for wave whereas second for frequency spectrum).
87 .TP
88 .B visualizer_color = COLORS
89 Comma separated list of colors to be used in music visualization.
90 .TP 
91 .B system_encoding = ENCODING
92 If you use encoding other than utf8, set it in order to handle utf8 encoded strings properly.
93 .TP
94 .B seek_time = SECONDS
95 Base seek time to begin with.
96 .TP 
97 .B volume_change_step = NUMBER
98 Number of percents volume has to be increased/decreased by in volume_up/volume_down.
99 .TP 
100 .B playlist_disable_highlight_delay = SECONDS
101 Delay for highlighting playlist since the last key was pressed. If set to 0, highlighting never fades away.
102 .TP 
103 .B message_delay_time = SECONDS
104 Delay for displayed messages to remain visible.
105 .TP
106 .B song_list_format
107 Format for songs' list.
108 .TP
109 .B song_columns_list_format
110 Format for songs' list displayed in columns.
111 .TP
112 .B song_status_format
113 Song's format for statusbar.
114 .TP
115 .B song_library_format
116 Format for songs in Media library.
117 .TP 
118 .B song_window_title_format
119 Song format for window title.
120 .TP
121 .B browser_sort_mode
122 Determines sort mode for browser. Possible values are "name", "mtime", "format" and "noop".
123 .TP
124 .B browser_sort_format
125 Format to use for sorting songs in browser. For this option to be effective, browser_sort_mode must be set to "format".
126 .TP 
127 .B external_editor = PATH
128 Path to external editor used to edit lyrics.
129 .TP
130 .B browser_playlist_prefix = TEXT
131 Prefix for playlists in Browser.
132 .TP
133 .B default_tag_editor_pattern = TEXT
134 Default pattern used by Tag editor's parser.
135 .TP 
136 .B now_playing_prefix = TEXT
137 Prefix for currently playing song.
138 .TP 
139 .B now_playing_suffix = TEXT
140 Suffix for currently playing song.
141 .TP 
142 .B selected_item_prefix = TEXT
143 Prefix for selected items.
144 .TP 
145 .B selected_item_suffix = TEXT
146 Suffix for selected items.
147 .TP 
148 .B modified_item_prefix = TEXT
149 Prefix for modified item (tag editor).
150 .TP 
151 .B alternative_header_first_line_format = TEXT
152 Now playing song format for the first line in alternative user interface header window.
153 .TP 
154 .B alternative_header_second_line_format = TEXT
155 Now playing song format for the second line in alternative user interface header window.
156 .TP 
157 .B color1 = COLOR
158 One of colors used in Song info, Tiny tag editor and Search engine.
159 .TP 
160 .B color2 = COLOR
161 One of colors used in Song info, Tiny tag editor and Search engine.
162 .TP 
163 .B colors_enabled = yes/no
164 No need to describe it, huh?
165 .TP 
166 .B header_text_scrolling = yes/no
167 If enabled, text in header window will scroll if its length is longer then actual screen width, otherwise it won't.
168 .TP 
169 .B cyclic_scrolling = yes/no
170 If enabled, cyclic scrolling is used (e.g. if you press down arrow being at the end of list, it'll take you to the beginning)
171 .TP 
172 .B mouse_list_scroll_whole_page = yes/no
173 If enabled, mouse wheel will scroll the whole page of item list at a time, otherwise the number of lines specified by lines_scrolled variable.
174 .TP 
175 .B lines_scrolled = NUMBER
176 Number of lines that are scrolled with mouse wheel.
177 .TP 
178 .B search_engine_default_search_mode = MODE_NUMBER
179 Number of default mode used in search engine.
180 .TP 
181 .B playlist_show_remaining_time = yes/no
182 If enabled, time remaining to end of playlist will be shown after playlist's statistics.
183 .TP 
184 .B playlist_shorten_total_times = yes/no
185 If enabled, total/remaining playlist time displayed in statusbar will be shown using shortened units' names (d:h:m:s instead of days:hours:minutes:seconds).
186 .TP 
187 .B playlist_separate_albums = yes/no
188 If enabled, separators will be placed between albums.
189 .TP 
190 .B playlist_display_mode = classic/columns
191 Default display mode for Playlist.
192 .TP 
193 .B browser_display_mode = classic/columns
194 Default display mode for Browser.
195 .TP 
196 .B search_engine_display_mode = classic/columns
197 Default display mode for Search engine.
198 .TP 
199 .B playlist_editor_display_mode = classic/columns
200 Default display mode for Playlist editor.
201 .TP 
202 .B discard_colors_if_item_is_selected = yes/no
203 Indicates whether custom colors of tags have to be discarded if item is selected or not.
204 .TP 
205 .B header_visibility = yes/no
206 If enabled, header window will be displayed, otherwise hidden.
207 .TP 
208 .B statusbar_visibility = yes/no
209 If enabled, statusbar will be displayed, otherwise hidden.
210 .TP 
211 .B titles_visibility = yes/no
212 If enabled, column titles will be displayed, otherwise hidden.
213 .TP 
214 .B autocenter_mode = yes/no
215 Default state for autocenter mode at start.
216 .TP 
217 .B centered_cursor = yes/no
218 If enabled, currently highlighted position in the list will be always centered.
219 .TP 
220 .B progressbar_look = TEXT
221 This variable defines the look of progressbar. Note that it has to be exactly two or three characters long.
222 .TP 
223 .B progressbar_boldness = yes/no
224 This variable defines whether progressbar should be displayed in bold or not.
225 .TP 
226 .B default_find_mode = wrapped/normal
227 If set to "wrapped", going from last found position to next will take you to the first one (same goes for the first position and going to previous one), otherwise no actions will be performed.
228 .TP 
229 .B default_space_mode = select/add
230 If set to "select", space will select items instead of adding them to playlist (although selecting by space is default and the only one action for space in Playlist).
231 .TP 
232 .B incremental_seeking = yes/no
233 If enabled, seek time will increment by one each second of seeking.
234 .TP 
235 .B follow_now_playing_lyrics = yes/no
236 If enabled, lyrics will be switched at song's change to currently playing one's (Note: this works only if you are viewing lyrics of item from Playlist).
237 .TP
238 .B fetch_lyrics_for_current_song_in_background = yes/no
239 If enabled, each time song changes lyrics fetcher will be automatically run in background in attempt to download lyrics for currently playing song.
240 .TP
241 .B store_lyrics_in_song_dir = yes/no
242 If enabled, lyrics will be saved in song's directory, otherwise in ~/.lyrics. Note that it needs properly set mpd_music_dir.
243 .TP
244 .B generate_win32_compatible_filenames = yes/no
245 If set to yes, filenames generated by ncmpcpp (with tag editor, for lyrics, artists etc.) will not contain the following characters: \\?*:|"<> - otherwise only slash (/) will not be used.
246 .TP
247 .B allow_for_physical_item_deletion = yes/no
248 If set to yes, it will be possible to physically delete files and directories from the disk in the browser.
249 .TP
250 .B lastfm_preferred_language = ISO 639 alpha-2 language code
251 If set, ncmpcpp will try to get info from last.fm in language you set and if it fails, it will fall back to english. Otherwise it will use english the first time.
252 .TP
253 .B space_add_mode = add_remove/always_add
254 If set to add_remove, pressing space on item which is already in playlist will remove it, otherwise add it again.
255 .TP 
256 .B show_hidden_files_in_local_browser = yes/no
257 Trigger for displaying in local browser files and directories that begin with '.'
258 .TP 
259 .B default_place_to_search_in = database/playlist
260 If set to "playlist", Search engine will perform searching in current MPD playlist rather than in music database.
261 .TP 
262 .B display_screens_numbers_on_start = yes/no
263 If enabled, screens' names and their keybindings will be shown in header window until key is pressed, otherwise they won't be displayed at all.
264 .TP 
265 .B screen_switcher_mode = SWITCHER_MODE
266 If set to "previous", key_screen_switcher will switch between current and last used screen. If set to "screen1,...screenN" (a list of screens) it will switch between them in a sequence. Syntax clarification can be found in example config file.
267 .TP 
268 .B startup_screen = SCREEN_NAME
269 Screen that has to be displayed at start (playlist by default).
270 .TP 
271 .B startup_slave_screen = SCREEN_NAME
272 Slave screen that has to be displayed at start (nothing by default).
273 .TP 
274 .B locked_screen_width_part = 20-80
275 If you want to lock a screen, ncmpcpp asks for % of locked screen's width to be reserved before that and provides a default value, which is the one you can set here.
276 .TP 
277 .B ask_for_locked_screen_width_part = yes/no
278 If enabled, ncmpcpp will ask for % of locked screen's width each time you want to lock a screen. If you disable that, it'll silently attempt to use default value.
279 .TP 
280 .B jump_to_now_playing_song_at_start = yes/no
281 If enabled, ncmpcpp will jump at start to now playing song if mpd is playing or paused.
282 .TP 
283 .B ask_before_clearing_playlists = yes/no
284 If enabled, user will be asked if he really wants to clear the playlist after pressing key responsible for that.
285 .TP 
286 .B clock_display_seconds = yes/no
287 If enabled, clock will display time in format hh:mm:ss, otherwise hh:mm.
288 .TP 
289 .B display_volume_level = yes/no
290 If enabled, volume level will be displayed in statusbar, otherwise not.
291 .TP 
292 .B display_bitrate = yes/no
293 If enabled, bitrate of currently playing song will be displayed in statusbar.
294 .TP 
295 .B display_remaining_time = yes/no
296 If enabled, remaining time of currently playing song will be be displayed in statusbar instead of elapsed time.
297 .TP 
298 .B ignore_leading_the = yes/no
299 If enabled, word "the" at the beginning of tags/filenames/sort format will be ignored while sorting items.
300 .TP 
301 .B use_console_editor = yes/no
302 If your external editor is console application, you need to enable it.
303 .TP 
304 .B block_search_constraints_change_if_items_found = yes/no
305 If enabled, fields in Search engine above "Reset" button will be blocked after successful searching, otherwise they won't.
306 .TP 
307 .B mouse_support = yes/no
308 Self-descriptive, isn't it?
309 .TP 
310 .B tag_editor_extended_numeration  = yes/no
311 If enabled, tag editor will number tracks using format xx/yy (where xx is the current track and yy is total amount of all numbered tracks), not plain xx.
312 .TP
313 .B enable_window_title = yes/no
314 If enabled, ncmpcpp will override current window title with its own one.
315 .TP
316 .B regular_expressions = basic/extended
317 Type of currently used regular expressions.
318 .TP 
319 .B user_interface = classic/alternative
320 Default user interface used by ncmpcpp at start.
321 .TP 
322 .B data_fetching_delay = yes/no
323 If enabled, there will be a 250ms delay between refreshing position in media library or playlist editor and fetching appropriate data from MPD. This limits data fetched from the server and is particularly useful if ncmpcpp is connected to a remote host.
324 .TP
325 .B media_library_primary_tag = artist/date/genre/composer/performer
326 Default tag type for leftmost column in media library.
327 .TP 
328 .B empty_tag_marker = TEXT
329 Text that will be displayed, if requested tag is not set.
330 .TP 
331 .B tags_separator = TEXT
332 Separator that is placed between tags. Also interpreted by tag editor which splits input string into separate tags using it.
333 .TP 
334 .B empty_tag_color = COLOR
335 Color of empty tag marker.
336 .TP 
337 .B header_window_color = COLOR
338 Color of header window.
339 .TP 
340 .B volume_color = COLOR
341 Color of volume state.
342 .TP 
343 .B state_line_color = COLOR
344 Color of lines separating header and statusbar from main window.
345 .TP 
346 .B state_flags_color = COLOR
347 Color of MPD status flags.
348 .TP 
349 .B main_window_color = COLOR
350 Color of main window.
351 .TP 
352 .B main_window_highlight_color = COLOR
353 Color of main window's highlight.
354 .TP 
355 .B progressbar_color = COLOR
356 Color of progressbar.
357 .TP 
358 .B progressbar_elapsed_color = COLOR
359 Color of part of progressbar that represents elapsed time.
360 .TP 
361 .B statusbar_color = COLOR
362 Color of statusbar.
363 .TP 
364 .B alternative_ui_separator_color = COLOR
365 Color of separators used in alternative user interface.
366 .TP 
367 .B active_column_color = COLOR
368 Color of active column's highlight.
369 .TP 
370 .B active_window_border = COLOR
371 Color of active window's border.
372 .TP 
373 .SH "BINDINGS"
374 When ncmpcpp starts, it tries to read user's bindings from ~/.ncmpcpp/bindings file. If no bindings file is found, ncmpcpp uses the defaults. An example bindings file with the default values can be found usually in /usr/share/doc/ncmpcpp (exact location may depend on used distribution or configure prefix).
375
376 You can view current keybindings by pressing F1.
377 .SH "SONG FORMAT"
378
379 For song format you can use:
380
381  %l - length
382  %f - filename
383  %D - directory
384  %a - artist
385  %A - album artist
386  %t - title
387  %b - album
388  %y - date
389  %n - track number (01/12 -> 01)
390  %N - full track info (01/12 -> 01/12)
391  %g - genre
392  %c - composer
393  %p - performer
394  %d - disc
395  %C - comment
396  %P - priority
397  $R - begin right alignment
398
399 You can also put them in { } and then they will be displayed only if all requested values are available and/or define alternate value with { }|{ } e.g. {%a - %t}|{%f} will check if artist and title tags are available and if they are, display them. Otherwise it'll display filename.
400
401 \fBNote\fR: If you want to set limit on maximal length of a tag, just put the appropriate number between % and character that defines tag type, e.g. to make album take max. 20 terminal cells, use '%20b'.
402
403 \fBNote\fR: Format that is similar to "%a - %t" (i.e. without any additional braces) is equal to "{%a - %t}", so if one of the tags is missing, you'll get nothing.
404
405 Text can have different color than the main window, e.g. if you want length to be green, write $3%l$9.
406
407 Available values for colors:
408
409  - 0 - default window color (discards all other colors)
410  - 1 - black
411  - 2 - red
412  - 3 - green
413  - 4 - yellow
414  - 5 - blue
415  - 6 - magenta
416  - 7 - cyan
417  - 8 - white
418  - 9 - end of current color
419
420 \fBNote\fR: colors can be nested, so if you write $2some$5text$9, it'll disable only usage of blue color and make red the current one.
421
422 .SH "BUGS"
423 Report bugs on http://www.musicpd.org/mantis/
424 .SH "NOTE"
425 Since MPD uses UTF\-8, ncmpcpp needs to convert characters to the charset used by the local system. If you get character conversion errors while you are running ncmpcpp, you probably need to set up your locale. This is done by setting LANG and LC_ALL/LC_CTYPE environment variables (LC_CTYPE only affects character handling).
426 .SH "HOMEPAGE"
427 -> http://unkart.ovh.org/ncmpcpp
428
429 .SH "SEE ALSO"
430 mpc(1), mpd(1)