1ncmpc(1) ncmpc(1)
2
6 ncmpc - curses Music Player Daemon (MPD) client.
7
9 ncmpc [options]
10
12 ncmpc is a client for MPD, the Music Player Daemon. ncmpc connects to
13 a MPD running on a machine on the local network.
14 By default, ncmpc connects to localhost:6600. This can be changed
16 either at compile-time, or by exporting the MPD_HOST and MPD_PORT envi‐
17 ronment variables, or by the command line options --host and --port.
18 $ ncmpc --host=musicserver --port=44000
20 To use a password with mpd, set MPD_HOST to password@host or use the
22 command line option --password. Values from the command line overrides
23 values from the environment.
24 Read more about MPD on http://www.musicpd.org
26
29 -?, --help
30 Display help.
31 -V, --version
33 Display version information.
34 -c, --colors
36 Enable colors.
37 -C, --no-colors
39 Disable colors.
40 -e, --exit
42 Exit on connection errors. The default is to reconnect.
43 -h, --host=HOSTNAME
45 Specify MPD host.
46 -p, --port=PORT
48 Connect to server on PORT.
49 -P, --password=PASSWORD
51 Use password when connecting.
52 -f, --config=FILE
54 Read configuration from file.
55 -k, --key-file=FILE
57 Read key bindings from FILE.
58 -P, --no-splash=FILE
60 Disable the splash screen.
61 Mandatory or optional arguments to long options are also mandatory or
63 optional for any corresponding short options.
64
66 When ncmpc start it tries to read user setting from the ~/.ncmpc/con‐
67 fig. If no user configuration is found ncmpc tries to load global set‐
68 tings from $SYSCONFDIR/ncmpc/config (the actual path is displayed on
69 the help screen). An example configuration file (config.sample) should
70 be provided with ncmpc.
71 Connection
76 host = HOST
77 Connect to mpd running on specified host
78 port = PORT
80 Connect to mpd on the specified port
81 password = PASSWORD
83 Connect to mpd using the specified password.
84 Interface
86 enable-mouse = yes|no
87 Enable mouse support (if enabled at compile time).
88 screen-list = SCREEN1 SCREEN2...
90 A list of screens to cycle through when using the previous/next
91 screen commands. Valid choices, if enabled at compile time, are
92 playlist, browse, artist, help, search, song, keydef, lyrics,
93 and outputs.
94 search-mode = MODE
96 Default search mode for the search screen. The mode is an inte‐
97 ger index, with 0 for title, 1 for artist, 2 for album, 3 for
98 filename, and 4 for artist+title.
99 auto-center = yes|no
101 Enable/disable auto center mode. When auto center mode is
102 enabled ncmpc centers the current track in the playlist window.
103 scroll-offset = NUM
105 Keep at least NUM lines above and below the cursor on list win‐
106 dows, if possible.
107 find-show-last = yes|no
109 Show the most recent query instead of a blank line for a find.
110 find-wrap = yes|no
112 Wrapped find mode.
113 wrap-around = yes|no
115 Wrapped cursor movement.
116 bell-on-wrap = yes|no
118 Ring bell when find wraps around.
119 audible-bell = yes|no
121 Sound audible bell on alerts.
122 visible-bell = yes|no
124 Visible bell on alerts.
125 crossfade-time = CROSSFADE TIME
127 Default crossfade time in seconds
128 seek-time = NUM
130 Seek forward/backward by NUM seconds.
131 lyrics-timeout = NUM
133 Quits downloading lyrics of a song after the timeout of NUM sec‐
134 onds is reached.
135 jump-prefix-only = yes|no
137 When using the jump command, search for the prefix of an entry.
138 That means typing "m" will start to the first entry which begins
139 with "m".
140 Display
142 welcome-screen-list = yes|no
143 Show a list of the screens in the top line on startup.
144 wide-cursor = yes|no
146 Make the cursor as wide as the screen.
147 hide-cursor = NUM
149 Hide the playlist cursor after NUM seconds of inactivity.
150 scroll = yes|no
152 Scroll the title if it is too long for the screen.
153 scroll-sep = STRING
155 The separator to show at the end of the scrolling title.
156 list-format = SONG FORMAT
158 The format used to display songs in the main window.
159 status-format = SONG FORMAT
161 The format used to display songs on the status line.
162 status-message-time = TIME
164 The time, in seconds, for which status messages will be dis‐
165 played.
166 display-time = yes|no
168 Display the time in the status bar when idle.
169 timedisplay-type = elapsed/remaining
171 Sets whether to display remaining or elapsed time in the status
172 window. Default is elapsed.
173 visible-bitrate = yes|no
175 Show the bitrate in the status bar when playing a stream.
176 set-xterm-title = yes|no
178 Change the XTerm title (ncmpc will not restore the title).
179 xterm-title-format = SONG FORMAT
181 The format used to for the xterm title when ncmpc is playing.
182 Colors
184 enable-colors = yes|no
185 Enable/disable colors.
186 color background = COLOR
188 Set the background color. If the background color is assigned to
189 the keyword none, ncmpc will not change the background color.
190 Valid background colors are the base colors: black, red, green,
191 yellow, blue, magenta, cyan and white.
192 color title = TEXTCOLOR
194 Set the text color for the title row. Possible text colors are
195 the base colors plus grey, brightred, brightgreen, brightyellow,
196 brightblue, brightmagenta, brightcyan and brightwhite.
197 color title-bold = TEXTCOLOR
199 Set the text color for the title row (the bold part).
200 color line = TEXTCOLOR
202 Set the color of the line on the second row.
203 color line-flags = TEXTCOLOR
205 Set the text color used to indicate mpd flags on the second row.
206 color list = TEXTCOLOR
208 Set the text color in the main area of ncmpc.
209 color list-bold = TEXTCOLOR
211 Set the bold text color in the main area of ncmpc.
212 color progressbar = TEXTCOLOR
214 Set the color of the progress indicator.
215 color status-state = TEXTCOLOR
217 Set the text color used to display mpd status in the status win‐
218 dow.
219 color status-song = TEXTCOLOR
221 Set the text color used to display song names in the status win‐
222 dow.
223 color status-time = TEXTCOLOR
225 Set the text color used to display time the status window.
226 color alert = TEXTCOLOR
228 Text color used to display alerts in the status window.
229 colordef COLOR = R, G, B
231 Redefine any of the base colors. The RGB values must be an inte‐
232 ger value between 0 and 1000. Note: Only some terminals allow
233 redefinitions of colors!
234
237 When ncmpc start it tries to read user key bindings from the
238 ~/.ncmpc/keys file. If no user key bindings is found ncmpc tries to
239 load global key bindings from $SYSCONFDIR/ncmpc/keys (the actual path
240 is displayed on the help screen).
241 You can view ncmpc's key bindings by pressing '1' (help) when ncmpc is
243 running. To edit key bindings use the key editor in ncmpc (press 'K').
244
246 Format of song display for status and the list window. The metadata
247 delimeters are: %name%, %artist%, %track%, %time%, %file%, %short‐
248 file%.
249 The [] operators is used to group output such that if no metadata
251 delimeters are found or matched between '[' and ']', then none of the
252 characters between '[' and ']' are outputed. '&' and '|' are logical
253 operators for and and or. '#' is used to escape characters.
254 Some useful examples for format are:
256 "%file%"
258 and
260 "[[%artist% - ]%title%]|[%file]"
262
264 Report bugs on http://www.musicpd.org/mantis/
265
267 Since MPD uses UTF-8, ncmpc needs to convert characters to the charset
268 used by the local system. If you get character conversion errors when
269 your running ncmpc you probably need to set up your locale. This is
270 done by setting any of the LC_CTYPE, LANG or LC_ALL enviroment vari‐
271 ables (LC_CTYPE only affects character handling).
272
275 mpc(1), mpd(1), locale(5), locale(7)
276 June 2005 ncmpc(1)