Handle streams separately in tree_add_track()
[cmus.git] / Doc / cmus-remote.txt
blob3a8e9c1fc9bd9c9e6c5ee092809828a4c57c5949
1 @title CMUS-REMOTE 1 05/11/2006 cmus
3 @h1 NAME
5 cmus-remote - control cmus
8 @h1 SYNOPSIS
10 cmus-remote [*OPTION*]... [`FILE`|`DIR`|`PLAYLIST`]...@br
11 cmus-remote *-C* `COMMAND`...@br
12 cmus-remote
15 @h1 DESCRIPTION
17 Add `FILE/DIR/PLAYLIST` to playlist, library (*-l*) or play queue (*-q*).
19 If no arguments are given cmus-remote reads raw commands from stdin (one
20 command per line).  Raw commands are cmus' command mode commands.  These same
21 commands are used in configuration files and key bindings.  *cmus*(1) contains
22 full list of commands.
24 When *-C* is given all command line arguments are treated as raw commands.
27 @h1 OPTIONS
29 --server SOCKET
30         Connect using socket *SOCKET* instead of `/tmp/cmus-$USER`.
32 --help
33         Display usage information and exit.
35 --version
36         Display version information and exit.
38 -p, --play
39         Start playing.
41 -u, --pause
42         Toggle pause.
44 -s, --stop
45         Stop playing.
47 -n, --next
48         Skip forward in playlist.
50 -r, --prev
51         Skip backward in playlist.
53 -R, --repeat
54         Toggle repeat.
56 -S, --shuffle
57         Toggle shuffle.
59 -v, --volume VOL
60         Change volume. See *vol* command in *cmus*(1).
62 -k, --seek SEEK
63         Seek. See *seek* command in *cmus*(1).
65 -l, --library
66         Modify library instead of playlist.
68 -P, --playlist
69         Modify playlist (default).
71 -q, --queue
72         Modify play queue instead of playlist.
74 -c, --clear
75         Clear playlist, library (*-l*) or play queue (*-q*).
77 -C, --raw
78         Treat arguments (instead of stdin) as raw commands.
80 @h1 EXAMPLES
82 Add playlists/files/directories/URLs to library view (1 & 2):
84         @pre
85         $ cmus-remote -l music.m3u \\
86         http://live.urn1350.net:8080/urn_high.ogg
87         @endpre
89 Load (clear and add) playlist to playlist view (3):
91         @pre
92         $ cmus-remote -c music.m3u
93         @endpre
95 Three different ways to toggle repeat:
97         @pre
98         $ cmus-remote -R
99         $ cmus-remote -C "toggle repeat"
100         $ cmus-remote
101         toggle repeat
102         ^D
103         @endpre
105 @h1 SEE ALSO
107 *cmus*(1)
109 @h1 AUTHOR
111 Written by Timo Hirvonen <tihirvon\@gmail.com>