Code

doc/ncmpc.1: replace obsolete Mantis link
[ncmpc.git] / doc / ncmpc.1
index c55fbbfa35f6d4846e48285bcbbc2c4f63055672..da2ce42dc8173f50766b61c28ff4d4ccb8ac9220 100644 (file)
@@ -5,7 +5,7 @@ ncmpc \- curses Music Player Daemon (MPD) client.
 .B ncmpc
 [options]
 .SH "DESCRIPTION"
-ncmpc is  a client for MPD, the Music Player Daemon. 
+ncmpc is a client for MPD, the Music Player Daemon.
 ncmpc connects to a MPD running on a machine on the local 
 network.
 
@@ -27,19 +27,19 @@ Read more about MPD on http://www.musicpd.org
 .B \-?, \-\-help
 Display help.
 .TP 
-.B \-V,  \-\-version
+.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
@@ -167,6 +167,9 @@ the separator to show at the end of the scrolling title.
 .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
@@ -197,7 +200,7 @@ Enable/disable colors.
 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).
@@ -246,11 +249,13 @@ You can view ncmpc's key bindings by pressing '1' (help) when
 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 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.
+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%" 
 
@@ -265,7 +270,7 @@ Another one is:
 .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).