doc/ncmpc.1: update connection setup, add local socket

[ncmpc.git] / doc / ncmpc.1

diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index b7fd7ce9be4d46805e013a1853396dc7dcab2d6c..50141d9081bf00a371d3c766bf68448e18f6567b 100644 (file)
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
@@ -6,19 +6,20 @@ ncmpc \- curses Music Player Daemon (MPD) client.
 [options]
 .SH "DESCRIPTION"
 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: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.
+By default, ncmpc connects to the local MPD instance.  A different MPD
+instance can be selected using the command line options \-\-host and
+\-\-port, or by setting the environment variables MPD_HOST and MPD_PORT.
 
 $ ncmpc \-\-host=musicserver \-\-port=44000
 
+You can connect to a "local" socket by setting the host to a file path
+(e.g. "/run/mpd/socket").  Abstract sockets can be used with a "@"
+prefix (e.g. "@mpd").
+
 To use a password with mpd, set MPD_HOST to password@host 
 or use the command line option \-\-password. Values from 
-the command line overrides values from the environment.
+the command line override values from the environment.
 
 Read more about MPD on http://www.musicpd.org
 
@@ -167,6 +168,9 @@ the separator to show at the end of the scrolling title.
 .B list\-format = SONG FORMAT
 The format used to display songs in the main window.
 .TP 
+.B search\-format = SONG FORMAT
+The format used to display songs in the search window. Default is to use list\-format.
+.TP
 .B status\-format = SONG FORMAT
 The format used to display songs on the status line.
 .TP
@@ -246,7 +250,9 @@ You can view ncmpc's key bindings by pressing '1' (help) when
 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: %artist%, %albumartist%, %composer%, %performer%, %title%, %album%, %shortalbum%, %track%, %genre%, %name%, %time%, %date%, %file%, %shortfile%.
+The metadata delimiters are: %artist%, %albumartist%, %composer%,
+%performer%, %title%, %album%, %shortalbum%, %track%, %disc,
+%genre%, %name%, %time%, %date%, %file%, %shortfile%.
 
 The [] operators are used to group output such that if none of the metadata delimiters between '[' and ']' are matched, then none of the characters between '[' and ']' are output; literal text is always output. '&' and '|' are logical operators for AND and OR. '#' is used to escape characters.
 
@@ -265,7 +271,7 @@ Another one is:
 .SH "CHAT PROTOCOL"
 If ncmpc has been compiled with "chat" support, it uses the client-to-client protocol available in MPD 0.17 or higher to communicate with other clients. In order to receive messages it subscribes to the channel with the name "chat", and displays any message sent there as-is. When the user enters a message, it is first with the prefix specified by the \fBchat-prefix\fR option (or the default prefix), and then sent to the "chat" channel for others to read.
 .SH "BUGS"
-Report bugs on http://www.musicpd.org/mantis/
+Report bugs on https://github.com/MusicPlayerDaemon/ncmpc/issues
 .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 environment variables (LC_CTYPE only affects character handling).