ID3 TOOLS - Useful ID3 tools for DOS

* SOURCE CODE DOCUMENTATION *
* If you want to know how to USE the tools, get the binary distribution
* and see the readme.txt in there...

By Matt Craven
(c)2000 Hedgehog Software
---------------------------------------------------------------------

Contents
========

1. Disclaimer / Legal
2. Usage
3. Credits
4. Future

---------------------------------------------------------------------

1. Disclaimer / Legal
=====================

This code is provided as-is. No warranty is either expressed or
implied. Use this software at your own risk.  Neither the author
nor Hedgehog Software can be held responsible for the effects,
adverse or otherwise of using this software.

In English: If something goes wrong, unlucky, you can't sue me.


Distribution:
This code is free. 
You can copy it, give it to people, put it on websites/cds etc.
You cannot sell it on its own, but you can use it in commercial
products provided you let me know via email to
id3tools@damp-mp3.co.uk

Licence:
If you make changes, fix bugs, or add features to the code, you
MUST release the source code, and you MUST send a copy to:
id3tools@damp-mp3.co.uk

This licence will also apply to the source code you release.

The main distribution site for this source is:
http://www.damp-mp3.co.uk/

---------------------------------------------------------------------

2. Usage
========

The ID3 TOOLS are coded in C.

To compile the code, I used DJGPP.  It'll probably work with other
compiers, but I haven't tried.

You can get DJGPP from:
http://www.delorie.com/djgpp/

I recommend using the "Zip Picker" on the site to get what you need.
(You'll need the gcc package, and the binutils at least).

Don't email me with any problems you have downloading and/or
installing DJGPP - there's plenty of help available elsewhere for
that.

When you have DJGPP installed correctly, change to the directory where
you unzipped this source code and type:

  make

It should compile and create id3edit.exe and id3dir.exe - if it doesn't,
you've done something wrong.

You can specify individual tools if you don't want to compile them all:

   make id3edit.exe
   make id3dir.exe

There are a couple of other makefile targets:

  make clean

will remove the object files after you've compiled id3edit.

  make veryclean

will remove the object files and the EXEs.

  make compress

will use the compressor specified in the Makefile (the default is
UPX, but you might have DJP) to compress the EXE files.

I'd recommend getting UPX if you don't have it. It's available at:
http://wildsau.idv.uni-linz.ac.at/mfx/upx.html
http://www.nexus.hu/upx
http://upx.tsx.org/


In my opinion, the source code is easy to understand. It's pretty
well commented, but if there's something you don't understand
about the way I've done something, ask me at id3tools@damp-mp3.co.uk
(note: Only ask me questions about why I've done something a
particular way, DON'T ask me questions about the language - eg:
"what does 'printf' mean?" - if you don't know C, there's plenty
of tutorials on the net).

id3.c and id3.h are the ID3 routines.
id3edit.c and id3dir.c are the main files for each tool.

A warning: If you edit the Makefile in DOS Edit, it won't work.  I
used Notepad to create/edit the Makefile.

---------------------------------------------------------------------

3. Credits
==========

These little utilities were programmed by Matt Craven of Hedehog Software.
http://come.to/hedgehog-software/

They make great companions to DAMP.
http://www.damp-mp3.co.uk/

"Burnfire" suggested I write them, so it's thanks to him that this
program exists.

It was written using the excellent DJGPP.
http://www.delorie.com/djgpp/

---------------------------------------------------------------------

4. Future
=========

These tools are early versions, written for one person in particular,
but they were released since others may find them useful.

Of course, if there's anything you'd like to add, then go ahead!
Remember to read the "Disclaimer / Legal" section above about submitting
any changes you make.

Have fun!
