Code

ncmpc.1: document the "chat-prefix" option
[ncmpc.git] / doc / ncmpc.1
index 27167989dc0acaab901b435496115b72514dcbc1..187e37579d20fcba43f1a48397a12977daccbb1b 100644 (file)
@@ -59,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.
 
 
 
@@ -85,7 +85,7 @@ configuration file or in the environment, the default is 5 seconds.
 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.).
@@ -139,6 +139,9 @@ The text editor used for editing lyrics.
 .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