summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorKeith Packard <keithp@keithp.com>2013-09-12 17:15:33 -0700
committerKeith Packard <keithp@keithp.com>2013-09-12 17:15:33 -0700
commit0c90a6e5f8e127d179d870a7fdad660acb9299c7 (patch)
tree8e5623d64e720d4456bc87fa655e4a0d416bf0be /man
Initial import of Xlib Present binding
Signed-off-by: Keith Packard <keithp@keithp.com>
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am39
-rw-r--r--man/Xpresent.man70
2 files changed, 109 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..0e9f4a4
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,39 @@
+#
+# Copyright (c) 2005, Oracle and/or its affiliates. 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, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice (including the next
+# paragraph) shall be included in all copies or substantial portions of the
+# Software.
+#
+# 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. IN NO EVENT SHALL
+# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+# DEALINGS IN THE SOFTWARE.
+#
+
+libmandir = $(LIB_MAN_DIR)
+
+libman_PRE = Xpresent.man
+
+libman_DATA = $(libman_PRE:man=@LIB_MAN_SUFFIX@)
+
+EXTRA_DIST = $(libman_PRE)
+
+CLEANFILES = $(libman_DATA)
+
+# String replacements for man pages now come from xorg-macros.m4 via configure
+
+SUFFIXES = .$(LIB_MAN_SUFFIX) .man
+
+.man.$(LIB_MAN_SUFFIX):
+ $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
diff --git a/man/Xpresent.man b/man/Xpresent.man
new file mode 100644
index 0000000..f615d69
--- /dev/null
+++ b/man/Xpresent.man
@@ -0,0 +1,70 @@
+.\"
+.\"
+.\" Copyright © 2013 Keith Packard
+.\"
+.\" Permission to use, copy, modify, distribute, and sell this software and its
+.\" documentation for any purpose is hereby granted without fee, provided that
+.\" the above copyright notice appear in all copies and that both that copyright
+.\" notice and this permission notice appear in supporting documentation, and
+.\" that the name of the copyright holders not be used in advertising or
+.\" publicity pertaining to distribution of the software without specific,
+.\" written prior permission. The copyright holders make no representations
+.\" about the suitability of this software for any purpose. It is provided "as
+.\" is" without express or implied warranty.
+.\"
+.\" THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+.\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
+.\" EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR 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.
+.\"
+.de TQ
+.br
+.ns
+.TP \\$1
+..
+.TH XPRESENT __libmansuffix__ __xorgversion__
+
+.SH NAME
+Xpresent \- X Present Extension
+.SH SYNTAX
+\&#include <X11/extensions/Xpresent.h>
+.nf
+.sp
+Bool XPresentQueryExtension \^(\^Display *\fIdpy\fP,
+ int *\fIevent_base_return\fP, int *\fIerror_base_return\fP\^);
+.sp
+Status XPresentQueryVersion \^(\^Display *\fIdpy\fP,
+ int *\fImajor_version_return\fP,
+ int *\fIminor_version_return\fP\^);
+.sp
+void XPresentRegion \^(\^Display *dpy,
+ Window \fIwindow\fP,
+ Pixmap \fIpixmap\fP,
+ uint32_t serial,
+ XserverRegion valid,
+ XserverRegion update,
+ int x_off,
+ int y_off,
+ XID idle_fence,
+ XID target_crtc,
+ uint64_t target_msc,
+ uint64_t divisor,
+ uint64_t remainder);
+.fi
+.SH ARGUMENTS
+.IP \fIdisplay\fP 1i
+Specifies the connection to the X server.
+.IP \fIwindow\fP 1i
+Specifies which window.
+.SH DESCRIPTION
+.B Xpresent
+is a library designed to interface the X Present
+Extension.
+.SH RESTRICTIONS
+.B Xpresent
+will remain upward compatible after the 1.0 release.
+.SH AUTHORS
+Keith Packard, Intel