xserver/hw/kdrive/ephyr
Eric Anholt 2822cbc1fb Rearrange EXA driver structures so that there's a hope of maintaining ABI
when extending the driver interface. The card and accel structures are
    merged into the ExaDriverRec, which is to be allocated using
    exaDriverAlloc(). The driver structure also grows exa_major and
    exa_minor, which drivers fill in and have checked by EXA
    (double-checking that the driver really did check that the EXA version
    was correct). Removes exaInitCard(), which is replaced by the driver
    filling in the rec by hand, and the exaGetVersion() and related
    EXA_*VERSION which are replaced by always using the XFree86 loadable
    module versioning.
2006-03-09 06:04:07 +00:00
..
Makefile.am Add a new flag to ephyr, "-fakexa", which turns on an EXA acceleration 2006-03-07 19:57:46 +00:00
README Xephyr grab fix 2004-11-11 14:55:30 +00:00
ephyr.c Build fixes: XSERVER_LIBS -> KDRIVE_LIBS, config.h -> kdrive-config.h 2005-12-27 08:29:50 +00:00
ephyr.h Rearrange EXA driver structures so that there's a hope of maintaining ABI 2006-03-09 06:04:07 +00:00
ephyr_draw.c Rearrange EXA driver structures so that there's a hope of maintaining ABI 2006-03-09 06:04:07 +00:00
ephyrinit.c Add a new flag to ephyr, "-fakexa", which turns on an EXA acceleration 2006-03-07 19:57:46 +00:00
hostx.c Build with modular X.org libraries and headers. 2005-08-08 06:25:21 +00:00
hostx.h Another Xephyr focus/modifier fix 2005-06-30 13:39:00 +00:00
os.c Build fixes: XSERVER_LIBS -> KDRIVE_LIBS, config.h -> kdrive-config.h 2005-12-27 08:29:50 +00:00

Xephyr README
=============


What Is It ?
============

Xephyr is a a kdrive server that outputs to a window on a pre-existing
'host' X display. Think Xnest but with support for modern extensions
like composite, damage and randr. 

Unlike Xnest which is an X proxy, i.e.  limited to the
capabilities of the host X server, Xephyr is a real X server which
uses the host X server window as "framebuffer" via fast SHM XImages.

It also has support for 'visually' debugging what the server is
painting.


How To Use 
==========

You probably want to run like;

Xephyr :1 -ac -screen 800x600 &

Then set DISPLAY=:1 and run whatever X apps you like.

Use 'xrandr' to change to orientation/size. 

There is a '-parent' switch which works just like Xnests ( for use
with things like matchbox-nest - http://matchbox.handhelds.org ).

There is also a '-host-cursor' switch to set 'cursor acceleration' -
The host's cursor is reused. This is only really there to aid
debugging by avoiding server paints for the cursor. Performance
improvement is negiable. 

Send a SIGUSR1 to the server ( eg kill -USR1 `pidof Xephyr` ) to
toggle the debugging mode. In this mode red rectangles are painted to
screen areas getting painted before painting the actual content. The
delay between this can be altered by setting a XEPHYR_PAUSE env var to
a value in micro seconds.


Caveats
=======

 - Depth is limited to being the same as the host. 
   *Update* As of 8/11/2004. Xephyr can now do 8bpp & 16bpp 
            on 24bpp host.

 - Rotated displays are currently updated via full blits. This
   is slower than a normal oprientated display. Debug mode will
   therefor not be of much use rotated.  

 - The '-host-cursor' cursor is static in its appearence. 

 - The build gets a warning about 'nanosleep'. I think the various '-D'
   build flags are causing this. I havn't figured as yet how to work
   round it. It doesn't appear to break anything however. 

 - Keyboard handling is basic but works. 

 - Mouse button 5 probably wont work. 





Matthew Allum <mallum@o-hand.com> 2004