'\" t
.\"     Title: DEEJAYD.CONF
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: June, 30th 2008
.\"    Manual: [FIXME: manual]
.\"    Source: [FIXME: source]
.\"  Language: English
.\"
.TH "DEEJAYD\&.CONF" "5" "June, 30th 2008" "[FIXME: source]" "[FIXME: manual]"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
deejayd.conf \- Site\-wide configuration file for deejayd, a media player daemon\&.
.SH "DESCRIPTION"
.PP
The file
/etc/deejayd\&.conf
is an INI like file which configures
deejayd\&. The format looks like this :
.sp
.if n \{\
.RS 4
.\}
.nf
[sectionname]
variable = value
othervariable = othervalue

[othersection]
foo = bar
.fi
.if n \{\
.RE
.\}
.SH "GENERAL SECTION"
.PP
This section defines the
\fIgeneral\fR
section configuration values for all of deejayd components\&.
.PP
log
.RS 4
Log level\&. Possible values are
\fIerror\fR
to log only errors,
\fIinfo\fR
to be more verbose and
\fIdebug\fR
to log all messages\&.
.RE
.PP
activated_modes
.RS 4
Modes enabled\&. Available modes are :
\fIplaylist\fR
for audio playlists,
\fIpanel\fR
for audio panel mode like rhythmbox,
\fIwebradio\fR
for streamed webradios,
\fIvideo\fR
for video directories playback,
\fIdvd\fR
for DVD playback\&. As an example :
.sp
.if n \{\
.RS 4
.\}
.nf
activated_modes = playlist, panel, webradio, video
.fi
.if n \{\
.RE
.\}
.RE
.PP
fullscreen
.RS 4
Fullscreen video\&. This is mainly a debugging configuration value and you want this to be set to
\fIyes\fR
if you use the video mode\&. Set this to
\fIno\fR
if you want to be able to control deejayd using some graphical client on the same display\&.
.RE
.PP
replaygain
.RS 4
Replaygain support,
\fIyes\fR
or
\fIno\fR\&.
.RE
.PP
media_backend
.RS 4
The chosen media backend\&. Possible values are :
\fIauto\fR
for whichever works, trying first with Xine,
\fIxine\fR
for the Xine backend,
\fIgstreamer\fR
for the GStreamer backend\&.
.RE
.SH "NET SECTION"
.PP
This section defines the
\fInet\fR
section configuration values\&. This defines all that relates to the TCP XML messaging interface to deejayd\&.
.PP
enabled
.RS 4
Remote control using XML messages,
\fIyes\fR
or
\fIno\fR\&.
.RE
.PP
port
.RS 4
The numerical TCP port number to listen on for XML messages,
\fIyes\fR
or
\fIno\fR\&.
.RE
.PP
bind_addresses
.RS 4
The hostname(s), the IP address(es) of the network ipv4 interface to listen on for XML messages, or
\fIall\fR
to listen on all available interfaces\&.
.sp
.if n \{\
.RS 4
.\}
.nf
bind_addresses = localhost, 192\&.168\&.51\&.1, 10\&.2\&.3\&.4
.fi
.if n \{\
.RE
.\}
.RE
.SH "WEBUI SECTION"
.PP
This section defines the
\fIwebui\fR
section configuration values\&. This defines all that relates to the HTTP web user interface to deejayd\&.
.PP
enabled
.RS 4
Remote control using the HTTP web ui,
\fIyes\fR
or
\fIno\fR\&.
.RE
.PP
port
.RS 4
The numerical TCP port number to listen on for HTTP request\&.
\fIyes\fR
or
\fIno\fR\&. You can then access the web ui by pointing your browser to
http://deejayd\-host:port/\&.
.RE
.PP
bind_addresses
.RS 4
The hostname(s), the IP address(es) of the network ipv4 interface to listen on for HTTP requests, or
\fIall\fR
to listen on all available interfaces\&.
.sp
.if n \{\
.RS 4
.\}
.nf
bind_addresses = 192\&.168\&.51\&.2, 10\&.0\&.0\&.3
.fi
.if n \{\
.RE
.\}
.RE
.PP
tmp_dir
.RS 4
This is a temporary directory used by the deejayd webui for caching\&. It should probably be located in
/tmp\&. 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)\&.
.RE
.PP
refresh
.RS 4
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
\fI0\fR
to disable this automatic reloading\&.
.RE
.SH "DATABASE SECTION"
.PP
This section defines the
\fIdatabase\fR
section configuration values\&. This defines all that relates to the internal media database used by deejayd\&.
.PP
db_type
.RS 4
Database backend used, among
\fIsqlite\fR
and
\fImysql\fR\&.
.RE
.PP
db_name
.RS 4
(SQLite only) The full path to the sqlite database file\&.
.RE
.PP
db_user
.RS 4
(MySQL only) The username to use to connect to the database\&.
.RE
.PP
db_password
.RS 4
(MySQL only) The password to use to connect to the database\&.
.RE
.PP
db_host
.RS 4
(MySQL only) The host to try to connect to to reach the database\&.
.RE
.PP
db_port
.RS 4
(MySQL only) The port to try to connect to to reach the database\&. Usually
\fI3306\fR\&.
.RE
.SH "MEDIADB SECTION"
.PP
This section defines the
\fImediadb\fR
section configuration values\&. This defines all that relates to the relationship between you media files and deejayd and its database\&.
.PP
Symlinked directories in both audio and video locations will be followed and watched if
inotify
is supported\&.
.PP
music_directory
.RS 4
The full path to the directory holding you music files\&.
.RE
.PP
video_directory
.RS 4
The full path to the directory holding you video files\&.
.RE
.PP
filesystem_charset
.RS 4
The character set to use to decode your filenames\&. This should probably be autodetected\&.
.RE
.SH "PANEL SECTION"
.PP
This section defines the
\fIpanel\fR
section configuration values\&. Those options configure the behaviour of the
\fIpanel\fR
mode\&.
.PP
panel_tags
.RS 4
Music tags that are avilable for filtering in the
\fIpanel\fR
mode\&. Available possibilities are :
\fIgenre,artist,album\fR
which is the default,
\fIartist,album\fR,
\fIgenre,various_artist,album\fR,
\fIvarious_artist,album\fR\&.
\fIvarious_artist\fR
here is the same as artist, except compilation albums are grouped into a special "Various Artists" label\&.
.sp
As an example :
.sp
.if n \{\
.RS 4
.\}
.nf
panel_tags = genre,artist,album
.fi
.if n \{\
.RE
.\}
.RE
.SH "GSTREAMER SECTION"
.PP
This section defines the
\fIgstreamer\fR
section configuration values\&. Those options are specific to the GStreamer backend\&.
.PP
audio_output
.RS 4
The output device to use\&. This is usually one among
\fIauto\fR,
\fIalsa\fR,
\fIoss\fR,
\fIesd\fR, etc\&.
.RE
.PP
alsa_card
.RS 4
Optionnaly, the alsa card to output to, e\&.g\&.
\fIhw:2\fR\&. This is useful if you have more than one soundcard\&.
.RE
.SH "XINE SECTION"
.PP
This section defines the
\fIxine\fR
section configuration values\&. Those options are specific to the Xine backend\&.
.PP
The Xine backend may be customised even more using de Xine configuration file used by deejayd\&. This is usually
~/\&.xine/config,
\fI~\fR
being to home directory of the user running deejayd\&. This should change to be
/etc\&.
.PP
audio_output
.RS 4
The output device to use\&. This is usually one among
\fIauto\fR,
\fIalsa\fR,
\fIoss\fR, etc\&.
.RE
.PP
software_mixer
.RS 4
Set to true to use xine software mixer
\fIyes\fR
or
\fIno\fR\&.
.RE
.PP
video_output
.RS 4
The video driver to use\&. This is usually one among
\fIauto\fR,
\fIxv\fR,
\fIx\fR, etc\&.
.RE
.PP
video_display
.RS 4
The X display to play the video to\&. Usually
\fI:0\&.0\fR\&.
.RE
.PP
osd_support
.RS 4
On\-screen display enabled
\fIyes\fR
or
\fIno\fR\&.
.RE
.PP
osd_font_size
.RS 4
The On\-screen display font size, an integer\&.
.RE
.SH "SEE ALSO"
.PP
\fBdeejayd\fR(1)\&.
.SH "AUTHOR"
.PP
This manual page was written by Alexandre Rossi
alexandre\&.rossi@gmail\&.com
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\&.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2008 Alexandre Rossi
.br