upload tizen2.0 source
[framework/uifw/xorg/lib/libxres.git] / man / XRes.man
index e62c07b..c35dec4 100644 (file)
@@ -1,6 +1,6 @@
 .\"
 .\" Copyright (C) 1994-2003 The XFree86 Project, 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
@@ -8,10 +8,10 @@
 .\" 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 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 NON-INFRINGEMENT.
 .\" 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.
-.\" 
+.\"
 .\" Except as contained in this notice, the name of the XFree86 Project
 .\" shall not be used in advertising or otherwise to promote the sale, use
 .\" or other dealings in this Software without prior written authorization
 .\" from the XFree86 Project.
-.\" 
+.\"
 .TH XRes __libmansuffix__ __vendorversion__
 .SH NAME
 XRes \- X-Resource extension client library
@@ -44,19 +44,19 @@ typedef struct {
 } XResType;
 .fi
 .HP
-Bool XResQueryExtension(Display *\fIdpy\fP, 
+Bool XResQueryExtension(Display *\fIdpy\fP,
 int *\fIevent_base_return\fP, int *\fIerror_base_return\fP\^);
 .HP
 Status XResQueryVersion(Display *\fIdpy\fP, int *\fImajor_version_return\fP,
 int *\fIminor_version_return\fP\^);
 .HP
-Status XResQueryClients(Display *\fIdpy\fP, int *\fInum_clients\fP, 
+Status XResQueryClients(Display *\fIdpy\fP, int *\fInum_clients\fP,
 XResClient **\fIclients\fP\^);
 .HP
-Status XResQueryClientResources(Display *\fIdpy\fP, XID \fIxid\fP, 
+Status XResQueryClientResources(Display *\fIdpy\fP, XID \fIxid\fP,
 int *\fInum_types\fP, XResType **\fItypes\fP\^);
 .HP
-Status XResQueryClientPixmapBytes(Display *\fIdpy\fP, XID \fIxid\fP, 
+Status XResQueryClientPixmapBytes(Display *\fIdpy\fP, XID \fIxid\fP,
 unsigned long *\fIbytes\fP\^);
 .PP
 .SH DESCRIPTION
@@ -68,10 +68,10 @@ with the X resource database access functions.
 .B XResQueryExtension
 returns
 .B True
-if the 
+if the
 .I XRes
 extension is available on the given display.
-A client must call 
+A client must call
 .B XResQueryExtension
 before calling any other XRes function in order
 to negotiate a compatible protocol version; otherwise the client will
@@ -81,57 +81,57 @@ get undefined behavior (XRes may or may not work).
 returns
 .B True
 if the request succeeded; the values of the major and minor protocol
-versions supported by the server are returned in 
+versions supported by the server are returned in
 .I major_version_return
-and 
+and
 .I minor_version_return .
 .PP
 .PP
-.B XResQueryClients 
+.B XResQueryClients
 fills a list of clients of the given display. For each client it
-returns in the 
+returns in the
 .I XResClient
 structure a mask and a base value of the resources used by these
-clients. 
-Returns 
+clients.
+Returns
 .B True
-on success or 
+on success or
 .B False
-on failure. 
+on failure.
 .PP
 .B XResQueryClientResources
-fills a list of 
+fills a list of
 XResType
 structures, indicating for each resource type allocated by the client its
-name (as an Atom) and the number of resources of this type allocated. 
-Returns 
+name (as an Atom) and the number of resources of this type allocated.
+Returns
 .B True
-on success or 
+on success or
 .B False
-on failure. 
+on failure.
 .PP
 .B XResQueryClientPixmapBytes
-gives, for resources of type 
+gives, for resources of type
 .I PIXMAP
 the total number of bytes allocated in the X server by the given
-client. 
-Returns 
+client.
+Returns
 .B True
-on success or 
+on success or
 .B False
-on failure. 
+on failure.
 .SH "ERRORS"
 .B XResQueryClientResources
 and
 .B XResQueryClientPixmapBytes
-will return 
+will return
 .I BadValue
-if passed an illegal client identifier. 
+if passed an illegal client identifier.
 .SH "SEE ALSO"
 X(__miscmansuffix__)
 .SH AUTHOR
-Mark Vojkovich, originally for The XFree86 Project Inc. 
+Mark Vojkovich, originally for The XFree86 Project Inc.
 .SH STABILITY
 This API is considered as experimental. The XRes library major
 revision may be incremented whenever incompatible changes are done to
-the API without notice. Use with care. 
+the API without notice. Use with care.