push

Doc/cmus-remote.txt

@@ -0,0 +1,156 @@
+@title CMUS-REMOTE 1 05/11/2006 cmus
+
+@h1 NAME
+
+cmus-remote - control cmus
+
+
+@h1 SYNOPSIS
+
+cmus-remote [*OPTION*]... [`FILE`|`DIR`|`PLAYLIST`]...@br
+cmus-remote *-C* `COMMAND`...@br
+cmus-remote
+
+
+@h1 DESCRIPTION
+
+Add `FILE/DIR/PLAYLIST` to playlist, library (*-l*) or play queue (*-q*).
+
+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.  *cmus*(1) contains
+full list of commands.  For consistency also searching is supported:
+*-C /text*.
+
+If *-C* is given, all command line arguments are treated as raw commands.
+
+@h1 OPTIONS
+
+--server SOCKET
+	Connect using socket *SOCKET* instead of `$XDG_RUNTIME_DIR/cmus-socket`.
+
+--passwd PASSWD
+	password to use for TCP/IP connection
+
+--help
+	Display usage information and exit.
+
+--version
+	Display version information and exit.
+
+-p, --play
+	Start playing.
+
+-u, --pause
+	Toggle pause.
+
+-U, --pause-playback
+	Pause if currently playing.
+
+-s, --stop
+	Stop playing.
+
+-n, --next
+	Skip forward in playlist.
+
+-r, --prev
+	Skip backward in playlist.
+
+-R, --repeat
+	Toggle repeat.
+
+-S, --shuffle
+	Toggle shuffle.
+
+-v, --volume VOL
+	Change volume. See *vol* command in *cmus*(1).
+
+-k, --seek SEEK
+	Seek. See *seek* command in *cmus*(1).
+
+-f, --file FILE
+	Play from file.
+
+-Q
+	Get player status information.  Same as *-C status*.  Note that
+	*status* is a special command only available to cmus-remote.
+
+-l, --library
+	Modify library instead of playlist.
+
+-P, --playlist
+	Modify playlist (default).
+
+-q, --queue
+	Modify play queue instead of playlist.
+
+-c, --clear
+	Clear playlist, library (*-l*) or play queue (*-q*).
+
+-C, --raw
+	Treat arguments (instead of stdin) as raw commands.
+
+@h1 REMOTE COMMANDS
+
+Special commands only available to cmus-remote.
+
+status
+	Print information about currently playing track.
+
+format_print
+	Print arguments as `Format Strings`. Each argument starts a new line.
+
+@h1 EXAMPLES
+
+Add playlists/files/directories/URLs to library view (1 & 2):
+
+	@pre
+	$ cmus-remote -l music.m3u \\
+	http://live.urn1350.net:8080/urn_high.ogg
+	@endpre
+
+Load (clear and add) playlist to playlist view (3):
+
+	@pre
+	$ cmus-remote -c music.m3u
+	@endpre
+
+Three different ways to toggle repeat:
+
+	@pre
+	$ cmus-remote -R
+	$ cmus-remote -C "toggle repeat"
+	$ cmus-remote
+	toggle repeat
+	^D
+	@endpre
+
+Query settings or key bindings:
+
+	@pre
+	$ cmus-remote -C "set repeat?"
+	setting: 'repeat=false'
+	$ cmus-remote -C "showbind common a"
+	bind common a win-add-l
+	@endpre
+
+Dump the playlist to stdout:
+
+	@pre
+	$ cmus-remote -C "save -p -"
+	[...]
+	@endpre
+
+Search works too:
+
+	@pre
+	$ cmus-remote -C /beatles
+	@endpre
+
+@h1 SEE ALSO
+
+*cmus*(1)
+
+@h1 AUTHOR
+
+Written by Timo Hirvonen <tihirvon\@gmail.com>