Home | History | Annotate | Line # | Download | only in ephyr
      1      1.1  mrg Xephyr README
      2      1.1  mrg =============
      3      1.1  mrg 
      4      1.1  mrg 
      5      1.1  mrg What Is It ?
      6      1.1  mrg ============
      7      1.1  mrg 
      8      1.1  mrg Xephyr is a a kdrive server that outputs to a window on a pre-existing
      9      1.1  mrg 'host' X display. Think Xnest but with support for modern extensions
     10  1.1.1.2  mrg like composite, damage and randr.
     11      1.1  mrg 
     12      1.1  mrg Unlike Xnest which is an X proxy, i.e.  limited to the
     13      1.1  mrg capabilities of the host X server, Xephyr is a real X server which
     14      1.1  mrg uses the host X server window as "framebuffer" via fast SHM XImages.
     15      1.1  mrg 
     16      1.1  mrg It also has support for 'visually' debugging what the server is
     17      1.1  mrg painting.
     18      1.1  mrg 
     19      1.1  mrg 
     20  1.1.1.2  mrg How To Use
     21      1.1  mrg ==========
     22      1.1  mrg 
     23      1.1  mrg You probably want to run like;
     24      1.1  mrg 
     25      1.1  mrg Xephyr :1 -ac -screen 800x600 &
     26      1.1  mrg 
     27      1.1  mrg Then set DISPLAY=:1 and run whatever X apps you like.
     28      1.1  mrg 
     29  1.1.1.2  mrg Use 'xrandr' to change to orientation/size.
     30      1.1  mrg 
     31  1.1.1.2  mrg There is a '-parent' switch which works just like Xnest's ( for use
     32      1.1  mrg with things like matchbox-nest - http://matchbox.handhelds.org ).
     33      1.1  mrg 
     34      1.1  mrg There is also a '-host-cursor' switch to set 'cursor acceleration' -
     35      1.1  mrg The host's cursor is reused. This is only really there to aid
     36      1.1  mrg debugging by avoiding server paints for the cursor. Performance
     37  1.1.1.2  mrg improvement is negligible.
     38      1.1  mrg 
     39      1.1  mrg Send a SIGUSR1 to the server ( eg kill -USR1 `pidof Xephyr` ) to
     40      1.1  mrg toggle the debugging mode. In this mode red rectangles are painted to
     41      1.1  mrg screen areas getting painted before painting the actual content. The
     42      1.1  mrg delay between this can be altered by setting a XEPHYR_PAUSE env var to
     43  1.1.1.2  mrg a value in microseconds.
     44      1.1  mrg 
     45      1.1  mrg 
     46      1.1  mrg Caveats
     47      1.1  mrg =======
     48      1.1  mrg 
     49  1.1.1.2  mrg  - Depth is limited to being the same as the host.
     50  1.1.1.2  mrg    *Update* As of 8/11/2004. Xephyr can now do 8bpp & 16bpp
     51      1.1  mrg             on 24bpp host.
     52      1.1  mrg 
     53      1.1  mrg  - Rotated displays are currently updated via full blits. This
     54      1.1  mrg    is slower than a normal oprientated display. Debug mode will
     55  1.1.1.2  mrg    therefore not be of much use rotated.
     56      1.1  mrg 
     57  1.1.1.2  mrg  - The '-host-cursor' cursor is static in its appearance.
     58      1.1  mrg 
     59      1.1  mrg  - The build gets a warning about 'nanosleep'. I think the various '-D'
     60  1.1.1.2  mrg    build flags are causing this. I haven't figured as yet how to work
     61  1.1.1.2  mrg    around it. It doesn't appear to break anything however.
     62      1.1  mrg 
     63  1.1.1.2  mrg  - Keyboard handling is basic but works.
     64      1.1  mrg 
     65  1.1.1.2  mrg  - Mouse button 5 probably won't work.
     66      1.1  mrg 
     67      1.1  mrg 
     68      1.1  mrg 
     69      1.1  mrg 
     70      1.1  mrg 
     71  1.1.1.2  mrg Matthew Allum <mallum (a] o-hand.com> 2004
     72