doc: Updated manpage.

[ncmpc.git] / doc / ncmpc.1

diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index e09a65c512499ba2c4a8eecb902ed2d18d1728ea..7fcc1d720dea795d6b8a35974ccb7fee30574514 100644 (file)
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
@@ -35,6 +35,12 @@ Enable colors.
 .TP 
 .B \-C,  \-\-no\-colors
 Disable colors.
+.TP
+.B \-m,  \-\-mouse
+Enable mouse.
+.TP
+.B \-M,  \-\-no\-mouse
+Disable mouse.
 .TP 
 .B \-e,  \-\-exit
 Exit on connection errors. The default is to reconnect.
@@ -54,7 +60,7 @@ Read configuration from file.
 .B \-k, \-\-key\-file=FILE
 Read key bindings from FILE.
 .TP
-.B \-P, \-\-no\-splash=FILE
+.B \-S, \-\-no\-splash
 Disable the splash screen.
 .TP 
 Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
@@ -176,39 +182,39 @@ The format used to for the xterm title when ncmpc is playing.
 Enable/disable colors.
 .TP 
 .B color background = COLOR
-Set the background color. If the background color is assigned to the keyword \fBnone\fR, ncmpc will not change the background color. Valid background colors are the base colors: black, red, green, yellow, blue, magenta, cyan and white. 
+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 = TEXTCOLOR
-Set the text color for the title row.  Possible text colors are the base colors plus grey, brightred, brightgreen, brightyellow, brightblue, brightmagenta, brightcyan and brightwhite.
+.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.
 .TP 
-.B color title\-bold = TEXTCOLOR
+.B color title\-bold = COLOR[,ATTRIBUTE]...
 Set the text color for the title row (the bold part).
 .TP 
-.B color line = TEXTCOLOR
+.B color line = COLOR
 Set the color of the line on the second row.
 .TP 
-.B color line\-flags = TEXTCOLOR
+.B color line\-flags = COLOR[,ATTRIBUTE]...
 Set the text color used to indicate mpd flags on the second row.
 .TP 
-.B color list = TEXTCOLOR
+.B color list = COLOR[,ATTRIBUTE]...
 Set the text color in the main area of ncmpc.
 .TP 
-.B color list\-bold = TEXTCOLOR
+.B color list\-bold = COLOR[,ATTRIBUTE]...
 Set the bold text color in the main area of ncmpc.
 .TP 
-.B color progressbar = TEXTCOLOR
+.B color progressbar = COLOR[,ATTRIBUTE]...
 Set the color of the progress indicator.
 .TP 
-.B color status\-state = TEXTCOLOR
+.B color status\-state = COLOR[,ATTRIBUTE]...
 Set the text color used to display mpd status in the status window.
 .TP 
-.B color status\-song = TEXTCOLOR
+.B color status\-song = COLOR[,ATTRIBUTE]...
 Set the text color used to display song names in the status window.
 .TP 
-.B color status\-time = TEXTCOLOR
+.B color status\-time = COLOR[,ATTRIBUTE]...
 Set the text color used to display time the status window. 
 .TP 
-.B color alert = TEXTCOLOR
+.B color alert = COLOR[,ATTRIBUTE]...
 Text color used to display alerts in the status window.
 .TP 
 .B colordef COLOR = R, G, B
@@ -222,9 +228,9 @@ You can view ncmpc's key bindings by pressing '1' (help) when
 ncmpc is running. To edit key bindings use the key editor in ncmpc (press 'K').
 .SH "SONG FORMAT"
 Format of song display for status and the list window.
-The  metadata  delimeters  are: %name%, %artist%, %track%, %time%, %file%, %shortfile%.
+The  metadata  delimiters  are: %name%, %artist%, %track%, %time%, %file%, %shortfile%.
 
-The [] operators is used to group output such that if no metadata delimeters are found or matched between '[' and ']', then none of  the  characters between '[' and ']' are outputed. '&' and '|' are logical operators for and and or. '#'  is used to escape characters. 
+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. 
 
 Some  useful examples for format are: 
 
@@ -237,7 +243,7 @@ and
 Report bugs on http://www.musicpd.org/mantis/
 .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 enviroment variables (LC_CTYPE only affects character handling).
+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).
 
 .SH "SEE ALSO"
 mpc(1), mpd(1), locale(5), locale(7)