![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index ca89ded3803b5fe9814a3f6a318747e6c3fcc0f8..7e83ea6c642c2c2ec4c9ed47a4c0a7e1dd36e3fa 100644 (file)
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
-.TH "ncmpc" "1" "April 2004" "" ""
+.TH "ncmpc" "1" "May 2004" "" ""
.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 \-P, \-\-password=PASSWORD
Use password when connecting.
.TP
+.B \-f, \-\-config=FILE
+Read configuration from file.
+.TP
+.B \-P, \-\-key\-file=FILE
+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.
-Avalible colors: black, red, green, yellow, blue, magenta, cyan and white.
+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
+.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
+.B wide\-cursor = yes|no
Make the cursor as wide as the screen.
.TP
-.B enable_colors = yes|no
+.B wrap\-around = yes|no
+Wrapped cursor movement.
+.TP
+.B find\-wrap = yes|no
+Wrapped find mode.
+.TP
+.B audible\-bell = yes|no
+Sound audible bell on alerts.
+.TP
+.B visible\-bell = yes|no
+Visible bell on alerts.
+.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 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.
+.TP
+.B enable\-colors = yes|no
Enable/disable colors.
.TP
-.B title_color = color
-Set the text color for the title row (first row).
+.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 line_color = color
+.B color title\-bold = TEXTCOLOR
+Set the text color for the title row (the bold part).
+.TP
+.B color line = TEXTCOLOR
Set the color of the line on the second row.
.TP
-.B list_color = color
+.B color line\-flags = TEXTCOLOR
+Set the text color used to indicate mpd flags on the second row.
+.TP
+.B color list = TEXTCOLOR
Set the text color in the main area of ncmpc.
.TP
-.B progress_color = color
+.B color list\-bold = TEXTCOLOR
+Set the bold text color in the main area of ncmpc.
+.TP
+.B color progressbar = TEXTCOLOR
Set the color of the progress indicator.
.TP
-.B status_color = color
-Set the text color used in the status window (last row).
+.B color status\-state = TEXTCOLOR
+Set the text color used to display mpd status in the status window.
.TP
-.B alert_color = color
+.B color status\-song = TEXTCOLOR
+Set the text color used to display song names in the status window.
+.TP
+.B color status\-time = TEXTCOLOR
+Set the text color used to display time the status window.
+.TP
+.B color alert = TEXTCOLOR
Text color used to display alerts in the status window.
+.TP
+.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).
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). For example if you want UK settings and use bash you should add the following line to your /etc/profile:
-
- export LC_CTYPE=en_UK
+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"
mpc(1), mpd(1), locale(5), locale(7)