xmms2 - Man Page

xmms2 [command] [arguments]
xmms2 help [command]

XMMS2 is a redesign of the XMMS (https://en.wikipedia.org/wiki/XMMS) music player. It features a client-server model, allowing multiple (even simultaneous!) user interfaces, both textual and graphical. All common audio formats are supported using plugins. On top of this, there is a flexible media library to organise your music.

xmms2 is the official CLI XMMS2 client.

All commands accept the option -h/--help which displays the command's help.

pattern refers to a collection definition. (See Pattern below.)

position is a pattern to match playlist positions. When absent in a command, the default is the end of the playlist. (See Position Pattern below.)

Patterns are used to search for songs in the media library, some of these patterns may require escaping (with '\') depending on what shell is used. The properties can be found in the output of xmms2 info.

<property>:<string>

Match songs whose property matches the string. A ? in the string indicates a single wildcard character, and a * indicates multiple wildcard characters.

<property>~<string>

Match songs whose property fuzzily matches the string. Equal to matching by <property>:*<string>*.

<property><operation><number>

The operation can be <, <=, > or >=, the pattern will match songs whose property is a numerical value smaller, smaller or equal, bigger, bigger or equal in comparison to the number.

+<property>

Match songs which has the property.

in:<namespace>/<collection>

Match songs in the given collection. The namespace may be Playlists, or Collections.

NOT <pattern>

Match the complement of the pattern.

<pattern> <pattern>

<pattern> AND <pattern>

Match songs that are matched by both patterns.

<pattern> OR <pattern>

Match songs that are matched by at least one of the two pattern.

( <pattern> )

Match songs matched by the pattern, used for grouping AND and OR matches.

<string>

Match songs whose artist, title or album match the string.

~<string>

Match songs whose artist, title or album fuzzily matches the string.

#<number>

Match a specific media library id.

Position patterns are used together with commands that operate on playlist content.

M_N

Select playlist entries ranging from M positions before the current song, to N positions after. Both M and N may be omitted and will then default to 0.

-N

Select the song N positions before the current song.

+N

Select the song N positions after the current song.

pos0,pos1,...,posN

Select one to many playlist positions.

Commands that output formatted metadata can be customized with the help of user-defined format strings like the following:

´${artist} - ${title}´

When passed metadata the name of the artist and the title will be inserted into the resulting string. In addition to the metadata supplied from the media library the following list of properties are also available:

position

The current playlist position.

playback_status

The playback status as a string (Stopped, Playing, Paused, Unknown).

playtime

The playtime of the currently playing song.

duration

The duration of the current song, as zero-padded minutes:seconds

minutes

The minutes part, zero-padded, of the current song duration.

seconds

The seconds part, zero-padded, of the current song duration.

A list of command aliases are read from the configuration file in the section [alias] at runtime. The syntax of xmms2 aliases are somewhat similar to bash and other shells. An alias is defined by a list of semi-colon separated commands and arguments. Parameter expansion is supported (see Expansion below).

The default configuration includes the following aliases:

addpls

add -f -P $@

clear

playlist clear

status

current -f $1

ls

list

mute

server volume 0

quit

server shutdown

repeat

seek 0

scap

stop ; playlist clear ; add $@ ; play

All control characters are interpreted as expected, including ANSI escape sequences.

AUTO_UNIQUE_COMPLETE

Boolean, complete an abbreviation of a command and it's arguments. For example: `serv vol 42' will complete to `server volume 42'. (Note: Abbreviations must be non-ambiguous)

CLASSIC_LIST

Boolean, format list output similar to the classic cli.

CLASSIC_LIST_FORMAT

String to format classic list output with.

GUESS_PLS

Boolean, try to guess if the URL is a playlist and add accordingly. (Not reliable)

HISTORY_FILE

File to save command history to.

PLAYLIST_MARKER

String to use to mark the current active entry in the playlist

PROMPT

String to use as a prompt in INTERACTIVE MODE

SERVER_AUTOSTART

Boolean, if true xmms2 will attempt to start xmms2d(1) if it's not running already.

SHELL_START_MESSAGE

Boolean, if true, xmms2 will display a greeting message and basic help when started in INTERACTIVE MODE

STATUS_FORMAT

String to format status output with.

$XDG_CACHE_HOME/xmms2/nyxmms2_history

Default command history file if HISTORY_FILE is unset.

$XDG_CONFIG_HOME/xmms2/clients/nycli.conf

The configuration file for xmms2

XMMS_PATH

Override the default connection path.

To connect via IPv4

tcp://IPv4-Address:port

To connect via IPv6

tcp://[IPv6-Address]:port

To connect via unix socket

unix:///path/to/socket

Please report all bugs at https://github.com/xmms2

Igor Assis, Anders Waldenborg, Anthony Garcia, Sebastien Cevey, and Jonne Lehtinen, Daniel Svensson, Raphaël Bois

See the AUTHORS file in the XMMS2 source distribution for more info.

The blame for this man page is on Anthony.

If you contributed and feel you should be listed here please send me a mail.

playerctl(1), xmms2d(1), xmms2-et(1), xmms2-mdns-avahi(1).