1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
|
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % deejaydent SYSTEM "deejayd.ent">
%deejaydent;
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Alexandre</firstname>">
<!ENTITY dhsurname "<surname>Rossi</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>June, 30th 2008</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>5</manvolnum>">
<!ENTITY dhemail "<email>alexandre.rossi@gmail.com</email>">
<!ENTITY dhusername "Alexandre Rossi">
<!ENTITY dhucpackage "<refentrytitle>DEEJAYD.CONF</refentrytitle>">
<!ENTITY dhpackage "deejayd.conf">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<copyright>
<year>2008</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Site-wide configuration file for deejayd,
a media player daemon.</refpurpose>
</refnamediv>
<refsect1>
<title>DESCRIPTION</title>
<para>The file <filename>/etc/deejayd.conf</filename> is an INI like file
which configures <literal>deejayd</literal>. The format looks like this :
</para>
<informalexample><programlisting>
[sectionname]
variable = value
othervariable = othervalue
[othersection]
foo = bar
</programlisting></informalexample>
</refsect1>
<refsect1>
<title>general section</title>
<para>This section defines the <parameter>general</parameter> section
configuration values for all of deejayd components.</para>
<variablelist>
<varlistentry>
<term>log</term>
<listitem>
<para>Log level. Possible values are
<parameter>error</parameter> to log only errors,
<parameter>info</parameter> to be more verbose and
<parameter>debug</parameter> to log all messages.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>activated_modes</term>
<listitem>
<para>Modes enabled. Available modes are :
<parameter>playlist</parameter> for audio playlists,
<parameter>panel</parameter> for audio panel mode like rhythmbox,
<parameter>webradio</parameter> for streamed webradios,
<parameter>video</parameter> for video directories playback,
<parameter>dvd</parameter> for DVD playback.
As an example :
</para>
<informalexample><programlisting>
activated_modes = playlist, panel, webradio, video
</programlisting></informalexample>
</listitem>
</varlistentry>
<varlistentry>
<term>fullscreen</term>
<listitem>
<para>Fullscreen video. This is mainly a debugging configuration
value and you want this to be set to <parameter>yes</parameter> if
you use the video mode. Set this to <parameter>no</parameter> if you
want to be able to control deejayd using some graphical client on
the same display.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>replaygain</term>
<listitem>
<para>Replaygain support, <parameter>yes</parameter> or
<parameter>no</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>media_backend</term>
<listitem>
<para>The chosen media backend. Possible values are :
<parameter>auto</parameter> for whichever works, trying first with
Xine,
<parameter>xine</parameter> for the Xine backend,
<parameter>gstreamer</parameter> for the GStreamer backend.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>net section</title>
<para>This section defines the <parameter>net</parameter> section
configuration values. This defines all that relates to the TCP XML
messaging interface to deejayd.</para>
<variablelist>
<varlistentry>
<term>enabled</term>
<listitem>
<para>Remote control using XML messages, <parameter>yes</parameter>
or <parameter>no</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>port</term>
<listitem>
<para>The numerical TCP port number to listen on for XML messages,
<parameter>yes</parameter> or <parameter>no</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>bind_addresses</term>
<listitem>
<para>The hostname(s), the IP address(es) of the network ipv4
interface to listen on for XML messages, or
<parameter>all</parameter> to listen on all available interfaces.
</para>
<informalexample><programlisting>
bind_addresses = localhost, 192.168.51.1, 10.2.3.4
</programlisting></informalexample>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>webui section</title>
<para>This section defines the <parameter>webui</parameter> section
configuration values. This defines all that relates to the HTTP web user
interface to deejayd.</para>
<variablelist>
<varlistentry>
<term>enabled</term>
<listitem>
<para>Remote control using the HTTP web ui, <parameter>yes</parameter>
or <parameter>no</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>port</term>
<listitem>
<para>The numerical TCP port number to listen on for HTTP request.
<parameter>yes</parameter> or <parameter>no</parameter>. You can then
access the web ui by pointing your browser to
<filename>http://deejayd-host:port/</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>bind_addresses</term>
<listitem>
<para>The hostname(s), the IP address(es) of the network ipv4
interface to listen on for HTTP requests, or
<parameter>all</parameter> to listen on all available interfaces.
</para>
<informalexample><programlisting>
bind_addresses = 192.168.51.2, 10.0.0.3
</programlisting></informalexample>
</listitem>
</varlistentry>
<varlistentry>
<term>tmp_dir</term>
<listitem>
<para>This is a temporary directory used by the deejayd webui for
caching. It should probably be located in <filename>/tmp</filename>.
The only use case which would involve changing this would be for
running multiple deejayd daemons running on the same host (with both
webuis enabled).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>refresh</term>
<listitem>
<para>Automatic refreshing time for the webui (in seconds). This is
the delay after which your browser will be asked to reload the web ui
state (song position, current song, etc). Set to
<parameter>0</parameter> to disable this automatic reloading.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>database section</title>
<para>This section defines the <parameter>database</parameter> section
configuration values. This defines all that relates to the internal media
database used by deejayd.</para>
<variablelist>
<varlistentry>
<term>db_type</term>
<listitem>
<para>Database backend used, among <parameter>sqlite</parameter>
and <parameter>mysql</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>db_name</term>
<listitem>
<para>(SQLite only) The full path to the sqlite database file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>db_user</term>
<listitem>
<para>(MySQL only) The username to use to connect to the database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>db_password</term>
<listitem>
<para>(MySQL only) The password to use to connect to the database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>db_host</term>
<listitem>
<para>(MySQL only) The host to try to connect to to reach the
database.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>db_port</term>
<listitem>
<para>(MySQL only) The port to try to connect to to reach the
database. Usually <parameter>3306</parameter>.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>mediadb section</title>
<para>This section defines the <parameter>mediadb</parameter> section
configuration values. This defines all that relates to the relationship
between you media files and deejayd and its database.</para>
<para>Symlinked directories in both audio and video locations will be
followed and watched if <literal>inotify</literal> is supported.</para>
<variablelist>
<varlistentry>
<term>music_directory</term>
<listitem>
<para>The full path to the directory holding you music files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>video_directory</term>
<listitem>
<para>The full path to the directory holding you video files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>filesystem_charset</term>
<listitem>
<para>The character set to use to decode your filenames. This should
probably be autodetected.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>panel section</title>
<para>This section defines the <parameter>panel</parameter> section
configuration values. Those options configure the behaviour of the
<parameter>panel</parameter> mode.</para>
<variablelist>
<varlistentry>
<term>panel_tags</term>
<listitem>
<para>Music tags that are avilable for filtering in the
<parameter>panel</parameter> mode. Available possibilities are :
<parameter>genre,artist,album</parameter> which is the default,
<parameter>artist,album</parameter>,
<parameter>genre,various_artist,album</parameter>,
<parameter>various_artist,album</parameter>.
<parameter>various_artist</parameter> here is the same as artist,
except compilation albums are grouped into a special
"Various Artists" label.</para>
<para>As an example :</para>
<informalexample><programlisting>
panel_tags = genre,artist,album
</programlisting></informalexample>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>gstreamer section</title>
<para>This section defines the <parameter>gstreamer</parameter> section
configuration values. Those options are specific to the GStreamer backend.
</para>
<variablelist>
<varlistentry>
<term>audio_output</term>
<listitem>
<para>The output device to use. This is usually one among
<parameter>auto</parameter>,
<parameter>alsa</parameter>,
<parameter>oss</parameter>,
<parameter>esd</parameter>, etc.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>alsa_card</term>
<listitem>
<para>Optionnaly, the alsa card to output to,
e.g. <parameter>hw:2</parameter>.
This is useful if you have more than one soundcard.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>xine section</title>
<para>This section defines the <parameter>xine</parameter> section
configuration values. Those options are specific to the Xine backend.
</para>
<para>The Xine backend may be customised even more using de Xine
configuration file used by deejayd. This is usually
<filename>~/.xine/config</filename>, <parameter>~</parameter> being
to home directory of the user running deejayd. This should change to be
<filename>/etc</filename>.
</para>
<variablelist>
<varlistentry>
<term>audio_output</term>
<listitem>
<para>The output device to use. This is usually one among
<parameter>auto</parameter>,
<parameter>alsa</parameter>,
<parameter>oss</parameter>, etc.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>software_mixer</term>
<listitem>
<para>Set to true to use xine software mixer
<parameter>yes</parameter> or
<parameter>no</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>video_output</term>
<listitem>
<para>The video driver to use. This is usually one among
<parameter>auto</parameter>,
<parameter>xv</parameter>,
<parameter>x</parameter>, etc.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>video_display</term>
<listitem>
<para>The X display to play the video to.
Usually <parameter>:0.0</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>osd_support</term>
<listitem>
<para>On-screen display enabled <parameter>yes</parameter> or
<parameter>no</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>osd_font_size</term>
<listitem>
<para>The On-screen display font size, an integer.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&deejayd;.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; &dhemail; for
the &debian; system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the &gnu; General Public License, Version 2 any
later version published by the Free Software Foundation.
</para>
<para>
On Debian systems, the complete text of the GNU General Public
License can be found in /usr/share/common-licenses/GPL.
</para>
</refsect1>
</refentry>
|
