Code

git-svn-id: https://svn.musicpd.org/ncmpc/trunk@763 09075e82-0dd4-0310-85a5-a0d7c8717e4f
[ncmpc.git] / doc / ncmpc.1
1 .TH "ncmpc" "1" "0.10.0" "Kalle Wallin" ""
2 .SH "NAME"
3 ncmpc \- curses Music Player Daemon (MPD) client.
4 .SH "SYNOPSIS"
5 .B ncmpc
6 [options]
7 .SH "DESCRIPTION"
8 ncmpc is  a client for MPD, the Music Player Daemon. 
9 ncmpc connects to a MPD running on a machine on the local 
10 network.
12 By default, ncmpc connects to localhost:2100. 
13 This can be changed either at compile\-time, or by exporting the 
14 MPD_HOST and MPD_PORT environment variables, or by the command line
15 options \-\-host and \-\-port.
17 $ ncmpc \-\-host=musicserver \-\-port=44000
19 To use a password with mpd, set MPD_HOST to password@host 
20 or use the command line option \-\-password. Values from 
21 the command line overrides values from the environment.
23 Read more about MPD on http://www.musicpd.org
25 .SH "OPTIONS"
26 .TP 
27 .B \-?, \-\-help
28 Display help.
29 .TP 
30 .B \-V,  \-\-version
31 Display version information.
32 .TP 
33 .B \-c,  \-\-colors
34 Enable colors.
35 .TP 
36 .B \-C,  \-\-no\-colors
37 Disable colors.
38 .TP 
39 .B \-e,  \-\-exit
40 Exit on connection errors. The default is to reconnect.
41 .TP 
42 .B \-h, \-\-host=HOSTNAME
43 Specify MPD host.
44 .TP 
45 .B \-p, \-\-port=PORT
46 Connect to server on PORT.
47 .TP 
48 .B \-P, \-\-password=PASSWORD
49 Connect top MPD with a password.
50 .TP 
51 Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
52 .SH "KEYS"
53 You can view ncmpc's key bindings by pressing F1 (help) when 
54 ncmpc is running.
55 .SH "CONFIGURATION FILE"
56 When ncmpc start it read user setting from ~/.ncmpcrc. An example file ncmpcrc.sample should be provided with ncmpc.
59 .SH "SEE ALSO"
60 mpc(1), MPD(1)