1XMMS2D(1) General Commands Manual XMMS2D(1)
2
6 xmms2d - XMMS2 daemon which handles the playback of music and storage
7 of music metadata
8
10 xmms2d [-v|-q] [-p dir] [-o plugin] [-i url] [-c file] [-s fd] [--yes-
11 run-as-root]
12 xmms2d -?
13 xmms2d -V
14
16 XMMS2 is a redesign of the XMMS (http://legacy.xmms2.org) music player.
17 It features a client-server model, allowing multiple (even simultane‐
18 ous!) user interfaces, both textual and graphical. All common audio
19 formats are supported using plugins. On top of this, there is a flexi‐
20 ble media library to organise your music.
21 xmms2d is the daemon through which XMMS2 clients playback and manage
23 music. A client library provided allows third parties to easily write
24 XMMS2 clients, especially using the Python and Ruby bindings.
25 xmms2d uses a three part method to playback music. Music is accessed
27 from disk or network using a transport plugin, the data is then passed
28 on to a decoder plugin which decodes the audio into a form that can be
29 played back by an output plugin.
30
32 General options
33 -v, --verbose
34 Increase verbosity.
35 -q, --quiet
37 Decrease verbosity.
38 -p dir, --plugindir=dir
40 Use plugin directory dir.
41 -o plugin, --output=plugin
43 Use output plugin plugin.
44 -i url, --ipc-socket=url
46 Listen to socket at url. Multiple sockets can be specified
47 seperated by ;-characters. See section IPC SOCKET.
48 -c file, --conf=file
50 Use configuration file file.
51 -s fd, --status-fd=fd
53 Write to filedescriptor fd when started. This can be used to
54 wait until inter-process communication (IPC) is up, as for
55 instance xmms2-launcher(1) does.
56 --yes-run-as-root
58 Allow xmms2d to be run as root.
59 Getting help
61 -h, -?, --help
62 Display basic help information and exit.
63 -V, --version
65 Display version information.
66
68 XMMS2 clients use IPC sockets to communicate with xmms2d. These IPC
69 sockets are specified in an URL based format with three possible trans‐
70 port methods: unix, tcp, and tcp6.
71 The TCP methods allow clients to connect over IPv4 and IPv6 to xmms2d
73 and therefore allow remote control of XMMS2. A typical IPC socket url
74 using TCP is tcp://127.0.0.1:9667.
75 The UNIX transport method is for local clients only and creates a file
77 through which XMMS2 clients can access xmms2d. A typical IPC socket
78 path using the UNIX transport is unix:///tmp/xmms-ipc-foobar.
79
81 Below CONFDIR is $XDG_CONFIG_HOME/xmms2 on UNIX if the XDG_CONFIG_HOME-
82 environment variable is set. Otherwise it is $HOME/.config/xmms2 (UNIX
83 except Darwin), or $HOME/Library/xmms2 (Darwin). On Win32 it is %APP‐
84 DATA%/xmms2.
85 CONFDIR/xmms2.conf
87 An XML formatted configuration file that allows changing the
88 settings of xmms2d.
89 CONFDIR/startup.d/
91 A directory populated with programs that are run when xmms2d is
92 executed. An alternative location can be specified in the con‐
93 figuration file.
94 CONFDIR/shutdown.d/
96 A directory populated with programs that are run when xmms2d is
97 shutdown correctly. An alternative location can be specified in
98 the configuration file.
99 CONFDIR/medialib.db
101 An sqlite3(1) database that includes information about each song
102 that has been added the the XMMS2 media library. An alternative
103 location can be specified in the configuration file.
104 CONFDIR/bindata/
106 A directory that contains files with binary data entrusted to
107 the XMMS2 media library, such as cover art. An alternative
108 location can be specified in the configuration file.
109 /tmp/xmms-ipc-USER
111 The typical location for the UNIX IPC Socket. Here USER is the
112 name of the user that executed xmms2d.
113
115 XDG_CONFIG_HOME
116 The path where the XMMS2 configuration files and resources are
117 located.
118 XMMS_PATH
120 The url of the first socket that xmms2d listens to. This envi‐
121 ronment variable is set for programs in the startup and shutdown
122 directories.
123 XMMS_PATH_FULL
125 A ;-seperated list of paths to which xmms2d listens. This envi‐
126 ronment variable is set for programs in the startup and shutdown
127 directories.
128
130 xmms2(1), xmms2-launcher(1), http://xmms2.org/.
131
133 The XMMS2 Project was started by Tobias Rundström and Anders Walden‐
134 borg. It is developed by a small group of contributers from all over
135 the world.
136
138 This manual page was originally written by Alexander Botero-Lowry
139 <alex@foxybanana.com>. It was reformatted and slightly extended by Erik
140 Massop <e.massop@hccnet.nl>.
141 XMMS2D(1)