Xephyr.man (3184B)
1 .\" 2 .\" Copyright (c) Matthieu Herrb <matthieu@herrb.eu> 3 .\" 4 .\" Permission to use, copy, modify, and distribute this software for any 5 .\" purpose with or without fee is hereby granted, provided that the above 6 .\" copyright notice and this permission notice appear in all copies. 7 .\" 8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15 .\" 16 .TH Xephyr @appmansuffix@ @vendorversion@ 17 .SH NAME 18 Xephyr - X server outputting to a window on a pre-existing X display 19 .SH SYNOPSIS 20 .B Xephyr 21 .RI [\fB:\fP display ] 22 .RI [ option 23 .IR ... ] 24 .SH DESCRIPTION 25 .B Xephyr 26 is a kdrive server that outputs to a window on a pre-existing "host" 27 X display. 28 Think 29 .I Xnest 30 but with support for modern extensions like composite, damage and randr. 31 .PP 32 Unlike 33 .I Xnest 34 which is an X proxy, i.e. limited to the capabilities of the host X server, 35 .B Xephyr 36 is a real X server which 37 uses the host X server window as "framebuffer" via fast SHM XImages. 38 .PP 39 It also has support for "visually" debugging what the server is 40 painting. 41 .SH OPTIONS 42 The server accepts all the standard options of Xserver(@appmansuffix@) 43 and the following additional options: 44 .TP 8 45 .BI -screen " width" x height 46 sets the screen size. 47 .TP 8 48 .BI -parent " id" 49 uses existing window 50 .I id . 51 If a 52 .BI -screen 53 argument follows a 54 .BI -parent 55 argument, this screen is embedded into the given window. 56 .TP 8 57 .B -host-cursor 58 set 'cursor acceleration': 59 The host's cursor is reused. This is only really there to aid 60 debugging by avoiding server paints for the cursor. Performance 61 improvement is negligible. 62 .TP 8 63 .B -resizeable 64 Allow the Xephyr window to be resized, even if not embedded into a parent 65 window. By default, the Xephyr window has a fixed size. 66 .TP 8 67 .B -no-host-grab 68 Disable grabbing the keyboard and mouse. 69 .SH "SIGNALS" 70 Send a SIGUSR1 to the server (e.g. pkill -USR1 Xephyr) to 71 toggle the debugging mode. 72 In this mode red rectangles are painted to 73 screen areas getting painted before painting the actual content. 74 The 75 delay between this can be altered by setting a XEPHYR_PAUSE env var to 76 a value in micro seconds. 77 .SH CAVEATS 78 .PP 79 .IP \(bu 2 80 Rotated displays are currently updated via full blits. This 81 is slower than a normal orientated display. Debug mode will 82 therefore not be of much use rotated. 83 .IP \(bu 2 84 The '-host-cursor' cursor is static in its appearance. 85 .IP \(bu 2 86 The build gets a warning about 'nanosleep'. I think the various '-D' 87 build flags are causing this. I haven't figured as yet how to work 88 round it. It doesn't appear to break anything however. 89 .IP \(bu 2 90 Keyboard handling is basic but works. 91 .IP \(bu 2 92 Mouse button 5 probably won't work. 93 .SH "SEE ALSO" 94 X(@miscmansuffix@), Xserver(@appmansuffix@) 95 .SH AUTHOR 96 Matthew Allum <mallum@o-hand.com> 2004