Code

colors: Change config to use attribute list
[ncmpc.git] / doc / ncmpc.1
index 3f87cb98a4a07169cbfeb63dc3fcaf8bfb5c20a0..7c4e8df26ef731e016f9a75bc7690b884b632b1b 100644 (file)
@@ -79,15 +79,18 @@ Connect to mpd using the specified password.
 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, and outputs.
 .TP
 .B search\-mode = MODE
-Default search mode for the search screen.  The mode is an integer index, with 0 for title, 1 for artist, 2 for album, 3 for filename, and 4 for artist+title.
+Default search mode for the search screen. The mode is an integer index, with 0 for title, 1 for artist, 2 for album, 3 for filename, and 4 for artist+title.
 .TP 
 .B auto\-center = yes|no
 Enable/disable auto center mode. When auto center mode is enabled 
 ncmpc centers the current track in the playlist window.
 .TP
+.B scroll-offset = NUM
+Keep at least NUM lines above and below the cursor on list windows, if possible.
+.TP
 .B find\-show\-last = yes|no
 Show the most recent query instead of a blank line for a find.
 .TP 
@@ -117,6 +120,12 @@ Quits downloading lyrics of a song after the timeout of NUM seconds is reached.
 .TP
 .B jump\-prefix\-only = yes|no
 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".
+.TP
+.B lyrics\-autosave = yes|no
+Automatically save lyrics after receiving them.
+.TP
+.B second-column = yes|no
+Display song length in a second column.
 .SS Display
 .TP
 .B welcome\-screen\-list = yes|no
@@ -124,6 +133,9 @@ Show a list of the screens in the top line on startup.
 .TP 
 .B wide\-cursor = yes|no
 Make the cursor as wide as the screen.
+.TP
+.B hardware\-cursor = yes|no
+Use the terminal's hardware cursor instead of inverse colors.
 .TP 
 .B hide\-cursor = NUM
 Hide the playlist cursor after NUM seconds of inactivity.
@@ -164,39 +176,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