doc/ncmpc.1

   1 .TH "ncmpc" "1" "April 2004" "" ""
   2 .SH "NAME"
   3 ncmpc \- curses Music Player Daemon (MPD) client.
   4 .SH "SYNOPSIS"
   5 .B ncmpc
   6 [options]
   7 .SH "DESCRIPTION"
   8 ncmpc is  a client for MPD, the Music Player Daemon.
   9 ncmpc connects to a MPD running on a machine on the local
  10 network.
  11
  12 By default, ncmpc connects to localhost:2100.
  13 This can be changed either at compile\-time, or by exporting the
  14 MPD_HOST and MPD_PORT environment variables, or by the command line
  15 options \-\-host and \-\-port.
  16
  17 $ ncmpc \-\-host=musicserver \-\-port=44000
  18
  19 To use a password with mpd, set MPD_HOST to password@host
  20 or use the command line option \-\-password. Values from
  21 the command line overrides values from the environment.
  22
  23 Read more about MPD on http://www.musicpd.org
  24
  25 .SH "OPTIONS"
  26 .TP
  27 .B \-?, \-\-help
  28 Display help.
  29 .TP
  30 .B \-V,  \-\-version
  31 Display version information.
  32 .TP
  33 .B \-c,  \-\-colors
  34 Enable colors.
  35 .TP
  36 .B \-C,  \-\-no\-colors
  37 Disable colors.
  38 .TP
  39 .B \-e,  \-\-exit
  40 Exit on connection errors. The default is to reconnect.
  41 .TP
  42 .B \-h, \-\-host=HOSTNAME
  43 Specify MPD host.
  44 .TP
  45 .B \-p, \-\-port=PORT
  46 Connect to server on PORT.
  47 .TP
  48 .B \-P, \-\-password=PASSWORD
  49 Use password when connecting.
  50 .TP
  51 Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
  52 .SH "CONFIGURATION"
  53 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 settings from $SYSCONFDIR/ncmpc/config (the actual path is displayed on the help screen). An example configuration file (config.sample) should be provided with ncmpc.
  54
  55 Avalible colors: black, red, green, yellow, blue, magenta, cyan and white.
  56
  57 Supported configuration options:
  58 .TP
  59 .B auto_center = yes|no
  60 Enable/disable auto center mode. When auto center mode is enabled
  61 ncmpc centers the current track in the playlist window.
  62 .TP
  63 .B wide_cursor = yes|no
  64 Make the cursor as wide as the screen.
  65 .TP
  66 .B enable_colors = yes|no
  67 Enable/disable colors.
  68 .TP
  69 .B title_color = color
  70 Set the text color for the title row (first row).
  71 .TP
  72 .B line_color = color
  73 Set the color of the line on the second row.
  74 .TP
  75 .B list_color = color
  76 Set the text color in the main area of ncmpc.
  77 .TP
  78 .B progress_color = color
  79 Set the color of the progress indicator.
  80 .TP
  81 .B status_color = color
  82 Set the text color used in the status window (last row).
  83 .TP
  84 .B alert_color = color
  85 Text color used to display alerts in the status window.
  86 .SH "KEYS"
  87 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).
  88
  89 You can view ncmpc's key bindings by pressing '1' (help) when
  90 ncmpc is running. To edit key bindings use the key editor in ncmpc (press 'K').
  91 .SH "BUGS"
  92 Report bugs on http://www.musicpd.org/mantis/
  93 .SH "NOTE"
  94 Since MPD uses UTF\-8, ncmpc needs to convert characters to the
  95 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 variables (LC_CTYPE only affects character handling). For example if you want UK settings and use bash you should add the following line to your /etc/profile:
  96
  97   export LC_CTYPE=en_UK
  98
  99 .SH "SE ALSO"
 100 mpc(1), mpd(1), locale(5), locale(7)