index.txt

   1 Gnome Music Player Client handbook
   2 ==================================
   3 Marcel Klein <marcel.klein@gmail.com>
   4 {date}
   5
   6 = Preface =
   7 http://gmpc.wikia.com[Gnome Music Player Client] is a GTK2 frontend for
   8 http://mpd.wikia.com/[Music Player Daemon]. It is released under the
   9 http://en.wikipedia.org/wiki/GNU_General_Public_License[GNU General Public
  10 License] and is free software.
  11
  12 It is designed to be lightweight and easy to use, while providing full access
  13 to all of MPD's features. Users are presented with several different methods
  14 to browse through their music.
  15
  16 It can be extended by plugins, of which many are available.
  17
  18 == Options ==
  19
  20 === Usage ===
  21 gmpc [OPTION...] Gnome Music Player Client
  22
  23 === Help ===
  24 `-?, --help`::
  25         Show help options
  26
  27 `--help-all`::
  28         Show all help options
  29
  30 `--help-gtk`::
  31         Show GTK+ Options
  32
  33 `--help-sm-client`::
  34         Show session management options
  35
  36 === Application ===
  37 `--fullscreen`::
  38         Start the program in full screen
  39
  40 `-v, --version`::
  41         Show program version and revision
  42
  43 `-q, --quit`::
  44         Quits the running GMPC
  45
  46 `-r, --replace`::
  47         Replace the running GMPC
  48
  49 `--disable-plugins`::
  50         Don't load the plugins
  51
  52 `--config=PATH`::
  53         Load alternative config file
  54
  55 `-d, --debug-level=LEVEL`::
  56         Set the debug level
  57 +
  58 `0` no output
  59 +
  60 `1` error messages
  61 +
  62 `2` error + warning messages
  63 +
  64 `3` all messages
  65
  66 `-h, --start-hidden`::
  67         Start GMPC hidden to tray
  68
  69 `--clean-cover-db`::
  70         Remove all failed hits from metadata cache
  71
  72 `-b, --bug-information`::
  73         Show bug information dialog
  74
  75 `-f, --log-filter=<Log domain>`::
  76         Shows all output from a certain log domain
  77
  78 `-p, --profile=<Profile Name>`::
  79         Select a profile
  80
  81 `--display=DISPLAY`::
  82         X display to use
  83
  84 == Keybindings ==
  85
  86 === Database Browser ===
  87 `[ctrl]+a`::
  88         Select all songs
  89
  90 `[ctrl]+c`::
  91         Copy selected song(s) into paste queue
  92
  93 `[ctrl]+[ins]`::
  94         Clear play queue and add selected song(s)
  95
  96 `[enter]`::
  97         Add selected song(s) to play queue and start playback
  98
  99 `[ins]`::
 100         Add selected song(s) to play queue
 101
 102 === Interface ===
 103 `[ctrl]+i`::
 104         Switch to now playing
 105
 106 `[ctrl]+q`::
 107         Quit GMPC
 108
 109 `[ctrl]+w`::
 110         Close GMPC.
 111
 112 `[ctrl]+[+]`::
 113         Expand GMPC
 114
 115 `[ctrl]+[-]`::
 116         Collapse GMPC
 117
 118 `[ctrl]+[space]`::
 119         Start <<easy_command,easy command>>
 120
 121 `[F1]`::
 122         Switch to play queue
 123
 124 `[F2]`::
 125         Switch to database browser
 126
 127 `[F3]`::
 128         Switch to search browser
 129
 130 `[F4]`::
 131         Switch to metadata browser
 132
 133 `[F5]`::
 134         Switch to playlist editor
 135
 136 `[F12]`::
 137         Toggle fullscreen
 138
 139 `[shift]+[F1]`::
 140         Switch to genre browser
 141
 142 `[shift]+[F2]`::
 143         Switch to artist browser
 144
 145 === Play Queue ===
 146 `[ctrl]+a`::
 147         Select all songs
 148
 149 `[ctrl]+b`::
 150         Paste song(s) from paste queue before the first selected song
 151
 152 `[ctrl]+c`::
 153         Copy selected song(s) into paste queue
 154
 155 `[ctrl]+v`::
 156         Paste song(s) from paste queue after the first selected song
 157
 158 `[ctrl]+x`::
 159         Cut selected song(s) into paste queue
 160
 161 `[del]`::
 162         Delete selected song(s)
 163
 164 `[enter]`::
 165         Play selected song
 166
 167 `[space]`::
 168         Select playing song
 169
 170 TIP: You can start an in-line search by just typing in your play queue. To
 171 clear or close the search hit `[esc]`.
 172
 173 === Player Control ===
 174 `[ctrl]+k`::
 175         Toggle single mode (on|off)
 176
 177 `[ctrl]+l`::
 178         Toggle consume mode (on|off)
 179
 180 `[ctrl]+m`::
 181         Mute MPD
 182
 183 `[ctrl]+r`::
 184         Toggle repeat mode (on|off)
 185
 186 `[ctrl]+s`::
 187         Toggle random mode (on|off)
 188
 189 `[ctrl]+[<number>]`::
 190         Toggle output (on|off)
 191
 192 `[ctrl]+[down]`::
 193         Stop playback
 194
 195 `[ctrl]+[enter]`::
 196         Add current song to favorites
 197
 198 `[ctrl]+[left]`::
 199         Play previous song
 200
 201 `[ctrl]+[right]`::
 202         Play next song
 203
 204 `[ctrl]+[up]`::
 205         Pause/Start playback
 206
 207 == Query Syntax ==
 208 Query syntax is used in the search browser, playlist quick search and in
 209 <<easy_command,easy command>>. It supports the following fields and is used
 210 with `<field>=<value>`.
 211
 212 NOTE: You can also run multiple queries by using the `or` operator `||`.
 213
 214 === Fields ===
 215 `albuartist`
 216
 217 `album`
 218
 219 `any`::
 220         Search in all fields
 221
 222 `artist`
 223
 224 `comment`
 225
 226 `composer`
 227
 228 `date`
 229
 230 `disc`
 231
 232 `filename`
 233
 234 `genre`
 235
 236 `name`::
 237         Only applies to streams
 238
 239 `performer`
 240
 241 `title`
 242
 243 `track`
 244
 245 [[easy_command]]
 246 == Easy Command ==
 247 Easy command gives you a small command box, allowing you to quickly execute
 248 commands without having to use the mouse.
 249
 250 To start easy command mode hit `[ctrl]+[space]`. You can close the command box
 251 with `[esc]`.
 252
 253 === Main ===
 254 `hide`::
 255         Hide GMPC
 256
 257 `show`::
 258         Show GMPC
 259
 260 `show notification`::
 261         Show trayicon notification
 262
 263 === Play Queue ===
 264 `add <query>`::
 265         Add `<query>` to play queue
 266
 267 `clear play queue`::
 268         Clear play queue
 269
 270 `replace <query>`::
 271         Replace play queue
 272
 273 === Playback ===
 274 `consume <on|off>`::
 275         Toggle consume mode `(on|off)`
 276
 277 `crossfade <seconds>`::
 278         Enable crossfade
 279
 280 `mute`::
 281         Mute MPD
 282
 283 `next`::
 284         Play next song
 285
 286 `pause`::
 287         Pause playback
 288
 289 `play`::
 290         Start playback
 291
 292 `play <query>`::
 293         Play `<query>` song
 294
 295 `prev`::
 296         Play previous song
 297
 298 `random <on|off>`::
 299         Toggle random mode `(on|off)`
 300
 301 `repeat <on|off>`::
 302         Toggle repeat mode `(on|off)`
 303
 304 `repeat current song`::
 305         Repeat the current song
 306
 307 `seek <position>`::
 308         Seek within the current song
 309 +
 310 `HH:MM:SS` Seek to position
 311 +
 312 `+HH:MM:SS` Seek relative to current position
 313 +
 314 `-HH:MM:SS` Seek backwards relative to current position
 315
 316 `single <on|off>`::
 317         Toggle single mode (on|off)
 318
 319 `stop`::
 320         Stop playback
 321
 322 `stop after current song`::
 323         Stop playback after the current song
 324
 325 `volume <+|-><level>`::
 326         Change the volume level
 327
 328 === Search ===
 329 `search database <query>`::
 330         Search database
 331
 332 `search playlist <query>`::
 333         Search playlist
 334
 335 === Switch ===
 336 `switch play queue`::
 337         Switch to play queue
 338
 339 `switch search`::
 340         Switch to the search browser