Code

8bda42e11a328dfae3ffe686e5aad4459ae16221
[ncmpc.git] / doc / ncmpc.1
1 .TH "mpc-ncurses" "1" "" "Kalle Wallin" ""
2 .SH "NAME"
3 ncmpc \- ncurses 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 Read more about MPD on http://www.musicpd.org
21 .SH "OPTIONS"
22 .TP 
23 .B \-?, \-\-help
24 Display help.
25 .TP 
26 .B \-V,  \-\-version
27 Display version information.
28 .TP 
29 .B \-k,  \-\-keys
30 Display key bindings.
31 .TP 
32 .B \-h, \-\-host=HOSTNAME
33 Specify host.
34 .TP 
35 .B \-p, \-\-port=PORT
36 Connect to server on PORT.
37 .TP 
38 Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
39 .SH "KEYS"
40 Since ncmpc is under development key bindings may change. 
41 View current ncmpc key bindings in the help screen or by running:
43 $ ncmpc \-\-keys
44   
45 .SH "SEE ALSO"
46 mpc(1), MPD(1)