1 [Adjusted to apply to 1.5.x tree] |
|
2 |
|
3 From 6a1b2fed7e465a9c652e8ee250b8eab440945862 Mon Sep 17 00:00:00 2001 |
|
4 From: Matthieu Herrb <[email protected]> |
|
5 Date: Sun, 28 Sep 2008 12:18:16 +0200 |
|
6 Subject: [PATCH] Add a man page for Xephyr, with information from the README file. |
|
7 |
|
8 --- |
|
9 hw/kdrive/ephyr/Makefile.am | 16 +++++++- |
|
10 hw/kdrive/ephyr/Xephyr.man.pre | 84 ++++++++++++++++++++++++++++++++++++++++ |
|
11 2 files changed, 99 insertions(+), 1 deletions(-) |
|
12 create mode 100644 hw/kdrive/ephyr/Xephyr.man.pre |
|
13 |
|
14 diff --git a/hw/kdrive/ephyr/Makefile.am b/hw/kdrive/ephyr/Makefile.am |
|
15 index bf1f475..9380e4d 100644 |
|
16 --- a/hw/kdrive/ephyr/Makefile.am |
|
17 +++ b/hw/kdrive/ephyr/Makefile.am |
|
18 @@ -83,2 +83,18 @@ Xephyr_LDFLAGS = $(LD_EXPORT_SYMBOLS_FLAG) |
|
19 relink: |
|
20 rm -f $(bin_PROGRAMS) && make $(bin_PROGRAMS) |
|
21 + |
|
22 +MAN_SRCS = Xephyr.man.pre |
|
23 + |
|
24 +appmandir = $(APP_MAN_DIR) |
|
25 +appman_DATA = Xephyr.$(APP_MAN_SUFFIX) |
|
26 + |
|
27 +Xephyr.$(APP_MAN_SUFFIX): Xephyr.man |
|
28 + -rm -f Xephyr.$(APP_MAN_SUFFIX) |
|
29 + $(LN_S) Xephyr.man Xephyr.$(APP_MAN_SUFFIX) |
|
30 + |
|
31 +include $(top_srcdir)/cpprules.in |
|
32 + |
|
33 +CLEANFILES = $(appman_DATA) Xephyr.man |
|
34 + |
|
35 +EXTRA_DIST = \ |
|
36 + $(MAN_SRCS) |
|
37 diff --git a/hw/kdrive/ephyr/Xephyr.man.pre b/hw/kdrive/ephyr/Xephyr.man.pre |
|
38 new file mode 100644 |
|
39 index 0000000..19c9b86 |
|
40 --- /dev/null |
|
41 +++ b/hw/kdrive/ephyr/Xephyr.man.pre |
|
42 @@ -0,0 +1,84 @@ |
|
43 +." |
|
44 +." Copyright (c) Matthieu Herrb <[email protected]> |
|
45 +." |
|
46 +." Permission to use, copy, modify, and distribute this software for any |
|
47 +." purpose with or without fee is hereby granted, provided that the above |
|
48 +." copyright notice and this permission notice appear in all copies. |
|
49 +." |
|
50 +." THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
51 +." WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
52 +." MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
53 +." ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
54 +." WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
55 +." ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
56 +." OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
57 +." |
|
58 +.TH Xephyr __appmansuffix__ __vendorversion__ |
|
59 +.SH NAME |
|
60 +Xephyr - X server outputting to a window on a pre-existing X display |
|
61 +.SH SYNOPSIS |
|
62 +.B Xephyr |
|
63 +.RI [\fB:\fP display ] |
|
64 +.RI [ option |
|
65 +.IR ... ] |
|
66 +.SH DESCRIPTION |
|
67 +.B Xephyr |
|
68 +is a a kdrive server that outputs to a window on a pre-existing |
|
69 +'host' X display. |
|
70 +Think |
|
71 +.I Xnest |
|
72 +but with support for modern extensions like composite, damage and randr. |
|
73 +.PP |
|
74 +Unlike |
|
75 +.I Xnest |
|
76 +which is an X proxy, i.e. limited to the capabilities of the host X server, |
|
77 +.B Xephyr |
|
78 +is a real X server which |
|
79 +uses the host X server window as "framebuffer" via fast SHM XImages. |
|
80 +.PP |
|
81 +It also has support for "visually" debugging what the server is |
|
82 +painting. |
|
83 +.SH OPTIONS |
|
84 +.TP 8 |
|
85 +.BI -screen " width" x height |
|
86 +sets the screen size. |
|
87 +.TP 8 |
|
88 +.BI -parent " id" |
|
89 +uses exiting window |
|
90 +.I id . |
|
91 +.TP 8 |
|
92 +.B -host-cursor |
|
93 +set 'cursor acceleration': |
|
94 +The host's cursor is reused. This is only really there to aid |
|
95 +debugging by avoiding server paints for the cursor. Performance |
|
96 +improvement is negiable. |
|
97 +.SH "SIGNALS" |
|
98 +Send a SIGUSR1 to the server (e.g. pkill -USR1 Xephyr) to |
|
99 +toggle the debugging mode. |
|
100 +In this mode red rectangles are painted to |
|
101 +screen areas getting painted before painting the actual content. |
|
102 +The |
|
103 +delay between this can be altered by setting a XEPHYR_PAUSE env var to |
|
104 +a value in micro seconds. |
|
105 +.SH CAVEATS |
|
106 +.PP |
|
107 +.IP \(bu 2 |
|
108 +Rotated displays are currently updated via full blits. This |
|
109 +is slower than a normal oprientated display. Debug mode will |
|
110 +therefore not be of much use rotated. |
|
111 +.IP \(bu 2 |
|
112 +The '-host-cursor' cursor is static in its appearence. |
|
113 +.IP \(bu 2 |
|
114 +The build gets a warning about 'nanosleep'. I think the various '-D' |
|
115 +build flags are causing this. I havn't figured as yet how to work |
|
116 +round it. It doesn't appear to break anything however. |
|
117 +.IP \(bu 2 |
|
118 +Keyboard handling is basic but works. |
|
119 +.TP \(bu 2 |
|
120 +Mouse button 5 probably wont work. |
|
121 +.SH "SEE ALSO" |
|
122 +X(__miscmansuffix), Xserver(__appmansuffix__) |
|
123 +.SH AUTHOR |
|
124 +Matthew Allum <[email protected]> 2004 |
|
125 + |
|
126 + |
|
127 -- |
|
128 1.5.6.5 |
|
129 |
|
130 |
|
131 From dacad9ae0bdaedff9403fbe84a5c5a4b4eef3542 Mon Sep 17 00:00:00 2001 |
|
132 From: Alan Coopersmith <[email protected]> |
|
133 Date: Fri, 21 Nov 2008 17:16:22 -0800 |
|
134 Subject: [PATCH] Xephyr man page typo fixes. |
|
135 |
|
136 Also trailing white space removal to clear git warnings. |
|
137 --- |
|
138 hw/kdrive/ephyr/Xephyr.man.pre | 42 ++++++++++++++++++++-------------------- |
|
139 1 files changed, 21 insertions(+), 21 deletions(-) |
|
140 |
|
141 diff --git a/hw/kdrive/ephyr/Xephyr.man.pre b/hw/kdrive/ephyr/Xephyr.man.pre |
|
142 index 19c9b86..7f0e811 100644 |
|
143 --- a/hw/kdrive/ephyr/Xephyr.man.pre |
|
144 +++ b/hw/kdrive/ephyr/Xephyr.man.pre |
|
145 @@ -22,17 +22,17 @@ Xephyr - X server outputting to a window on a pre-existing X display |
|
146 .RI [ option |
|
147 .IR ... ] |
|
148 .SH DESCRIPTION |
|
149 -.B Xephyr |
|
150 +.B Xephyr |
|
151 is a a kdrive server that outputs to a window on a pre-existing |
|
152 -'host' X display. |
|
153 -Think |
|
154 -.I Xnest |
|
155 -but with support for modern extensions like composite, damage and randr. |
|
156 +'host' X display. |
|
157 +Think |
|
158 +.I Xnest |
|
159 +but with support for modern extensions like composite, damage and randr. |
|
160 .PP |
|
161 -Unlike |
|
162 -.I Xnest |
|
163 -which is an X proxy, i.e. limited to the capabilities of the host X server, |
|
164 -.B Xephyr |
|
165 +Unlike |
|
166 +.I Xnest |
|
167 +which is an X proxy, i.e. limited to the capabilities of the host X server, |
|
168 +.B Xephyr |
|
169 is a real X server which |
|
170 uses the host X server window as "framebuffer" via fast SHM XImages. |
|
171 .PP |
|
172 @@ -51,12 +51,12 @@ uses exiting window |
|
173 set 'cursor acceleration': |
|
174 The host's cursor is reused. This is only really there to aid |
|
175 debugging by avoiding server paints for the cursor. Performance |
|
176 -improvement is negiable. |
|
177 +improvement is negligible. |
|
178 .SH "SIGNALS" |
|
179 Send a SIGUSR1 to the server (e.g. pkill -USR1 Xephyr) to |
|
180 -toggle the debugging mode. |
|
181 +toggle the debugging mode. |
|
182 In this mode red rectangles are painted to |
|
183 -screen areas getting painted before painting the actual content. |
|
184 +screen areas getting painted before painting the actual content. |
|
185 The |
|
186 delay between this can be altered by setting a XEPHYR_PAUSE env var to |
|
187 a value in micro seconds. |
|
188 @@ -64,21 +64,21 @@ a value in micro seconds. |
|
189 .PP |
|
190 .IP \(bu 2 |
|
191 Rotated displays are currently updated via full blits. This |
|
192 -is slower than a normal oprientated display. Debug mode will |
|
193 -therefore not be of much use rotated. |
|
194 +is slower than a normal orientated display. Debug mode will |
|
195 +therefore not be of much use rotated. |
|
196 .IP \(bu 2 |
|
197 -The '-host-cursor' cursor is static in its appearence. |
|
198 +The '-host-cursor' cursor is static in its appearance. |
|
199 .IP \(bu 2 |
|
200 The build gets a warning about 'nanosleep'. I think the various '-D' |
|
201 -build flags are causing this. I havn't figured as yet how to work |
|
202 -round it. It doesn't appear to break anything however. |
|
203 +build flags are causing this. I haven't figured as yet how to work |
|
204 +round it. It doesn't appear to break anything however. |
|
205 .IP \(bu 2 |
|
206 -Keyboard handling is basic but works. |
|
207 +Keyboard handling is basic but works. |
|
208 .TP \(bu 2 |
|
209 -Mouse button 5 probably wont work. |
|
210 +Mouse button 5 probably wont work. |
|
211 .SH "SEE ALSO" |
|
212 -X(__miscmansuffix), Xserver(__appmansuffix__) |
|
213 +X(__miscmansuffix__), Xserver(__appmansuffix__) |
|
214 .SH AUTHOR |
|
215 -Matthew Allum <[email protected]> 2004 |
|
216 +Matthew Allum <[email protected]> 2004 |
|
217 |
|
218 |
|
219 -- |
|
220 1.5.6.5 |
|
221 |
|