Code

implement the "lyrics-timeout" config option
[ncmpc.git] / doc / ncmpc.1
index c0006635e114b4f16a55fbe697c2c0a774ae6089..24c0007f7dd18d8c6d2f1ffade8a41f2e68c09d9 100644 (file)
@@ -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,9 +60,6 @@ Read configuration from file.
 .B \-k, \-\-key\-file=FILE
 Read key bindings from FILE.
 .TP
-.B \-P, \-\-no\-splash=FILE
-Disable the splash screen.
-.TP 
 Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
 .SH "CONFIGURATION"
 When ncmpc start it tries to read user setting from the ~/.ncmpc/config. If no user configuration is found ncmpc tries to load 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.
@@ -116,10 +119,19 @@ Default crossfade time in seconds
 Seek forward/backward by NUM seconds.
 .TP 
 .B lyrics\-timeout = NUM
-Quits downloading lyrics of a song after the timeout of NUM seconds is reached.
+Quits downloading lyrics of a song after the timeout of NUM seconds is reached, if NUM is greater than zero.
 .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 lyrics\-show\-plugin = yes|no
+Show the name of the plugin used to receive lyrics on the lyrics screen.
+.TP
+.B second-column = yes|no
+Display song length in a second column.
 .SS Display
 .TP
 .B welcome\-screen\-list = yes|no
@@ -170,39 +182,45 @@ 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 browser-directory = COLOR[,ATTRIBUTE]...
+Set the text color used to display directories in the browser window.
+.TP 
+.B color browser-playlist = COLOR[,ATTRIBUTE]...
+Set the text color used to display playlists in the browser window.
+.TP 
+.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
@@ -216,9 +234,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: 
 
@@ -231,7 +249,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)