Code

Use glib's functions (g_strlcat, g_strlcpy, g_snprintf, g_strdup_vprintf)
[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 Requirements:
19         * ncurses 
20         * glib-2.2 (2.4 for NLS support)
22 Download the ncmpc source code, then:
23         $ tar zxvf ncmpc-x.y.z.tar.gz
24         $ cd ncmpc-x.y.z
25         $ ./configure
26         $  make
27         $  make install
31 Upgrading to ncmpc-0.11.0 
32 ------------------------------------------------------------------------------
33 The syntax for the configuration file (~/.ncmpc/config) has changed, view the
34 manual page or the sample configuration file for details.
36 The old key binding to the select command (space,a) will result in a 
37 conflict as the a key is used for the new add command in 0.11.0. The easy 
38 solution is to delete your old key bindings (~/.ncmpc/keys), but you can use 
39 the built in key editor to solve any key conflicts.
43 Usage
44 -------------------------------------------------------------------------------
45 ncmpc connects to a MPD running on a machine on the local network. 
46 By default, ncmpc  connects  to  localhost:6600.   This  can  be
47 changed  either  at  compile-time,  or  by  exporting  the MPD_HOST and
48 MPD_PORT environment variables, or by the command line  options  --host
49 and --port.
51         $ ncmpc --host=musicserver --port=44000
53 For more information please view ncmpc's manual page.
58 Web Page, Forums and Bug Reports
59 -------------------------------------------------------------------------------
60         * Read more about ncmpc & MPD on http://www.musicpd.org
61         * a ncmpc forum exists at musicpd.org - http://www.musicpd.org/forum
62         * report bugs at musicpd.org - http://www.musicpd.org/mantis/
67 -------------------------------------------------------------------------------
68 $Id$