Code

INSTALL: replaced generic instructions
[ncmpc.git] / README
2 Overview
3 ------------------------------------------------------------------------------
4 ncmpc is a curses client for the Music Player Daemon (MPD). ncmpc connects to 
5 a MPD running on a machine on the local network, and controls this with an 
6 interface inspired by cplay. 
8 Music Player Daemon (MPD) allows remote access for playing music (MP3, 
9 Ogg Vorbis, FLAC, AAC, and wave files) and managing playlists. MPD is 
10 designed for integrating a computer into a stereo system that provides 
11 control for music playback over a local network. Read more at musicpd.org
15 How to compile and install ncmpc
16 -------------------------------------------------------------------------------
18 See the INSTALL file.
21 Upgrading to ncmpc-0.11.0 
22 ------------------------------------------------------------------------------
23 The syntax for the configuration file (~/.ncmpc/config) has changed, view the
24 manual page or the sample configuration file for details.
26 The old key binding to the select command (space,a) will result in a 
27 conflict as the a key is used for the new add command in 0.11.0. The easy 
28 solution is to delete your old key bindings (~/.ncmpc/keys), but you can use 
29 the built in key editor to solve any key conflicts.
33 Usage
34 -------------------------------------------------------------------------------
35 ncmpc connects to a MPD running on a machine on the local network. 
36 By default, ncmpc  connects  to  localhost:6600.   This  can  be
37 changed  either  at  compile-time,  or  by  exporting  the MPD_HOST and
38 MPD_PORT environment variables, or by the command line  options  --host
39 and --port.
41         $ ncmpc --host=musicserver --port=44000
43 For more information please view ncmpc's manual page.
48 Web Page, Forums and Bug Reports
49 -------------------------------------------------------------------------------
50         * Read more about ncmpc & MPD on http://www.musicpd.org
51         * a ncmpc forum exists at musicpd.org - http://www.musicpd.org/forum
52         * report bugs at musicpd.org - http://www.musicpd.org/mantis/