Make jump_to_playing_song not runnable if there is no playing song
[ncmpcpp.git] / doc / ncmpcpp.1
blob43db0d8e77d4e86cddf86001b830d20bae76d05d
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 \-\-current-song
19 Print current song using given format and exit
20 .TP
21 .B \-c, \-\-config
22 Specify configuration file(s)
23 .TP
24 .B \-\-ignore-config-errors
25 Ignore unknown and invalid options in configuration files
26 .TP
27 .B \-c, \-\-bindings
28 Specify bindings file
29 .TP
30 .B \-s, \-\-screen <name>
31 Specify the startup screen (<name> may be: help, playlist, browser, search_engine, media_library, playlist_editor, tag_editor, outputs, visualizer, clock)
32 .TP
33 .B \-S, \-\-slave-screen <name>
34 Specify the startup slave screen (<name> may be: help, playlist, browser, search_engine, media_library, playlist_editor, tag_editor, outputs, visualizer, clock)
35 .TP
36 .B \-?, \-\-help
37 Display help.
38 .TP
39 .B \-v, \-\-version
40 Display version information.
41 .TP
42 .SH "CONFIGURATION"
43 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).
45 Note: Configuration option values can either be enclosed in quotation marks or not.
46  - 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.
47  - 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.
49 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.
51 Note: COLOR has to be the name (not a number) of one of colors 1-8 from SONG FORMAT section.
53 Supported configuration options:
54 .TP
55 .B ncmpcpp_directory = PATH
56 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.
57 .TP
58 .B lyrics_directory = PATH
59 Directory for storing downloaded lyrics. It defaults to ~/.lyrics since other MPD clients (eg. ncmpc) also use that location.
60 .TP
61 .B mpd_host = HOST
62 Connect to MPD running on specified host/unix socket. When HOST starts with a '/', it is assumed to be a unix socket. Note: MPD_HOST environment variable overrides this setting.
63 .TP
64 .B mpd_port = PORT
65 Connect to MPD on the specified port. Note: MPD_PORT environment variable overrides this setting.
66 .TP
67 .B mpd_music_dir = PATH
68 Search for files in specified directory. This is needed for tag editor to work.
69 .TP
70 .B mpd_connection_timeout = SECONDS
71 Set connection timeout to MPD to given value.
72 .TP
73 .B mpd_crossfade_time = SECONDS
74 Default number of seconds to crossfade, if enabled by ncmpcpp.
75 .TP
76 .B visualizer_fifo_path = PATH
77 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)
78 .TP
79 .B visualizer_output_name = NAME
80 Name of output that provides data for visualizer. Needed to keep sound and visualization in sync.
81 .TP
82 .B visualizer_in_stereo = yes/no
83 Should be set to 'yes', if fifo output's format was set to 44100:16:2.
84 .TP
85 .B visualizer_sync_interval = SECONDS
86 Defines interval between syncing visualizer and audio outputs.
87 .TP
88 .B visualizer_type = spectrum/wave/wave_filled/ellipse
89 Defines default visualizer type (spectrum is available only if ncmpcpp was compiled with fftw support).
90 .TP
91 .B visualizer_look = STRING
92 Defines visualizer's look (string has to be exactly 2 characters long: first one is for wave whereas second for frequency spectrum).
93 .TP
94 .B visualizer_color = COLORS
95 Comma separated list of colors to be used in music visualization.
96 .TP
97 .B system_encoding = ENCODING
98 If you use encoding other than utf8, set it in order to handle utf8 encoded strings properly.
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.
103 .B message_delay_time = SECONDS
104 Delay for displayed messages to remain visible.
106 .B song_list_format
107 Song format for lists of songs.
109 .B song_status_format
110 Song format for statusbar.
112 .B song_library_format
113 Song format for media library.
115 .B alternative_header_first_line_format = TEXT
116 Now playing song format for the first line in alternative user interface header window.
118 .B alternative_header_second_line_format = TEXT
119 Now playing song format for the second line in alternative user interface header window.
121 .B now_playing_prefix = TEXT
122 Prefix for currently playing song.
124 .B now_playing_suffix = TEXT
125 Suffix for currently playing song.
127 .B browser_playlist_prefix = TEXT
128 Prefix for playlists in Browser.
130 .B selected_item_prefix = TEXT
131 Prefix for selected items.
133 .B selected_item_suffix = TEXT
134 Suffix for selected items.
136 .B modified_item_prefix = TEXT
137 Prefix for modified item (tag editor).
139 .B browser_sort_mode
140 Determines sort mode for browser. Possible values are "name", "mtime", "format" and "noop".
142 .B browser_sort_format
143 Format to use for sorting songs in browser. For this option to be effective, browser_sort_mode must be set to "format".
145 .B song_window_title_format
146 Song format for window title.
148 .B song_columns_list_format
149 Format for songs' list displayed in columns.
151 .B execute_on_song_change = COMMAND
152 Shell command to execute on song change.
154 .B execute_on_player_state_change = COMMAND
155 Shell command to execute on player state change. The environment variable
156 .B MPD_PLAYER_STATE
157 is set to the current state (either unknown, play, pause, or stop) for its duration.
159 .B playlist_show_mpd_host = yes/no
160 If enabled, current MPD host will be shown in playlist.
162 .B playlist_show_remaining_time = yes/no
163 If enabled, time remaining to end of playlist will be shown after playlist statistics.
165 .B playlist_shorten_total_times = yes/no
166 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).
168 .B playlist_separate_albums = yes/no
169 If enabled, separators will be placed between albums.
171 .B playlist_display_mode = classic/columns
172 Default display mode for Playlist.
174 .B browser_display_mode = classic/columns
175 Default display mode for Browser.
177 .B search_engine_display_mode = classic/columns
178 Default display mode for Search engine.
180 .B playlist_editor_display_mode = classic/columns
181 Default display mode for Playlist editor.
183 .B discard_colors_if_item_is_selected = yes/no
184 Indicates whether custom colors of tags have to be discarded if item is selected or not.
186 .B show_duplicate_tags = yes/no
187 Indicates whether ncmpcpp should display multiple tags as-is or remove duplicates.
189 .B incremental_seeking = yes/no
190 If enabled, seek time will increment by one each second of seeking.
192 .B seek_time = SECONDS
193 Base seek time to begin with.
195 .B volume_change_step = NUMBER
196 Number of percents volume has to be increased/decreased by in volume_up/volume_down.
198 .B autocenter_mode = yes/no
199 Default state for autocenter mode at start.
201 .B centered_cursor = yes/no
202 If enabled, currently highlighted position in the list will be always centered.
204 .B progressbar_look = TEXT
205 This variable defines the look of progressbar. Note that it has to be exactly two or three characters long.
207 .B default_place_to_search_in = database/playlist
208 If set to "playlist", Search engine will perform searching in current MPD playlist rather than in music database.
210 .B user_interface = classic/alternative
211 Default user interface used by ncmpcpp at start.
213 .B data_fetching_delay = yes/no
214 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.
216 .B media_library_primary_tag = artist/album_artist/date/genre/composer/performer
217 Default tag type for leftmost column in media library.
219 .B default_find_mode = wrapped/normal
220 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.
222 .B default_tag_editor_pattern = TEXT
223 Default pattern used by Tag editor's parser.
225 .B header_visibility = yes/no
226 If enabled, header window will be displayed, otherwise hidden.
228 .B statusbar_visibility = yes/no
229 If enabled, statusbar will be displayed, otherwise hidden.
231 .B titles_visibility = yes/no
232 If enabled, column titles will be displayed, otherwise hidden.
234 .B header_text_scrolling = yes/no
235 If enabled, text in header window will scroll if its length is longer then actual screen width, otherwise it won't.
237 .B cyclic_scrolling = yes/no
238 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)
240 .B lines_scrolled = NUMBER
241 Number of lines that are scrolled with mouse wheel.
243 .B lyrics_fetchers = FETCHERS
244 Comma separated list of lyrics fetchers.
246 .B follow_now_playing_lyrics = yes/no
247 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).
249 .B fetch_lyrics_for_current_song_in_background = yes/no
250 If enabled, each time song changes lyrics fetcher will be automatically run in background in attempt to download lyrics for currently playing song.
252 .B store_lyrics_in_song_dir = yes/no
253 If enabled, lyrics will be saved in song's directory, otherwise in ~/.lyrics. Note that it needs properly set mpd_music_dir.
255 .B generate_win32_compatible_filenames = yes/no
256 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.
258 .B allow_for_physical_item_deletion = yes/no
259 If set to yes, it will be possible to physically delete files and directories from the disk in the browser.
261 .B lastfm_preferred_language = ISO 639 alpha-2 language code
262 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.
264 .B space_add_mode = add_remove/always_add
265 If set to add_remove, attepting to add files that are already in playlist will remove them. Otherwise they can be added multiple times.
267 .B show_hidden_files_in_local_browser = yes/no
268 Trigger for displaying in local browser files and directories that begin with '.'
270 .B screen_switcher_mode = SWITCHER_MODE
271 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.
273 .B startup_screen = SCREEN_NAME
274 Screen that has to be displayed at start (playlist by default).
276 .B startup_slave_screen = SCREEN_NAME
277 Slave screen that has to be displayed at start (nothing by default).
279 .B startup_slave_screen_focus = yes/no
280 If set to yes, slave screen will be the active one after startup. Otherwise master screen will be.
281 .TP 
282 .B locked_screen_width_part = 20-80
283 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.
285 .B ask_for_locked_screen_width_part = yes/no
286 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.
288 .B jump_to_now_playing_song_at_start = yes/no
289 If enabled, ncmpcpp will jump at start to now playing song if mpd is playing or paused.
291 .B ask_before_clearing_playlists = yes/no
292 If enabled, user will be asked if he really wants to clear the playlist after pressing key responsible for that.
294 .B clock_display_seconds = yes/no
295 If enabled, clock will display time in format hh:mm:ss, otherwise hh:mm.
297 .B display_volume_level = yes/no
298 If enabled, volume level will be displayed in statusbar, otherwise not.
300 .B display_bitrate = yes/no
301 If enabled, bitrate of currently playing song will be displayed in statusbar.
303 .B display_remaining_time = yes/no
304 If enabled, remaining time of currently playing song will be be displayed in statusbar instead of elapsed time.
306 .B regular_expressions = none/basic/extended/perl
307 Type of currently used regular expressions.
309 .B ignore_leading_the = yes/no
310 If enabled, word "the" at the beginning of tags/filenames/sort format will be ignored while sorting items.
312 .B block_search_constraints_change_if_items_found = yes/no
313 If enabled, fields in Search engine above "Reset" button will be blocked after successful searching, otherwise they won't.
315 .B mouse_support = yes/no
316 If set to yes, mouse support will be enabled.
318 .B mouse_list_scroll_whole_page = yes/no
319 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.
321 .B empty_tag_marker = TEXT
322 Text that will be displayed, if requested tag is not set.
324 .B tags_separator = TEXT
325 Separator that is placed between tags. Also interpreted by tag editor which splits input string into separate tags using it.
327 .B tag_editor_extended_numeration = yes/no
328 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.
330 .B media_library_sort_by_mtime = yes/no
331 If enabled, media library will be sorted by modification time. Otherwise lexicographic sorting is used.
333 .B enable_window_title = yes/no
334 If enabled, ncmpcpp will override current window title with its own one.
336 .B search_engine_default_search_mode = MODE_NUMBER
337 Number of default mode used in search engine.
339 .B external_editor = PATH
340 Path to external editor used to edit lyrics.
342 .B use_console_editor = yes/no
343 If your external editor is console application, you need to enable it.
345 .B colors_enabled = yes/no
346 No need to describe it, huh?
348 .B empty_tag_color = COLOR
349 Color of empty tag marker.
351 .B header_window_color = COLOR
352 Color of header window.
354 .B volume_color = COLOR
355 Color of volume state.
357 .B state_line_color = COLOR
358 Color of lines separating header and statusbar from main window.
360 .B state_flags_color = COLOR
361 Color of MPD status flags.
363 .B main_window_color = COLOR
364 Color of main window.
366 .B color1 = COLOR
367 One of colors used in Song info, Tiny tag editor and Search engine.
369 .B color2 = COLOR
370 One of colors used in Song info, Tiny tag editor and Search engine.
372 .B main_window_highlight_color = COLOR
373 Color of main window's highlight.
375 .B progressbar_color = COLOR
376 Color of progressbar.
378 .B progressbar_elapsed_color = COLOR
379 Color of part of progressbar that represents elapsed time.
381 .B statusbar_color = COLOR
382 Color of statusbar.
384 .B statusbar_time_color = COLOR
385 Color of current track time shown in statusbar.
387 .B player_state_color = COLOR
388 Color of player state shown in statusbar.
390 .B alternative_ui_separator_color = COLOR
391 Color of separators used in alternative user interface.
393 .B active_column_color = COLOR
394 Color of active column's highlight.
396 .B window_border_color = BORDER
397 Border color of pop-up windows. If set to 'none', no border will be shown.
399 .B active_window_border = COLOR
400 Color of active window's border.
402 .SH "BINDINGS"
403 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).
405 You can view current keybindings by pressing F1.
406 .SH "SONG FORMAT"
408 For song format you can use:
410  %l - length
411  %f - filename
412  %D - directory
413  %a - artist
414  %A - album artist
415  %t - title
416  %b - album
417  %y - date
418  %n - track number (01/12 -> 01)
419  %N - full track info (01/12 -> 01/12)
420  %g - genre
421  %c - composer
422  %p - performer
423  %d - disc
424  %C - comment
425  %P - priority
426  $R - begin right alignment
428 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.
430 \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'.
432 \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.
434 Text can have different color than the main window, e.g. if you want length to be green, write $3%l$9.
436 Available values for colors:
438  - 0 - default window color (discards all other colors)
439  - 1 - black
440  - 2 - red
441  - 3 - green
442  - 4 - yellow
443  - 5 - blue
444  - 6 - magenta
445  - 7 - cyan
446  - 8 - white
447  - 9 - end of current color
449 \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.
451 .SH "BUGS"
452 Report bugs on http://www.musicpd.org/mantis/
453 .SH "NOTE"
454 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).
455 .SH "HOMEPAGE"
456 -> http://unkart.ovh.org/ncmpcpp
458 .SH "SEE ALSO"
459 mpc(1), mpd(1)