ncmpc(1)
ncmpc(1)



NNAAMMEE
       ncmpc - curses Music Player Daemon (MPD) client.

SSYYNNOOPPSSIISS
       nnccmmppcc [options]

DDEESSCCRRIIPPTTIIOONN
       ncmpc is  a client for MPD, the Music Player Daemon.
       ncmpc connects to a MPD running on a machine on the
       local network.

       By default, ncmpc connects to  localhost:6600.   This
       can  be  changed either at compile-time, or by exporting
       the MPD_HOST and MPD_PORT envi‐ ronment variables,
       or by the command line options --host and --port.

       $ ncmpc --host=musicserver --port=44000

       To use a password with mpd, set MPD_HOST to
       password@host  or  use  the command  line option
       --password. Values from the command line overrides
       values from the environment.

       Read more about MPD on http://www.musicpd.org


OOPPTTIIOONNSS
       --??,, ----hheellpp
              Display help.

       --VV,, ----vveerrssiioonn
              Display version information.

       --cc,, ----ccoolloorrss
              Enable colors.

       --CC,, ----nnoo--ccoolloorrss
              Disable colors.

       --ee,, ----eexxiitt
              Exit on connection errors. The default is
              to reconnect.

       --hh,, ----hhoosstt==HHOOSSTTNNAAMMEE
              Specify MPD host.

       --pp,, ----ppoorrtt==PPOORRTT
              Connect to server on PORT.

       --PP,,
       ----ppaasssswwoorrdd==PPAASSSSWWOORRDD
              Use password when connecting.

       --ff,, ----ccoonnffiigg==FFIILLEE
              Read configuration from file.

       --PP,, ----kkeeyy--ffiillee==FFIILLEE
              Read key bindings from FILE.

       Mandatory or optional arguments to long options are
       also  mandatory  or optional for any corresponding
       short options.

CCOONNFFIIGGUURRAATTIIOONN
       When  ncmpc start it tries to read user setting from
       the ~/ncmpc/config file. If no user configuration is
       found ncmpc tries to load global set‐ tings  from
       $SYSCONFDIR/ncmpc/config  (the actual path is displayed
       on the help screen). An example configuration file
       (config.sample)  should be provided with ncmpc.

       Base  colors  are:  black,  red, green, yellow, blue,
       magenta, cyan and white.

       Possible text colors are the base colors plus
       grey, brightred,  bright‐ green,   brightyellow,
       brightblue,   brightmagenta,   brightcyan  and
       brightwhite.


       Supported configuration options:

       aauuttoo--cceenntteerr == yyeess||nnoo
              Enable/disable auto  center  mode.  When  auto
              center  mode  is enabled ncmpc centers the
              current track in the playlist window.

       wwiiddee--ccuurrssoorr == yyeess||nnoo
              Make the cursor as wide as the screen.

       wwrraapp--aarroouunndd == yyeess||nnoo
              Wrapped cursor movement.

       ffiinndd--wwrraapp == yyeess||nnoo
              Wrapped find mode.

       aauuddiibbllee--bbeellll ==
       yyeess||nnoo
              Sound audible bell on alerts.

       vviissiibbllee--bbeellll ==
       yyeess||nnoo
              Visible bell on alerts.

       lliisstt--ffoorrmmaatt == SSOONNGG
       FFOORRMMAATT
              The format used to display songs in the main
              window.

       ssttaattuuss--ffoorrmmaatt == SSOONNGG
       FFOORRMMAATT
              The format used to display songs on the status
              line.

       sseett--xxtteerrmm--ttiittllee ==
       yyeess||nnoo
              Change the XTerm title (ncmpc will not restore
              the title).

       xxtteerrmm--ttiittllee--ffoorrmmaatt
       == SSOONNGG FFOORRMMAATT
              The format used to for the xterm title when
              ncmpc is playing.

       eennaabbllee--ccoolloorrss ==
       yyeess||nnoo
              Enable/disable colors.

       ccoolloorr bbaacckkggrroouunndd ==
       CCOOLLOORR
              Set the background color. If the background
              color is assigned to the keyword nnoonnee,
              ncmpc will not change  the  background  color.
              Only the base colors are valid background colors.

       ccoolloorr ttiittllee ==
       TTEEXXTTCCOOLLOORR
              Set the text color for the title row.

       ccoolloorr ttiittllee--bboolldd ==
       TTEEXXTTCCOOLLOORR
              Set the text color for the title row (the
              bold part).

       ccoolloorr lliinnee ==
       TTEEXXTTCCOOLLOORR
              Set the color of the line on the second row.

       ccoolloorr lliinnee--ffllaaggss ==
       TTEEXXTTCCOOLLOORR
              Set the text color used to indicate mpd flags
              on the second row.

       ccoolloorr lliisstt ==
       TTEEXXTTCCOOLLOORR
              Set the text color in the main area of ncmpc.

       ccoolloorr lliisstt--bboolldd ==
       TTEEXXTTCCOOLLOORR
              Set the bold text color in the main area
              of ncmpc.

       ccoolloorr pprrooggrreessssbbaarr ==
       TTEEXXTTCCOOLLOORR
              Set the color of the progress indicator.

       ccoolloorr ssttaattuuss--ssttaattee
       == TTEEXXTTCCOOLLOORR
              Set the text color used to display mpd status
              in the status win‐ dow.

       ccoolloorr ssttaattuuss--ssoonngg ==
       TTEEXXTTCCOOLLOORR
              Set the text color used to display song names
              in the status win‐ dow.

       ccoolloorr ssttaattuuss--ttiimmee ==
       TTEEXXTTCCOOLLOORR
              Set the text color used to display time the
              status window.

       ccoolloorr aalleerrtt ==
       TTEEXXTTCCOOLLOORR
              Text color used to display alerts in the
              status window.

       ccoolloorrddeeff CCOOLLOORR == RR,,
       GG,, BB
              Redefine any of the base colors. The RGB values
              must be an inte‐ ger value between 0 and 1000.
              NNoottee: Only some  terminals  allow
              redefinitions of colors!

KKEEYYSS
       When  ncmpc  start  it  tries  to  read  user  key
       bindings  from  the ~/ncmpc/keys file. If no user key
       bindings is found ncmpc tries to load global  key
       bindings  from  $SYSCONFDIR/ncmpc/keys (the actual
       path is displayed on the help screen).

       You can view ncmpc's key bindings by pressing '1'
       (help) when ncmpc  is running. To edit key bindings
       use the key editor in ncmpc (press 'K').

SSOONNGG FFOORRMMAATT
       Format  of  song display for status and the list window.
       The  metadata delimeters  are: %name%, %artist%,
       %track%,  %time%,  %file%,  %short‐ file%.

       The  []  operators  is  used  to  group output such that
       if no metadata delimeters are found or matched between
       '[' and ']', then none of   the characters  between  '['
       and ']' are outputed. '&' and '|' are logical operators
       for and and or. '#'  is used to escape characters.

       Some  useful examples for format are:

          "%file%"

       and

          "[[%artist% - ]%title%]|[%file]"

BBUUGGSS
       Report bugs on http://www.musicpd.org/mantis/

NNOOTTEE
       Since MPD uses UTF-8, ncmpc needs to convert characters
       to the  charset used  by  the local system. If you
       get character conversion errors when your running
       ncmpc you probably need to set up  your  locale.
       This  is done  by  setting  any of the LC_CTYPE, LANG
       or LC_ALL enviroment vari‐ ables (LC_CTYPE only
       affects character handling).


SSEE AALLSSOO
       mpc(1), mpd(1), locale(5), locale(7)



                                   May 2004
                                   ncmpc(1)
