the updated sources

[ncmpc.git] / doc / ncmpc.1

diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index fb1dfa61d1680ca1a95c44e3b3f7a51f0afa31f8..ace0f4237b74adb0698465423b00494405245638 100644 (file)
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
@@ -1,4 +1,4 @@
-.TH "ncmpc" "1" "May 2004" "" ""
+.TH "ncmpc" "1" "June 2005" "" ""
 .SH "NAME"
 ncmpc \- curses Music Player Daemon (MPD) client.
 .SH "SYNOPSIS"
@@ -56,7 +56,7 @@ Read key bindings from FILE.
 .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 file. 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.
+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. 
 
@@ -72,6 +72,9 @@ ncmpc centers the current track in the playlist window.
 .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 wrap\-around = yes|no
 Wrapped cursor movement.
 .TP 
@@ -84,11 +87,29 @@ Sound audible bell on alerts.
 .B visible\-bell = yes|no
 Visible bell on alerts.
 .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.
 .TP 
 .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
+.TP
+.B port = PORT
+Connect to mpd on the specified port
+.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.
 .TP 
 .B enable\-colors = yes|no
 Enable/disable colors.
@@ -99,6 +120,9 @@ Set the background color. If the background color is assigned to the keyword \fB
 .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.
+.TP 
 .B color title\-bold = TEXTCOLOR
 Set the text color for the title row (the bold part).
 .TP 
@@ -133,7 +157,7 @@ Text color used to display alerts in the status window.
 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). 
+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). 
 
 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').