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 and build-time configuration.
  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 \-h, \-\-host=HOSTNAME
  46 Specify MPD host.
  47 .TP
  48 .B \-p, \-\-port=PORT
  49 Connect to server on PORT.
  50 .TP
  51 .B \-P, \-\-password=PASSWORD
  52 Use password when connecting.
  53 .TP
  54 .B \-f, \-\-config=FILE
  55 Read configuration from file.
  56 .TP
  57 .B \-k, \-\-key\-file=FILE
  58 Read key bindings from FILE.
  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 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 in the output of the --version option). An example configuration file (config.sample) should be provided with ncmpc.
  63
  64
  65
  66 .SS Connection
  67 .TP
  68 .B host = HOST
  69 Connect to mpd running on the specified host.
  70 .TP
  71 .B port = PORT
  72 Connect to mpd on the specified port.
  73 .TP
  74 .B password = PASSWORD
  75 Connect to mpd using the specified password.
  76 .TP
  77 .B timeout = TIMEOUT
  78 Attempt to reconnect to mpd if a response to a command is not received within
  79 TIMEOUT seconds. Specifying a value in the configuration file overrides the
  80 "MPD_TIMEOUT" environment variable. If no timeout is specified in the
  81 configuration file or in the environment, the default is 5 seconds.
  82 .SS Interface
  83 .TP
  84 .B enable\-mouse = yes|no
  85 Enable mouse support (if enabled at compile time).
  86 .TP
  87 .B screen\-list = SCREEN1 SCREEN2...
  88 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, outputs, and chat.
  89 .TP
  90 .B search\-mode = MODE
  91 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.).
  92 .TP
  93 .B auto\-center = yes|no
  94 Enable/disable auto center mode. When auto center mode is enabled
  95 ncmpc centers the current track in the playlist window.
  96 .TP
  97 .B scroll-offset = NUM
  98 Keep at least NUM lines above and below the cursor on list windows, if possible.
  99 .TP
 100 .B find\-show\-last = yes|no
 101 Show the most recent query instead of a blank line for a find.
 102 .TP
 103 .B find\-wrap = yes|no
 104 Wrapped find mode.
 105 .TP
 106 .B wrap\-around = yes|no
 107 Wrapped cursor movement.
 108 .TP
 109 .B bell\-on\-wrap = yes|no
 110 Ring bell when find wraps around.
 111 .TP
 112 .B audible\-bell = yes|no
 113 Sound audible bell on alerts.
 114 .TP
 115 .B visible\-bell = yes|no
 116 Visible bell on alerts.
 117 .TP
 118 .B crossfade\-time = CROSSFADE TIME
 119 Default crossfade time in seconds.
 120 .TP
 121 .B seek\-time = NUM
 122 Seek forward/backward by NUM seconds.
 123 .TP
 124 .B lyrics\-timeout = NUM
 125 Quits downloading lyrics of a song after the timeout of NUM seconds is reached, if NUM is greater than zero.
 126 .TP
 127 .B jump\-prefix\-only = yes|no
 128 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".
 129 .TP
 130 .B lyrics\-autosave = yes|no
 131 Automatically save lyrics after receiving them.
 132 .TP
 133 .B lyrics\-show\-plugin = yes|no
 134 Show the name of the plugin used to receive lyrics on the lyrics screen.
 135 .TP
 136 .B text\-editor = EDITOR
 137 The text editor used for editing lyrics.
 138 .TP
 139 .B text\-editor\-ask = yes|no
 140 Ask before starting an editor.
 141 .TP
 142 .B chat\-prefix = PREFIX
 143 Prefix messages send with the chat screen with PREFIX. By default they are prefixed with the current user name enclosed by \fB<\fR and \fB>\fR and a space (i.e. "<name> ").
 144 .TP
 145 .B second-column = yes|no
 146 Display song length in a second column.
 147 .SS Display
 148 .TP
 149 .B welcome\-screen\-list = yes|no
 150 Show a list of the screens in the top line on startup.
 151 .TP
 152 .B wide\-cursor = yes|no
 153 Make the cursor as wide as the screen.
 154 .TP
 155 .B hardware\-cursor = yes|no
 156 Use the terminal's hardware cursor instead of inverse colors.
 157 .TP
 158 .B hide\-cursor = NUM
 159 Hide the playlist cursor after NUM seconds of inactivity.
 160 .TP
 161 .B scroll = yes|no
 162 Scroll the title if it is too long for the screen.
 163 .TP
 164 .B scroll\-sep = STRING
 165 the separator to show at the end of the scrolling title.
 166 .TP
 167 .B list\-format = SONG FORMAT
 168 The format used to display songs in the main window.
 169 .TP
 170 .B search\-format = SONG FORMAT
 171 The format used to display songs in the search window. Default is to use list\-format.
 172 .TP
 173 .B status\-format = SONG FORMAT
 174 The format used to display songs on the status line.
 175 .TP
 176 .B status\-message\-time = TIME
 177 The time, in seconds, for which status messages will be displayed.
 178 .TP
 179 .B display\-time = yes|no
 180 Display the time in the status bar when idle.
 181 .TP
 182 .B timedisplay-type = elapsed/remaining
 183 Sets whether to display remaining or elapsed time in the status window. Default is elapsed.
 184 .TP
 185 .B visible\-bitrate = yes|no
 186 Show the bitrate in the status bar when playing a stream.
 187 .B
 188 .TP
 189 .B set\-xterm\-title = yes|no
 190 Change the XTerm title (ncmpc will not restore the title).
 191 .TP
 192 .B xterm\-title\-format = SONG FORMAT
 193 The format used to for the xterm title when ncmpc is playing.
 194 .SS Colors
 195 .TP
 196 .B enable\-colors = yes|no
 197 Enable/disable colors.
 198 .TP
 199 .B color background = COLOR
 200 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.
 201 .TP
 202 .B color title = COLOR[,ATTRIBUTE]...
 203 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.
 204 .TP
 205 .B color title\-bold = COLOR[,ATTRIBUTE]...
 206 Set the text color for the title row (the bold part).
 207 .TP
 208 .B color line = COLOR
 209 Set the color of the line on the second row.
 210 .TP
 211 .B color line\-flags = COLOR[,ATTRIBUTE]...
 212 Set the text color used to indicate mpd flags on the second row.
 213 .TP
 214 .B color list = COLOR[,ATTRIBUTE]...
 215 Set the text color in the main area of ncmpc.
 216 .TP
 217 .B color list\-bold = COLOR[,ATTRIBUTE]...
 218 Set the bold text color in the main area of ncmpc.
 219 .TP
 220 .B color browser-directory = COLOR[,ATTRIBUTE]...
 221 Set the text color used to display directories in the browser window.
 222 .TP
 223 .B color browser-playlist = COLOR[,ATTRIBUTE]...
 224 Set the text color used to display playlists in the browser window.
 225 .TP
 226 .B color progressbar = COLOR[,ATTRIBUTE]...
 227 Set the color of the progress indicator.
 228 .TP
 229 .B color status\-state = COLOR[,ATTRIBUTE]...
 230 Set the text color used to display mpd status in the status window.
 231 .TP
 232 .B color status\-song = COLOR[,ATTRIBUTE]...
 233 Set the text color used to display song names in the status window.
 234 .TP
 235 .B color status\-time = COLOR[,ATTRIBUTE]...
 236 Set the text color used to display time the status window.
 237 .TP
 238 .B color alert = COLOR[,ATTRIBUTE]...
 239 Set the text color used to display alerts in the status window.
 240 .TP
 241 .B colordef COLOR = R, G, B
 242 Redefine any of the base colors. The RGB values must be integer values between 0 and 1000.
 243 \fBNote\fR: Only some terminals allow redefinitions of colors!
 244
 245 .SH "KEYS"
 246 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).
 247
 248 You can view ncmpc's key bindings by pressing '1' (help) when
 249 ncmpc is running. To edit key bindings press 'K' and use the key editor in ncmpc.
 250 .SH "SONG FORMAT"
 251 Format of song display for status and the list window.
 252 The metadata delimiters are: %artist%, %albumartist%, %composer%,
 253 %performer%, %title%, %album%, %shortalbum%, %track%, %disc,
 254 %genre%, %name%, %time%, %date%, %file%, %shortfile%.
 255
 256 The [] operators are used to group output such that if none of the metadata delimiters between '[' and ']' are matched, then none of the characters between '[' and ']' are output; literal text is always output. '&' and '|' are logical operators for AND and OR. '#' is used to escape characters.
 257
 258 Some useful examples for format are:
 259
 260    "%file%"
 261
 262 and
 263
 264    "[[%artist% \- ]%title%]|%file%"
 265
 266 Another one is:
 267
 268    "[%artist%|(artist n/a)] - [%title%|(title n/a)]"
 269
 270 .SH "CHAT PROTOCOL"
 271 If ncmpc has been compiled with "chat" support, it uses the client-to-client protocol available in MPD 0.17 or higher to communicate with other clients. In order to receive messages it subscribes to the channel with the name "chat", and displays any message sent there as-is. When the user enters a message, it is first with the prefix specified by the \fBchat-prefix\fR option (or the default prefix), and then sent to the "chat" channel for others to read.
 272 .SH "BUGS"
 273 Report bugs on https://github.com/MusicPlayerDaemon/ncmpc/issues
 274 .SH "NOTE"
 275 Since MPD uses UTF\-8, ncmpc needs to convert characters to the
 276 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).
 277
 278 .SH "SEE ALSO"
 279 mpc(1), mpd(1), locale(5), locale(7)