1. Disclaimer

I am not liable for any damage caused by the use of this program. If it doesn't do what you think it is supposed to do, you are either wrong or you could try to fix it.

2. Installation

This libary uses gnu autoconf. This is my first forray into the Autoconf domain, so I will not guarantee it'll work.

You will need the following items for XmmsTcl to compile correctly:

xmms 1.2.5 or better.
Tcl 8.1 or better.

2. Basic Installation

cd XmmsTcl-1.0
./configure
make
make install

By default, the man page will be installed in /usr/local/man, this may not be good enough for you, I specify '--mandir=/usr/share/man' which is the RedHat 7.1 location for Tcl manpages.

Make install will put xmmstcl.so in /usr/lib/tcl<tcl-version>/xmms/ and register the package in you tcl environment. The '/usr/lib/' in the installation path is deduced from your Tcl installation. 'make install' will only work if tclsh is in the PATH environment variable.

3. Documentation

See xmmstcl.html or 'man xmmstcl' for all commands.

3.1 Usage

You can either directly load xmmstcl.so in your tcl script:

load /usr/src/xmmstcl.so Xmms

or (after 'make install'):

package require xmms

4. Features

Currently the entire interface provided by xmmsctrl.h/xmms_remote_* functions are implemented. Some semantics have changed do be more tcl-ish.

I plan to implement events, so your application gets notified when the xmms state (playback, playlist position, etc.) changes.

I want to make an RPM distribution. I don't have Debian, if is your send me the files to create a debian package I'll include them in the distribution.

xmms is somewhat slow to respond, this is not a bug, nor a feature. If you do 'xmms play' and 'xmms pause'. Playback will begin just as if the 'pause' command was not given. I think this is because when you give the pause command, the output plugin hasn't yet received input from the xmms input plugin.

Setting the volume is not session specific, I don't know why but xmms just sets the global volume. Don't know why.

5. Bugs

If you find any, tell me!

6. Obtaining XmmsTcl

You can download xmmstcl-1.0.tar.gz from my website http://pascal.scheffers.net/software/

alternatively you can use anonymous CVS to get the latest, greatest version. Which may or may not compile:

         cvs -d:pserver:anoncvs@pascal.scheffers.net:/cvsroot login
         (password 'anoncvs')
         cvs -z3 -d:pserver:anoncvs@pascal.scheffers.net:/cvsroot co xmmstcl

This will create a directory named xmmstcl in your current directory, you MUST run autoconf before you run ./configure.

To update an earlier checked out version, do:

cd /usr/src/xmmstcl
cvs -z3 update -dP

Please, always use -z3. I actually pay for my bandwidth usage.

7. Contact Email

Contact me at Pascal@Scheffers.Net

$Id: README,v 1.2 2002/03/12 19:10:21 pascal Exp $