strfsong: evaluate literal text as "true"

[ncmpc.git] / doc / ncmpc.1

diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index f72c99c8cc6bc2c6afbdce77673d13f49774f10e..a298b33ced328978dba31e8e67b5fb5a41384d99 100644 (file)
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
@@ -85,7 +85,7 @@ configuration file or in the environment, the default is 5 seconds.
 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.).
@@ -139,6 +139,9 @@ The text editor used for editing lyrics.
 .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
@@ -245,7 +248,7 @@ ncmpc is running. To edit key bindings press 'K' and use the key editor in ncmpc
 Format of song display for status and the list window.
 The  metadata  delimiters  are: %name%, %artist%, %track%, %time%, %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: 
 
@@ -254,6 +257,13 @@ Some  useful examples for format are:
 and 
 
    "[[%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/
 .SH "NOTE"