1XMMS2(1) General Commands Manual XMMS2(1)
2
6 xmms2 - offers a simple command-line interface to the XMMS2 daemon
7
9 xmms2 command
10 xmms2 mlib command
12 xmms2 playlist command
14 xmms2 coll command
16
18 XMMS2 is a redesign of the XMMS (http://www.xmms.org) music player. It
19 features a client-server model, allowing multiple (even simultaneous!)
20 user interfaces, both textual and graphical. All common audio formats
21 are supported using plugins. On top of this, there is a flexible media
22 library to organize your music.
23 xmms2 is the official command-line interface client for XMMS2 and acts
25 as a reference implementation for the development of new clients.
26 xmms2 is able to issue commands to control the active playlist and
27 playback as well as commands to control the media library.
28 The following commands effect the current XMMS2 playlist.
30 xmms2 includes many commands that allow the user to execute actions on
32 xmms2d.
33 These commands are currently recognized:
35 add [playlist] url...
37 Adds URL(s) to playlist or the active playlist.
38 addarg [playlist] url arguments
40 Adds an URL to playlist or the active playlist, with arguments.
41 addid [playlist] medialib_id...
43 Adds song(s) to playlist or the active playlist using its Media
44 Library ID.
45 addpls [playlist] url
47 Adds a playlist in a file to playlist or the active playlist.
48 insert [playlist] pos url
50 Adds a URL to playlist or the active playlist at a specific
51 position.
52 insertid [playlist] pos medialib_id
54 Adds a song to playlist or the active playlist at a specific
55 position using its Media Library ID.
56 radd [playlist] directory
58 Adds a directory of songs recursively to playlist or the active
59 playlist.
60 clear [playlist]
62 Clears all entries from playlist or the active playlist.
63 shuffle [playlist]
65 Places the songs in playlist or the active playlist in a random
66 order.
67 sort property
69 Sort the active playlist based on metadata from the Media
70 Library. The metadata which is used for the sorting is based on
71 what was given for property. An overview of the media library,
72 and the potential properties, can be found in the MEDIA LIBRARY
73 section of this manual page.
74 sort playlist properties
76 Sort playlist based on metadata from the Media Library. Separate
77 the properties with a spaces.
78 remove [playlist] playlist_position
80 Removes a song from playlist or the active playlist at the posi‐
81 tion given by playlist_position.
82 list [playlist]
84 Lists the contents of playlist or the active playlist. An expla‐
85 nation of how to change the output format can be found in the
86 FILES section of this manual page.
87 play Starts playback of the playlist.
89 stop Stops playback of the playlist.
91 toggleplay
93 Toggles playback status between play/pause
94 pause Pauses playback of the playlist.
96 next Skips to the next song in the playlist.
98 prev Skips to the previous song in the playlist.
100 seek [+ / -]seconds
102 Seeks to a specific position in the currently playing song. The
103 way in which seek moves in the file is based on the arguments
104 passed to it. If + is used xmms2 will seek seconds forward in
105 the song. If - is used xmms2 will seek seconds backwards in the
106 song. If merely a number of seconds is given xmms2 will seek to
107 that absolute position in the song.
108 jump [+ / -]playlist_position
110 Jumps to playlist_position in the playlist or playlist_position
111 forward/backward if + or - is specified.
112 move [playlist] playlist_position new_position
114 Moves the song at playlist position to the position denoted by
115 new_position in playlist or the active playlist.
116 volume channel volume
118 Sets the volume of channel to volume.
119 volume_list
121 Lists the volume for each channel.
122 mlib Allows for the manipulation of the Media Library. The signifi‐
124 cance of the sub-commands of mlib can be found in the MEDIA
125 LIBRARY section of this manual page.
126 playlist
128 Allows for the manipulation of playlists. The significance of
129 the sub-commands of playlist can be found in the PLAYLIST sec‐
130 tion of this manual page.
131 coll Allows for the manipulation of collections. The significance of
133 this sub-commands of coll can be found in the COLLECTIONS sec‐
134 tion of this manual page.
135 browse url
137 Lists the contents of url in a list of encoded urls.
138 status Gives a live status of the currently playing song.
140 info [id]
142 Gives the metadata archived by the Media Library for Media
143 Library id id or the currently playing song.
144 current [pattern]
146 Gives some summary of the currently playing song's meta data. A
147 pattern can be specified in the form "${album} - ${tracknr}".
148 Please be aware of your shells substitution features.
149 config config_key [=] value
151 Sets config_key to value on xmms2d(8).
152 config_list
154 Lists all the configuration values of XMMS2.
155 plugin_list
157 Prints a list of the plugins being used by XMMS2.
158 stats Retrieves the uptime and version from XMMS2.
160 quit Makes xmms2d(8) quit.
162 help Prints a concise overview of all commands offered by xmms2.
164
166 XMMS2 stores metadata about every song in the Media Library. One can
167 retrieve data from the Media Library using the mlib command of xmms2.
168 The Media Library is an SQL database which is created and accessed by
169 use of the sqlite library. xmms2 mlib includes many commands for
170 manipulating and retrieving data from the Media Library.
171 The following mlib commands are currently recognized:
173 add url
175 Adds a URL to the Media Library but not to the current playlist.
176 The Media Library also fetches associated metadata for the added
177 song.
178 loadall
180 Load all songs in the Media Library into the current playlist.
181 searchadd pattern
183 Searches the Media Library for songs that match pattern criteria
184 and adds them to the current playlist.
185 search pattern
187 Searches and returns a list of songs in the Media Library that
188 match pattern.
189 For example one could execute:
191 xmms2 mlib search artist:Dismantled
193 The result of which would be that all songs by Dismantled in the
195 Media Library would be listed.
196 addpath path
198 Adds all songs in directory path into the Media Library.
199 rehash Force the Media Library to check whether its data is up to date.
201 remove id
203 Removes a song from the Media Library with the id id.
204 setstr id key value [source]
206 sets a string Media Library property with key key and value
207 value for song with ID id. Optionally a source can be supplied
208 with the source argument. If no source is defined
209 client/xmms2-cli will be used.
210 setint id key value [source]
212 Sets a string Media Library property with key key and value
213 value for song with ID id. Optionally a source can be supplied
214 with the source argument. If no source is defined
215 client/xmms2-cli will be used.
216 rmprop id key [source]
218 Removes properties from the Media Library entry with id and with
219 key key and optionally source source.
220 addcover file id
222 Add a cover image for id(s) id.
223 The Media Library allows for any variety of keys (sometimes called
225 properties) to be stored within. There is no set list of available keys
226 but rather the Media Library can store any variety of different values.
227 For this reason it is difficult to give a complete list of available
228 keys but some examples are:
229 url The path to the song in url
231 added The time in seconds since UTC 00:00:00, 1 Jan 1970 that the song
233 was added to the Media Library
234 mime The MIME type of the song in the Media Library
236 lmod The last time in seconds since UTC 00:00:00, 1 Jan 1970 that the
238 song was modified
239 laststarted
241 The last time the song was played
242 timesplayed
244 The number of times the song was played
245 duration
247 The length of the song in milliseconds
248 bitrate
250 The bitrate of the song in bps
251 album The name of the album the song is on
253 artist The name of the artist that produced the song
255 title The title of the song
257 tracknr
259 The track number of the song
260 {album, artist, track}_id
262 MusicBrainz ID numbers for the song
263
265 XMMS2 has support for playlists which is tightly coupled with XMMS2's
266 Collections system. Playlist manipulation is accessible with the
267 playlist command of xmms2. xmms2 playlist includes many commands for
268 manipulating and retrieving data about playlists.
269 The following playlist commands are currently recognized:
271 list Lists all currently available playlists.
273 create [playlistname]
275 Create a new playlist named playlistname.
276 type [playlistname] [type]
278 Sets type of the playlist named playlistname to type type.
279 Descriptions of the available types can be found later in the
280 PLAYLIST section of this manual page.
281 load [playlistname]
283 Load a playlist specified by playlistname from the Media Library
284 remove [playlistname]
286 Remove a playlist specified by playlistname from the Media
287 Library
288 XMMS2 currently supports three types of playlists, each of these
290 playlists has a number of attributes which can be set using the coll
291 attr command described in the COLLECTIONS section of this manual page.
292 The available playlist types are:
293 list A simple list of medialib ids. The list has one attribute:
295 jumplist which is the name of a playlist to jump to when the list is
297 finished.
298 queue A static playlist which supports a fixed length playlist where
300 songs are removed as they are played. The queue has two
301 attributes:
302 jumplist which is the name of a playlist to jump to when the queue is
304 finished
305 history which is the number of played entries to keep before beginning
307 to remove them
308 pshuffle
310 A playlist which picks a configurable number of songs from a
311 collection at random. The pshuffle has three attributes:
312 jumplist which is the name of a playlist to jump to when the pshuffle
314 is finished. A pshuffle playlist only finishes when the collection from
315 which new songs are pulled dries up, for instance when filtering on
316 timesplayed < 1
317 history which is the number of played entries to keep before beginning
319 to remove them
320 upcoming which is the number of unplayed entries to show in the
322 playlist
323
325 XMMS2 includes an extremely powerful method for querying and selecting
326 music from the Media Library called Collections. Some of the features
327 of collections are made accessible via the xmms2 client. xmms2 coll
328 includes many commands for manipulating and retrieving data about Col‐
329 lections.
330 The following coll commands are currently recognized:
332 save [collname] [pattern]
334 Save the pattern pattern as a Collection named collname
335 rename [oldname] [newname]
337 Rename a Collection from oldname to newname.
338 list [namespace]
340 List all Collections, or if namespace is specified list only
341 collections in the Collections or Playlists namespace.
342 query [collname] [order]
344 Retrieve information about all media in the Collection named
345 collname ordered by order
346 queryadd [collname] [order]
348 Add all media from the Collection collname ordered by order to
349 the active playlist
350 find [mid] [namespace]
352 Find all collections in namespace that include the media refer‐
353 enced by mid
354 get [collname]
356 Display information about the Collection collname
357 remove [collname]
359 Remove the collection referenced by collname
360 attr [collname] [attr] [val]
362 Set or get an attribute of name attr to value val on Collection
363 collname
364 xmms2 sometimes requires that the namespace of a Collection be speci‐
366 fied in collname. This is done by prepending either Playlists/ or Col‐
367 lections/ to the beginning of the Collection name. If not specified the
368 namespace defaults to Collections.
369
371 $XDG_CONFIG_HOME/xmms2/clients/cli.conf or
372 $HOME/Library/xmms2/clients/cli.conf or $HOME/.con‐
373 fig/xmms2/clients/cli.conf
374 A configuration file containing basic configuration values for
375 xmms2, including the output format used by the list and status
376 commands.
377
379 XMMS_PATH
380 The URL path to xmms2d.
381 XDG_CONFIG_HOME
383 The path where the xmms2 configuration files are located See IPC
384 SOCKET in xmms2d(8) for details of possible values for this
385 variable
386
389 xmms2d(8), http://xmms2.xmms.org
390
392 The XMMS2 Project was started by Tobias Rundström and Anders Gustafs‐
393 son. It is developed with their lead by a small group of contributors
394 from all over the world.
395
397 This manual page was written by Alexander Botero-Lowry <alex@foxy‐
398 banana.com>
399 XMMS2(1)