doc/ncmpc.1

   1 .TH "ncmpc" "1" "June 2005" "" ""
   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:6600.
  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 .B \-f, \-\-config=FILE
  52 Read configuration from file.
  53 .TP
  54 .B \-k, \-\-key\-file=FILE
  55 Read key bindings from FILE.
  56 .TP
  57 .B \-P, \-\-no\-splash=FILE
  58 Disable the splash screen.
  59 .TP
  60 Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
  61 .SH "CONFIGURATION"
  62 When ncmpc start it tries to read user setting from the ~/.ncmpc/config. 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.
  63
  64 Base colors are: black, red, green, yellow, blue, magenta, cyan and white.
  65
  66 Possible text colors are the base colors plus grey, brightred, brightgreen, brightyellow, brightblue, brightmagenta, brightcyan and brightwhite.
  67
  68
  69 Supported configuration options:
  70 .TP
  71 .B auto\-center = yes|no
  72 Enable/disable auto center mode. When auto center mode is enabled
  73 ncmpc centers the current track in the playlist window.
  74 .TP
  75 .B wide\-cursor = yes|no
  76 Make the cursor as wide as the screen.
  77 .TP
  78 .B hide\-cursor = NUM
  79 Hide the playlist cursor after NUM seconds of inactivity.
  80 .TP
  81 .B wrap\-around = yes|no
  82 Wrapped cursor movement.
  83 .TP
  84 .B find\-wrap = yes|no
  85 Wrapped find mode.
  86 .TP
  87 .B audible\-bell = yes|no
  88 Sound audible bell on alerts.
  89 .TP
  90 .B visible\-bell = yes|no
  91 Visible bell on alerts.
  92 .TP
  93 .B crossfade\-time = CROSSFADE TIME
  94 Default crossfade time in Seconds
  95 .TP
  96 .B scroll = yes|no
  97 Scroll the title if it is too long for the screen.
  98 .TP
  99 .B scroll\-sep = STRING
 100 The separator to show at the end of the scrolling title.
 101 .TP
 102 .B seek\-time = NUM
 103 Seek forward/backward by NUM seconds.
 104 .TP
 105 .B list\-format = SONG FORMAT
 106 The format used to display songs in the main window.
 107 .TP
 108 .B status\-format = SONG FORMAT
 109 The format used to display songs on the status line.
 110 .TP
 111 .B host = HOST
 112 Connect to mpd running on specified host
 113 .TP
 114 .B port = PORT
 115 Connect to mpd on the specified port
 116 .TP
 117 .B set\-xterm\-title = yes|no
 118 Change the XTerm title (ncmpc will not restore the title).
 119 .TP
 120 .B lyrics\-timeout = NUM
 121 Quits downloading lyrics of a song after the timeout of NUM seconds is reached.
 122 .TP
 123 .B xterm\-title\-format = SONG FORMAT
 124 The format used to for the xterm title when ncmpc is playing.
 125 .TP
 126 .B enable\-colors = yes|no
 127 Enable/disable colors.
 128 .TP
 129 .B show\-splash = yes|no
 130 Show/hide the splash screen.
 131 .TP
 132 .B color background = COLOR
 133 Set the background color. If the background color is assigned to the keyword \fBnone\fR, ncmpc will not change the background color. Only the base colors are valid background colors.
 134 .TP
 135 .B color title = TEXTCOLOR
 136 Set the text color for the title row.
 137 .TP
 138 .B timedisplay-type = elapsed/remaining
 139 Sets whether to display remaining or elapsed time in the status window. Default is elapsed.
 140 .TP
 141 .B color title\-bold = TEXTCOLOR
 142 Set the text color for the title row (the bold part).
 143 .TP
 144 .B color line = TEXTCOLOR
 145 Set the color of the line on the second row.
 146 .TP
 147 .B color line\-flags = TEXTCOLOR
 148 Set the text color used to indicate mpd flags on the second row.
 149 .TP
 150 .B color list = TEXTCOLOR
 151 Set the text color in the main area of ncmpc.
 152 .TP
 153 .B color list\-bold = TEXTCOLOR
 154 Set the bold text color in the main area of ncmpc.
 155 .TP
 156 .B color progressbar = TEXTCOLOR
 157 Set the color of the progress indicator.
 158 .TP
 159 .B color status\-state = TEXTCOLOR
 160 Set the text color used to display mpd status in the status window.
 161 .TP
 162 .B color status\-song = TEXTCOLOR
 163 Set the text color used to display song names in the status window.
 164 .TP
 165 .B color status\-time = TEXTCOLOR
 166 Set the text color used to display time the status window.
 167 .TP
 168 .B color alert = TEXTCOLOR
 169 Text color used to display alerts in the status window.
 170 .TP
 171 .B colordef COLOR = R, G, B
 172 Redefine any of the base colors. The RGB values must be an integer value between 0 and 1000.
 173 \fBNote\fR: Only some terminals allow redefinitions of colors!
 174 .SH "KEYS"
 175 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).
 176
 177 You can view ncmpc's key bindings by pressing '1' (help) when
 178 ncmpc is running. To edit key bindings use the key editor in ncmpc (press 'K').
 179 .SH "SONG FORMAT"
 180 Format of song display for status and the list window.
 181 The  metadata  delimeters  are: %name%, %artist%, %track%, %time%, %file%, %shortfile%.
 182
 183 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.
 184
 185 Some  useful examples for format are:
 186
 187    "%file%"
 188
 189 and
 190
 191    "[[%artist% \- ]%title%]|[%file]"
 192 .SH "BUGS"
 193 Report bugs on http://www.musicpd.org/mantis/
 194 .SH "NOTE"
 195 Since MPD uses UTF\-8, ncmpc needs to convert characters to the
 196 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).
 197
 198 .SH "SEE ALSO"
 199 mpc(1), mpd(1), locale(5), locale(7)