1706f2543Smrg."
2706f2543Smrg." Copyright (c) Matthieu Herrb <matthieu@herrb.eu>
3706f2543Smrg."
4706f2543Smrg." Permission to use, copy, modify, and distribute this software for any
5706f2543Smrg." purpose with or without fee is hereby granted, provided that the above
6706f2543Smrg." copyright notice and this permission notice appear in all copies.
7706f2543Smrg."
8706f2543Smrg." THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9706f2543Smrg." WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10706f2543Smrg." MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11706f2543Smrg." ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12706f2543Smrg." WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13706f2543Smrg." ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14706f2543Smrg." OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15706f2543Smrg."
16706f2543Smrg.TH Xephyr __appmansuffix__ __vendorversion__
17706f2543Smrg.SH NAME
18706f2543SmrgXephyr - X server outputting to a window on a pre-existing X display
19706f2543Smrg.SH SYNOPSIS
20706f2543Smrg.B Xephyr
21706f2543Smrg.RI [\fB:\fP display ]
22706f2543Smrg.RI [ option
23706f2543Smrg.IR ... ]
24706f2543Smrg.SH DESCRIPTION
25706f2543Smrg.B Xephyr
26706f2543Smrgis a kdrive server that outputs to a window on a pre-existing "host"
27706f2543SmrgX display.
28706f2543SmrgThink
29706f2543Smrg.I Xnest
30706f2543Smrgbut with support for modern extensions like composite, damage and randr.
31706f2543Smrg.PP
32706f2543SmrgUnlike
33706f2543Smrg.I Xnest
34706f2543Smrgwhich is an X proxy, i.e.  limited to the capabilities of the host X server,
35706f2543Smrg.B Xephyr
36706f2543Smrgis a real X server which
37706f2543Smrguses the host X server window as "framebuffer" via fast SHM XImages.
38706f2543Smrg.PP
39706f2543SmrgIt also has support for "visually" debugging what the server is
40706f2543Smrgpainting.
41706f2543Smrg.SH OPTIONS
42706f2543Smrg.TP 8
43706f2543Smrg.BI -screen " width" x height
44706f2543Smrgsets the screen size.
45706f2543Smrg.TP 8
46706f2543Smrg.BI -parent " id"
47706f2543Smrguses exiting window
48706f2543Smrg.I id .
49706f2543SmrgIf a
50706f2543Smrg.BI -screen
51706f2543Smrgargument follows a
52706f2543Smrg.BI -parent
53706f2543Smrgargument, this screen is embedded into the given window.
54706f2543Smrg.TP 8
55706f2543Smrg.B -host-cursor
56706f2543Smrgset 'cursor acceleration':
57706f2543SmrgThe host's cursor is reused. This is only really there to aid
58706f2543Smrgdebugging by avoiding server paints for the cursor. Performance
59706f2543Smrgimprovement is negligible.
60706f2543Smrg.SH "SIGNALS"
61706f2543SmrgSend a SIGUSR1 to the server (e.g. pkill -USR1 Xephyr) to
62706f2543Smrgtoggle the debugging mode.
63706f2543SmrgIn this mode red rectangles are painted to
64706f2543Smrgscreen areas getting painted before painting the actual content.
65706f2543SmrgThe
66706f2543Smrgdelay between this can be altered by setting a XEPHYR_PAUSE env var to
67706f2543Smrga value in micro seconds.
68706f2543Smrg.SH CAVEATS
69706f2543Smrg.PP
70706f2543Smrg.IP \(bu 2
71706f2543SmrgRotated displays are currently updated via full blits. This
72706f2543Smrgis slower than a normal orientated display. Debug mode will
73706f2543Smrgtherefore not be of much use rotated.
74706f2543Smrg.IP \(bu 2
75706f2543SmrgThe '-host-cursor' cursor is static in its appearance.
76706f2543Smrg.IP \(bu 2
77706f2543SmrgThe build gets a warning about 'nanosleep'. I think the various '-D'
78706f2543Smrgbuild flags are causing this. I haven't figured as yet how to work
79706f2543Smrground it. It doesn't appear to break anything however.
80706f2543Smrg.IP \(bu 2
81706f2543SmrgKeyboard handling is basic but works.
82706f2543Smrg.TP \(bu 2
83706f2543SmrgMouse button 5 probably won't work.
84706f2543Smrg.SH "SEE ALSO"
85706f2543SmrgX(__miscmansuffix__), Xserver(__appmansuffix__)
86706f2543Smrg.SH AUTHOR
87706f2543SmrgMatthew Allum <mallum@o-hand.com> 2004
88