ncmpc.1: document the "chat-prefix" option

[ncmpc.git] / doc / ncmpc.1

diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index fc191f127a83a92e54e81fa2e0cab08446e27114..187e37579d20fcba43f1a48397a12977daccbb1b 100644 (file)
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
@@ -28,7 +28,7 @@ Read more about MPD on http://www.musicpd.org
 Display help.
 .TP 
 .B \-V,  \-\-version
-Display version information.
+Display version information and build-time configuration.
 .TP 
 .B \-c,  \-\-colors
 Enable colors.
@@ -42,9 +42,6 @@ Enable mouse.
 .B \-M,  \-\-no\-mouse
 Disable mouse.
 .TP 
-.B \-e,  \-\-exit
-Exit on connection errors. The default is to reconnect.
-.TP 
 .B \-h, \-\-host=HOSTNAME
 Specify MPD host.
 .TP 
@@ -62,7 +59,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 starts it tries to read the user's configuration file, ~/.ncmpc/config. If no user configuration file is found then ncmpc tries to load the 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 starts it tries to read the user's configuration file, ~/.ncmpc/config. If no user configuration file is found then ncmpc tries to load the global settings from $SYSCONFDIR/ncmpc/config (the actual path is displayed in the output of the --version option). An example configuration file (config.sample) should be provided with ncmpc.
 
 
 
@@ -76,13 +73,19 @@ Connect to mpd on the specified port.
 .TP
 .B password = PASSWORD
 Connect to mpd using the specified password.
+.TP
+.B timeout = TIMEOUT
+Attempt to reconnect to mpd if a response to a command is not received within
+TIMEOUT seconds. Specifying a value in the configuration file overrides the
+"MPD_TIMEOUT" environment variable. If no timeout is specified in the
+configuration file or in the environment, the default is 5 seconds.
 .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.
+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, outputs, and chat.
 .TP
 .B search\-mode = MODE
 Default search mode for the search screen. MODE must be one of title, artist, album, filename, and artist+title, or an interger index (0 for title, 1 for artist etc.).
@@ -130,6 +133,15 @@ Automatically save lyrics after receiving them.
 .B lyrics\-show\-plugin = yes|no
 Show the name of the plugin used to receive lyrics on the lyrics screen.
 .TP
+.B text\-editor = EDITOR
+The text editor used for editing lyrics.
+.TP
+.B text\-editor\-ask = yes|no
+Ask before starting an editor.
+.TP
+.B chat\-prefix = PREFIX
+Prefix messages send with the chat screen with PREFIX. By default they are prefixed with the current user name enclosed by \fB<\fR and \fB>\fR and a space (i.e. "<name> ").
+.TP
 .B second-column = yes|no
 Display song length in a second column.
 .SS Display