man: configuration section updated

Add undocumented options to the configuration section, and organize it
into subsections - it's getting long!

diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index f7592ce99cdc306ced7079ae2158b77865b8f98e..383ccc311f4dcf8c57555d59a4fbced84e136c19 100644 (file)
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
@@ -61,28 +61,41 @@ Mandatory or optional arguments to long options are also mandatory or optional f
 .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.
 
-Base colors are: black, red, green, yellow, blue, magenta, cyan and white. 
 
-Possible text colors are the base colors plus grey, brightred, brightgreen, brightyellow, brightblue, brightmagenta, brightcyan and brightwhite.
 
-
-Supported configuration options:
+.SS Connection
+.TP
+.B host = HOST
+Connect to mpd running on specified host
+.TP
+.B port = PORT
+Connect to mpd on the specified port
+.TP
+.B password = PASSWORD
+Connect to mpd using the specified password.
+.SS Interface
+.TP
+.B enable\-mouse = yes|no
+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.
+.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.
 .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 find\-show\-last = yes|no
+Show the most recent query instead of a blank line for a find.
 .TP 
-.B wide\-cursor = yes|no
-Make the cursor as wide as the screen.
-.TP 
-.B hide\-cursor = NUM
-Hide the playlist cursor after NUM seconds of inactivity.
+.B find\-wrap = yes|no
+Wrapped find mode.
 .TP 
 .B wrap\-around = yes|no
 Wrapped cursor movement.
-.TP 
-.B find\-wrap = yes|no
-Wrapped find mode.
 .TP
 .B bell\-on\-wrap = yes|no
 Ring bell when find wraps around.
@@ -94,16 +107,29 @@ Sound audible bell on alerts.
 Visible bell on alerts.
 .TP
 .B crossfade\-time = CROSSFADE TIME
-Default crossfade time in Seconds
+Default crossfade time in seconds
+.TP
+.B seek\-time = NUM
+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.
+.SS Display
+.TP
+.B welcome\-screen\-list = yes|no
+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 hide\-cursor = NUM
+Hide the playlist cursor after NUM seconds of inactivity.
 .TP
 .B scroll = yes|no
 Scroll the title if it is too long for the screen.
 .TP
 .B scroll\-sep = STRING
 The separator to show at the end of the scrolling title.
-.TP
-.B seek\-time = NUM
-Seek forward/backward by NUM seconds.
 .TP 
 .B list\-format = SONG FORMAT
 The format used to display songs in the main window.
@@ -111,35 +137,34 @@ The format used to display songs in the main window.
 .B status\-format = SONG FORMAT
 The format used to display songs on the status line.
 .TP
-.B host = HOST
-Connect to mpd running on specified host
+.B status\-message\-time = TIME
+The time, in seconds, for which status messages will be displayed.
 .TP
-.B port = PORT
-Connect to mpd on the specified port
+.B display\-time = yes|no
+Display the time in the status bar when idle.
+.TP 
+.B timedisplay-type = elapsed/remaining
+Sets whether to display remaining or elapsed time in the status window. Default is elapsed.
+.TP 
+.B visible\-bitrate = yes|no
+Show the bitrate in the status bar when playing a stream.
+.B 
 .TP 
 .B set\-xterm\-title = yes|no
 Change the XTerm title (ncmpc will not restore the title).
 .TP 
-.B lyrics\-timeout = NUM
-Quits downloading lyrics of a song after the timeout of NUM seconds is reached.
-.TP 
 .B xterm\-title\-format = SONG FORMAT
 The format used to for the xterm title when ncmpc is playing.
+.SS Colors
 .TP 
 .B enable\-colors = yes|no
 Enable/disable colors.
 .TP 
-.B show\-splash = yes|no
-Show/hide the splash screen.
-.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. Only the base colors are valid background colors.
+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. 
 .TP 
 .B color title = TEXTCOLOR
-Set the text color for the title row.
-.TP 
-.B timedisplay-type = elapsed/remaining
-Sets whether to display remaining or elapsed time in the status window. Default is elapsed.
+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.
 .TP 
 .B color title\-bold = TEXTCOLOR
 Set the text color for the title row (the bold part).
@@ -174,6 +199,7 @@ Text color used to display alerts in the status window.
 .B colordef COLOR = R, G, B
 Redefine any of the base colors. The RGB values must be an integer value between 0 and 1000. 
 \fBNote\fR: Only some terminals allow redefinitions of colors! 
+
 .SH "KEYS"
 When ncmpc start it tries to read user key bindings from the ~/.ncmpc/keys file. If no user key bindings is found ncmpc tries to load global key bindings from $SYSCONFDIR/ncmpc/keys (the actual path is displayed on the help screen).