                                   README

                        Free AudioGalaxy Satellite
                               Version 0.2.0
                       http://www.tty0.org/page/fags

==============================================================================
What is FAGS and what are it's features?
==============================================================================
FAGS is a Free AudioGalaxy Satellite client for UNIX and Linux.
It is written in C and licensed under the GNU General Public License.

FAGS features up to 20 simultaneous uploads or downloads using asynchronous
socket I/O, resuming of uploads and downloads, sharing of multiple
directories, reading of MP3 and OGG Vorbis ID3 tags, and bandwidth limiting.
FAGS also uses the latest AudioGalaxy protocol version 0.609W.

For more information about AudioGalaxy please see http://www.audiogalaxy.com/


==============================================================================
Installing the Free AudioGalaxy Satellite
==============================================================================
Quick installation for the impatient:

$ ./configure
$ make
$ su -c "make install"
Password: (enter your root password)
$ fags
$ joe ~/.fags/config  (press ctrl+k x to save and exit)
$ fags


Detailed installation instructions:

Run './configure' in the directory where you untared FAGS.
Running './configure --help' displays a list of options.

The most important options are:

  --disable-vorbis
     Disable the use of Ogg Vorbis even if 'configure' has detected it.

  --disable-contexts
     Disables the use of 'contexts'. Contexts are useful to debug crashes
     if FAGS crashed when it was not attached to a debugger. When FAGS
     crashes it will dump a list of these 'contexts'.

  --enable-mdebug
     Enables malloc(), free() and strdup() memory debugging.
     Don't use this unless you know what you're doing. It will tripple the
     memory usage and increase cpu usage.


After you have run './configure', run 'make' or 'gmake' to compile fags.

If you don't run into any problems, run 'make install' as root to install
the FAGS binary.


Now run 'fags'. If this is the first time you run FAGS, it will create a
bunch of files and directories in ~/.fags/ and then exit. You must then
edit ~/.fags/config before running 'fags' again.

If you've run FAGS before, see if there are any new configuration options
in FAGS's manual page.



==============================================================================
Configuration File Options
==============================================================================
See the manual page for information about configuration options.


==============================================================================
Supported Platforms
==============================================================================
FAGS is known to compile and run on the following platforms:

  Linux 2.2/2.4 (i386/alpha/ppc/sparc)
  MacOSX 10.1 (ppc)
  SunOS 4.1/5.6/5.8 (sparc)
  OpenBSD 3.x (i386/sparc)
  FreeBSD 4.x (i386)
  NetBSD 1.5.2 (i386)
  Irix 6.5 (?)

Thanks to:
  Marcin TROFIMIUK <mt23890@sgh.waw.pl> (SunOS 5.6 testing)
  Maciej Korze <maciekk@linux.sky.pl> (FreeBSD testing)
  Claudio Leite <leitec@staticky.com> (SunOS 4.1 testing)
  Sylvester F <sylvester_f@hotmail.com> (NetBSD 1.5.2 testing)
  Michael Anteboth <michael.anteboth@david-bs.de> (Irix 6.5 testing)
  Sven-Olof Johansson <sven-olof_johansson@mkv.mh.se> (OpenBSD sparc testing)
  Dr. Mirco (OpenBSD/FreeBSD testing)


If you get FAGS to compile on an unlisted platform please email me
at <dinkles@tty0.org>.


==============================================================================
Known Problems
==============================================================================
None ;-)


==============================================================================
Special Thanks
==============================================================================
o Alpha Programming for the AudioGalaxy Protocol
  http://www.alpha-programming.co.uk/software/satellite/index.php
  http://www.alpha-programming.co.uk/

o Mity <mity@ropnet.ru> AudioGalaxy Protocol
  http://tudfgbqvbn.tripod.com/AGProtocol.htm

o Justin Fletcher <gerph@innocent.com> updated AG Protocol
  http://www.movspclr.co.uk/info/agprotocol.html
  http://www.movspclr.co.uk/

o L. Peter Deutsch <ghost@aladdin.com> for the MD5 functions
  http://sourceforge.net/projects/libmd5-rfc/

o Mark Glines <mark@glines.org>
  automake, autoconf, configure script, etc
  http://www.glines.org:8000/

o Sourceforge and arachnid for letting me use his sourceforge
  account to access sourceforge's compile farm.

o Erik Wenzel <erik@debian.org>
  Manual page, official fags debian package maintainer

o Erkki at irc.openproject.net #debian.se
  Debian packages

o Ken Kizaki <ken_kizaki@yahoo.co.jp>
  RPM packages, lot's of bug reports, etc :)

o Cedric Tefft <cedric@phreaker.net>
  http://www.ibiblio.org/mp3info/

o And finally, AudioGalaxy for creating the best fscking
  music sharing app/site ever. :)
  Let's hope the RIAA won't shut them down.

------------------------------------------------------------------------------
Send bug reports / patches / ideas to Andreas Allerdahl <dinkles@tty0.org>
