diff options
author | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2007-09-30 06:13:09 +0000 |
---|---|---|
committer | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2007-09-30 06:13:09 +0000 |
commit | e79bc4fc257a5239d8817ad8eebc1214b936c46f (patch) | |
tree | ad84aac1aee2bcba663b3ff70b7e388de63e3524 | |
parent | 3cce69fb749bec5cf48bf6df88cc10d938983191 (diff) |
libXcomposite 0.4.0
-rw-r--r-- | lib/libXcomposite/man/Makefile.am | 77 | ||||
-rw-r--r-- | lib/libXcomposite/man/Makefile.in | 439 | ||||
-rw-r--r-- | lib/libXcomposite/man/Xcomposite.man | 254 | ||||
-rw-r--r-- | lib/libXcomposite/man/Xcomposite.xml | 407 |
4 files changed, 1177 insertions, 0 deletions
diff --git a/lib/libXcomposite/man/Makefile.am b/lib/libXcomposite/man/Makefile.am new file mode 100644 index 000000000..8ff4f37aa --- /dev/null +++ b/lib/libXcomposite/man/Makefile.am @@ -0,0 +1,77 @@ +libmandir = $(LIB_MAN_DIR) + +LIB_MAN_DIR_SUFFIX = $(LIB_MAN_DIR:@mandir@/man%=%) + +libman_xml = Xcomposite.xml + +libman_PRE = $(libman_xml:xml=man) + +Xcomposite_man_aliases = \ + XCompositeQueryExtension \ + XCompositeQueryVersion \ + XCompositeVersion \ + XCompositeRedirectWindow \ + XCompositeRedirectSubwindows \ + XCompositeUnredirectWindow \ + XCompositeUnredirectSubwindows \ + XCompositeCreateRegionFromBorderClip \ + XCompositeNameWindowPixmap \ + XCompositeGetOverlayWindow \ + XCompositeReleaseOverlayWindow + +libman_DATA = $(libman_PRE:man=@LIB_MAN_SUFFIX@) \ + $(Xcomposite_man_aliases:=.@LIB_MAN_SUFFIX@) + +EXTRA_DIST = $(libman_PRE) $(libman_xml) + +CLEANFILES = $(libman_DATA) + +MAINTAINERCLEANFILES = $(libman_PRE) + +# Generate man page shadow files (Replaces InstallManPageAliases from Imake) + +BUILT_SOURCES = shadows.DONE + +shadows.DONE: + -rm -f $(Xcomposite_man_aliases:=.@LIB_MAN_SUFFIX@) + (for i in $(Xcomposite_man_aliases:=.@LIB_MAN_SUFFIX@) ; do \ + echo .so man$(LIB_MAN_DIR_SUFFIX)/Xcomposite.$(LIB_MAN_SUFFIX) > $$i; \ + done) + touch shadows.DONE + +CLEANFILES += shadows.DONE + +# Substitute system-specific values in man pages + +XORGRELSTRING = @PACKAGE_STRING@ + XORGMANNAME = X Version 11 + +MAN_SUBSTS = \ + -e 's|"__vendorversion__"|"$(XORGRELSTRING)" "$(XORGMANNAME)"|' \ + -e 's|__xorgversion__|"$(XORGRELSTRING)" "$(XORGMANNAME)"|' \ + -e 's|__xservername__|Xorg|g' \ + -e 's|__xconfigfile__|xorg.conf|g' \ + -e 's|__projectroot__|$(prefix)|g' \ + -e 's|__apploaddir__|$(appdefaultdir)|' \ + -e 's|__appmansuffix__|$(APP_MAN_SUFFIX)|g' \ + -e 's|__libmansuffix__|$(LIB_MAN_SUFFIX)|g' \ + -e 's|__adminmansuffix__|$(ADMIN_MAN_SUFFIX)|g' \ + -e 's|__miscmansuffix__|$(MISC_MAN_SUFFIX)|g' \ + -e 's|__filemansuffix__|$(FILE_MAN_SUFFIX)|g' + +SUFFIXES = .$(LIB_MAN_SUFFIX) .man .xml + +.man.$(LIB_MAN_SUFFIX): + sed $(MAN_SUBSTS) < $< > $@ + +# Generate nroff sources from DocBook/xml + +dist-hook: $(libman_PRE) + +if HAVE_XMLTO +.xml.man: + $(XMLTO) man $< && mv $*.__libmansuffix__ $@ +else +.xml.man: + @echo "WARNING: configure did not find xmlto, cannot create $@ without it" +endif diff --git a/lib/libXcomposite/man/Makefile.in b/lib/libXcomposite/man/Makefile.in new file mode 100644 index 000000000..16a5ebfb2 --- /dev/null +++ b/lib/libXcomposite/man/Makefile.in @@ -0,0 +1,439 @@ +# Makefile.in generated by automake 1.9.6 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005 Free Software Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +srcdir = @srcdir@ +top_srcdir = @top_srcdir@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +top_builddir = .. +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +INSTALL = @INSTALL@ +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = man +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +SOURCES = +DIST_SOURCES = +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = `echo $$p | sed -e 's|^.*/||'`; +am__installdirs = "$(DESTDIR)$(libmandir)" +libmanDATA_INSTALL = $(INSTALL_DATA) +DATA = $(libman_DATA) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +ADMIN_MAN_DIR = @ADMIN_MAN_DIR@ +ADMIN_MAN_SUFFIX = @ADMIN_MAN_SUFFIX@ +AMDEP_FALSE = @AMDEP_FALSE@ +AMDEP_TRUE = @AMDEP_TRUE@ +AMTAR = @AMTAR@ +APP_MAN_DIR = @APP_MAN_DIR@ +APP_MAN_SUFFIX = @APP_MAN_SUFFIX@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +COMPOSITEEXT_VERSION = @COMPOSITEEXT_VERSION@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CXX = @CXX@ +CXXCPP = @CXXCPP@ +CXXDEPMODE = @CXXDEPMODE@ +CXXFLAGS = @CXXFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DRIVER_MAN_DIR = @DRIVER_MAN_DIR@ +DRIVER_MAN_SUFFIX = @DRIVER_MAN_SUFFIX@ +ECHO = @ECHO@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +F77 = @F77@ +FFLAGS = @FFLAGS@ +FILE_MAN_DIR = @FILE_MAN_DIR@ +FILE_MAN_SUFFIX = @FILE_MAN_SUFFIX@ +GREP = @GREP@ +HAVE_XMLTO_FALSE = @HAVE_XMLTO_FALSE@ +HAVE_XMLTO_TRUE = @HAVE_XMLTO_TRUE@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LDFLAGS = @LDFLAGS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIB_MAN_DIR = @LIB_MAN_DIR@ +LIB_MAN_SUFFIX = @LIB_MAN_SUFFIX@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAINTAINER_MODE_FALSE = @MAINTAINER_MODE_FALSE@ +MAINTAINER_MODE_TRUE = @MAINTAINER_MODE_TRUE@ +MAKEINFO = @MAKEINFO@ +MISC_MAN_DIR = @MISC_MAN_DIR@ +MISC_MAN_SUFFIX = @MISC_MAN_SUFFIX@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +RANLIB = @RANLIB@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +VERSION = @VERSION@ +XCOMPOSITE_CFLAGS = @XCOMPOSITE_CFLAGS@ +XCOMPOSITE_LIBS = @XCOMPOSITE_LIBS@ +XMLTO = @XMLTO@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_CXX = @ac_ct_CXX@ +ac_ct_F77 = @ac_ct_F77@ +am__fastdepCC_FALSE = @am__fastdepCC_FALSE@ +am__fastdepCC_TRUE = @am__fastdepCC_TRUE@ +am__fastdepCXX_FALSE = @am__fastdepCXX_FALSE@ +am__fastdepCXX_TRUE = @am__fastdepCXX_TRUE@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +libmandir = $(LIB_MAN_DIR) +LIB_MAN_DIR_SUFFIX = $(LIB_MAN_DIR:@mandir@/man%=%) +libman_xml = Xcomposite.xml +libman_PRE = $(libman_xml:xml=man) +Xcomposite_man_aliases = \ + XCompositeQueryExtension \ + XCompositeQueryVersion \ + XCompositeVersion \ + XCompositeRedirectWindow \ + XCompositeRedirectSubwindows \ + XCompositeUnredirectWindow \ + XCompositeUnredirectSubwindows \ + XCompositeCreateRegionFromBorderClip \ + XCompositeNameWindowPixmap \ + XCompositeGetOverlayWindow \ + XCompositeReleaseOverlayWindow + +libman_DATA = $(libman_PRE:man=@LIB_MAN_SUFFIX@) \ + $(Xcomposite_man_aliases:=.@LIB_MAN_SUFFIX@) + +EXTRA_DIST = $(libman_PRE) $(libman_xml) +CLEANFILES = $(libman_DATA) shadows.DONE +MAINTAINERCLEANFILES = $(libman_PRE) + +# Generate man page shadow files (Replaces InstallManPageAliases from Imake) +BUILT_SOURCES = shadows.DONE + +# Substitute system-specific values in man pages +XORGRELSTRING = @PACKAGE_STRING@ +XORGMANNAME = X Version 11 +MAN_SUBSTS = \ + -e 's|"__vendorversion__"|"$(XORGRELSTRING)" "$(XORGMANNAME)"|' \ + -e 's|__xorgversion__|"$(XORGRELSTRING)" "$(XORGMANNAME)"|' \ + -e 's|__xservername__|Xorg|g' \ + -e 's|__xconfigfile__|xorg.conf|g' \ + -e 's|__projectroot__|$(prefix)|g' \ + -e 's|__apploaddir__|$(appdefaultdir)|' \ + -e 's|__appmansuffix__|$(APP_MAN_SUFFIX)|g' \ + -e 's|__libmansuffix__|$(LIB_MAN_SUFFIX)|g' \ + -e 's|__adminmansuffix__|$(ADMIN_MAN_SUFFIX)|g' \ + -e 's|__miscmansuffix__|$(MISC_MAN_SUFFIX)|g' \ + -e 's|__filemansuffix__|$(FILE_MAN_SUFFIX)|g' + +SUFFIXES = .$(LIB_MAN_SUFFIX) .man .xml +all: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) all-am + +.SUFFIXES: +.SUFFIXES: .$(LIB_MAN_SUFFIX) .man .xml +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \ + && exit 0; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu man/Makefile'; \ + cd $(top_srcdir) && \ + $(AUTOMAKE) --gnu man/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs + +distclean-libtool: + -rm -f libtool +uninstall-info-am: +install-libmanDATA: $(libman_DATA) + @$(NORMAL_INSTALL) + test -z "$(libmandir)" || $(mkdir_p) "$(DESTDIR)$(libmandir)" + @list='$(libman_DATA)'; for p in $$list; do \ + if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ + f=$(am__strip_dir) \ + echo " $(libmanDATA_INSTALL) '$$d$$p' '$(DESTDIR)$(libmandir)/$$f'"; \ + $(libmanDATA_INSTALL) "$$d$$p" "$(DESTDIR)$(libmandir)/$$f"; \ + done + +uninstall-libmanDATA: + @$(NORMAL_UNINSTALL) + @list='$(libman_DATA)'; for p in $$list; do \ + f=$(am__strip_dir) \ + echo " rm -f '$(DESTDIR)$(libmandir)/$$f'"; \ + rm -f "$(DESTDIR)$(libmandir)/$$f"; \ + done +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \ + list='$(DISTFILES)'; for file in $$list; do \ + case $$file in \ + $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \ + $(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \ + esac; \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test "$$dir" != "$$file" && test "$$dir" != "."; then \ + dir="/$$dir"; \ + $(mkdir_p) "$(distdir)$$dir"; \ + else \ + dir=''; \ + fi; \ + if test -d $$d/$$file; then \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ + fi; \ + cp -pR $$d/$$file $(distdir)$$dir || exit 1; \ + else \ + test -f $(distdir)/$$file \ + || cp -p $$d/$$file $(distdir)/$$file \ + || exit 1; \ + fi; \ + done + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$(top_distdir)" distdir="$(distdir)" \ + dist-hook +check-am: all-am +check: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) check-am +all-am: Makefile $(DATA) +installdirs: + for dir in "$(DESTDIR)$(libmandir)"; do \ + test -z "$$dir" || $(mkdir_p) "$$dir"; \ + done +install: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." + -test -z "$(BUILT_SOURCES)" || rm -f $(BUILT_SOURCES) + -test -z "$(MAINTAINERCLEANFILES)" || rm -f $(MAINTAINERCLEANFILES) +clean: clean-am + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-libtool + +dvi: dvi-am + +dvi-am: + +html: html-am + +info: info-am + +info-am: + +install-data-am: install-libmanDATA + +install-exec-am: + +install-info: install-info-am + +install-man: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-info-am uninstall-libmanDATA + +.PHONY: all all-am check check-am clean clean-generic clean-libtool \ + dist-hook distclean distclean-generic distclean-libtool \ + distdir dvi dvi-am html html-am info info-am install \ + install-am install-data install-data-am install-exec \ + install-exec-am install-info install-info-am \ + install-libmanDATA install-man install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ + uninstall-info-am uninstall-libmanDATA + + +shadows.DONE: + -rm -f $(Xcomposite_man_aliases:=.@LIB_MAN_SUFFIX@) + (for i in $(Xcomposite_man_aliases:=.@LIB_MAN_SUFFIX@) ; do \ + echo .so man$(LIB_MAN_DIR_SUFFIX)/Xcomposite.$(LIB_MAN_SUFFIX) > $$i; \ + done) + touch shadows.DONE + +.man.$(LIB_MAN_SUFFIX): + sed $(MAN_SUBSTS) < $< > $@ + +# Generate nroff sources from DocBook/xml + +dist-hook: $(libman_PRE) + +@HAVE_XMLTO_TRUE@.xml.man: +@HAVE_XMLTO_TRUE@ $(XMLTO) man $< && mv $*.__libmansuffix__ $@ +@HAVE_XMLTO_FALSE@.xml.man: +@HAVE_XMLTO_FALSE@ @echo "WARNING: configure did not find xmlto, cannot create $@ without it" +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/lib/libXcomposite/man/Xcomposite.man b/lib/libXcomposite/man/Xcomposite.man new file mode 100644 index 000000000..4b05b31fe --- /dev/null +++ b/lib/libXcomposite/man/Xcomposite.man @@ -0,0 +1,254 @@ +.\" Title: Xcomposite +.\" Author: Keith Packard <keithp@keithp.com> +.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/> +.\" Date: <pubdate>23 April 2007</pubdate> +.\" Manual: X Composite Extension Library +.\" Source: __vendorversion__ +.\" +.TH "XCOMPOSITE" "__libmansuffix__" "<pubdate>23 April 2007</pubdate>" "__vendorversion__" "X Composite Extension Library" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +Xcomposite \- X Composite Extension library +.SH "SYNOPSIS" +.sp +.ft B +.nf +#include <X11/extensions/Xcomposite.h> +.fi +.ft +.HP 30 +.BI "Bool XCompositeQueryExtension(Display\ *" "dpy" ", int\ *" "event_basep" ", int\ *" "error_basep" ");" +.HP 30 +.BI "Status XCompositeQueryVersion(Display\ *" "dpy" ", int\ *" "major_versionp" ", int\ *" "minor_versionp" ");" +.HP 22 +.BI "int XCompositeVersion(void);" +.HP 30 +.BI "void XCompositeRedirectWindow(Display\ *" "dpy" ", Window\ " "window" ", int\ " "update" ");" +.HP 34 +.BI "void XCompositeRedirectSubwindows(Display\ *" "dpy" ", Window\ " "window" ", int\ " "update" ");" +.HP 32 +.BI "void XCompositeUnredirectWindow(Display\ *" "dpy" ", Window\ " "window" ", int\ " "update" ");" +.HP 36 +.BI "void XCompositeUnredirectSubwindows(Display\ *" "dpy" ", Window\ " "window" ", int\ " "update" ");" +.HP 51 +.BI "XserverRegion XCompositeCreateRegionFromBorderClip(Display\ *" "dpy" ", Window\ " "window" ");" +.HP 34 +.BI "Pixmap XCompositeNameWindowPixmap(Display\ *" "dpy" ", Window\ " "window" ");" +.HP 34 +.BI "Window XCompositeGetOverlayWindow(Display\ *" "dpy" ", Window\ " "window" ");" +.HP 36 +.BI "void XCompositeReleaseOverlayWindow(Display\ *" "dpy" ", Window\ " "window" ");" +.SH "DESCRIPTION" +.PP +The composite extension provides several related mechanisms: +.PP +Per\-hierarchy storage +.RS 4 +The rendering of an entire hierarchy of windows is redirected to off\-screen storage. The pixels of that hierarchy are available whenever it is viewable. Storage is automatically reallocated when the top level window changes size. Contents beyond the geometry of the top window are not preserved. +.RE +.PP +Automatic shadow update +.RS 4 +When a hierarchy is rendered off\-screen, the X server provides an automatic mechanism for presenting those contents within the parent window. The implementation is free to make this update lag behind actual rendering operations by an unspecified amount of time. This automatic update mechanism may be disabled so that the parent window contents can be completely determined by an external application. +.RE +.PP +Composite Overlay Window +.RS 4 +Version 0.3 of the protocol adds the Composite Overlay Window, which provides compositing managers with a surface on which to draw without interference. This window is always above normal windows and is always below the screen saver window. It is an InputOutput window whose width and height are the screen dimensions. Its visual is the root visual and its border width is zero. Attempts to redirect it using the composite extension are ignored. This window does not appear in the reply of the QueryTree request. It is also an override redirect window. These last two features make it invisible to window managers and other X11 clients. The only way to access the XID of this window is via the CompositeGetOverlayWindow request. Initially, the Composite Overlay Window is unmapped. +.RE +.PP +Parent window clipping +.RS 4 +Version 0.4 of the protocol modifies the semantics of parent window clipping in the presence of manual redirected children. With this version, the area in the parent covered by manual redirected children is left in the parent clip list instead of being removed as in older versions. +.RE +.PP +Per\-hierarchy storage may be created for individual windows or for all children of a window. Manual shadow update may be selected by only a single application for each window; manual update may also be selected on a per\-window basis or for each child of a window. Detecting when to update may be done with the Damage extension. +.PP +The off\-screen storage includes the window contents, its borders and the contents of all descendants. +.SH "ARGUMENTS" +.PP +.PP +\fIdisplay\fR +.RS 4 +Pointer to the +\fBDisplay\fR +structure returned from +\fBXOpenDisplay\fR +for the connection to the X server. +.RE +.PP +\fIevent_basep\fR +.RS 4 +Pointer to integer where the base value for Composite Extension events will be stored. +.RE +.PP +\fIerror_basep\fR +.RS 4 +Pointer to integer where the base value for Composite Extension errors will be stored. +.RE +.PP +\fImajor_versionp\fR +.RS 4 +Pointer to integer where the major version of the Composite Extension supported by the X server will be stored. +.RE +.PP +\fIminor_versionp\fR +.RS 4 +Pointer to integer where the minor version of the Composite Extension supported by the X server will be stored. +.RE +.PP +\fIwindow\fR +.RS 4 +Specifies the window ID to operate on. +.RE +.PP +\fIupdate\fR +.RS 4 +Specifies the mode for updating the window contents. Must be either +\fBCompositeRedirectAutomatic\fR +or +\fBCompositeRedirectManual\fR. +.RE +.SH "FUNCTIONS" +.PP +.PP +\fBXCompositeQueryExtension\fR +.RS 4 + +\fBXCompositeQueryExtension\fR +determines if the Composite Extension is available on the given display. It returns +\fBTrue\fR +if the extension is supported, otherwise +\fBFalse\fR. If the extension is present, the base values for events and errors are returned, and can be used to decode incoming event and error values. +.RE +.PP +\fBXCompositeQueryVersion\fR +.RS 4 + +\fBXCompositeQueryVersion\fR +determines if the X Server supports a version of the X Composite Extension which is compatible with the client library. A non\-zero Status is returned if a compatible version of the extension is supported, otherwise a zero Status is returned. If the extension is supported, the major and minor version numbers are returned to indicate the level of Composite Extension support. No other XComposite functions (except XCompositeQueryExtension) may be called before this function. If a client violates this rule, the effects of all subsequent XComposite calls that it makes are undefined. +.RE +.PP +\fBXCompositeVersion\fR +.RS 4 + +\fBXCompositeVersion\fR +returns the version of the X Composite library. The version number is encoded as: +(major * 10000) + (minor * 100) + revision +.sp +For example, version 1.4.6 would be encoded as the integer 10406. +.RE +.PP +\fBXCompositeRedirectWindow\fR +.RS 4 + +\fBXCompositeRedirectWindow\fR +requests the X server to direct the hierarchy starting at +\fIwindow\fR +to off\-screen storage. The +\fIupdate\fR +argument specifies whether the contents are mirrored to the parent window automatically or not. Only one client at a time may specify an update type of +\fBCompositeRedirectManual\fR, another attempt will result in a +BadAccess +error. When all clients enabling redirection terminate, the redirection will automatically be disabled. +.sp +The root window may not be redirected. Doing so results in a +BadMatch +error. Specifying an invalid window id will result in a +BadWindow +error. +.RE +.PP +\fBXCompositeRedirectSubwindows\fR +.RS 4 + +\fBXCompositeRedirectSubwindows\fR +requests the X server to redirect hierarchies starting at all current and future children of +\fIwindow\fR +as in +\fBXCompositeRedirectWindow\fR. If +\fIupdate\fR +is +\fBCompositeRedirectManual\fR, then painting of the window background during window manipulation and ClearArea requests is inhibited. +.RE +.PP +\fBXCompositeUnredirectWindow\fR +.RS 4 + +\fBXCompositeUnredirectWindow\fR +requests the X server to terminate redirection of +\fIwindow\fR. If the specified window was not selected for redirection by the current client, a +BadValue +error results. +.RE +.PP +\fBXCompositeUnredirectSubwindows\fR +.RS 4 + +\fBXCompositeUnredirectWindow\fR +requests the X server to terminate redirection of all children of +\fIwindow\fR. If the specified window was not selected for sub\-redirection by the current client, a +BadValue +error results. +.RE +.PP +\fBXCompositeCreateRegionFromBorderClip\fR +.RS 4 + +\fBXCompositeCreateRegionFromBorderClip\fR +creates a region containing the "usual" border clip value; that is the area of the window clipped against siblings and the parent. This region can be used to restrict rendering to suitable areas while updating only a single window. The region is copied at the moment the request is executed; future changes to the window hierarchy will not be reflected in this region. +.RE +.PP +\fBXCompositeNameWindowPixmap\fR +.RS 4 + +\fBXCompositeNameWindowPixmap\fR +creates and returns a pixmap id that serves as a reference to the off\-screen storage for +\fIwindow\fR. This pixmap will remain allocated until freed, even if the window is unmapped, reconfigured or destroyed. However, the window will get a new pixmap allocated each time it is mapped or resized, so this function will need to be reinvoked for the client to continue to refer to the storage holding the current window contents. Generates a +BadMatch +error if +\fIwindow\fR +is not redirected or is not visible. +.sp +The X server must support at least version 0.2 of the Composite Extension for +\fBXCompositeNameWindowPixmap\fR. +.RE +.PP +\fBXCompositeGetOverlayWindow\fR +.RS 4 + +\fBXCompositeGetOverlayWindow\fR +returns the window ID of the Composite Overlay Window for the screen specified by the argument +\fIwindow\fR. This function notifies the X server that the client wishes to use the Composite Overlay Window of this screen. If this Composite Overlay Window has not yet been mapped, it is mapped by this request. +.sp +The Composite Overlay Window for a particular screen will be unmapped when all clients who have called this function have either called +\fBXCompositeReleaseOverlayWindow\fR +for that screen, or terminated their connection to the X server. +.sp +The X server must support at least version 0.3 of the Composite Extension for +\fBXCompositeGetOverlayWindow\fR. +.RE +.PP +\fBXCompositeReleaseOverlayWindow\fR +.RS 4 +This request specifies that the client is no longer using the Composite Overlay Window on the screen specified by the argument +\fIwindow\fR. A screen's Composite Overlay Window is unmapped when there are no longer any clients using it. +.sp +The X server must support at least version 0.3 of the Composite Extension for +\fBXCompositeReleaseOverlayWindow\fR. +.RE +.SH "AUTHORS" +.PP +\fBKeith Packard\fR <\&keithp@keithp.com\&> +.sp -1n +.IP "" 4 +Extension specification and implementation +.PP +\fBDeron Johnson\fR <\&deron.johnson@sun.com\&> +.sp -1n +.IP "" 4 +Overlay Window specification and implementation + diff --git a/lib/libXcomposite/man/Xcomposite.xml b/lib/libXcomposite/man/Xcomposite.xml new file mode 100644 index 000000000..939bc0f2d --- /dev/null +++ b/lib/libXcomposite/man/Xcomposite.xml @@ -0,0 +1,407 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" > +<reference> +<!-- + Based on proto/compositeproto/compositeproto.txt + + Conversion to DocBook/XML API documentation is: + + Copyright 2007 Sun Microsystems, Inc. All rights reserved. + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, and/or sell copies of the Software, and to permit persons + to whom the Software is furnished to do so, provided that the above + copyright notice(s) and this permission notice appear in all copies of + the Software and that both the above copyright notice(s) and this + permission notice appear in supporting documentation. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS + OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT + OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR + HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL + 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. + + Except as contained in this notice, the name of a copyright holder + shall not be used in advertising or otherwise to promote the sale, use + or other dealings in this Software without prior written authorization + of the copyright holder. + + --> +<title>X Composite Extension Library</title> + +<refentry id='Xcomposite.man'> + <refentryinfo> + <productname>__vendorversion__</productname> + <pubdate>23 April 2007</pubdate> + <authorgroup> + <author><firstname>Keith</firstname><surname>Packard</surname> + <contrib>Extension specification and implementation</contrib> + <email>keithp@keithp.com</email> + </author> + <author><firstname>Deron</firstname><surname>Johnson</surname> + <contrib>Overlay Window specification and implementation</contrib> + <email>deron.johnson@sun.com</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>Xcomposite</refentrytitle> + <manvolnum>__libmansuffix__</manvolnum> + </refmeta> + <refnamediv> + <refname>Xcomposite</refname> + <refpurpose>X Composite Extension library</refpurpose> + </refnamediv> + <refsynopsisdiv><funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/Xcomposite.h></funcsynopsisinfo> + <funcprototype> + <funcdef>Bool <function>XCompositeQueryExtension</function></funcdef> + <paramdef><type>Display *</type><parameter>dpy</parameter></paramdef> + <paramdef>int *<parameter>event_basep</parameter></paramdef> + <paramdef>int *<parameter>error_basep</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>Status <function>XCompositeQueryVersion</function></funcdef> + <paramdef>Display *<parameter>dpy</parameter></paramdef> + <paramdef>int *<parameter>major_versionp</parameter></paramdef> + <paramdef>int *<parameter>minor_versionp</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>int <function>XCompositeVersion</function></funcdef> + <void /> + </funcprototype> + <funcprototype> + <funcdef>void <function>XCompositeRedirectWindow</function></funcdef> + <paramdef>Display *<parameter>dpy</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + <paramdef>int <parameter>update</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>void <function>XCompositeRedirectSubwindows</function></funcdef> + <paramdef>Display *<parameter>dpy</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + <paramdef>int <parameter>update</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>void <function>XCompositeUnredirectWindow</function></funcdef> + <paramdef>Display *<parameter>dpy</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + <paramdef>int <parameter>update</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>void <function>XCompositeUnredirectSubwindows</function></funcdef> + <paramdef>Display *<parameter>dpy</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + <paramdef>int <parameter>update</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>XserverRegion <function>XCompositeCreateRegionFromBorderClip</function></funcdef> + <paramdef>Display *<parameter>dpy</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>Pixmap <function>XCompositeNameWindowPixmap</function></funcdef> + <paramdef>Display *<parameter>dpy</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>Window <function>XCompositeGetOverlayWindow</function></funcdef> + <paramdef>Display *<parameter>dpy</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>void <function>XCompositeReleaseOverlayWindow</function></funcdef> + <paramdef>Display *<parameter>dpy</parameter></paramdef> + <paramdef>Window <parameter>window</parameter></paramdef> + </funcprototype> + </funcsynopsis></refsynopsisdiv> + +<refsect1><title>Description</title> +<para> +The composite extension provides several related mechanisms: + <variablelist> + <varlistentry> + <term>Per-hierarchy storage</term> + <listitem><para> + The rendering of an entire hierarchy of windows + is redirected to off-screen storage. The pixels of that hierarchy + are available whenever it is viewable. Storage is automatically + reallocated when the top level window changes size. Contents beyond + the geometry of the top window are not preserved. + </para></listitem> + </varlistentry> + <varlistentry> + <term>Automatic shadow update</term> + <listitem><para> + When a hierarchy is rendered off-screen, + the X server provides an automatic mechanism for presenting those + contents within the parent window. The implementation is free to + make this update lag behind actual rendering operations by an + unspecified amount of time. This automatic update mechanism may + be disabled so that the parent window contents can be completely + determined by an external application. + </para></listitem> + </varlistentry> + <varlistentry> + <term>Composite Overlay Window</term> + <listitem><para> + Version 0.3 of the protocol adds the Composite Overlay Window, which + provides compositing managers with a surface on which to draw without + interference. This window is always above normal windows and is always + below the screen saver window. It is an InputOutput window whose width + and height are the screen dimensions. Its visual is the root visual + and its border width is zero. Attempts to redirect it using the + composite extension are ignored. This window does not appear in the + reply of the QueryTree request. It is also an override redirect window. + These last two features make it invisible to window managers and other + X11 clients. The only way to access the XID of this window is via the + CompositeGetOverlayWindow request. Initially, the Composite Overlay + Window is unmapped. + </para></listitem> + </varlistentry> + <varlistentry> + <term>Parent window clipping</term> + <listitem><para> + Version 0.4 of the protocol modifies the semantics of parent window + clipping in the presence of manual redirected children. With this + version, the area in the parent covered by manual redirected + children is left in the parent clip list instead of being removed as + in older versions. + </para></listitem> + </varlistentry> + </variablelist> +</para> +<para> +Per-hierarchy storage may be created for individual windows or for all +children of a window. Manual shadow update may be selected by only a single +application for each window; manual update may also be selected on a +per-window basis or for each child of a window. Detecting when to update +may be done with the Damage extension. +</para> +<para> +The off-screen storage includes the window contents, its borders and the +contents of all descendants. +</para> +</refsect1> +<refsect1><title>Arguments</title> +<para> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para> + Pointer to the <type>Display</type> structure returned from + <function>XOpenDisplay</function> for the connection to the X server. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>event_basep</parameter></term> + <listitem><para> + Pointer to integer where the base value for Composite Extension events + will be stored. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>error_basep</parameter></term> + <listitem><para> + Pointer to integer where the base value for Composite Extension errors + will be stored. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>major_versionp</parameter></term> + <listitem><para> + Pointer to integer where the major version of the Composite Extension + supported by the X server will be stored. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>minor_versionp</parameter></term> + <listitem><para> + Pointer to integer where the minor version of the Composite Extension + supported by the X server will be stored. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem><para> + Specifies the window ID to operate on. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>update</parameter></term> + <listitem><para> + Specifies the mode for updating the window contents. Must be either + <constant>CompositeRedirectAutomatic</constant> or + <constant>CompositeRedirectManual</constant>. + </para></listitem> + </varlistentry> + </variablelist> +</para></refsect1> +<refsect1><title>Functions</title> +<para> + <variablelist> + <varlistentry> + <term><function>XCompositeQueryExtension</function></term> + <listitem><para> + <function>XCompositeQueryExtension</function> determines if the + Composite Extension is available on the given display. It returns + <constant>True</constant> if the extension is supported, otherwise + <constant>False</constant>. If the extension is present, the base + values for events and errors are returned, and can be used to + decode incoming event and error values. + </para></listitem> + </varlistentry> + <varlistentry> + <term><function>XCompositeQueryVersion</function></term> + <listitem><para> + <function>XCompositeQueryVersion</function> determines if the X Server + supports a version of the X Composite Extension which is compatible + with the client library. A non-zero Status is returned if a compatible + version of the extension is supported, otherwise a zero Status is returned. + If the extension is supported, the major and minor version numbers are + returned to indicate the level of Composite Extension support. + No other XComposite functions (except XCompositeQueryExtension) may be + called before this function. If a client violates this rule, the + effects of all subsequent XComposite calls that it makes are undefined. + </para></listitem> + </varlistentry> + <varlistentry> + <term><function>XCompositeVersion</function></term> + <listitem><para> + <function>XCompositeVersion</function> returns the version of the + X Composite library. The version number is encoded as: + <blockquote><para><code language="C"> + (major * 10000) + (minor * 100) + revision + </code></para></blockquote> + </para> + <para> + For example, version 1.4.6 would be encoded as the integer 10406. + </para></listitem> + </varlistentry> + <varlistentry> + <term><function>XCompositeRedirectWindow</function></term> + <listitem><para> + <function>XCompositeRedirectWindow</function> requests the X server + to direct the hierarchy starting at <parameter>window</parameter> to + off-screen storage. + The <parameter>update</parameter> argument specifies whether + the contents are mirrored to the parent window automatically or not. + Only one client at a time may specify an update type of + <constant>CompositeRedirectManual</constant>, another attempt will + result in a <errorname>BadAccess</errorname> error. When all clients + enabling redirection terminate, the redirection will automatically be + disabled. + </para><para> + The root window may not be redirected. Doing so results in a + <errorname>BadMatch</errorname> error. Specifying an invalid + window id will result in a <errorname>BadWindow</errorname> error. + </para></listitem> + </varlistentry> + <varlistentry> + <term><function>XCompositeRedirectSubwindows</function></term> + <listitem><para> + <function>XCompositeRedirectSubwindows</function> requests the X + server to redirect hierarchies starting at all current and future + children of <parameter>window</parameter> as in + <function>XCompositeRedirectWindow</function>. + If <parameter>update</parameter> is + <constant>CompositeRedirectManual</constant>, then painting of the + window background during window manipulation and ClearArea requests + is inhibited. + </para></listitem> + </varlistentry> + <varlistentry> + <term><function>XCompositeUnredirectWindow</function></term> + <listitem><para> + <function>XCompositeUnredirectWindow</function> requests the X + server to terminate redirection of <parameter>window</parameter>. + If the specified window was not selected for redirection by the + current client, a <errorname>BadValue</errorname> error results. + </para></listitem> + </varlistentry> + <varlistentry> + <term><function>XCompositeUnredirectSubwindows</function></term> + <listitem><para> + <function>XCompositeUnredirectWindow</function> requests the X + server to terminate redirection of all children of + <parameter>window</parameter>. + If the specified window was not selected for sub-redirection by the + current client, a <errorname>BadValue</errorname> error results. + </para></listitem> + </varlistentry> + <varlistentry> + <term><function>XCompositeCreateRegionFromBorderClip</function></term> + <listitem><para> + <function>XCompositeCreateRegionFromBorderClip</function> + creates a region containing the "usual" border clip + value; that is the area of the window clipped against siblings and + the parent. This region can be used to restrict rendering to + suitable areas while updating only a single window. The region + is copied at the moment the request is executed; future changes + to the window hierarchy will not be reflected in this region. + </para></listitem> + </varlistentry> + <varlistentry> + <term><function>XCompositeNameWindowPixmap</function></term> + <listitem><para> + <function>XCompositeNameWindowPixmap</function> creates and returns + a pixmap id that serves as a reference to the off-screen storage for + <parameter>window</parameter>. This pixmap will remain allocated + until freed, even if the window is unmapped, reconfigured or + destroyed. However, the window will get a new pixmap allocated each + time it is mapped or resized, so this function will need to be + reinvoked for the client to continue to refer to the storage holding + the current window contents. Generates a + <errorname>BadMatch</errorname> error if <parameter>window</parameter> + is not redirected or is not visible. + </para><para> + The X server must support at least version 0.2 of the Composite + Extension for <function>XCompositeNameWindowPixmap</function>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><function>XCompositeGetOverlayWindow</function></term> + <listitem><para> + <function>XCompositeGetOverlayWindow</function> returns the window ID + of the Composite Overlay Window for + the screen specified by the argument <parameter>window</parameter>. + This function notifies the X server that the client wishes to use + the Composite Overlay Window of this screen. If this + Composite Overlay Window has not yet been mapped, it is mapped by this + request. + </para><para> + The Composite Overlay Window for a particular screen will be + unmapped when all clients who have called this function have + either called <function>XCompositeReleaseOverlayWindow</function> + for that screen, or terminated their connection to the X server. + </para><para> + The X server must support at least version 0.3 of the Composite + Extension for <function>XCompositeGetOverlayWindow</function>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><function>XCompositeReleaseOverlayWindow</function></term> + <listitem><para> + This request specifies that the client is no longer using the + Composite Overlay Window on the screen specified by the + argument <parameter>window</parameter>. A screen's Composite + Overlay Window is unmapped when there are no longer any clients using it. + </para><para> + The X server must support at least version 0.3 of the Composite + Extension for <function>XCompositeReleaseOverlayWindow</function>. + </para></listitem> + </varlistentry> + </variablelist> +</para> +</refsect1> +</refentry> +</reference> |