do not include error.h as it's not the desired file
[ncmpcpp.git] / doc / ncmpcpp.1
blob3672b1729b5006d8fc791881156435cf7ec97260
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.
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).
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.
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.
42 Note: COLOR has to be the name (not a number) of one of colors 1-8 from SONG FORMAT section.
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_port = PORT
56 Connect to MPD on the specified port.
57 .TP
58 .B mpd_music_dir = PATH
59 Search for files in specified directory. This is needed for tag editor to work.
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_fifo_path = PATH
68 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)
69 .TP
70 .B visualizer_output_name = NAME
71 Name of output that provides data for visualizer. Needed to keep sound and visualization in sync.
72 .TP
73 .B visualizer_in_stereo = yes/no
74 Should be set to 'yes', if fifo output's format was set to 44100:16:2.
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 playlist_disable_highlight_delay = SECONDS
95 Delay for highlighting playlist since the last key was pressed. If set to 0, highlighting never fades away.
96 .TP
97 .B message_delay_time = SECONDS
98 Delay for displayed messages to remain visible.
99 .TP
100 .B song_list_format
101 Format for songs' list.
102 .TP
103 .B song_status_format
104 Song's format for statusbar.
105 .TP
106 .B song_library_format
107 .B alternative_header_first_line_format = TEXT
108 Now playing song format for the first line in alternative user interface header window.
109 .TP
110 .B alternative_header_second_line_format = TEXT
111 Now playing song format for the second line in alternative user interface header window.
112 .TP
113 .B now_playing_prefix = TEXT
114 Prefix for currently playing song.
115 .TP
116 .B now_playing_suffix = TEXT
117 Suffix for currently playing song.
118 .TP
119 .B browser_playlist_prefix = TEXT
120 Prefix for playlists in Browser.
121 .TP
122 .B selected_item_prefix = TEXT
123 Prefix for selected items.
124 .TP
125 .B selected_item_suffix = TEXT
126 Suffix for selected items.
127 .TP
128 .B modified_item_prefix = TEXT
129 Prefix for modified item (tag editor).
130 .TP
131 .B browser_sort_mode
132 Determines sort mode for browser. Possible values are "name", "mtime", "format" and "noop".
133 .TP
134 .B browser_sort_format
135 Format to use for sorting songs in browser. For this option to be effective, browser_sort_mode must be set to "format".
136 .TP
137 .B song_window_title_format
138 Song format for window title.
139 .TP
140 .B song_columns_list_format
141 Format for songs' list displayed in columns.
142 .TP
143 .B execute_on_song_change = COMMAND
144 Shell command to execute on song change.
145 .TP
146 .B playlist_show_mpd_host = yes/no
147 If enabled, current MPD host will be shown in playlist.
148 .TP
149 .B playlist_show_remaining_time = yes/no
150 If enabled, time remaining to end of playlist will be shown after playlist statistics.
151 .TP
152 .B playlist_shorten_total_times = yes/no
153 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).
154 .TP
155 .B playlist_separate_albums = yes/no
156 If enabled, separators will be placed between albums.
157 .TP
158 .B playlist_display_mode = classic/columns
159 Default display mode for Playlist.
160 .TP
161 .B browser_display_mode = classic/columns
162 Default display mode for Browser.
163 .TP
164 .B search_engine_display_mode = classic/columns
165 Default display mode for Search engine.
166 .TP
167 .B playlist_editor_display_mode = classic/columns
168 Default display mode for Playlist editor.
169 .TP
170 .B discard_colors_if_item_is_selected = yes/no
171 Indicates whether custom colors of tags have to be discarded if item is selected or not.
172 .TP
173 .B incremental_seeking = yes/no
174 If enabled, seek time will increment by one each second of seeking.
175 .TP
176 .B seek_time = SECONDS
177 Base seek time to begin with.
178 .TP
179 .B volume_change_step = NUMBER
180 Number of percents volume has to be increased/decreased by in volume_up/volume_down.
181 .TP
182 .B autocenter_mode = yes/no
183 Default state for autocenter mode at start.
184 .TP
185 .B centered_cursor = yes/no
186 If enabled, currently highlighted position in the list will be always centered.
187 .TP
188 .B progressbar_look = TEXT
189 This variable defines the look of progressbar. Note that it has to be exactly two or three characters long.
190 .TP
191 .B progressbar_boldness = yes/no
192 This variable defines whether progressbar should be displayed in bold or not.
193 .TP
194 .B default_place_to_search_in = database/playlist
195 If set to "playlist", Search engine will perform searching in current MPD playlist rather than in music database.
196 .TP
197 .B user_interface = classic/alternative
198 Default user interface used by ncmpcpp at start.
199 .TP
200 .B data_fetching_delay = yes/no
201 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.
202 .TP
203 .B media_library_primary_tag = artist/date/genre/composer/performer
204 Default tag type for leftmost column in media library.
205 .TP
206 .B default_find_mode = wrapped/normal
207 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.
208 .TP
209 .B default_space_mode = select/add
210 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).
211 .TP
212 .B default_tag_editor_pattern = TEXT
213 Default pattern used by Tag editor's parser.
214 .TP
215 .B header_visibility = yes/no
216 If enabled, header window will be displayed, otherwise hidden.
217 .TP
218 .B statusbar_visibility = yes/no
219 If enabled, statusbar will be displayed, otherwise hidden.
220 .TP
221 .B titles_visibility = yes/no
222 If enabled, column titles will be displayed, otherwise hidden.
223 .TP
224 .B header_text_scrolling = yes/no
225 If enabled, text in header window will scroll if its length is longer then actual screen width, otherwise it won't.
226 .TP
227 .B cyclic_scrolling = yes/no
228 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)
229 .TP
230 .B lines_scrolled = NUMBER
231 Number of lines that are scrolled with mouse wheel.
232 .TP
233 .B follow_now_playing_lyrics = yes/no
234 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).
235 .TP
236 .B fetch_lyrics_for_current_song_in_background = yes/no
237 If enabled, each time song changes lyrics fetcher will be automatically run in background in attempt to download lyrics for currently playing song.
238 .TP
239 .B store_lyrics_in_song_dir = yes/no
240 If enabled, lyrics will be saved in song's directory, otherwise in ~/.lyrics. Note that it needs properly set mpd_music_dir.
241 .TP
242 .B generate_win32_compatible_filenames = yes/no
243 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.
244 .TP
245 .B allow_for_physical_item_deletion = yes/no
246 If set to yes, it will be possible to physically delete files and directories from the disk in the browser.
247 .TP
248 .B lastfm_preferred_language = ISO 639 alpha-2 language code
249 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.
250 .TP
251 .B space_add_mode = add_remove/always_add
252 If set to add_remove, pressing space on item which is already in playlist will remove it, otherwise add it again.
253 .TP
254 .B show_hidden_files_in_local_browser = yes/no
255 Trigger for displaying in local browser files and directories that begin with '.'
256 .TP
257 .B screen_switcher_mode = SWITCHER_MODE
258 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.
259 .TP
260 .B startup_screen = SCREEN_NAME
261 Screen that has to be displayed at start (playlist by default).
262 .TP
263 .B startup_slave_screen = SCREEN_NAME
264 Slave screen that has to be displayed at start (nothing by default).
265 .TP
266 .B locked_screen_width_part = 20-80
267 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.
268 .TP
269 .B ask_for_locked_screen_width_part = yes/no
270 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.
271 .TP
272 .B jump_to_now_playing_song_at_start = yes/no
273 If enabled, ncmpcpp will jump at start to now playing song if mpd is playing or paused.
274 .TP
275 .B ask_before_clearing_playlists = yes/no
276 If enabled, user will be asked if he really wants to clear the playlist after pressing key responsible for that.
277 .TP
278 .B clock_display_seconds = yes/no
279 If enabled, clock will display time in format hh:mm:ss, otherwise hh:mm.
280 .TP
281 .B display_volume_level = yes/no
282 If enabled, volume level will be displayed in statusbar, otherwise not.
283 .TP
284 .B display_bitrate = yes/no
285 If enabled, bitrate of currently playing song will be displayed in statusbar.
286 .TP
287 .B display_remaining_time = yes/no
288 If enabled, remaining time of currently playing song will be be displayed in statusbar instead of elapsed time.
289 .TP
290 .B regular_expressions = none/basic/extended/perl
291 Type of currently used regular expressions.
292 .TP
293 .B ignore_leading_the = yes/no
294 If enabled, word "the" at the beginning of tags/filenames/sort format will be ignored while sorting items.
295 .TP
296 .B block_search_constraints_change_if_items_found = yes/no
297 If enabled, fields in Search engine above "Reset" button will be blocked after successful searching, otherwise they won't.
298 .TP
299 .B mouse_support = yes/no
300 If set to yes, mouse support will be enabled.
301 .TP
302 .B mouse_list_scroll_whole_page = yes/no
303 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.
304 .TP
305 .B empty_tag_marker = TEXT
306 Text that will be displayed, if requested tag is not set.
307 .TP
308 .B tags_separator = TEXT
309 Separator that is placed between tags. Also interpreted by tag editor which splits input string into separate tags using it.
310 .TP
311 .B tag_editor_extended_numeration = yes/no
312 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.
313 .TP
314 .B media_library_sort_by_mtime = yes/no
315 If enabled, media library will be sorted by modification time. Otherwise lexicographic sorting is used.
316 .TP
317 .B enable_window_title = yes/no
318 If enabled, ncmpcpp will override current window title with its own one.
319 .TP
320 .B search_engine_default_search_mode = MODE_NUMBER
321 Number of default mode used in search engine.
322 .TP
323 .B external_editor = PATH
324 Path to external editor used to edit lyrics.
325 .TP
326 .B use_console_editor = yes/no
327 If your external editor is console application, you need to enable it.
328 .TP
329 .B colors_enabled = yes/no
330 No need to describe it, huh?
331 .TP
332 .B empty_tag_color = COLOR
333 Color of empty tag marker.
334 .TP
335 .B header_window_color = COLOR
336 Color of header window.
337 .TP
338 .B volume_color = COLOR
339 Color of volume state.
340 .TP
341 .B state_line_color = COLOR
342 Color of lines separating header and statusbar from main window.
343 .TP
344 .B state_flags_color = COLOR
345 Color of MPD status flags.
346 .TP
347 .B main_window_color = COLOR
348 Color of main window.
349 .TP
350 .B color1 = COLOR
351 One of colors used in Song info, Tiny tag editor and Search engine.
352 .TP
353 .B color2 = COLOR
354 One of colors used in Song info, Tiny tag editor and Search engine.
355 .TP
356 .B main_window_highlight_color = COLOR
357 Color of main window's highlight.
358 .TP
359 .B progressbar_color = COLOR
360 Color of progressbar.
361 .TP
362 .B progressbar_elapsed_color = COLOR
363 Color of part of progressbar that represents elapsed time.
364 .TP
365 .B statusbar_color = COLOR
366 Color of statusbar.
367 .TP
368 .B alternative_ui_separator_color = COLOR
369 Color of separators used in alternative user interface.
370 .TP
371 .B active_column_color = COLOR
372 Color of active column's highlight.
373 .TP
374 .B window_border_color = BORDER
375 Border color of pop-up windows. If set to 'none', no border will be shown.
376 .TP
377 .B active_window_border = COLOR
378 Color of active window's border.
379 .TP
380 .SH "BINDINGS"
381 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).
383 You can view current keybindings by pressing F1.
384 .SH "SONG FORMAT"
386 For song format you can use:
388  %l - length
389  %f - filename
390  %D - directory
391  %a - artist
392  %A - album artist
393  %t - title
394  %b - album
395  %y - date
396  %n - track number (01/12 -> 01)
397  %N - full track info (01/12 -> 01/12)
398  %g - genre
399  %c - composer
400  %p - performer
401  %d - disc
402  %C - comment
403  %P - priority
404  $R - begin right alignment
406 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.
408 \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'.
410 \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.
412 Text can have different color than the main window, e.g. if you want length to be green, write $3%l$9.
414 Available values for colors:
416  - 0 - default window color (discards all other colors)
417  - 1 - black
418  - 2 - red
419  - 3 - green
420  - 4 - yellow
421  - 5 - blue
422  - 6 - magenta
423  - 7 - cyan
424  - 8 - white
425  - 9 - end of current color
427 \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.
429 .SH "BUGS"
430 Report bugs on http://www.musicpd.org/mantis/
431 .SH "NOTE"
432 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).
433 .SH "HOMEPAGE"
434 -> http://unkart.ovh.org/ncmpcpp
436 .SH "SEE ALSO"
437 mpc(1), mpd(1)