Tobias Schmidt-Samoa schmidt@informatik.uni-kl.de Mar. 26, 2003 *** A brief guide in order to install XQuodLibet (xql) *** Overview -------- XQuodLibet is written for a unix-based operating system. It is known to work on solaris 7 and SuSE linux 8.1. The system itself is installed in three steps: a) compile the system in the build directory b) install the system in the installation directory c) for each user install the user files in the home directory of the user As a prerequisite you have to install some tools. 0 Install the following programs -------------------------------- - standard unix tools for the installation process, e.g. tar (gnu), make (gnu), sed, install, chmod, rm, rmdir - CMUCL Lisp - Tcl - Tk - Expect (Expectk) - Tix - Blt This installation depends on dynamic package loading supported by tcl/tk 8. xql is known to work with for instance tcl8.4, tk8.4, expect5.34, tix8.1, blt2.4. 1 Get and unpack the sources ---------------------------- Get the sources at http://www-avenhaus.informatik.uni-kl.de/quodlibet/quodlibet-1.1.tar.gz Unpack the sources typing tar xzf quodlibet-1.1.tar.gz This will create the top-level build directory "itp-system" in the current directory. 2 Edit the Makefile ------------------- In the top-level build directory copy the file Makefile.in to Makefile: - cp Makefile.in Makefile Edit the Makefile to your needs. Essentially, you have to edit the variables CMUCL: path to CMUCL installation WISH: path to wish installation (tcl/tk-shell) BUILDROOT: build directory By default the binaries are installed in /usr/local/bin and some other configuration files in /usr/local/lib/quodlibet. You can change this by setting the variables that start with INSTALL especially INSTALLPREFIX INSTALLEXECPREFIX At startup the system looks for some user initialization files in the home directory of the user. By default, the initialization files are .xql.ql and .xql.tcl. You can change the prefix of the initialization files by editing the variable XQLCONFIGUSERRELINIT Besides you can choose to turn on auto-logging by setting the variable XQLCONFIGAUTOLOG to 1. The prefix of the automatically created script file, that is updated after each command, is set by XQLCONFIGAUTOLOGNAME (The file will be stored in the startup script directory and supplemented by the script suffix, by default .ql.) 3 Compile the system -------------------- In the top-level build directory type make This will hopefully build the complete system. If you want to test the system before installation you will have to set the following shell variables to the the specified subdirectories of the top-level build directory QUODLIBETLIBDIR to the subdirectory lib QUODLIBETBINDIR to the subdirectory bin XQLLIBDIR to the subdirectory xql and start the one of the programs in the bin subdirectory. You may achieve this by typing in the top-level build directory: env QUODLIBETLIBDIR=lib bin/quodlibet to start the text-based interface env QUODLIBETLIBDIR=lib XQLLIBDIR=xql QUODLIBETBINDIR=bin bin/xql to start the graphical interface 4 Install the system -------------------- To install the system type make install (Depending on the installation directory you possibly will have to be root to perform the installation.) 5 Install user files -------------------- Change to the "userinitsamples" directory that is located in the installation directory of the configuration files, by default cd /usr/local/quodlibet/userinitsamples By default, for each user a directory called "quodlibet" is created in the users home directory, that contains a directory "qml" with the standard tactics and a directory "Examples" with some sample specifications. You can edit the Makefile in "userinitsamples" to change this default behavior. Besides default user initialization will be installed. As a user type make (or make install) This will create the required directories in your home directory and install the standard tactics, examples and user initialization files. If you just want to install the tactics type make install-qml examples type make install-examples user initialization files make install-init Edit the user initialization files as you like. You can also install the user files as root by typing make OWNER=user GROUP=group USERHOME=/home/user This will install the user files for user "user" with group "group" and home directory "/home/user". 6 Start the system ------------------ Start the system by typing quodlibet (without graphical user interface) xql (with graphical user interface) 7 Documentation --------------- Most documentation can be found at http://www-avenhaus.informatik.uni-kl.de/quodlibet as Internal Papers, most of them unfortunately only in German. For further documentation, please contact schmidt@informatik.uni-kl.de