![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index 24c0007f7dd18d8c6d2f1ffade8a41f2e68c09d9..187e37579d20fcba43f1a48397a12977daccbb1b 100644 (file)
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
Display help.
.TP
.B \-V, \-\-version
-Display version information.
+Display version information and build-time configuration.
.TP
.B \-c, \-\-colors
Enable colors.
.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
.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. 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 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.
.SS Connection
.TP
.B host = HOST
-Connect to mpd running on specified host
+Connect to mpd running on the specified host.
.TP
.B port = PORT
-Connect to mpd on the specified port
+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. The mode is an integer index, with 0 for title, 1 for artist, 2 for album, 3 for filename, and 4 for artist+title.
+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.).
.TP
.B auto\-center = yes|no
Enable/disable auto center mode. When auto center mode is enabled
Visible bell on alerts.
.TP
.B crossfade\-time = CROSSFADE TIME
-Default crossfade time in seconds
+Default crossfade time in seconds.
.TP
.B seek\-time = NUM
Seek forward/backward by NUM seconds.
.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
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.
+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.
Set the text color used to display time the status window.
.TP
.B color alert = COLOR[,ATTRIBUTE]...
-Text color used to display alerts in the status window.
+Set the 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.
+Redefine any of the base colors. The RGB values must be integer values 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 starts it tries to read user-defined key bindings from the ~/.ncmpc/keys file. If no user-defined key bindings are found then ncmpc tries to load the 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').
+ncmpc is running. To edit key bindings press 'K' and use the key editor in ncmpc.
.SH "SONG FORMAT"
Format of song display for status and the list window.
The metadata delimiters are: %name%, %artist%, %track%, %time%, %file%, %shortfile%.
-The [] operators is used to group output such that if no metadata delimiters are found or matched between '[' and ']', then none of the characters between '[' and ']' are output. '&' and '|' are logical operators for AND and OR. '#' is used to escape characters.
+The [] operators are used to group output such that if no metadata delimiters are found or matched between '[' and ']', then none of the characters between '[' and ']' are output. '&' and '|' are logical operators for AND and OR. '#' is used to escape characters.
Some useful examples for format are: