= Guide =

== Installation ==

=== Requirements ===

Hopefully, your distribution will easily handle those.

  * [http://python.org Python] >= 2.4
  * [http://twistedmatrix.com/trac twisted] >= 2.0
  * [http://code.google.com/p/simplejson/ simplejson] (it is included in python 2.6.0)
  * a database backend
    * [http://www.initd.org/tracker/pysqlite/wiki/pysqlite pysqlite] >= 2.2 for sqlite
    * [http://sourceforge.net/projects/mysql-python mysql-python] >= 1.2.1 for mysql 
  * [http://www.sacredchao.net/quodlibet/wiki/Development/Mutagen mutagen] >= 1.6
  * [http://doc.freevo.org/2.0/Kaa kaa-metadata] >= 1.1
  * [http://codespeak.net/lxml/ lxml] >= 2.0
  * [http://twistedmatrix.com/trac twisted-web] >= 0.6.0 if you want to use the webui
  * for the GStreamer backend (audio playback only) :
    * [http://gstreamer.freedesktop.org gstreamer] >= 0.10
    * gstreamer plugins :
      * Required :
         * gst-python
      * Optionnal :
         * alsa, oss, esd for output
         * mad to play mp3 files
         * ogg to play ogg files
         * for webradio support, gst-plugins-gnomevfs
    * [http://www.pygtk.org/ pygobject] >= 2.12
  * for the Xine backend :
    * [http://xinehq.de/ xine-lib] >= 1.1.0
    * python-ctypes (it is included in python-2.5.0)
  * [http://pyinotify.sourceforge.net/ pyinotify] >= 0.6.0 for inotify support

If you want to build {{{deejayd}}} (distutils distribution), you also need the {{{gettext}}} package installed because of the usage of the {{{msgfmt}}} binary.

=== Manual installation ===
To install and run Deejayd, you have to :
  * Download the [wiki:Download latest version of deejayd],
  * Extract archive content :
{{{
tar xzvf deejayd-<version>.tar.gz
}}}
  * Install it with :
{{{
cd deejayd-<version>
python setup.py build
python setup.py install
}}}
 
=== Distribution specific packages ===

==== Gentoo ====
For gentoo users, I have created 2 ebuilds to install Deejayd properly. It is avalaible in the tarball (gentoo directory).
  * an ebuild for 0.9.0 version
  * a [source:gentoo/deejayd-9999.ebuild live ebuild]
Copy one of them in your overlay and just do :
{{{
emerge deejayd
}}}

==== Debian ====

deejayd is now available in [http://debian.org Debian]. See the [http://packages.debian.org/deejayd Deejayd Debian package page].

Whichever debian distribution you use, you can install {{{deejayd}}} by issuing the following commands. 
{{{
aptitude update
aptitude install deejayd deejayd-webui djc
}}}

==== Ubuntu ====
Ubuntu packages are available in universe repository.
{{{
aptitude install deejayd deejayd-webui djc
}}}

== Usage ==
To launch deejayd just do
{{{
deejayd
}}}
See {{{deejayd --help}}} for more informations

If you install deejayd with a package, you can also launch deejayd with
{{{
/etc/init.d/deejayd start
}}}
In this case, configuration file is {{{/etc/deejayd.conf}}}.