![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index 40183d35c8c386b1e0f1c28c4157a678ca048f02..f7592ce99cdc306ced7079ae2158b77865b8f98e 100644 (file)
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
-.TH "ncmpc" "1" "May 2004" "" ""
+.TH "ncmpc" "1" "June 2005" "" ""
.SH "NAME"
ncmpc \- curses Music Player Daemon (MPD) client.
.SH "SYNOPSIS"
.B \-f, \-\-config=FILE
Read configuration from file.
.TP
-.B \-P, \-\-key\-file=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 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.
.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
+.B find\-wrap = yes|no
+Wrapped find mode.
+.TP
+.B bell\-on\-wrap = yes|no
+Ring bell when find wraps around.
+.TP
+.B audible\-bell = yes|no
+Sound audible bell on alerts.
+.TP
+.B visible\-bell = yes|no
+Visible bell on alerts.
+.TP
+.B crossfade\-time = CROSSFADE TIME
+Default crossfade time in Seconds
+.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.
.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.
.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.
.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.
+.TP
.B color title\-bold = TEXTCOLOR
Set the text color for the title row (the bold part).
.TP
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').
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).
-.SH "SE ALSO"
+.SH "SEE ALSO"
mpc(1), mpd(1), locale(5), locale(7)