![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index f09defa4d1e58f699d1b4986f57ef4341abb6106..50141d9081bf00a371d3c766bf68448e18f6567b 100644 (file)
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
.B ncmpc
[options]
.SH "DESCRIPTION"
-ncmpc is a client for MPD, the Music Player Daemon.
-ncmpc connects to a MPD running on a machine on the local
-network.
+ncmpc is a client for MPD, the Music Player Daemon.
-By default, ncmpc connects to localhost:6600.
-This can be changed either at compile\-time, or by exporting the
-MPD_HOST and MPD_PORT environment variables, or by the command line
-options \-\-host and \-\-port.
+By default, ncmpc connects to the local MPD instance. A different MPD
+instance can be selected using the command line options \-\-host and
+\-\-port, or by setting the environment variables MPD_HOST and MPD_PORT.
$ ncmpc \-\-host=musicserver \-\-port=44000
+You can connect to a "local" socket by setting the host to a file path
+(e.g. "/run/mpd/socket"). Abstract sockets can be used with a "@"
+prefix (e.g. "@mpd").
+
To use a password with mpd, set MPD_HOST to password@host
or use the command line option \-\-password. Values from
-the command line overrides values from the environment.
+the command line override values from the environment.
Read more about MPD on http://www.musicpd.org
.B \-?, \-\-help
Display help.
.TP
-.B \-V, \-\-version
-Display version information.
+.B \-V, \-\-version
+Display version information and build-time configuration.
.TP
-.B \-c, \-\-colors
+.B \-c, \-\-colors
Enable colors.
.TP
-.B \-C, \-\-no\-colors
+.B \-C, \-\-no\-colors
Disable colors.
.TP
-.B \-m, \-\-mouse
+.B \-m, \-\-mouse
Enable mouse.
.TP
-.B \-M, \-\-no\-mouse
+.B \-M, \-\-no\-mouse
Disable mouse.
.TP
.B \-h, \-\-host=HOSTNAME
.TP
Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
.SH "CONFIGURATION"
-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.
+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.
Attempt to reconnect to mpd if a response to a command is not received within
TIMEOUT seconds. Specifying a value in the configuration file overrides the
"MPD_TIMEOUT" environment variable. If no timeout is specified in the
-configuration file or in the environment, the default is 1.5 seconds.
+configuration file or in the environment, the default is 5 seconds.
.SS Interface
.TP
.B enable\-mouse = yes|no
Enable mouse support (if enabled at compile time).
.TP
.B screen\-list = SCREEN1 SCREEN2...
-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.
+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.
.TP
.B search\-mode = MODE
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.).
.B text\-editor = EDITOR
The text editor used for editing lyrics.
.TP
+.B text\-editor\-ask = yes|no
+Ask before starting an editor.
+.TP
+.B chat\-prefix = PREFIX
+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> ").
+.TP
.B second-column = yes|no
Display song length in a second column.
.SS Display
.B list\-format = SONG FORMAT
The format used to display songs in the main window.
.TP
+.B search\-format = SONG FORMAT
+The format used to display songs in the search window. Default is to use list\-format.
+.TP
.B status\-format = SONG FORMAT
The format used to display songs on the status line.
.TP
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.
.TP
.B color title = COLOR[,ATTRIBUTE]...
-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.
+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.
.TP
.B color title\-bold = COLOR[,ATTRIBUTE]...
Set the text color for the title row (the bold part).
ncmpc is running. To edit key bindings press 'K' and use the key editor in ncmpc.
.SH "SONG FORMAT"
Format of song display for status and the list window.
-The metadata delimiters are: %name%, %artist%, %track%, %time%, %file%, %shortfile%.
+The metadata delimiters are: %artist%, %albumartist%, %composer%,
+%performer%, %title%, %album%, %shortalbum%, %track%, %disc,
+%genre%, %name%, %time%, %date%, %file%, %shortfile%.
-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.
+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.
-Some useful examples for format are:
+Some useful examples for format are:
"%file%"
and
- "[[%artist% \- ]%title%]|[%file]"
+ "[[%artist% \- ]%title%]|%file%"
+
+Another one is:
+
+ "[%artist%|(artist n/a)] - [%title%|(title n/a)]"
+
+.SH "CHAT PROTOCOL"
+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.
.SH "BUGS"
-Report bugs on http://www.musicpd.org/mantis/
+Report bugs on https://github.com/MusicPlayerDaemon/ncmpc/issues
.SH "NOTE"
Since MPD uses UTF\-8, ncmpc needs to convert characters to the
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).