Crossfade time can now be definied in the rc file (crossfade-time)

[ncmpc.git] / doc / ncmpc.1

diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index 93d297ff5d2af0628d9354cf6898293ff54efc1a..7e83ea6c642c2c2ec4c9ed47a4c0a7e1dd36e3fa 100644 (file)
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
@@ -9,7 +9,7 @@ ncmpc is  a client for MPD, the Music Player Daemon.
 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.
@@ -65,14 +65,38 @@ Possible text colors are the base colors plus grey, brightred, brightgreen, brig
 
 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 color background = COLOR
@@ -119,6 +143,19 @@ When ncmpc start it tries to read user key bindings from the ~/ncmpc/keys file.
 
 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"