[PATCH libXi] man: update property and grab man pages for new constants
Peter Hutterer
peter.hutterer at who-t.net
Thu Jun 2 22:48:53 PDT 2011
Suggest the use of the new XIGrabModeAsync, etc. defines instead of the core
defines. Add a BUGS section to each man page explaining
backwards-compatibility.
Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
---
man/XIChangeProperty.txt | 16 ++++++++++++----
man/XIGrabButton.txt | 13 ++++++++++---
man/XIGrabDevice.txt | 15 +++++++++++----
man/XIGrabEnter.txt | 13 ++++++++++---
4 files changed, 43 insertions(+), 14 deletions(-)
diff --git a/man/XIChangeProperty.txt b/man/XIChangeProperty.txt
index 2e5eea1..b35d90f 100644
--- a/man/XIChangeProperty.txt
+++ b/man/XIChangeProperty.txt
@@ -76,7 +76,7 @@ SYNOPSIS
quantities) where the data is to be retrieved.
mode
- One of PropModeAppend, PropModePrepend or PropModeReplace.
+ One of XIPropModeAppend, XIPropModePrepend or XIPropModeReplace.
num_items
Number of items in data in the format specified.
@@ -121,7 +121,7 @@ XIGetProperty sets the return arguments as follows:
nitems_return argument is empty.
- If the specified property exists and either you assign
- AnyPropertyType to the req_type argument or the specified type
+ XIAnyPropertyType to the req_type argument or the specified type
matches the actual property type, XIGetProperty returns the
actual property type to actual_type_return and the actual property
format (never zero) to actual_format_return. It also returns a value
@@ -165,10 +165,10 @@ The XIChangeProperty function alters the property for the specified device
and causes the X server to generate a XIPropertyNotify event for that
device. XIChangeProperty performs the following:
-- If mode is PropModeReplace, XIChangeProperty discards the previous
+- If mode is XIPropModeReplace, XIChangeProperty discards the previous
property value and stores the new data.
-- If mode is PropModePrepend or PropModeAppend, XIChangeProperty
+- If mode is XIPropModePrepend or XIPropModeAppend, XIChangeProperty
inserts the specified data before the beginning of the existing
data or onto the end of the existing data, respectively. The type
and format must match the existing property value, or a BadMatch
@@ -221,6 +221,14 @@ BadAtom
An invalid property was specified. The property does not
exist.
+BUGS
+----
+
+ The protocol headers for XI 2.0 did not provide
+ XIAnyPropertyType, XIPropModeReplace, XIPropModePrepend or
+ XIPropModeAppend. Use AnyPropertyType, PropModeReplace,
+ PropModePrepend and PropModeAppend instead, respectively.
+
SEE ALSO
--------
diff --git a/man/XIGrabButton.txt b/man/XIGrabButton.txt
index aa45800..13bb55f 100644
--- a/man/XIGrabButton.txt
+++ b/man/XIGrabButton.txt
@@ -103,12 +103,12 @@ SYNOPSIS
grab_mode
Specifies further processing of events from this device.
- You can pass GrabModeSync or GrabModeAsync.
+ You can pass XIGrabModeSync or XIGrabModeAsync.
paired_device_mode
Specifies further processing of events from the paired
- master device. You can pass GrabModeSync or
- GrabModeAsync. If deviceid specifies a floating slave
+ master device. You can pass XIGrabModeSync or
+ XIGrabModeAsync. If deviceid specifies a floating slave
device, this parameter is ignored.
confine_to
@@ -223,6 +223,13 @@ DIAGNOSTICS
A value for a Window argument does not name a defined
Window.
+BUGS
+----
+
+ The protocol headers for XI 2.0 did not provide
+ XIGrabModeAsync or XIGrabModeSync. Use GrabModeSync and
+ GrabModeAsync instead, respectively.
+
SEE ALSO
--------
diff --git a/man/XIGrabDevice.txt b/man/XIGrabDevice.txt
index a46f51f..420c80e 100644
--- a/man/XIGrabDevice.txt
+++ b/man/XIGrabDevice.txt
@@ -89,10 +89,10 @@ DESCRIPTION
grab_window, and is only reported if specified in the event
mask.
- If the grab_mode argument is GrabModeAsync, device event
+ If the grab_mode argument is XIGrabModeAsync, device event
processing continues as usual. If the device is currently
frozen by this client, then processing of device events is
- resumed. If the grab_mode argument is GrabModeSync, the state
+ resumed. If the grab_mode argument is XIGrabModeSync, the state
of the device (as seen by client applications) appears to
freeze, and the X server generates no further device events
until the grabbing client issues a releasing XIAllowEvents call
@@ -100,9 +100,9 @@ DESCRIPTION
not lost while the device is frozen; they are simply queued in
the server for later processing.
- If paired_device_mode is GrabModeAsync, processing of events
+ If paired_device_mode is XIGrabModeAsync, processing of events
from the paired master device is unaffected by activation of
- the grab. If paired_device_mode is GrabModeSync, the state of
+ the grab. If paired_device_mode is XIGrabModeSync, the state of
the paired master device (as seen by client applications)
appears to freeze, and the X server generates no further events
from this device until the grabbing client issues a releasing
@@ -159,6 +159,13 @@ DIAGNOSTICS
A value for a Window argument does not name a defined
Window.
+BUGS
+----
+
+ The protocol headers for XI 2.0 did not provide
+ XIGrabModeAsync or XIGrabModeSync. Use GrabModeSync and
+ GrabModeAsync instead, respectively.
+
SEE ALSO
--------
XIAllowEvents(libmansuffix)
diff --git a/man/XIGrabEnter.txt b/man/XIGrabEnter.txt
index ac2be3f..da890ab 100644
--- a/man/XIGrabEnter.txt
+++ b/man/XIGrabEnter.txt
@@ -89,12 +89,12 @@ SYNOPSIS
grab_mode
Specifies further processing of events from this device.
- You can pass GrabModeSync or GrabModeAsync.
+ You can pass XIGrabModeSync or XIGrabModeAsync.
paired_device_mode
Specifies further processing of events from the paired
- master device. You can pass GrabModeSync or
- GrabModeAsync. If deviceid specifies a floating slave
+ master device. You can pass XIGrabModeSync or
+ XIGrabModeAsync. If deviceid specifies a floating slave
device, this parameter is ignored.
confine_to
@@ -196,6 +196,13 @@ DIAGNOSTICS
A value for a Window argument does not name a defined
Window.
+BUGS
+----
+
+ The protocol headers for XI 2.0 did not provide
+ XIGrabModeAsync or XIGrabModeSync. Use GrabModeSync and
+ GrabModeAsync instead, respectively.
+
SEE ALSO
--------
--
1.7.5.1
More information about the xorg-devel
mailing list