1706f2543SmrgXephyr README
2706f2543Smrg=============
3706f2543Smrg
4706f2543Smrg
5706f2543SmrgWhat Is It ?
6706f2543Smrg============
7706f2543Smrg
8706f2543SmrgXephyr is a a kdrive server that outputs to a window on a pre-existing
9706f2543Smrg'host' X display. Think Xnest but with support for modern extensions
10706f2543Smrglike composite, damage and randr. 
11706f2543Smrg
12706f2543SmrgUnlike Xnest which is an X proxy, i.e.  limited to the
13706f2543Smrgcapabilities of the host X server, Xephyr is a real X server which
14706f2543Smrguses the host X server window as "framebuffer" via fast SHM XImages.
15706f2543Smrg
16706f2543SmrgIt also has support for 'visually' debugging what the server is
17706f2543Smrgpainting.
18706f2543Smrg
19706f2543Smrg
20706f2543SmrgHow To Use 
21706f2543Smrg==========
22706f2543Smrg
23706f2543SmrgYou probably want to run like;
24706f2543Smrg
25706f2543SmrgXephyr :1 -ac -screen 800x600 &
26706f2543Smrg
27706f2543SmrgThen set DISPLAY=:1 and run whatever X apps you like.
28706f2543Smrg
29706f2543SmrgUse 'xrandr' to change to orientation/size. 
30706f2543Smrg
31706f2543SmrgThere is a '-parent' switch which works just like Xnests ( for use
32706f2543Smrgwith things like matchbox-nest - http://matchbox.handhelds.org ).
33706f2543Smrg
34706f2543SmrgThere is also a '-host-cursor' switch to set 'cursor acceleration' -
35706f2543SmrgThe host's cursor is reused. This is only really there to aid
36706f2543Smrgdebugging by avoiding server paints for the cursor. Performance
37706f2543Smrgimprovement is negiable. 
38706f2543Smrg
39706f2543SmrgSend a SIGUSR1 to the server ( eg kill -USR1 `pidof Xephyr` ) to
40706f2543Smrgtoggle the debugging mode. In this mode red rectangles are painted to
41706f2543Smrgscreen areas getting painted before painting the actual content. The
42706f2543Smrgdelay between this can be altered by setting a XEPHYR_PAUSE env var to
43706f2543Smrga value in micro seconds.
44706f2543Smrg
45706f2543Smrg
46706f2543SmrgCaveats
47706f2543Smrg=======
48706f2543Smrg
49706f2543Smrg - Depth is limited to being the same as the host. 
50706f2543Smrg   *Update* As of 8/11/2004. Xephyr can now do 8bpp & 16bpp 
51706f2543Smrg            on 24bpp host.
52706f2543Smrg
53706f2543Smrg - Rotated displays are currently updated via full blits. This
54706f2543Smrg   is slower than a normal oprientated display. Debug mode will
55706f2543Smrg   therefor not be of much use rotated.  
56706f2543Smrg
57706f2543Smrg - The '-host-cursor' cursor is static in its appearence. 
58706f2543Smrg
59706f2543Smrg - The build gets a warning about 'nanosleep'. I think the various '-D'
60706f2543Smrg   build flags are causing this. I havn't figured as yet how to work
61706f2543Smrg   round it. It doesn't appear to break anything however. 
62706f2543Smrg
63706f2543Smrg - Keyboard handling is basic but works. 
64706f2543Smrg
65706f2543Smrg - Mouse button 5 probably wont work. 
66706f2543Smrg
67706f2543Smrg
68706f2543Smrg
69706f2543Smrg
70706f2543Smrg
71706f2543SmrgMatthew Allum <mallum@o-hand.com> 2004 
72706f2543Smrg
73706f2543Smrg
74