PTC 2.0 C++ API X11 CLASSES Version 2.0.2 (alpha)

The X11 classes are Copyright (c) 1998 Christian Nentwich (brn@eleet.mcb.at)
The PTC 2.0 C++ API is (c) 1998 Glenn Fiedler (ptc@gaffer.org)

This package and all included source code is licensed under the GNU LGPL
Please refer to the included file COPYING.LIB for the exact terms
------------------------------------------------------------------------------

(Please read the CHANGES file first if you're upgrading!)


Contents
-----------

  1. Missing features

  2. How to link your own program to PTC 2.0.* X

  3. How to submit bug reports




Missing features
-------------------

  Missing features means, features missing on my side, no matter what is  
still missing in the platform independent part of PTC:

  - More Testing. 

  - Display over the net hasn't really been tested.

  - read() does not return any scancode, you can use it to wait for a 
    keypress though, and to read from the "keyboard buffer" after waiting
    for key()

  - Dynamic library (it's sposed to be linked statically though in order
    to run on every system)

  - Java interface routines. We want the Java interface under Linux too,
    don't we? I think we do :)

  - Proper documentation for the X11 specific part

  - Put the assembler conversion routines in. (Soon!)

Check out BUGS for .. you know what.




How to link your own program to PTC 2.0.* X
----------------------------------------------

  The following instructions assume you installed in '/usr/local/', which is
the default.

  For compiling, everything should be fine, just include "ptc.h" in your code.
You might have to add "-I/usr/local/include" to you compiler command line
if it complains.

  For linking, you need to add the PTC library and all the X libraries it
used (which are probably going to be linked dynamicly on your system). A
soft link is made from the current library version to libptc.a by the install
function, so you just have to use "-lptc". Again, you might have to use 
"-L/usr/local/lib" if your linker doesn't search that path by default.


Example command lines:
  - Compiling: "g++ -c cooleffect.cpp -o cooleffect.o -O6 -mpentium \
                -I/usr/local/include"

  - Linking: "g++ cooleffect.o -L/usr/X11/lib -lX11 -lXext -lXxf86dga \
	      -lXxf86vm -lptc -o cooleffect"


  I'm assuming that you have your X libraries in /usr/X11/lib and that DGA
was built in. If not, you can leave the '-lXxf86dga' and '-lXxf86vm' out.

  All the path- and filenames above might be different on your system, so
please check again before complaining :).




How to submit bug reports
----------------------------

  This is an alpha version, don't be surprised if something goes wrong. If you
don't mind, send an e-mail to brn@eleet.mcb.at if something does go wrong and
include the following files (check if the bug is know first, read the BUGS
file):

        config.log
	config.status
	XF86Config (or your Metro-X config, or whatever)

  In addition, please run the dumpinfo program you can find in the
source/static directory and send me the stuff it produces (this is quite
important):

	source/static/dumpinfo > visual.x11
  	  Send me visual.x11 then... or
	source/static/dumpinfo | mail brn@eleet.mcb.at
	  if you're online already :)

  It would also be quite useful if you could tell me your compiler version and
which version of X you are using if it is < R6. I'd be forever thankful ;)

Then again, if you're bored enough, a patch with a bugfix and comments
would be cool, send me the diff :)


Thanks,
  brn/S!P
 
