head 1.1; branch 1.1.1; access; symbols libXres-1-2-3:1.1.1.4 netbsd-11-0-RC6:1.1.1.3 netbsd-11-0-RC5:1.1.1.3 netbsd-11-0-RC4:1.1.1.3 netbsd-11-0-RC3:1.1.1.3 netbsd-11-0-RC2:1.1.1.3 netbsd-11-0-RC1:1.1.1.3 netbsd-11:1.1.1.3.0.16 netbsd-11-base:1.1.1.3 netbsd-10-1-RELEASE:1.1.1.3 netbsd-8-3-RELEASE:1.1.1.3 netbsd-9-4-RELEASE:1.1.1.3 netbsd-10-0-RELEASE:1.1.1.3 netbsd-10-0-RC6:1.1.1.3 netbsd-10-0-RC5:1.1.1.3 netbsd-10-0-RC4:1.1.1.3 netbsd-10-0-RC3:1.1.1.3 netbsd-10-0-RC2:1.1.1.3 netbsd-10-0-RC1:1.1.1.3 libXres-1-2-2:1.1.1.3 netbsd-10:1.1.1.3.0.14 netbsd-10-base:1.1.1.3 netbsd-9-3-RELEASE:1.1.1.3 netbsd-9-2-RELEASE:1.1.1.3 libXres-1-2-1:1.1.1.3 netbsd-9-1-RELEASE:1.1.1.3 netbsd-8-2-RELEASE:1.1.1.3 netbsd-9-0-RELEASE:1.1.1.3 netbsd-9-0-RC2:1.1.1.3 netbsd-9-0-RC1:1.1.1.3 netbsd-9:1.1.1.3.0.12 netbsd-9-base:1.1.1.3 netbsd-8-1-RELEASE:1.1.1.3 netbsd-8-1-RC1:1.1.1.3 netbsd-7-2-RELEASE:1.1.1.3 netbsd-8-0-RELEASE:1.1.1.3 netbsd-8-0-RC2:1.1.1.3 netbsd-8-0-RC1:1.1.1.3 netbsd-7-1-2-RELEASE:1.1.1.3 libXres-1-2-0:1.1.1.3 netbsd-7-1-1-RELEASE:1.1.1.3 netbsd-8:1.1.1.3.0.10 netbsd-8-base:1.1.1.3 netbsd-7-1:1.1.1.3.0.8 netbsd-7-1-RELEASE:1.1.1.3 netbsd-7-1-RC2:1.1.1.3 netbsd-7-1-RC1:1.1.1.3 netbsd-7-0-2-RELEASE:1.1.1.3 netbsd-7-0-1-RELEASE:1.1.1.3 netbsd-7-0:1.1.1.3.0.6 netbsd-7-0-RELEASE:1.1.1.3 netbsd-7-0-RC3:1.1.1.3 netbsd-7-0-RC2:1.1.1.3 netbsd-7-0-RC1:1.1.1.3 netbsd-5-2-3-RELEASE:1.1.1.1 netbsd-5-1-5-RELEASE:1.1.1.1 netbsd-6-0-6-RELEASE:1.1.1.2 netbsd-6-1-5-RELEASE:1.1.1.2 netbsd-7:1.1.1.3.0.4 netbsd-7-base:1.1.1.3 netbsd-6-1-4-RELEASE:1.1.1.2 netbsd-6-0-5-RELEASE:1.1.1.2 riastradh-xf86-video-intel-2-7-1-pre-2-21-15:1.1.1.3 riastradh-drm2:1.1.1.3.0.2 riastradh-drm2-base:1.1.1.3 netbsd-6-1-3-RELEASE:1.1.1.2 netbsd-6-0-4-RELEASE:1.1.1.2 netbsd-5-2-2-RELEASE:1.1.1.1 netbsd-5-1-4-RELEASE:1.1.1.1 netbsd-6-1-2-RELEASE:1.1.1.2 netbsd-6-0-3-RELEASE:1.1.1.2 netbsd-5-2-1-RELEASE:1.1.1.1 netbsd-5-1-3-RELEASE:1.1.1.1 netbsd-6-1-1-RELEASE:1.1.1.2 libXres-1-0-7:1.1.1.3 netbsd-6-1:1.1.1.2.0.6 netbsd-6-0-2-RELEASE:1.1.1.2 netbsd-6-1-RELEASE:1.1.1.2 netbsd-6-1-RC4:1.1.1.2 netbsd-6-1-RC3:1.1.1.2 netbsd-6-1-RC2:1.1.1.2 netbsd-6-1-RC1:1.1.1.2 netbsd-5-2:1.1.1.1.0.8 netbsd-6-0-1-RELEASE:1.1.1.2 netbsd-5-2-RELEASE:1.1.1.1 netbsd-5-2-RC1:1.1.1.1 netbsd-6-0:1.1.1.2.0.4 netbsd-6-0-RELEASE:1.1.1.2 netbsd-6-0-RC2:1.1.1.2 netbsd-6-0-RC1:1.1.1.2 netbsd-6:1.1.1.2.0.2 netbsd-6-base:1.1.1.2 netbsd-5-1-2-RELEASE:1.1.1.1 netbsd-5-1-1-RELEASE:1.1.1.1 libXres-1-0-5:1.1.1.2 netbsd-5-1:1.1.1.1.0.6 netbsd-5-1-RELEASE:1.1.1.1 netbsd-5-1-RC4:1.1.1.1 netbsd-5-1-RC3:1.1.1.1 netbsd-5-1-RC2:1.1.1.1 netbsd-5-1-RC1:1.1.1.1 netbsd-5-0-2-RELEASE:1.1.1.1 libXres-1-0-4:1.1.1.2 netbsd-5-0-1-RELEASE:1.1.1.1 netbsd-5-0:1.1.1.1.0.4 netbsd-5-0-RELEASE:1.1.1.1 netbsd-5-0-RC4:1.1.1.1 netbsd-5-0-RC3:1.1.1.1 netbsd-5-0-RC2:1.1.1.1 netbsd-5-0-RC1:1.1.1.1 netbsd-5:1.1.1.1.0.2 netbsd-5-base:1.1.1.1 libXres-1-0-3:1.1.1.1 xorg:1.1.1; locks; strict; comment @.\" @; 1.1 date 2008.07.30.02.56.16; author mrg; state Exp; branches 1.1.1.1; next ; 1.1.1.1 date 2008.07.30.02.56.16; author mrg; state Exp; branches; next 1.1.1.2; 1.1.1.2 date 2009.11.08.10.09.51; author mrg; state Exp; branches; next 1.1.1.3; 1.1.1.3 date 2013.05.31.09.19.50; author mrg; state Exp; branches; next 1.1.1.4; commitid wfLdDDGQhrsDqLRw; 1.1.1.4 date 2026.07.11.23.47.54; author mrg; state Exp; branches; next ; commitid EUAVBOG0hmGriiNG; desc @@ 1.1 log @Initial revision @ text @.\" .\" $XdotOrg$ .\" $XFree86: xc/lib/XRes/XRes.man,v 1.2 2003/10/13 21:22:54 herrb Exp $ .\" .\" 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 .\" 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 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. .\" IN NO EVENT SHALL THE XFREE86 PROJECT 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. .\" .\" 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 3 __vendorversion__ .SH NAME XRes \- X-Resource extension client library .SH SYNOPSIS .B #include .PP .nf .ta .5i 2i typedef struct { XID resource_base; XID resource_mask; } XResClient; typedef struct { Atom resource_type; unsigned int count; } XResType; .fi .HP Bool XResQueryExtension(Display *\fIdpy\fP, int *\fIevent_basep\fP, int *\fIerror_basep\fP\^); .HP Status XResQueryVersion(Display *\fIdpy\fP, int *\fImajor_versionp\fP, int *\fIminor_versionp\fP\^); .HP Status XResQueryClients(Display *\fIdpy\fP, int *\fInum_clients\fP, XResClient **\fIclients\fP\^); .HP Status XResQueryClientResources(Display *\fIdpy\fP, XID \fIxid\fP, int *\fInum_types\fP, XResType **\fItypes\fP\^); .HP Status XResQueryClientPixmapBytes(Display *\fIdpy\fP, XID \fIxid\fP, unsigned long *\fIbytes\fP\^); .PP .SH DESCRIPTION .B X-Resource is an extension that allows a client to query the X server about its usage of various resources. It should not be mixed with the X resource database access functions. .PP .B XResQueryExtension returns .B True if the .I XRes extension is available on the given display. A client must call .B XResQueryExtension before calling any other XRes function in order to negotiate a compatible protocol version; otherwise the client will get undefined behavior (XRes may or may not work). .PP .B XResQueryVersion returns .B True if the request succeeded; the values of the major and minor protocol versions supported by the server are returned in .I major_versionp and .I minor_versionp . .PP .PP .B XResQueryClients fills a list of clients of the given display. For each client it returns in the .I XResClient structure a mask and a base value of the resources used by these clients. Returns .B True on success or .B False on failure. .PP .B XResQueryClientResources 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 .B True on success or .B False on failure. .PP .B XresQueryClientPixmapBytes gives, for resources of type .I PIXMAP the total number of bytes allocated in the X server by the given client. Returns .B True on success or .B False on failure. .SH "ERRORS" .B XResQueryClientResources and .B XResQueryClientPixmapBytes will return .I BadValue if passed an illegal client identifier. .SH "SEE ALSO" X(__miscmansuffix__) .SH AUTHOR 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. @ 1.1.1.1 log @initial import of libXres-1.0.3 @ text @@ 1.1.1.2 log @initial import of libXres-1.0.4 @ text @d2 3 d31 1 a31 1 .TH XRes __libmansuffix__ __vendorversion__ d51 1 a51 1 int *\fIevent_base_return\fP, int *\fIerror_base_return\fP\^); d53 2 a54 2 Status XResQueryVersion(Display *\fIdpy\fP, int *\fImajor_version_return\fP, int *\fIminor_version_return\fP\^); d68 1 a68 1 server about its usage of various resources. It should not be confused d88 1 a88 1 .I major_version_return d90 1 a90 1 .I minor_version_return . d116 1 a116 1 .B XResQueryClientPixmapBytes @ 1.1.1.3 log @initial import of libXres-1.0.7 @ text @d3 1 a3 1 .\" d11 1 a11 1 .\" d14 1 a14 1 .\" d22 1 a22 1 .\" d27 1 a27 1 .\" d47 1 a47 1 Bool XResQueryExtension(Display *\fIdpy\fP, d53 1 a53 1 Status XResQueryClients(Display *\fIdpy\fP, int *\fInum_clients\fP, d56 1 a56 1 Status XResQueryClientResources(Display *\fIdpy\fP, XID \fIxid\fP, d59 1 a59 1 Status XResQueryClientPixmapBytes(Display *\fIdpy\fP, XID \fIxid\fP, d71 1 a71 1 if the d74 1 a74 1 A client must call d84 1 a84 1 versions supported by the server are returned in d86 1 a86 1 and d90 1 a90 1 .B XResQueryClients d92 1 a92 1 returns in the d95 2 a96 2 clients. Returns d98 1 a98 1 on success or d100 1 a100 1 on failure. d103 1 a103 1 fills a list of d106 2 a107 2 name (as an Atom) and the number of resources of this type allocated. Returns d109 1 a109 1 on success or d111 1 a111 1 on failure. d114 1 a114 1 gives, for resources of type d117 2 a118 2 client. Returns d120 1 a120 1 on success or d122 1 a122 1 on failure. d127 1 a127 1 will return d129 1 a129 1 if passed an illegal client identifier. d133 1 a133 1 Mark Vojkovich, originally for The XFree86 Project Inc. d137 1 a137 1 the API without notice. Use with care. @ 1.1.1.4 log @initial import of libXres-1.2.3 @ text @d28 1 a28 1 .TH XRes __libmansuffix__ 2009-10-08 __vendorversion__ d40 1 a40 1 .sp d45 2 a46 2 .sp .PP d48 8 a55 8 int *\fIevent_base_return\fP, int *\fIerror_base_return\fP\^); .PP Status XResQueryVersion(Display *\fIdpy\fP, int *\fImajor_version_return\fP, int *\fIminor_version_return\fP\^); .PP Status XResQueryClients(Display *\fIdpy\fP, int *\fInum_clients\fP, XResClient **\fIclients\fP\^); .PP d57 4 a60 1 int *\fInum_types\fP, XResType **\fItypes\fP\^); a61 3 Status XResQueryClientPixmapBytes(Display *\fIdpy\fP, XID \fIxid\fP, unsigned long *\fIbytes\fP\^); .fi d64 3 a66 3 is an extension that allows a client to query the X server about its usage of various resources. It should not be confused with the X resource database access functions. d87 2 a88 1 .IR minor_version_return . d91 2 a92 2 fills a list of clients of the given display. For each client it returns in the d104 1 a104 1 .B XResType d131 1 a131 1 .BR X (__miscmansuffix__) d135 3 a137 4 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. @