Code

README: convert to reStructuredText
[ncmpc.git] / README.rst
1 ncmpc
2 =====
4 Overview
5 --------
7 ncmpc is a curses client for the `Music Player Daemon
8 <http://www.musicpd.org/>`__.  ncmpc connects to a MPD running on a
9 machine on the local network, and controls this with an interface
10 inspired by cplay.
12 Music Player Daemon (MPD) allows remote access for playing music (MP3, 
13 Ogg Vorbis, FLAC, AAC, and wave files) and managing playlists. MPD is 
14 designed for integrating a computer into a stereo system that provides 
15 control for music playback over a local network. Read more at musicpd.org
19 How to compile and install ncmpc
20 --------------------------------
22 See the `INSTALL <INSTALL>`__ file.
25 Usage
26 -----
28 ncmpc connects to a MPD running on a machine on the local network. 
29 By default, ncmpc  connects  to  localhost:6600.   This  can  be
30 changed  either  at  compile-time,  or  by  exporting  the MPD_HOST and
31 MPD_PORT environment variables, or by the command line options `--host`
32 and `--port`::
34  ncmpc --host=musicserver --port=44000
36 For more information please view ncmpc's manual page.
39 Web Page, Forums and Bug Reports
40 --------------------------------
42 Home page and download:
43         http://www.musicpd.org/clients/ncmpc/
45 MPD's home page:
46         http://www.musicpd.org/
48 Bug tracker:
49         http://bugs.musicpd.org/
51 Forum:
52         http://forum.musicpd.org/