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 == Query Syntax ==
  85 Query syntax is used in the search browser, playlist quick search and in easy
  86 command. It supports the following fields and is used with `<field>=<value>`.
  87
  88 NOTE: You can also run multiple queries by using the `or` operator `||`.
  89
  90 === Fields ===
  91 `albuartist`
  92
  93 `album`
  94
  95 `any`::
  96         Search in all fields
  97
  98 `artist`
  99
 100 `comment`
 101
 102 `composer`
 103
 104 `date`
 105
 106 `disc`
 107
 108 `filename`
 109
 110 `genre`
 111
 112 `name`::
 113         Only applies to streams
 114
 115 `performer`
 116
 117 `title`
 118
 119 `track`
 120
 121 == Easy Command ==
 122 Easy command gives you a small command box, allowing you to quickly execute
 123 commands without having to use the mouse.
 124
 125 To start easy command mode hit `[ctrl]+[space]`.
 126
 127 === Main ===
 128 `hide`::
 129         Hide GMPC
 130
 131 `show`::
 132         Show GMPC
 133
 134 `show notification`::
 135         Show trayicon notification
 136
 137 === Play Queue ===
 138 `add <query>`::
 139         Add `<query>` to play queue
 140
 141 `clear play queue`::
 142         Clear play queue
 143
 144 `replace <query>`::
 145         Replace play queue
 146
 147 === Playback ===
 148 `consume <on|off>`::
 149         Switch consume mode `(on|off)`
 150
 151 `crossfade <seconds>`::
 152         Enable crossfade
 153
 154 `mute`::
 155         Mute MPD
 156
 157 `next`::
 158         Play next song
 159
 160 `pause`::
 161         Pause playback
 162
 163 `play`::
 164         Start playback
 165
 166 `play <query>`::
 167         Play `<query>` song
 168
 169 `prev`::
 170         Play previous song
 171
 172 `random <on|off>`::
 173         Switch random mode `(on|off)`
 174
 175 `repeat <on|off>`::
 176         Switch repeat mode `(on|off)`
 177
 178 `repeat current song`::
 179         Repeat the current song
 180
 181 `seek <position>`::
 182         Seek within the current song
 183 +
 184 `HH:MM:SS` Seek to position
 185 +
 186 `+HH:MM:SS` Seek relative to current position
 187 +
 188 `-HH:MM:SS` Seek backwards relative to current position
 189
 190 `single <on|off>`::
 191         Switch single mode (on|off)
 192
 193 `stop`::
 194         Stop playback
 195
 196 `stop after current song`::
 197         Stop playback after the current song
 198
 199 `volume <+|-><level>`::
 200         Change the volume level
 201
 202 === Search ===
 203 `search database <query>`::
 204         Search database
 205
 206 `search playlist <query>`::
 207         Search playlist
 208
 209 === Switch ===
 210 `switch play queue`::
 211         Switch to play queue
 212
 213 `switch search`::
 214         Switch to the search browser