.TH CMUS\-REMOTE 1 05/11/2006 cmus
.nh
.ad l
.SH NAME
cmus\-remote \- control cmus
.SH SYNOPSIS
cmus\-remote [\fBOPTION\fR]... [\fIFILE\fR|\fIDIR\fR|\fIPLAYLIST\fR]...
.br
cmus\-remote \fB\-C\fR \fICOMMAND\fR...
.br
cmus\-remote
.SH DESCRIPTION
Add \fIFILE/DIR/PLAYLIST\fR to playlist, library (\fB\-l\fR) or play queue (\fB\-q\fR).

If no arguments are given cmus\-remote reads raw commands from stdin (one command per line).  Raw commands are cmus' command mode commands.  These same commands are used in configuration files and key bindings.  \fBcmus\fR(1) contains full list of commands.  For consistency also searching is supported: \fB\-C /text\fR.

If \fB\-C\fR is given, all command line arguments are treated as raw commands.
.SH OPTIONS
\-\-server SOCKET
.RS
Connect using socket \fBSOCKET\fR instead of \fI$XDG_RUNTIME_DIR/cmus\-socket\fR.
.RE

\-\-passwd PASSWD
.RS
password to use for TCP/IP connection
.RE

\-\-help
.RS
Display usage information and exit.
.RE

\-\-version
.RS
Display version information and exit.
.RE

\-p, \-\-play
.RS
Start playing.
.RE

\-u, \-\-pause
.RS
Toggle pause.
.RE

\-U, \-\-pause\-playback
.RS
Pause if currently playing.
.RE

\-s, \-\-stop
.RS
Stop playing.
.RE

\-n, \-\-next
.RS
Skip forward in playlist.
.RE

\-r, \-\-prev
.RS
Skip backward in playlist.
.RE

\-R, \-\-repeat
.RS
Toggle repeat.
.RE

\-S, \-\-shuffle
.RS
Toggle shuffle.
.RE

\-v, \-\-volume VOL
.RS
Change volume. See \fBvol\fR command in \fBcmus\fR(1).
.RE

\-k, \-\-seek SEEK
.RS
Seek. See \fBseek\fR command in \fBcmus\fR(1).
.RE

\-f, \-\-file FILE
.RS
Play from file.
.RE

\-Q
.RS
Get player status information.  Same as \fB\-C status\fR.  Note that \fBstatus\fR is a special command only available to cmus\-remote.
.RE

\-l, \-\-library
.RS
Modify library instead of playlist.
.RE

\-P, \-\-playlist
.RS
Modify playlist (default).
.RE

\-q, \-\-queue
.RS
Modify play queue instead of playlist.
.RE

\-c, \-\-clear
.RS
Clear playlist, library (\fB\-l\fR) or play queue (\fB\-q\fR).
.RE

\-C, \-\-raw
.RS
Treat arguments (instead of stdin) as raw commands.
.RE
.SH REMOTE COMMANDS
Special commands only available to cmus\-remote.

status
.RS
Print information about currently playing track.
.RE

format_print
.RS
Print arguments as \fIFormat Strings\fR. Each argument starts a new line.
.RE
.SH EXAMPLES
Add playlists/files/directories/URLs to library view (1 & 2):

.RS
.nf
$ cmus\-remote \-l music.m3u \\
http://live.urn1350.net:8080/urn_high.ogg
.fi
.RE

Load (clear and add) playlist to playlist view (3):

.RS
.nf
$ cmus\-remote \-c music.m3u
.fi
.RE

Three different ways to toggle repeat:

.RS
.nf
$ cmus\-remote \-R
$ cmus\-remote \-C "toggle repeat"
$ cmus\-remote
toggle repeat
^D
.fi
.RE

Query settings or key bindings:

.RS
.nf
$ cmus\-remote \-C "set repeat?"
setting: 'repeat=false'
$ cmus\-remote \-C "showbind common a"
bind common a win\-add\-l
.fi
.RE

Dump the playlist to stdout:

.RS
.nf
$ cmus\-remote \-C "save \-p \-"
[...]
.fi
.RE

Search works too:

.RS
.nf
$ cmus\-remote \-C /beatles
.fi
.RE
.SH SEE ALSO
\fBcmus\fR(1)
.SH AUTHOR
Written by Timo Hirvonen <tihirvon@gmail.com>