From ac5ffef60e05eb05275913b133786709881e7e7e Mon Sep 17 00:00:00 2001 From: Gaetan Nadon Date: Sun, 9 Jan 2011 20:27:52 -0500 Subject: Xephyr: build Xephyr man pages using XORG_MANPAGE_SECTIONS MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Nothing requires the use of a C preprocessor Using standard file extensions (.man) means no need for .gitignore Use standard directory and makefile Fix trailing whitespaces Reviewed-by: Alan Coopersmith Reviewed-by: Rémi Cardona Signed-off-by: Gaetan Nadon Signed-off-by: Keith Packard --- hw/kdrive/ephyr/.gitignore | 2 - hw/kdrive/ephyr/Makefile.am | 18 ++------- hw/kdrive/ephyr/Xephyr.man.pre | 89 ----------------------------------------- hw/kdrive/ephyr/man/Makefile.am | 10 +++++ hw/kdrive/ephyr/man/Xephyr.man | 87 ++++++++++++++++++++++++++++++++++++++++ 5 files changed, 100 insertions(+), 106 deletions(-) delete mode 100644 hw/kdrive/ephyr/Xephyr.man.pre create mode 100644 hw/kdrive/ephyr/man/Makefile.am create mode 100644 hw/kdrive/ephyr/man/Xephyr.man (limited to 'hw/kdrive') diff --git a/hw/kdrive/ephyr/.gitignore b/hw/kdrive/ephyr/.gitignore index bfe7e08c2..4962d1ef0 100644 --- a/hw/kdrive/ephyr/.gitignore +++ b/hw/kdrive/ephyr/.gitignore @@ -1,3 +1 @@ -# Add & Override for this directory and it's subdirectories Xephyr -Xephyr.man diff --git a/hw/kdrive/ephyr/Makefile.am b/hw/kdrive/ephyr/Makefile.am index 8646703ad..9d9b64ee5 100644 --- a/hw/kdrive/ephyr/Makefile.am +++ b/hw/kdrive/ephyr/Makefile.am @@ -1,3 +1,5 @@ +SUBDIRS = man + INCLUDES = \ @KDRIVE_INCS@ \ @KDRIVE_CFLAGS@ \ @@ -83,20 +85,6 @@ Xephyr_LDFLAGS = $(LD_EXPORT_SYMBOLS_FLAG) relink: $(AM_V_at)rm -f $(bin_PROGRAMS) && $(MAKE) $(bin_PROGRAMS) -MAN_SRCS = Xephyr.man.pre - -appmandir = $(APP_MAN_DIR) -appman_DATA = Xephyr.$(APP_MAN_SUFFIX) - -Xephyr.$(APP_MAN_SUFFIX): Xephyr.man - -$(AM_V_at)rm -f Xephyr.$(APP_MAN_SUFFIX) - $(AM_V_at)$(LN_S) Xephyr.man Xephyr.$(APP_MAN_SUFFIX) - -include $(top_srcdir)/cpprules.in - -CLEANFILES = $(appman_DATA) Xephyr.man - EXTRA_DIST = \ $(HOSTVIDEO_SRCS) \ - $(HOSTDRI_SRCS) \ - $(MAN_SRCS) + $(HOSTDRI_SRCS) diff --git a/hw/kdrive/ephyr/Xephyr.man.pre b/hw/kdrive/ephyr/Xephyr.man.pre deleted file mode 100644 index eb80b96b0..000000000 --- a/hw/kdrive/ephyr/Xephyr.man.pre +++ /dev/null @@ -1,89 +0,0 @@ -." -." Copyright (c) Matthieu Herrb -." -." Permission to use, copy, modify, and distribute this software for any -." purpose with or without fee is hereby granted, provided that the above -." copyright notice and this permission notice appear in all copies. -." -." THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -." WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -." MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -." ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -." WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -." ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -." OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -." -.TH Xephyr __appmansuffix__ __vendorversion__ -.SH NAME -Xephyr - X server outputting to a window on a pre-existing X display -.SH SYNOPSIS -.B Xephyr -.RI [\fB:\fP display ] -.RI [ option -.IR ... ] -.SH DESCRIPTION -.B Xephyr -is a kdrive server that outputs to a window on a pre-existing "host" -X display. -Think -.I Xnest -but with support for modern extensions like composite, damage and randr. -.PP -Unlike -.I Xnest -which is an X proxy, i.e. limited to the capabilities of the host X server, -.B Xephyr -is a real X server which -uses the host X server window as "framebuffer" via fast SHM XImages. -.PP -It also has support for "visually" debugging what the server is -painting. -.SH OPTIONS -.TP 8 -.BI -screen " width" x height -sets the screen size. -.TP 8 -.BI -parent " id" -uses exiting window -.I id . -If a -.BI -screen -argument follows a -.BI -parent -argument, this screen is embedded into the given window. -.TP 8 -.B -host-cursor -set 'cursor acceleration': -The host's cursor is reused. This is only really there to aid -debugging by avoiding server paints for the cursor. Performance -improvement is negligible. -.SH "SIGNALS" -Send a SIGUSR1 to the server (e.g. pkill -USR1 Xephyr) to -toggle the debugging mode. -In this mode red rectangles are painted to -screen areas getting painted before painting the actual content. -The -delay between this can be altered by setting a XEPHYR_PAUSE env var to -a value in micro seconds. -.SH CAVEATS -.PP -.IP \(bu 2 -Rotated displays are currently updated via full blits. This -is slower than a normal orientated display. Debug mode will -therefore not be of much use rotated. -.IP \(bu 2 -The '-host-cursor' cursor is static in its appearance. -.IP \(bu 2 -The build gets a warning about 'nanosleep'. I think the various '-D' -build flags are causing this. I haven't figured as yet how to work -round it. It doesn't appear to break anything however. -.IP \(bu 2 -Keyboard handling is basic but works. -.TP \(bu 2 -Mouse button 5 probably won't work. -.SH "SEE ALSO" -X(__miscmansuffix__), Xserver(__appmansuffix__) -.SH AUTHOR -Matthew Allum 2004 - - diff --git a/hw/kdrive/ephyr/man/Makefile.am b/hw/kdrive/ephyr/man/Makefile.am new file mode 100644 index 000000000..58f1cbd4a --- /dev/null +++ b/hw/kdrive/ephyr/man/Makefile.am @@ -0,0 +1,10 @@ +appmandir = $(APP_MAN_DIR) +appman_PRE = Xephyr.man +appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX)) + +EXTRA_DIST = $(appman_PRE) +CLEANFILES = $(appman_DATA) +SUFFIXES = .$(APP_MAN_SUFFIX) .man + +.man.$(APP_MAN_SUFFIX): + $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@ diff --git a/hw/kdrive/ephyr/man/Xephyr.man b/hw/kdrive/ephyr/man/Xephyr.man new file mode 100644 index 000000000..8e7bfd550 --- /dev/null +++ b/hw/kdrive/ephyr/man/Xephyr.man @@ -0,0 +1,87 @@ +." +." Copyright (c) Matthieu Herrb +." +." Permission to use, copy, modify, and distribute this software for any +." purpose with or without fee is hereby granted, provided that the above +." copyright notice and this permission notice appear in all copies. +." +." THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +." WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +." MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +." ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +." WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +." ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +." OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +." +.TH Xephyr __appmansuffix__ __vendorversion__ +.SH NAME +Xephyr - X server outputting to a window on a pre-existing X display +.SH SYNOPSIS +.B Xephyr +.RI [\fB:\fP display ] +.RI [ option +.IR ... ] +.SH DESCRIPTION +.B Xephyr +is a kdrive server that outputs to a window on a pre-existing "host" +X display. +Think +.I Xnest +but with support for modern extensions like composite, damage and randr. +.PP +Unlike +.I Xnest +which is an X proxy, i.e. limited to the capabilities of the host X server, +.B Xephyr +is a real X server which +uses the host X server window as "framebuffer" via fast SHM XImages. +.PP +It also has support for "visually" debugging what the server is +painting. +.SH OPTIONS +.TP 8 +.BI -screen " width" x height +sets the screen size. +.TP 8 +.BI -parent " id" +uses exiting window +.I id . +If a +.BI -screen +argument follows a +.BI -parent +argument, this screen is embedded into the given window. +.TP 8 +.B -host-cursor +set 'cursor acceleration': +The host's cursor is reused. This is only really there to aid +debugging by avoiding server paints for the cursor. Performance +improvement is negligible. +.SH "SIGNALS" +Send a SIGUSR1 to the server (e.g. pkill -USR1 Xephyr) to +toggle the debugging mode. +In this mode red rectangles are painted to +screen areas getting painted before painting the actual content. +The +delay between this can be altered by setting a XEPHYR_PAUSE env var to +a value in micro seconds. +.SH CAVEATS +.PP +.IP \(bu 2 +Rotated displays are currently updated via full blits. This +is slower than a normal orientated display. Debug mode will +therefore not be of much use rotated. +.IP \(bu 2 +The '-host-cursor' cursor is static in its appearance. +.IP \(bu 2 +The build gets a warning about 'nanosleep'. I think the various '-D' +build flags are causing this. I haven't figured as yet how to work +round it. It doesn't appear to break anything however. +.IP \(bu 2 +Keyboard handling is basic but works. +.TP \(bu 2 +Mouse button 5 probably won't work. +.SH "SEE ALSO" +X(__miscmansuffix__), Xserver(__appmansuffix__) +.SH AUTHOR +Matthew Allum 2004 -- cgit v1.2.3