README.rst

   1 ncmpc
   2 =====
   3
   4 ncmpc is a curses client for the `Music Player Daemon
   5 <http://www.musicpd.org/>`__.
   6
   7
   8 How to compile and install ncmpc
   9 --------------------------------
  10
  11 You need:
  12
  13 - a C99 compliant compiler (e.g. gcc)
  14 - libmpdclient 2.9
  15 - `GLib 2.30 <https://developer.gnome.org/glib/>`__
  16 - `ncurses <https://www.gnu.org/software/ncurses/>`__
  17 - `Meson 0.37 <http://mesonbuild.com/>`__ and `Ninja <https://ninja-build.org/>`__
  18
  19 Run ``meson``:
  20
  21  meson . output
  22
  23 Compile and install::
  24
  25  ninja -C output
  26  ninja -C output install
  27
  28
  29 Usage
  30 -----
  31
  32 ncmpc connects to a MPD running on a machine on the local network.
  33 By default, ncmpc  connects  to  localhost:6600.   This  can  be
  34 changed  either  at  compile-time,  or  by  exporting  the MPD_HOST and
  35 MPD_PORT environment variables, or by the command line options ``--host``
  36 and ``--port``::
  37
  38  ncmpc --host=musicserver --port=44000
  39
  40 For more information please view ncmpc's manual page.
  41
  42
  43 Links
  44 -----
  45
  46 - `Home page and download <http://www.musicpd.org/clients/ncmpc/>`__
  47 - `git repository <https://github.com/MusicPlayerDaemon/ncmpc/>`__
  48 - `Bug tracker <https://github.com/MusicPlayerDaemon/ncmpc/issues>`__
  49 - `Forum <http://forum.musicpd.org/>`__