aboutsummaryrefslogtreecommitdiffstats
path: root/doc/ncmpc.1
diff options
context:
space:
mode:
authorKalle Wallin <kaw@linux.se>2004-03-19 13:26:18 +0000
committerKalle Wallin <kaw@linux.se>2004-03-19 13:26:18 +0000
commita0592c8cc08b802f86061c88dc6862352b6c3e94 (patch)
treefeda87ba55a404023e62b8d744e2667dccebdc95 /doc/ncmpc.1
downloadmpd-a0592c8cc08b802f86061c88dc6862352b6c3e94.tar.gz
mpd-a0592c8cc08b802f86061c88dc6862352b6c3e94.tar.xz
mpd-a0592c8cc08b802f86061c88dc6862352b6c3e94.zip
Imported ncmpc (mpc-ncures).
git-svn-id: https://svn.musicpd.org/ncmpc/trunk@292 09075e82-0dd4-0310-85a5-a0d7c8717e4f
Diffstat (limited to 'doc/ncmpc.1')
-rw-r--r--doc/ncmpc.146
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)