Doc/cmus-remote.txt

   1 @title CMUS-REMOTE 1 05/11/2006 cmus
   2
   3 @h1 NAME
   4
   5 cmus-remote - control cmus
   6
   7
   8 @h1 SYNOPSIS
   9
  10 cmus-remote [*OPTION*]... [`FILE`|`DIR`|`PLAYLIST`]...@br
  11 cmus-remote *-C* `COMMAND`...@br
  12 cmus-remote
  13
  14
  15 @h1 DESCRIPTION
  16
  17 Add `FILE/DIR/PLAYLIST` to playlist, library (*-l*) or play queue (*-q*).
  18
  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.  For consistency also searching is supported:
  23 *-C /text*.
  24
  25 When *-C* is given all command line arguments are treated as raw commands.
  26
  27 @h1 OPTIONS
  28
  29 --server SOCKET
  30         Connect using socket *SOCKET* instead of `/tmp/cmus-$USER`.
  31
  32 --help
  33         Display usage information and exit.
  34
  35 --version
  36         Display version information and exit.
  37
  38 -p, --play
  39         Start playing.
  40
  41 -u, --pause
  42         Toggle pause.
  43
  44 -s, --stop
  45         Stop playing.
  46
  47 -n, --next
  48         Skip forward in playlist.
  49
  50 -r, --prev
  51         Skip backward in playlist.
  52
  53 -R, --repeat
  54         Toggle repeat.
  55
  56 -S, --shuffle
  57         Toggle shuffle.
  58
  59 -v, --volume VOL
  60         Change volume. See *vol* command in *cmus*(1).
  61
  62 -k, --seek SEEK
  63         Seek. See *seek* command in *cmus*(1).
  64
  65 -Q
  66         Get player status information.  Same as *-C status*.  Note that
  67         *status* is a special command only available to cmus-remote.
  68
  69 -l, --library
  70         Modify library instead of playlist.
  71
  72 -P, --playlist
  73         Modify playlist (default).
  74
  75 -q, --queue
  76         Modify play queue instead of playlist.
  77
  78 -c, --clear
  79         Clear playlist, library (*-l*) or play queue (*-q*).
  80
  81 -C, --raw
  82         Treat arguments (instead of stdin) as raw commands.
  83
  84 @h1 EXAMPLES
  85
  86 Add playlists/files/directories/URLs to library view (1 & 2):
  87
  88         @pre
  89         $ cmus-remote -l music.m3u \\
  90         http://live.urn1350.net:8080/urn_high.ogg
  91         @endpre
  92
  93 Load (clear and add) playlist to playlist view (3):
  94
  95         @pre
  96         $ cmus-remote -c music.m3u
  97         @endpre
  98
  99 Three different ways to toggle repeat:
 100
 101         @pre
 102         $ cmus-remote -R
 103         $ cmus-remote -C "toggle repeat"
 104         $ cmus-remote
 105         toggle repeat
 106         ^D
 107         @endpre
 108
 109 Search works too:
 110
 111         @pre
 112         $ cmus-remote -C /beatles
 113         @endpre
 114
 115 @h1 SEE ALSO
 116
 117 *cmus*(1)
 118
 119 @h1 AUTHOR
 120
 121 Written by Timo Hirvonen <tihirvon\@gmail.com>