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 -P, --key-file=FILE
57 Read key bindings from FILE.
58 Mandatory or optional arguments to long options are also mandatory or
60 optional for any corresponding short options.
61
63 When ncmpc start it tries to read user setting from the ~/ncmpc/config
64 file. If no user configuration is found ncmpc tries to load global set‐
65 tings from $SYSCONFDIR/ncmpc/config (the actual path is displayed on
66 the help screen). An example configuration file (config.sample) should
67 be provided with ncmpc.
68 Base colors are: black, red, green, yellow, blue, magenta, cyan and
70 white.
71 Possible text colors are the base colors plus grey, brightred, bright‐
73 green, brightyellow, brightblue, brightmagenta, brightcyan and
74 brightwhite.
75 Supported configuration options:
78 auto-center = yes|no
80 Enable/disable auto center mode. When auto center mode is
81 enabled ncmpc centers the current track in the playlist window.
82 wide-cursor = yes|no
84 Make the cursor as wide as the screen.
85 wrap-around = yes|no
87 Wrapped cursor movement.
88 find-wrap = yes|no
90 Wrapped find mode.
91 audible-bell = yes|no
93 Sound audible bell on alerts.
94 visible-bell = yes|no
96 Visible bell on alerts.
97 list-format = SONG FORMAT
99 The format used to display songs in the main window.
100 status-format = SONG FORMAT
102 The format used to display songs on the status line.
103 set-xterm-title = yes|no
105 Change the XTerm title (ncmpc will not restore the title).
106 xterm-title-format = SONG FORMAT
108 The format used to for the xterm title when ncmpc is playing.
109 enable-colors = yes|no
111 Enable/disable colors.
112 color background = COLOR
114 Set the background color. If the background color is assigned to
115 the keyword none, ncmpc will not change the background color.
116 Only the base colors are valid background colors.
117 color title = TEXTCOLOR
119 Set the text color for the title row.
120 color title-bold = TEXTCOLOR
122 Set the text color for the title row (the bold part).
123 color line = TEXTCOLOR
125 Set the color of the line on the second row.
126 color line-flags = TEXTCOLOR
128 Set the text color used to indicate mpd flags on the second row.
129 color list = TEXTCOLOR
131 Set the text color in the main area of ncmpc.
132 color list-bold = TEXTCOLOR
134 Set the bold text color in the main area of ncmpc.
135 color progressbar = TEXTCOLOR
137 Set the color of the progress indicator.
138 color status-state = TEXTCOLOR
140 Set the text color used to display mpd status in the status win‐
141 dow.
142 color status-song = TEXTCOLOR
144 Set the text color used to display song names in the status win‐
145 dow.
146 color status-time = TEXTCOLOR
148 Set the text color used to display time the status window.
149 color alert = TEXTCOLOR
151 Text color used to display alerts in the status window.
152 colordef COLOR = R, G, B
154 Redefine any of the base colors. The RGB values must be an inte‐
155 ger value between 0 and 1000. Note: Only some terminals allow
156 redefinitions of colors!
157
159 When ncmpc start it tries to read user key bindings from the
160 ~/ncmpc/keys file. If no user key bindings is found ncmpc tries to load
161 global key bindings from $SYSCONFDIR/ncmpc/keys (the actual path is
162 displayed on the help screen).
163 You can view ncmpc's key bindings by pressing '1' (help) when ncmpc is
165 running. To edit key bindings use the key editor in ncmpc (press 'K').
166
168 Format of song display for status and the list window. The metadata
169 delimeters are: %name%, %artist%, %track%, %time%, %file%, %short‐
170 file%.
171 The [] operators is used to group output such that if no metadata
173 delimeters are found or matched between '[' and ']', then none of the
174 characters between '[' and ']' are outputed. '&' and '|' are logical
175 operators for and and or. '#' is used to escape characters.
176 Some useful examples for format are:
178 "%file%"
180 and
182 "[[%artist% - ]%title%]|[%file]"
184
186 Report bugs on http://www.musicpd.org/mantis/
187
189 Since MPD uses UTF-8, ncmpc needs to convert characters to the charset
190 used by the local system. If you get character conversion errors when
191 your running ncmpc you probably need to set up your locale. This is
192 done by setting any of the LC_CTYPE, LANG or LC_ALL enviroment vari‐
193 ables (LC_CTYPE only affects character handling).
194
197 mpc(1), mpd(1), locale(5), locale(7)
198 May 2004 ncmpc(1)