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 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.
  66
  67
  68
  69 .SS Connection
  70 .TP
  71 .B host = HOST
  72 Connect to mpd running on 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 .SS Interface
  80 .TP
  81 .B enable\-mouse = yes|no
  82 Enable mouse support (if enabled at compile time).
  83 .TP
  84 .B screen\-list = SCREEN1 SCREEN2...
  85 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.
  86 .TP
  87 .B search\-mode = MODE
  88 Default search mode for the search screen. The mode is an integer index, with 0 for title, 1 for artist, 2 for album, 3 for filename, and 4 for artist+title.
  89 .TP
  90 .B auto\-center = yes|no
  91 Enable/disable auto center mode. When auto center mode is enabled
  92 ncmpc centers the current track in the playlist window.
  93 .TP
  94 .B scroll-offset = NUM
  95 Keep at least NUM lines above and below the cursor on list windows, if possible.
  96 .TP
  97 .B find\-show\-last = yes|no
  98 Show the most recent query instead of a blank line for a find.
  99 .TP
 100 .B find\-wrap = yes|no
 101 Wrapped find mode.
 102 .TP
 103 .B wrap\-around = yes|no
 104 Wrapped cursor movement.
 105 .TP
 106 .B bell\-on\-wrap = yes|no
 107 Ring bell when find wraps around.
 108 .TP
 109 .B audible\-bell = yes|no
 110 Sound audible bell on alerts.
 111 .TP
 112 .B visible\-bell = yes|no
 113 Visible bell on alerts.
 114 .TP
 115 .B crossfade\-time = CROSSFADE TIME
 116 Default crossfade time in seconds
 117 .TP
 118 .B seek\-time = NUM
 119 Seek forward/backward by NUM seconds.
 120 .TP
 121 .B lyrics\-timeout = NUM
 122 Quits downloading lyrics of a song after the timeout of NUM seconds is reached.
 123 .TP
 124 .B jump\-prefix\-only = yes|no
 125 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".
 126 .TP
 127 .B lyrics\-autosave = yes|no
 128 Automatically save lyrics after receiving them.
 129 .TP
 130 .B lyrics\-show\-plugin = yes|no
 131 Show the name of the plugin used to receive lyrics on the lyrics screen.
 132 .TP
 133 .B second-column = yes|no
 134 Display song length in a second column.
 135 .SS Display
 136 .TP
 137 .B welcome\-screen\-list = yes|no
 138 Show a list of the screens in the top line on startup.
 139 .TP
 140 .B wide\-cursor = yes|no
 141 Make the cursor as wide as the screen.
 142 .TP
 143 .B hardware\-cursor = yes|no
 144 Use the terminal's hardware cursor instead of inverse colors.
 145 .TP
 146 .B hide\-cursor = NUM
 147 Hide the playlist cursor after NUM seconds of inactivity.
 148 .TP
 149 .B scroll = yes|no
 150 Scroll the title if it is too long for the screen.
 151 .TP
 152 .B scroll\-sep = STRING
 153 The separator to show at the end of the scrolling title.
 154 .TP
 155 .B list\-format = SONG FORMAT
 156 The format used to display songs in the main window.
 157 .TP
 158 .B status\-format = SONG FORMAT
 159 The format used to display songs on the status line.
 160 .TP
 161 .B status\-message\-time = TIME
 162 The time, in seconds, for which status messages will be displayed.
 163 .TP
 164 .B display\-time = yes|no
 165 Display the time in the status bar when idle.
 166 .TP
 167 .B timedisplay-type = elapsed/remaining
 168 Sets whether to display remaining or elapsed time in the status window. Default is elapsed.
 169 .TP
 170 .B visible\-bitrate = yes|no
 171 Show the bitrate in the status bar when playing a stream.
 172 .B
 173 .TP
 174 .B set\-xterm\-title = yes|no
 175 Change the XTerm title (ncmpc will not restore the title).
 176 .TP
 177 .B xterm\-title\-format = SONG FORMAT
 178 The format used to for the xterm title when ncmpc is playing.
 179 .SS Colors
 180 .TP
 181 .B enable\-colors = yes|no
 182 Enable/disable colors.
 183 .TP
 184 .B color background = COLOR
 185 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.
 186 .TP
 187 .B color title = COLOR[,ATTRIBUTE]...
 188 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.
 189 .TP
 190 .B color title\-bold = COLOR[,ATTRIBUTE]...
 191 Set the text color for the title row (the bold part).
 192 .TP
 193 .B color line = COLOR
 194 Set the color of the line on the second row.
 195 .TP
 196 .B color line\-flags = COLOR[,ATTRIBUTE]...
 197 Set the text color used to indicate mpd flags on the second row.
 198 .TP
 199 .B color list = COLOR[,ATTRIBUTE]...
 200 Set the text color in the main area of ncmpc.
 201 .TP
 202 .B color list\-bold = COLOR[,ATTRIBUTE]...
 203 Set the bold text color in the main area of ncmpc.
 204 .TP
 205 .B color browser-directory = COLOR[,ATTRIBUTE]...
 206 Set the text color used to display directories in the browser window.
 207 .TP
 208 .B color browser-playlist = COLOR[,ATTRIBUTE]...
 209 Set the text color used to display playlists in the browser window.
 210 .TP
 211 .B color progressbar = COLOR[,ATTRIBUTE]...
 212 Set the color of the progress indicator.
 213 .TP
 214 .B color status\-state = COLOR[,ATTRIBUTE]...
 215 Set the text color used to display mpd status in the status window.
 216 .TP
 217 .B color status\-song = COLOR[,ATTRIBUTE]...
 218 Set the text color used to display song names in the status window.
 219 .TP
 220 .B color status\-time = COLOR[,ATTRIBUTE]...
 221 Set the text color used to display time the status window.
 222 .TP
 223 .B color alert = COLOR[,ATTRIBUTE]...
 224 Text color used to display alerts in the status window.
 225 .TP
 226 .B colordef COLOR = R, G, B
 227 Redefine any of the base colors. The RGB values must be an integer value between 0 and 1000.
 228 \fBNote\fR: Only some terminals allow redefinitions of colors!
 229
 230 .SH "KEYS"
 231 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).
 232
 233 You can view ncmpc's key bindings by pressing '1' (help) when
 234 ncmpc is running. To edit key bindings use the key editor in ncmpc (press 'K').
 235 .SH "SONG FORMAT"
 236 Format of song display for status and the list window.
 237 The  metadata  delimiters  are: %name%, %artist%, %track%, %time%, %file%, %shortfile%.
 238
 239 The [] operators is 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.
 240
 241 Some  useful examples for format are:
 242
 243    "%file%"
 244
 245 and
 246
 247    "[[%artist% \- ]%title%]|[%file]"
 248 .SH "BUGS"
 249 Report bugs on http://www.musicpd.org/mantis/
 250 .SH "NOTE"
 251 Since MPD uses UTF\-8, ncmpc needs to convert characters to the
 252 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).
 253
 254 .SH "SEE ALSO"
 255 mpc(1), mpd(1), locale(5), locale(7)