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