Code

Documentation update for 0.11.0
[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 -------------------------------------------------------------------------------
17 Download the ncmpc source code, then:
18         $ tar zxvf ncmpc-x.y.z.tar.gz
19         $ cd ncmpc-x.y.z
20         $ ./configure
21         $  make
22         $  make install
26 Upgrading to ncmpc-0.11.0 
27 ------------------------------------------------------------------------------
28 The syntax for the configuration file (~/.ncmpc/config) has changed, view the
29 manual page or the sample configuration file for details.
31 The old key binding to the select command (space,a) will result in a 
32 conflict as the a key is used for the new add command in 0.11.0. The easy 
33 solution is to delete your old key bindings (~/.ncmpc/keys), but you can use 
34 the built in key editor to solve any key conflicts.
38 Usage
39 -------------------------------------------------------------------------------
40 ncmpc connects to a MPD running on a machine on the local network. 
41 By default, ncmpc  connects  to  localhost:6600.   This  can  be
42 changed  either  at  compile-time,  or  by  exporting  the MPD_HOST and
43 MPD_PORT environment variables, or by the command line  options  --host
44 and --port.
46         $ ncmpc --host=musicserver --port=44000
48 For more information please view ncmpc's manual page.
53 Web Page, Forums and Bug Reports
54 -------------------------------------------------------------------------------
55         * Read more about ncmpc & MPD on http://www.musicpd.org
56         * a ncmpc forum exists at musicpd.org - http://www.musicpd.org/forum
57         * report bugs at musicpd.org - http://www.musicpd.org/mantis/
62 -------------------------------------------------------------------------------
63 $Id$