$Id: INSTALL,v 1.5 2001/10/28 00:46:34 mickey Exp $

VChat client and TELNET gateway installation notes:
===================================================


I.   Installation checklist:
-----------------------------

  [ ] 0. This software has currently been tested with the following
         operating system types:

         FreeBSD, Linux, Solaris

         Since the software is auto-configuring it should also
         compile on other UN*X systems. I would appreciate to
         hear from you when you successfully compile this
         software on other systems as the ones listed above,
         or if compilation fails on your system for a particular
         purpose. In either case, feel free to send mail to:
         <vchat@netassembly.de>

  [ ] 1. C compiler installed (gcc recommended)

  [ ] 2. make installed (either BSD make or GNU make)

  [ ] 3. GNU autoconf installed (only when you retrieved this software
         from a CVSup mirror).

  [ ] 4. optional: AAS audio library installed (auto-detected by configure)
         *** currently not implemented ***

  [ ] 5. optional: RPLAY audio library installed (auto-detected by configure)
         *** currently not implemented ***


II.  Building and installing:
------------------------------

  [ ] 0. In case you retrieved the CVS version of this software
         from a CVSup server you will first have to run 'autoheader'
         and then 'autoconf' from within the distribution directory
         in order to generate the configure script. This requires
         GNU autoconf to be installed on your system. Since the
         configure script is the generated output of other files,
         it is not included in the CVS version of this software.

         When you downloaded this software in form of a package
         from the VChat website, you should already have the
         configure script and are therefore ready to proceed
         to the next step already.

  [ ] 1. Run './configure' in the distribution directory.
         Running './configure --help' will display a list of
         compile time options that may be configured.

  [ ] 2. When the configure script was successfully completed,
         type 'make' in the distribution directory. This will
         compile the software.

  [ ] 3. After finishing the build process without errors, you
         may type 'make install' in the VChat distribution
         directory to install the software and manual pages on
         your system. You will need write access to the target
         directories that have been configured in order to
         install.

  [ ] 4. If you plan to run the VChat telnet gateway (vchatd)
         on your system, please read the vchatd manual page for
         details on how to configure this service.

  Congratulations! You're done.


III. Other make targets:
--------------------------

   The following other make targets are available from within the
   distribution directory:

   [ ] 0. Typing 'make clean' will remove all targets and intermediate
          object files that were created as a result of compiling the
          correspondig C source files.

   [ ] 1. Typing 'make distclean' will remove all files that were
          created during the process of configuring and building
          the software. This is equivalent to resetting the
          distribution directory to it's initial state.

   [ ] 2. Typing 'make develclean' will remove *all* intermediate
          target and object files as well as files that are generated
          by autoconf.

          *WARNING*

          You will definiately need an installed version of GNU
          autoconf to get things back going in your distribution
          directory after doing so.

   [ ] 3. Typing 'make uninstall' will remove the installed targets
          from your system.