doc/meson.build: rename API documentation directory to "api"
[ncmpc-debian.git] / 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
10 By default, ncmpc connects to the local MPD instance.  A different MPD
11 instance can be selected using the command line options \-\-host and
12 \-\-port, or by setting the environment variables MPD_HOST and MPD_PORT.
13
14 $ ncmpc \-\-host=musicserver \-\-port=44000
15
16 You can connect to a "local" socket by setting the host to a file path
17 (e.g. "/run/mpd/socket").  Abstract sockets can be used with a "@"
18 prefix (e.g. "@mpd").
19
20 To use a password with mpd, set MPD_HOST to password@host 
21 or use the command line option \-\-password. Values from 
22 the command line override values from the environment.
23
24 Read more about MPD on http://www.musicpd.org
25
26 .SH "OPTIONS"
27 .TP 
28 .B \-?, \-\-help
29 Display help.
30 .TP 
31 .B \-V, \-\-version
32 Display version information and build-time configuration.
33 .TP 
34 .B \-c, \-\-colors
35 Enable colors.
36 .TP 
37 .B \-C, \-\-no\-colors
38 Disable colors.
39 .TP
40 .B \-m, \-\-mouse
41 Enable mouse.
42 .TP
43 .B \-M, \-\-no\-mouse
44 Disable mouse.
45 .TP 
46 .B \-h, \-\-host=HOSTNAME
47 Specify MPD host.
48 .TP 
49 .B \-p, \-\-port=PORT
50 Connect to server on PORT.
51 .TP 
52 .B \-P, \-\-password=PASSWORD
53 Use password when connecting.
54 .TP 
55 .B \-f, \-\-config=FILE
56 Read configuration from file.
57 .TP 
58 .B \-k, \-\-key\-file=FILE
59 Read key bindings from FILE.
60 .TP
61 Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
62 .SH "CONFIGURATION"
63 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.
64
65
66
67 .SS Connection
68 .TP
69 .B host = HOST
70 Connect to mpd running on the specified host.
71 .TP
72 .B port = PORT
73 Connect to mpd on the specified port.
74 .TP
75 .B password = PASSWORD
76 Connect to mpd using the specified password.
77 .TP
78 .B timeout = TIMEOUT
79 Attempt to reconnect to mpd if a response to a command is not received within
80 TIMEOUT seconds. Specifying a value in the configuration file overrides the
81 "MPD_TIMEOUT" environment variable. If no timeout is specified in the
82 configuration file or in the environment, the default is 5 seconds.
83 .SS Interface
84 .TP
85 .B enable\-mouse = yes|no
86 Enable mouse support (if enabled at compile time).
87 .TP
88 .B screen\-list = SCREEN1 SCREEN2...
89 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.
90 .TP
91 .B search\-mode = MODE
92 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.).
93 .TP 
94 .B auto\-center = yes|no
95 Enable/disable auto center mode. When auto center mode is enabled 
96 ncmpc centers the current track in the playlist window.
97 .TP
98 .B scroll-offset = NUM
99 Keep at least NUM lines above and below the cursor on list windows, if possible.
100 .TP
101 .B find\-show\-last = yes|no
102 Show the most recent query instead of a blank line for a find.
103 .TP 
104 .B find\-wrap = yes|no
105 Wrapped find mode.
106 .TP 
107 .B wrap\-around = yes|no
108 Wrapped cursor movement.
109 .TP
110 .B bell\-on\-wrap = yes|no
111 Ring bell when find wraps around.
112 .TP 
113 .B audible\-bell = yes|no
114 Sound audible bell on alerts.
115 .TP 
116 .B visible\-bell = yes|no
117 Visible bell on alerts.
118 .TP
119 .B crossfade\-time = CROSSFADE TIME
120 Default crossfade time in seconds.
121 .TP
122 .B seek\-time = NUM
123 Seek forward/backward by NUM seconds.
124 .TP 
125 .B lyrics\-timeout = NUM
126 Quits downloading lyrics of a song after the timeout of NUM seconds is reached, if NUM is greater than zero.
127 .TP
128 .B jump\-prefix\-only = yes|no
129 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".
130 .TP
131 .B lyrics\-autosave = yes|no
132 Automatically save lyrics after receiving them.
133 .TP
134 .B lyrics\-show\-plugin = yes|no
135 Show the name of the plugin used to receive lyrics on the lyrics screen.
136 .TP
137 .B text\-editor = EDITOR
138 The text editor used for editing lyrics.
139 .TP
140 .B text\-editor\-ask = yes|no
141 Ask before starting an editor.
142 .TP
143 .B chat\-prefix = PREFIX
144 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> ").
145 .TP
146 .B second-column = yes|no
147 Display song length in a second column.
148 .SS Display
149 .TP
150 .B welcome\-screen\-list = yes|no
151 Show a list of the screens in the top line on startup.
152 .TP 
153 .B wide\-cursor = yes|no
154 Make the cursor as wide as the screen.
155 .TP
156 .B hardware\-cursor = yes|no
157 Use the terminal's hardware cursor instead of inverse colors.
158 .TP 
159 .B hide\-cursor = NUM
160 Hide the playlist cursor after NUM seconds of inactivity.
161 .TP
162 .B scroll = yes|no
163 Scroll the title if it is too long for the screen.
164 .TP
165 .B scroll\-sep = STRING
166 the separator to show at the end of the scrolling title.
167 .TP 
168 .B list\-format = SONG FORMAT
169 The format used to display songs in the main window.
170 .TP 
171 .B search\-format = SONG FORMAT
172 The format used to display songs in the search window. Default is to use list\-format.
173 .TP
174 .B status\-format = SONG FORMAT
175 The format used to display songs on the status line.
176 .TP
177 .B status\-message\-time = TIME
178 The time, in seconds, for which status messages will be displayed.
179 .TP
180 .B display\-time = yes|no
181 Display the time in the status bar when idle.
182 .TP 
183 .B timedisplay-type = elapsed/remaining
184 Sets whether to display remaining or elapsed time in the status window. Default is elapsed.
185 .TP 
186 .B visible\-bitrate = yes|no
187 Show the bitrate in the status bar when playing a stream.
188 .B 
189 .TP 
190 .B set\-xterm\-title = yes|no
191 Change the XTerm title (ncmpc will not restore the title).
192 .TP 
193 .B xterm\-title\-format = SONG FORMAT
194 The format used to for the xterm title when ncmpc is playing.
195 .SS Colors
196 .TP 
197 .B enable\-colors = yes|no
198 Enable/disable colors.
199 .TP 
200 .B color background = COLOR
201 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.
202 .TP 
203 .B color title = COLOR[,ATTRIBUTE]...
204 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.
205 .TP 
206 .B color title\-bold = COLOR[,ATTRIBUTE]...
207 Set the text color for the title row (the bold part).
208 .TP 
209 .B color line = COLOR
210 Set the color of the line on the second row.
211 .TP 
212 .B color line\-flags = COLOR[,ATTRIBUTE]...
213 Set the text color used to indicate mpd flags on the second row.
214 .TP 
215 .B color list = COLOR[,ATTRIBUTE]...
216 Set the text color in the main area of ncmpc.
217 .TP 
218 .B color list\-bold = COLOR[,ATTRIBUTE]...
219 Set the bold text color in the main area of ncmpc.
220 .TP 
221 .B color browser-directory = COLOR[,ATTRIBUTE]...
222 Set the text color used to display directories in the browser window.
223 .TP 
224 .B color browser-playlist = COLOR[,ATTRIBUTE]...
225 Set the text color used to display playlists in the browser window.
226 .TP 
227 .B color progressbar = COLOR[,ATTRIBUTE]...
228 Set the color of the progress indicator.
229 .TP 
230 .B color status\-state = COLOR[,ATTRIBUTE]...
231 Set the text color used to display mpd status in the status window.
232 .TP 
233 .B color status\-song = COLOR[,ATTRIBUTE]...
234 Set the text color used to display song names in the status window.
235 .TP 
236 .B color status\-time = COLOR[,ATTRIBUTE]...
237 Set the text color used to display time the status window. 
238 .TP 
239 .B color alert = COLOR[,ATTRIBUTE]...
240 Set the text color used to display alerts in the status window.
241 .TP 
242 .B colordef COLOR = R, G, B
243 Redefine any of the base colors. The RGB values must be integer values between 0 and 1000. 
244 \fBNote\fR: Only some terminals allow redefinitions of colors! 
245
246 .SH "KEYS"
247 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). 
248
249 You can view ncmpc's key bindings by pressing '1' (help) when 
250 ncmpc is running. To edit key bindings press 'K' and use the key editor in ncmpc.
251 .SH "SONG FORMAT"
252 Format of song display for status and the list window.
253 The metadata delimiters are: %artist%, %albumartist%, %composer%,
254 %performer%, %title%, %album%, %shortalbum%, %track%, %disc,
255 %genre%, %name%, %time%, %date%, %file%, %shortfile%.
256
257 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.
258
259 Some useful examples for format are:
260
261    "%file%" 
262
263 and 
264
265    "[[%artist% \- ]%title%]|%file%"
266
267 Another one is:
268
269    "[%artist%|(artist n/a)] - [%title%|(title n/a)]"
270
271 .SH "CHAT PROTOCOL"
272 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.
273 .SH "BUGS"
274 Report bugs on https://github.com/MusicPlayerDaemon/ncmpc/issues
275 .SH "NOTE"
276 Since MPD uses UTF\-8, ncmpc needs to convert characters to the 
277 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).
278
279 .SH "SEE ALSO"
280 mpc(1), mpd(1), locale(5), locale(7)