Xephyr.man revision 706f2543 
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
18Xephyr - 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
26is a kdrive server that outputs to a window on a pre-existing "host"
27X display.
28Think
29.I Xnest
30but with support for modern extensions like composite, damage and randr.
31.PP
32Unlike
33.I Xnest
34which is an X proxy, i.e.  limited to the capabilities of the host X server,
35.B Xephyr
36is a real X server which
37uses the host X server window as "framebuffer" via fast SHM XImages.
38.PP
39It also has support for "visually" debugging what the server is
40painting.
41.SH OPTIONS
42.TP 8
43.BI -screen " width" x height
44sets the screen size.
45.TP 8
46.BI -parent " id"
47uses exiting window
48.I id .
49If a
50.BI -screen
51argument follows a
52.BI -parent
53argument, this screen is embedded into the given window.
54.TP 8
55.B -host-cursor
56set 'cursor acceleration':
57The host's cursor is reused. This is only really there to aid
58debugging by avoiding server paints for the cursor. Performance
59improvement is negligible.
60.SH "SIGNALS"
61Send a SIGUSR1 to the server (e.g. pkill -USR1 Xephyr) to
62toggle the debugging mode.
63In this mode red rectangles are painted to
64screen areas getting painted before painting the actual content.
65The
66delay between this can be altered by setting a XEPHYR_PAUSE env var to
67a value in micro seconds.
68.SH CAVEATS
69.PP
70.IP \(bu 2
71Rotated displays are currently updated via full blits. This
72is slower than a normal orientated display. Debug mode will
73therefore not be of much use rotated.
74.IP \(bu 2
75The '-host-cursor' cursor is static in its appearance.
76.IP \(bu 2
77The build gets a warning about 'nanosleep'. I think the various '-D'
78build flags are causing this. I haven't figured as yet how to work
79round it. It doesn't appear to break anything however.
80.IP \(bu 2
81Keyboard handling is basic but works.
82.TP \(bu 2
83Mouse button 5 probably won't work.
84.SH "SEE ALSO"
85X(__miscmansuffix__), Xserver(__appmansuffix__)
86.SH AUTHOR
87Matthew Allum <mallum@o-hand.com> 2004
88