XFree86/Mesa GLX

Disclaimer and Acknowledgments
------------------------------

This package is not a licensed implementation of OpenGL(R), as such the 
contributors to this package can make no claims as to the package's
comformance with OpenGL specs. For details see the disclaimer in
the Mesa package README and the OpenGL faq sections five and six:

http://www.sgi.com/software/opengl/faq.html


-----

OpenGL(R) is a registered trademark of _Silicon Graphics, Inc._

XFree86(tm) is a trademark of _The XFree86 Project, Inc._


What is Utah GLX?
-----------------

Simply put, GLX is the X extension used by OpenGL programs, it is the glue
between OpenGL (which is platform independent) and X.
After SGI released their GLX module as open source it was easy to confuse the
two GLX modules and it was decided to refer to this project as Utah GLX in order
to distinguish between them.


Online Resources
----------------

Some useful URL's:

   http://utah-glx.sourceforge.net/ -- Utah-GLX web page.

   http://www.OpenGL.org/  --  OpenGL specs, faqs, links, etc...

   http://www.mesa3d.org/ -- The Mesa web page

   http://www.sgi.com/software/opengl/  -- SGI's OpenGL page.

   http://oss.sgi.com/projects/ogl-sample/  -- SGI's Sample Implementation

   http://www.sgi.com/software/opensource/glx/ -- SGI's GLX module.

   http://reality.sgi.com/mjk_asd/ -- Mark Kilgard's webpage, 
                                      demos, technical papers,
                                      OpenGL evangalism.

   http://www.XFree86.org/  -- XFree86 web page.

   http://dri.sourceforge.net/  -- The direct rendering open source project web page.


Requirements
------------
You should use at least XFree86 3.3.5 if you are using the mga driver.
XFree86 3.3.6 is required for the nvidia driver.

Do note that Utah GLX doesn't support XFree86 4.0.
If you want accelerated 3d in XFree86 4.0 your best bet is to look at
http://dri.sourceforge.net/

In order to build Utah GLX you will need tclsh.
If you want to build the mga driver you'll need perl.
3dnow support is known to be broken if you are using an older version
of binutils. 2.9.1.0.19a and newer should be ok.


Build & Install
---------------

Instructions for building and installation is located in the file INSTALL
in this directory.

You'll also want to check the chipset-specific README in the docs 
directory for issues and information specific to your graphics card.


Configuration
-------------

The configuration file 'glx.conf' should be installed in the same
directory as your XF86Config, /etc/X11 on most systems. You'll want to
take a look at this to enable DMA transfers and otherwise tune the driver
behavior. The options are documented in the glx.conf file in this
directory.

Note that the options often change from one release to another. 'make
install' won't overwrite your old settings, but you may want to look for
changes manually when you upgrade.


Features
--------
!!! Change this into pointers to chipset specific README files?

* Support for nVidia's Riva 128, Riva TNT and Riva TNT2 chipset
   - Does not support DMA or direct rendering

* Support for Matrox's G200 and G400 chipsets

* Support for ATI's 3D Rage Pro chipset.
  (This does not include the Rage 128 family)

* Support for Intel's i810 chipset

* some support for the S3 ViRGE chipset

* some support for the SiS 6326 chipset


Documentation
-------------

INSTALL -- Building and installation instructions

docs/direct.txt -- Information about direct rendering.

docs/debug.txt -- Hints for debugging/development

docs/faq.html -- Frequently asked questions.
!!! This document requires some sgml tools to generate, but should be
!!! in the release tarball. also on the website


Bug reports
-----------

Bug reports should go to utah-glx-dev@lists.sourceforge.net
Relevant information includes:

* How to reproduce the problem
* Version of Mesa (Date of latest update if CVS version)
* Version of Utah-GLX (Date of latest update if CVS version)
* Version of operating system
* Version of gcc
* Type of graphics card you have
* If you are using DMA or not
* If you are using agpgart and if so the module version and your motherboard
  chipset
* If the bug persists with nohw set to 1 (In the glx.conf configuration file)
* If you are overclocking your system you should mention it in your bug report.
  Do try to reproduce your bug without overclocking though.

If your application crashes with standard Mesa as well the
bug report should probably go to mesa-bugs@mesa3d.org instead.


Mailing lists
-------------

There are three mailing lists at the moment:

utah-glx-dev@lists.sourceforge.net - Used for development. Bug reports
  should go here as well.

  Archived at http://lists.sourceforge.net/pipermail/utah-glx-dev/
  Subscriptions at http://lists.sourceforge.net/mailman/listinfo/utah-glx-dev/


utah-glx-users@lists.sourceforge.net - Intended for questions not directly
  related to development. Questions about using the module in conjunction
  with popular games belong here for example.

  Archived at http://lists.sourceforge.net/pipermail/utah-glx-users/
  Subscriptions at http://lists.sourceforge.net/mailman/listinfo/utah-glx-users/


utah-glx-cvs@lists.sourceforge.net - Messages about CVS changes will be sent
  to this list. Good for keeping up with improvements. All developers
  should subscribe.

  Archived at http://lists.sourceforge.net/pipermail/utah-glx-cvs/
  Subscriptions at http://lists.sourceforge.net/mailman/listinfo/utah-glx-cvs/


----
$Id: README,v 1.11 2000/04/12 22:57:59 ehliar Exp $
