diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ncmpc.1 | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/ncmpc.1 b/doc/ncmpc.1 new file mode 100644 index 000000000..8bda42e11 --- /dev/null +++ b/doc/ncmpc.1 @@ -0,0 +1,46 @@ +.TH "mpc-ncurses" "1" "" "Kalle Wallin" "" +.SH "NAME" +ncmpc \- ncurses MPD client. +.SH "SYNOPSIS" +.B ncmpc +[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:2100. +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. + +$ ncmpc \-\-host=musicserver \-\-port=44000 + +Read more about MPD on http://www.musicpd.org + +.SH "OPTIONS" +.TP +.B \-?, \-\-help +Display help. +.TP +.B \-V, \-\-version +Display version information. +.TP +.B \-k, \-\-keys +Display key bindings. +.TP +.B \-h, \-\-host=HOSTNAME +Specify host. +.TP +.B \-p, \-\-port=PORT +Connect to server on PORT. +.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: + +$ ncmpc \-\-keys + +.SH "SEE ALSO" +mpc(1), MPD(1) |