git-svn-id: https://svn.musicpd.org/ncmpc/trunk@763 09075e82-0dd4-0310-85a5-a0d7c8717e4f

[ncmpc.git] / doc / ncmpc.1

diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index 59f391e59ca50a0b0c318002694754adab500fae..ec83e888ca7b52c491bcfb5e6ae27ac1102f8692 100644 (file)
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
@@ -1,6 +1,6 @@
-.TH "mpc-ncurses" "1" "0.10.0" "Kalle Wallin" ""
+.TH "ncmpc" "1" "0.10.0" "Kalle Wallin" ""
 .SH "NAME"
-ncmpc \- ncurses MPD client.
+ncmpc \- curses Music Player Daemon (MPD) client.
 .SH "SYNOPSIS"
 .B ncmpc
 [options]
@@ -16,6 +16,10 @@ options \-\-host and \-\-port.
 
 $ ncmpc \-\-host=musicserver \-\-port=44000
 
+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.
+
 Read more about MPD on http://www.musicpd.org
 
 .SH "OPTIONS"
@@ -26,11 +30,14 @@ Display help.
 .B \-V,  \-\-version
 Display version information.
 .TP 
-.B \-k,  \-\-keys
-Display key bindings.
+.B \-c,  \-\-colors
+Enable colors.
+.TP 
+.B \-C,  \-\-no\-colors
+Disable colors.
 .TP 
 .B \-e,  \-\-exit
-Exit on connection errors. The default way is to reconnect.
+Exit on connection errors. The default is to reconnect.
 .TP 
 .B \-h, \-\-host=HOSTNAME
 Specify MPD host.
@@ -38,12 +45,16 @@ Specify MPD host.
 .B \-p, \-\-port=PORT
 Connect to server on PORT.
 .TP 
+.B \-P, \-\-password=PASSWORD
+Connect top MPD with a password.
+.TP 
 Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
 .SH "KEYS"
-Since ncmpc is under development key bindings may change. 
-View current ncmpc key bindings in the help screen or by running:
+You can view ncmpc's key bindings by pressing F1 (help) when 
+ncmpc is running.
+.SH "CONFIGURATION FILE"
+When ncmpc start it read user setting from ~/.ncmpcrc. An example file ncmpcrc.sample should be provided with ncmpc.
+
 
-$ ncmpc \-\-keys
-  
 .SH "SEE ALSO"
 mpc(1), MPD(1)