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 === Interface ===
  87 `[ctrl]+i`::
  88         Switch to now playing
  89
  90 `[ctrl]+q`::
  91         Quit GMPC
  92
  93 `[ctrl]+w`::
  94         Close GMPC.
  95
  96 `[ctrl]+[+]`::
  97         Expand GMPC
  98
  99 `[ctrl]+[-]`::
 100         Collapse GMPC
 101
 102 `[ctrl]+[space]`::
 103         Start <<easy_command,easy command>>
 104
 105 `[F1]`::
 106         Switch to play queue
 107
 108 `[F2]`::
 109         Switch to database browser
 110
 111 `[F3]`::
 112         Switch to search browser
 113
 114 `[F4]`::
 115         Switch to metadata browser
 116
 117 `[F5]`::
 118         Switch to playlist editor
 119
 120 `[F12]`::
 121         Toggle fullscreen
 122
 123 `[shift]+[F1]`::
 124         Switch to genre browser
 125
 126 `[shift]+[F2]`::
 127         Switch to artist browser
 128
 129 === Player Control ===
 130 `[ctrl]+k`::
 131         Toggle single mode (on|off)
 132
 133 `[ctrl]+l`::
 134         Toggle consume mode (on|off)
 135
 136 `[ctrl]+m`::
 137         Mute MPD
 138
 139 `[ctrl]+r`::
 140         Toggle repeat mode (on|off)
 141
 142 `[ctrl]+s`::
 143         Toggle random mode (on|off)
 144
 145 `[ctrl]+[<number>]`::
 146         Toggle output (on|off)
 147
 148 `[ctrl]+[down]`::
 149         Stop playback
 150
 151 `[ctrl]+[enter]`::
 152         Add current song to favorites
 153
 154 `[ctrl]+[left]`::
 155         Play previous song
 156
 157 `[ctrl]+[right]`::
 158         Play next song
 159
 160 `[ctrl]+[up]`::
 161         Pause/Start playback
 162
 163 == Query Syntax ==
 164 Query syntax is used in the search browser, playlist quick search and in
 165 <<easy_command,easy command>>. It supports the following fields and is used
 166 with `<field>=<value>`.
 167
 168 NOTE: You can also run multiple queries by using the `or` operator `||`.
 169
 170 === Fields ===
 171 `albuartist`
 172
 173 `album`
 174
 175 `any`::
 176         Search in all fields
 177
 178 `artist`
 179
 180 `comment`
 181
 182 `composer`
 183
 184 `date`
 185
 186 `disc`
 187
 188 `filename`
 189
 190 `genre`
 191
 192 `name`::
 193         Only applies to streams
 194
 195 `performer`
 196
 197 `title`
 198
 199 `track`
 200
 201 [[easy_command]]
 202 == Easy Command ==
 203 Easy command gives you a small command box, allowing you to quickly execute
 204 commands without having to use the mouse.
 205
 206 To start easy command mode hit `[ctrl]+[space]`.
 207
 208 === Main ===
 209 `hide`::
 210         Hide GMPC
 211
 212 `show`::
 213         Show GMPC
 214
 215 `show notification`::
 216         Show trayicon notification
 217
 218 === Play Queue ===
 219 `add <query>`::
 220         Add `<query>` to play queue
 221
 222 `clear play queue`::
 223         Clear play queue
 224
 225 `replace <query>`::
 226         Replace play queue
 227
 228 === Playback ===
 229 `consume <on|off>`::
 230         Toggle consume mode `(on|off)`
 231
 232 `crossfade <seconds>`::
 233         Enable crossfade
 234
 235 `mute`::
 236         Mute MPD
 237
 238 `next`::
 239         Play next song
 240
 241 `pause`::
 242         Pause playback
 243
 244 `play`::
 245         Start playback
 246
 247 `play <query>`::
 248         Play `<query>` song
 249
 250 `prev`::
 251         Play previous song
 252
 253 `random <on|off>`::
 254         Toggle random mode `(on|off)`
 255
 256 `repeat <on|off>`::
 257         Toggle repeat mode `(on|off)`
 258
 259 `repeat current song`::
 260         Repeat the current song
 261
 262 `seek <position>`::
 263         Seek within the current song
 264 +
 265 `HH:MM:SS` Seek to position
 266 +
 267 `+HH:MM:SS` Seek relative to current position
 268 +
 269 `-HH:MM:SS` Seek backwards relative to current position
 270
 271 `single <on|off>`::
 272         Toggle single mode (on|off)
 273
 274 `stop`::
 275         Stop playback
 276
 277 `stop after current song`::
 278         Stop playback after the current song
 279
 280 `volume <+|-><level>`::
 281         Change the volume level
 282
 283 === Search ===
 284 `search database <query>`::
 285         Search database
 286
 287 `search playlist <query>`::
 288         Search playlist
 289
 290 === Switch ===
 291 `switch play queue`::
 292         Switch to play queue
 293
 294 `switch search`::
 295         Switch to the search browser