Consistently use nullptr instead of 0 in type_conversions.cpp
[ncmpcpp.git] / doc / ncmpcpp.1
blob33c94ea573937e862854d9f70dd7454fdc912100
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.
63 .TP
64 .B mpd_port = PORT
65 Connect to MPD on the specified port.
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_sample_multiplier = NUMBER
86 Multiply received samples by given value. Very useful for proper visualization of quiet music.
87 .TP
88 .B visualizer_sync_interval = SECONDS
89 Defines interval between syncing visualizer and audio outputs.
90 .TP
91 .B visualizer_type = spectrum/wave/wave_filled/ellipse
92 Defines default visualizer type (spectrum is available only if ncmpcpp was compiled with fftw support).
93 .TP
94 .B visualizer_look = STRING
95 Defines visualizer's look (string has to be exactly 2 characters long: first one is for wave whereas second for frequency spectrum).
96 .TP
97 .B visualizer_color = COLORS
98 Comma separated list of colors to be used in music visualization.
99 .TP
100 .B system_encoding = ENCODING
101 If you use encoding other than utf8, set it in order to handle utf8 encoded strings properly.
103 .B playlist_disable_highlight_delay = SECONDS
104 Delay for highlighting playlist since the last key was pressed. If set to 0, highlighting never fades away.
106 .B message_delay_time = SECONDS
107 Delay for displayed messages to remain visible.
109 .B song_list_format
110 Format for songs' list.
112 .B song_status_format
113 Song's format for statusbar.
115 .B song_library_format
116 .B alternative_header_first_line_format = TEXT
117 Now playing song format for the first line in alternative user interface header window.
119 .B alternative_header_second_line_format = TEXT
120 Now playing song format for the second line in alternative user interface header window.
122 .B now_playing_prefix = TEXT
123 Prefix for currently playing song.
125 .B now_playing_suffix = TEXT
126 Suffix for currently playing song.
128 .B browser_playlist_prefix = TEXT
129 Prefix for playlists in Browser.
131 .B selected_item_prefix = TEXT
132 Prefix for selected items.
134 .B selected_item_suffix = TEXT
135 Suffix for selected items.
137 .B modified_item_prefix = TEXT
138 Prefix for modified item (tag editor).
140 .B browser_sort_mode
141 Determines sort mode for browser. Possible values are "name", "mtime", "format" and "noop".
143 .B browser_sort_format
144 Format to use for sorting songs in browser. For this option to be effective, browser_sort_mode must be set to "format".
146 .B song_window_title_format
147 Song format for window title.
149 .B song_columns_list_format
150 Format for songs' list displayed in columns.
152 .B execute_on_song_change = COMMAND
153 Shell command to execute on song change.
155 .B execute_on_player_state_change = COMMAND
156 Shell command to execute on player state change. The environment variable
157 .B MPD_PLAYER_STATE
158 is set to the current state (either unknown, play, pause, or stop) for its duration.
160 .B playlist_show_mpd_host = yes/no
161 If enabled, current MPD host will be shown in playlist.
163 .B playlist_show_remaining_time = yes/no
164 If enabled, time remaining to end of playlist will be shown after playlist statistics.
166 .B playlist_shorten_total_times = yes/no
167 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).
169 .B playlist_separate_albums = yes/no
170 If enabled, separators will be placed between albums.
172 .B playlist_display_mode = classic/columns
173 Default display mode for Playlist.
175 .B browser_display_mode = classic/columns
176 Default display mode for Browser.
178 .B search_engine_display_mode = classic/columns
179 Default display mode for Search engine.
181 .B playlist_editor_display_mode = classic/columns
182 Default display mode for Playlist editor.
184 .B discard_colors_if_item_is_selected = yes/no
185 Indicates whether custom colors of tags have to be discarded if item is selected or not.
187 .B incremental_seeking = yes/no
188 If enabled, seek time will increment by one each second of seeking.
190 .B seek_time = SECONDS
191 Base seek time to begin with.
193 .B volume_change_step = NUMBER
194 Number of percents volume has to be increased/decreased by in volume_up/volume_down.
196 .B autocenter_mode = yes/no
197 Default state for autocenter mode at start.
199 .B centered_cursor = yes/no
200 If enabled, currently highlighted position in the list will be always centered.
202 .B progressbar_look = TEXT
203 This variable defines the look of progressbar. Note that it has to be exactly two or three characters long.
205 .B progressbar_boldness = yes/no
206 This variable defines whether progressbar should be displayed in bold or not.
208 .B default_place_to_search_in = database/playlist
209 If set to "playlist", Search engine will perform searching in current MPD playlist rather than in music database.
211 .B user_interface = classic/alternative
212 Default user interface used by ncmpcpp at start.
214 .B data_fetching_delay = yes/no
215 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.
217 .B media_library_primary_tag = artist/album_artist/date/genre/composer/performer
218 Default tag type for leftmost column in media library.
220 .B default_find_mode = wrapped/normal
221 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.
223 .B default_tag_editor_pattern = TEXT
224 Default pattern used by Tag editor's parser.
226 .B header_visibility = yes/no
227 If enabled, header window will be displayed, otherwise hidden.
229 .B statusbar_visibility = yes/no
230 If enabled, statusbar will be displayed, otherwise hidden.
232 .B titles_visibility = yes/no
233 If enabled, column titles will be displayed, otherwise hidden.
235 .B header_text_scrolling = yes/no
236 If enabled, text in header window will scroll if its length is longer then actual screen width, otherwise it won't.
238 .B cyclic_scrolling = yes/no
239 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)
241 .B lines_scrolled = NUMBER
242 Number of lines that are scrolled with mouse wheel.
244 .B follow_now_playing_lyrics = yes/no
245 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).
247 .B fetch_lyrics_for_current_song_in_background = yes/no
248 If enabled, each time song changes lyrics fetcher will be automatically run in background in attempt to download lyrics for currently playing song.
250 .B store_lyrics_in_song_dir = yes/no
251 If enabled, lyrics will be saved in song's directory, otherwise in ~/.lyrics. Note that it needs properly set mpd_music_dir.
253 .B generate_win32_compatible_filenames = yes/no
254 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.
256 .B allow_for_physical_item_deletion = yes/no
257 If set to yes, it will be possible to physically delete files and directories from the disk in the browser.
259 .B lastfm_preferred_language = ISO 639 alpha-2 language code
260 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.
262 .B show_hidden_files_in_local_browser = yes/no
263 Trigger for displaying in local browser files and directories that begin with '.'
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.
268 .B startup_screen = SCREEN_NAME
269 Screen that has to be displayed at start (playlist by default).
271 .B startup_slave_screen = SCREEN_NAME
272 Slave screen that has to be displayed at start (nothing by default).
274 .B startup_slave_screen_focus = yes/no
275 If set to yes, slave screen will be the active one after startup. Otherwise master screen will be.
276 .TP 
277 .B locked_screen_width_part = 20-80
278 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.
280 .B ask_for_locked_screen_width_part = yes/no
281 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.
283 .B jump_to_now_playing_song_at_start = yes/no
284 If enabled, ncmpcpp will jump at start to now playing song if mpd is playing or paused.
286 .B ask_before_clearing_playlists = yes/no
287 If enabled, user will be asked if he really wants to clear the playlist after pressing key responsible for that.
289 .B clock_display_seconds = yes/no
290 If enabled, clock will display time in format hh:mm:ss, otherwise hh:mm.
292 .B display_volume_level = yes/no
293 If enabled, volume level will be displayed in statusbar, otherwise not.
295 .B display_bitrate = yes/no
296 If enabled, bitrate of currently playing song will be displayed in statusbar.
298 .B display_remaining_time = yes/no
299 If enabled, remaining time of currently playing song will be be displayed in statusbar instead of elapsed time.
301 .B regular_expressions = none/basic/extended/perl
302 Type of currently used regular expressions.
304 .B ignore_leading_the = yes/no
305 If enabled, word "the" at the beginning of tags/filenames/sort format will be ignored while sorting items.
307 .B block_search_constraints_change_if_items_found = yes/no
308 If enabled, fields in Search engine above "Reset" button will be blocked after successful searching, otherwise they won't.
310 .B mouse_support = yes/no
311 If set to yes, mouse support will be enabled.
313 .B mouse_list_scroll_whole_page = yes/no
314 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.
316 .B empty_tag_marker = TEXT
317 Text that will be displayed, if requested tag is not set.
319 .B tags_separator = TEXT
320 Separator that is placed between tags. Also interpreted by tag editor which splits input string into separate tags using it.
322 .B tag_editor_extended_numeration = yes/no
323 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.
325 .B media_library_sort_by_mtime = yes/no
326 If enabled, media library will be sorted by modification time. Otherwise lexicographic sorting is used.
328 .B enable_window_title = yes/no
329 If enabled, ncmpcpp will override current window title with its own one.
331 .B search_engine_default_search_mode = MODE_NUMBER
332 Number of default mode used in search engine.
334 .B external_editor = PATH
335 Path to external editor used to edit lyrics.
337 .B use_console_editor = yes/no
338 If your external editor is console application, you need to enable it.
340 .B colors_enabled = yes/no
341 No need to describe it, huh?
343 .B empty_tag_color = COLOR
344 Color of empty tag marker.
346 .B header_window_color = COLOR
347 Color of header window.
349 .B volume_color = COLOR
350 Color of volume state.
352 .B state_line_color = COLOR
353 Color of lines separating header and statusbar from main window.
355 .B state_flags_color = COLOR
356 Color of MPD status flags.
358 .B main_window_color = COLOR
359 Color of main window.
361 .B color1 = COLOR
362 One of colors used in Song info, Tiny tag editor and Search engine.
364 .B color2 = COLOR
365 One of colors used in Song info, Tiny tag editor and Search engine.
367 .B main_window_highlight_color = COLOR
368 Color of main window's highlight.
370 .B progressbar_color = COLOR
371 Color of progressbar.
373 .B progressbar_elapsed_color = COLOR
374 Color of part of progressbar that represents elapsed time.
376 .B statusbar_color = COLOR
377 Color of statusbar.
379 .B alternative_ui_separator_color = COLOR
380 Color of separators used in alternative user interface.
382 .B active_column_color = COLOR
383 Color of active column's highlight.
385 .B window_border_color = BORDER
386 Border color of pop-up windows. If set to 'none', no border will be shown.
388 .B active_window_border = COLOR
389 Color of active window's border.
391 .SH "BINDINGS"
392 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).
394 You can view current keybindings by pressing F1.
395 .SH "SONG FORMAT"
397 For song format you can use:
399  %l - length
400  %f - filename
401  %D - directory
402  %a - artist
403  %A - album artist
404  %t - title
405  %b - album
406  %y - date
407  %n - track number (01/12 -> 01)
408  %N - full track info (01/12 -> 01/12)
409  %g - genre
410  %c - composer
411  %p - performer
412  %d - disc
413  %C - comment
414  %P - priority
415  $R - begin right alignment
417 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.
419 \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'.
421 \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.
423 Text can have different color than the main window, e.g. if you want length to be green, write $3%l$9.
425 Available values for colors:
427  - 0 - default window color (discards all other colors)
428  - 1 - black
429  - 2 - red
430  - 3 - green
431  - 4 - yellow
432  - 5 - blue
433  - 6 - magenta
434  - 7 - cyan
435  - 8 - white
436  - 9 - end of current color
438 \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.
440 .SH "BUGS"
441 Report bugs on http://www.musicpd.org/mantis/
442 .SH "NOTE"
443 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).
444 .SH "HOMEPAGE"
445 -> http://unkart.ovh.org/ncmpcpp
447 .SH "SEE ALSO"
448 mpc(1), mpd(1)