![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index 93d297ff5d2af0628d9354cf6898293ff54efc1a..e09a65c512499ba2c4a8eecb902ed2d18d1728ea 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"
ncmpc connects to a MPD running on a machine on the local
network.
-By default, ncmpc connects to localhost:2100.
+By default, ncmpc connects to localhost:6600.
This can be changed either at compile\-time, or by exporting the
MPD_HOST and MPD_PORT environment variables, or by the command line
options \-\-host and \-\-port.
.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.
-Possible text colors are the base colors plus grey, brightred, brightgreen, brightyellow, brightblue, brightmagenta, brightcyan and brightwhite.
-
-Supported configuration options:
-.TP
-.B auto_center = yes|no
+.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 wide_cursor = yes|no
+.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
+.B find\-wrap = yes|no
+Wrapped find mode.
+.TP
+.B wrap\-around = yes|no
+Wrapped cursor movement.
+.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 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.
+.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
+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 enable_colors = yes|no
+.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.
+.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 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 status\-message\-time = TIME
+The time, in seconds, for which status messages will be displayed.
+.TP
+.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 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 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.
+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).
.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).
+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').
+.SH "SONG FORMAT"
+Format of song display for status and the list window.
+The metadata delimeters 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.
+
+Some useful examples for format are:
+
+ "%file%"
+
+and
+
+ "[[%artist% \- ]%title%]|[%file]"
.SH "BUGS"
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).
-.SH "SE ALSO"
+.SH "SEE ALSO"
mpc(1), mpd(1), locale(5), locale(7)