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 \-m,  \-\-mouse
  40 Enable mouse.
  41 .TP
  42 .B \-M,  \-\-no\-mouse
  43 Disable mouse.
  44 .TP
  45 .B \-e,  \-\-exit
  46 Exit on connection errors. The default is to reconnect.
  47 .TP
  48 .B \-h, \-\-host=HOSTNAME
  49 Specify MPD host.
  50 .TP
  51 .B \-p, \-\-port=PORT
  52 Connect to server on PORT.
  53 .TP
  54 .B \-P, \-\-password=PASSWORD
  55 Use password when connecting.
  56 .TP
  57 .B \-f, \-\-config=FILE
  58 Read configuration from file.
  59 .TP
  60 .B \-k, \-\-key\-file=FILE
  61 Read key bindings from FILE.
  62 .TP
  63 Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
  64 .SH "CONFIGURATION"
  65 When ncmpc starts it tries to read the user's configuration file, ~/.ncmpc/config. If no user configuration file is found then ncmpc tries to load the 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.
  66
  67
  68
  69 .SS Connection
  70 .TP
  71 .B host = HOST
  72 Connect to mpd running on the specified host.
  73 .TP
  74 .B port = PORT
  75 Connect to mpd on the specified port.
  76 .TP
  77 .B password = PASSWORD
  78 Connect to mpd using the specified password.
  79 .TP
  80 .B timeout = TIMEOUT
  81 Attempt to reconnect to mpd if a response to a command is not received within
  82 TIMEOUT seconds. Specifying a value in the configuration file overrides the
  83 "MPD_TIMEOUT" environment variable. If no timeout is specified in the
  84 configuration file or in the environment, the default is 1.5 seconds.
  85 .SS Interface
  86 .TP
  87 .B enable\-mouse = yes|no
  88 Enable mouse support (if enabled at compile time).
  89 .TP
  90 .B screen\-list = SCREEN1 SCREEN2...
  91 A list of screens to cycle through when using the previous/next screen commands. Valid choices, if enabled at compile time, are playlist, browse, artist, help, search, song, keydef, lyrics, and outputs.
  92 .TP
  93 .B search\-mode = MODE
  94 Default search mode for the search screen. MODE must be one of title, artist, album, filename, and artist+title, or an interger index (0 for title, 1 for artist etc.).
  95 .TP
  96 .B auto\-center = yes|no
  97 Enable/disable auto center mode. When auto center mode is enabled
  98 ncmpc centers the current track in the playlist window.
  99 .TP
 100 .B scroll-offset = NUM
 101 Keep at least NUM lines above and below the cursor on list windows, if possible.
 102 .TP
 103 .B find\-show\-last = yes|no
 104 Show the most recent query instead of a blank line for a find.
 105 .TP
 106 .B find\-wrap = yes|no
 107 Wrapped find mode.
 108 .TP
 109 .B wrap\-around = yes|no
 110 Wrapped cursor movement.
 111 .TP
 112 .B bell\-on\-wrap = yes|no
 113 Ring bell when find wraps around.
 114 .TP
 115 .B audible\-bell = yes|no
 116 Sound audible bell on alerts.
 117 .TP
 118 .B visible\-bell = yes|no
 119 Visible bell on alerts.
 120 .TP
 121 .B crossfade\-time = CROSSFADE TIME
 122 Default crossfade time in seconds.
 123 .TP
 124 .B seek\-time = NUM
 125 Seek forward/backward by NUM seconds.
 126 .TP
 127 .B lyrics\-timeout = NUM
 128 Quits downloading lyrics of a song after the timeout of NUM seconds is reached, if NUM is greater than zero.
 129 .TP
 130 .B jump\-prefix\-only = yes|no
 131 When using the jump command, search for the prefix of an entry. That means typing "m" will start to the first entry which begins with "m".
 132 .TP
 133 .B lyrics\-autosave = yes|no
 134 Automatically save lyrics after receiving them.
 135 .TP
 136 .B lyrics\-show\-plugin = yes|no
 137 Show the name of the plugin used to receive lyrics on the lyrics screen.
 138 .TP
 139 .B text\-editor = EDITOR
 140 The text editor used for editing lyrics.
 141 .TP
 142 .B second-column = yes|no
 143 Display song length in a second column.
 144 .SS Display
 145 .TP
 146 .B welcome\-screen\-list = yes|no
 147 Show a list of the screens in the top line on startup.
 148 .TP
 149 .B wide\-cursor = yes|no
 150 Make the cursor as wide as the screen.
 151 .TP
 152 .B hardware\-cursor = yes|no
 153 Use the terminal's hardware cursor instead of inverse colors.
 154 .TP
 155 .B hide\-cursor = NUM
 156 Hide the playlist cursor after NUM seconds of inactivity.
 157 .TP
 158 .B scroll = yes|no
 159 Scroll the title if it is too long for the screen.
 160 .TP
 161 .B scroll\-sep = STRING
 162 the separator to show at the end of the scrolling title.
 163 .TP
 164 .B list\-format = SONG FORMAT
 165 The format used to display songs in the main window.
 166 .TP
 167 .B status\-format = SONG FORMAT
 168 The format used to display songs on the status line.
 169 .TP
 170 .B status\-message\-time = TIME
 171 The time, in seconds, for which status messages will be displayed.
 172 .TP
 173 .B display\-time = yes|no
 174 Display the time in the status bar when idle.
 175 .TP
 176 .B timedisplay-type = elapsed/remaining
 177 Sets whether to display remaining or elapsed time in the status window. Default is elapsed.
 178 .TP
 179 .B visible\-bitrate = yes|no
 180 Show the bitrate in the status bar when playing a stream.
 181 .B
 182 .TP
 183 .B set\-xterm\-title = yes|no
 184 Change the XTerm title (ncmpc will not restore the title).
 185 .TP
 186 .B xterm\-title\-format = SONG FORMAT
 187 The format used to for the xterm title when ncmpc is playing.
 188 .SS Colors
 189 .TP
 190 .B enable\-colors = yes|no
 191 Enable/disable colors.
 192 .TP
 193 .B color background = COLOR
 194 Set the background color. If the background color is assigned to the keyword \fBnone\fR, ncmpc will not change the background color. Standard colors are: black, red, green, yellow, blue, magenta, cyan and white. Terminal specific colors can also be given as integers.
 195 .TP
 196 .B color title = COLOR[,ATTRIBUTE]...
 197 Set the text color and attributes for the title row.  Text colors are the same as for the background.  Valid attributes are: standout, underline, reverse, blink, dim, and bold.
 198 .TP
 199 .B color title\-bold = COLOR[,ATTRIBUTE]...
 200 Set the text color for the title row (the bold part).
 201 .TP
 202 .B color line = COLOR
 203 Set the color of the line on the second row.
 204 .TP
 205 .B color line\-flags = COLOR[,ATTRIBUTE]...
 206 Set the text color used to indicate mpd flags on the second row.
 207 .TP
 208 .B color list = COLOR[,ATTRIBUTE]...
 209 Set the text color in the main area of ncmpc.
 210 .TP
 211 .B color list\-bold = COLOR[,ATTRIBUTE]...
 212 Set the bold text color in the main area of ncmpc.
 213 .TP
 214 .B color browser-directory = COLOR[,ATTRIBUTE]...
 215 Set the text color used to display directories in the browser window.
 216 .TP
 217 .B color browser-playlist = COLOR[,ATTRIBUTE]...
 218 Set the text color used to display playlists in the browser window.
 219 .TP
 220 .B color progressbar = COLOR[,ATTRIBUTE]...
 221 Set the color of the progress indicator.
 222 .TP
 223 .B color status\-state = COLOR[,ATTRIBUTE]...
 224 Set the text color used to display mpd status in the status window.
 225 .TP
 226 .B color status\-song = COLOR[,ATTRIBUTE]...
 227 Set the text color used to display song names in the status window.
 228 .TP
 229 .B color status\-time = COLOR[,ATTRIBUTE]...
 230 Set the text color used to display time the status window.
 231 .TP
 232 .B color alert = COLOR[,ATTRIBUTE]...
 233 Set the text color used to display alerts in the status window.
 234 .TP
 235 .B colordef COLOR = R, G, B
 236 Redefine any of the base colors. The RGB values must be integer values between 0 and 1000.
 237 \fBNote\fR: Only some terminals allow redefinitions of colors!
 238
 239 .SH "KEYS"
 240 When ncmpc starts it tries to read user-defined key bindings from the ~/.ncmpc/keys file. If no user-defined key bindings are found then ncmpc tries to load the global key bindings from $SYSCONFDIR/ncmpc/keys (the actual path is displayed on the help screen).
 241
 242 You can view ncmpc's key bindings by pressing '1' (help) when
 243 ncmpc is running. To edit key bindings press 'K' and use the key editor in ncmpc.
 244 .SH "SONG FORMAT"
 245 Format of song display for status and the list window.
 246 The  metadata  delimiters  are: %name%, %artist%, %track%, %time%, %file%, %shortfile%.
 247
 248 The [] operators are used to group output such that if no metadata delimiters are found or matched between '[' and ']', then none of  the  characters between '[' and ']' are output. '&' and '|' are logical operators for AND and OR. '#'  is used to escape characters.
 249
 250 Some  useful examples for format are:
 251
 252    "%file%"
 253
 254 and
 255
 256    "[[%artist% \- ]%title%]|[%file]"
 257 .SH "BUGS"
 258 Report bugs on http://www.musicpd.org/mantis/
 259 .SH "NOTE"
 260 Since MPD uses UTF\-8, ncmpc needs to convert characters to the
 261 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 environment variables (LC_CTYPE only affects character handling).
 262
 263 .SH "SEE ALSO"
 264 mpc(1), mpd(1), locale(5), locale(7)