diff options
author | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2020-01-04 17:55:18 +0000 |
---|---|---|
committer | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2020-01-04 17:55:18 +0000 |
commit | 1128148d76d7952d7aacfa2b083f5b5a96b4b4d5 (patch) | |
tree | 9291b9dfdfb4da1828705353be85e340f302e651 /lib/libX11 | |
parent | 7b7fd95cb6ee85ebe6d6d08b126b770770e86688 (diff) |
Uppdate to libX11 1.6.9. Tested by krw@ and naddy@
Diffstat (limited to 'lib/libX11')
203 files changed, 7632 insertions, 12794 deletions
diff --git a/lib/libX11/ChangeLog b/lib/libX11/ChangeLog index 3ab204490..827fe5353 100644 --- a/lib/libX11/ChangeLog +++ b/lib/libX11/ChangeLog @@ -1,3 +1,219 @@ +commit db7cca17ad7807e92a928da9d4c68a00f4836da2 +Author: Adam Jackson <ajax@redhat.com> +Date: Wed Oct 9 13:41:29 2019 -0400 + + libX11 1.6.9 + + Signed-off-by: Adam Jackson <ajax@redhat.com> + +commit f5ba2c632a4c84279bdd48c687271292f5dc4f87 +Author: Dmitry Osipenko <digetx@gmail.com> +Date: Sat May 18 19:10:32 2019 +0300 + + Fix lockup in _XReply() caused by recursive synchronization + + This patch is based on a suggestion made by Uli Schlachter in a comment + to the bug report https://gitlab.freedesktop.org/xorg/lib/libx11/issues/93. + + Explanation of the bug (given by Uli Schlachter as well): + + An error was received and handled. Since there was an error callback set, + Xlib unlocks the display, runs the error callback, and then locks the display + again. This goes through _XLockDisplay and then calls _XSeqSyncFunction. + On this "lock the thing"-path, Xlib notices that sequence numbers are close to + wrap-around and tries to send a GetInputFocus request. However, the earlier + calls already registered themselves as "we are handling replies/errors, do + not interfere!" and so the code here waits for "that other thread" to be done + before it continues. Only that there is no other thread, but it is this thread + itself and thus a deadlock follows. + + The bug is relatively easy to reproduce on any desktop environment by + using actively a touchscreen input that supports multitouch, i.e. practically + all mobile devices are affected. + + Fixes: https://gitlab.freedesktop.org/xorg/lib/libx11/issues/93 + Suggested-by: Uli Schlachter <psychon@znc.in> + Tested-by: Dmitry Osipenko <digetx@gmail.com> + Reported-by: Dmitry Osipenko <digetx@gmail.com> + Signed-off-by: Dmitry Osipenko <digetx@gmail.com> + +commit 1f1ca0863fd81fd0538b104eb9d9841ddbc7c905 +Author: Adam Jackson <ajax@redhat.com> +Date: Fri Sep 13 16:44:32 2019 -0400 + + xkb: Provide <X11/extensions/XKBgeom.h> ourselves + + This header refers to libX11 types, it doesn't belong in xorgproto and + has been moved to legacy in 2019.2. Supply it ourselves. + +commit edc7680ed5a03cedb5facf14693823455e12c29c +Author: Ross Burton <ross.burton@intel.com> +Date: Tue Aug 6 14:53:43 2019 +0100 + + src/util/Makefile: explicitly reset LINK to not use libtool + + Simply looking at libtool redefines LINK globally to use libtool, which when + you're trying to cross-compile to Windows can cause complications. + + As in src/util/ we're simply building a small binary for the build host, reset + LINK to the automake default so that the traditional compile/link steps occur + without libtool. + + Also remove -all-static from LDFLAGS as that is a libtool-specific argument + intended to solve this problem. + + Closes: #100 + Signed-off-by: Ross Burton <ross.burton@intel.com> + +commit f111bf3ac091a3a6d1f094172621d9d033c3833c +Author: Thomas E. Dickey <dickey@invisible-island.net> +Date: Tue Jul 30 16:53:27 2019 -0400 + + improve some formatting + + Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net> + +commit 1d0a6fe9126c7ce61c6648cabf43b2de4d6d3ba9 +Author: Thomas E. Dickey <dickey@invisible-island.net> +Date: Tue Jul 30 15:49:09 2019 -0400 + + fix a substitution error from recent commit, e.g, "s/^\.EE/XDe/" + + Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net> + +commit 8fe8aafe7e9beffaff0460fe08354dfcde1efe98 +Author: Thomas E. Dickey <dickey@invisible-island.net> +Date: Tue Jul 30 05:07:40 2019 -0400 + + split lines at sentence endings + + Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net> + +commit 6f2cbcea5d6dcd1df7ef309481cad1663284c061 +Author: Thomas E. Dickey <dickey@invisible-island.net> +Date: Tue Jul 30 04:52:25 2019 -0400 + + trim trailing whitespace from manpages + + Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net> + +commit 4abf482d8e6b0b1ae84e0f528e71066afd6d18b5 +Author: Thomas E. Dickey <dickey@invisible-island.net> +Date: Tue Jul 30 04:36:24 2019 -0400 + + another fake-quote fix + + Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net> + +commit c0f0651f2b4dfa9fef86d1374689220125631993 +Author: Thomas E. Dickey <dickey@invisible-island.net> +Date: Tue Jul 30 04:34:54 2019 -0400 + + the last commit overlooked some fake-quote pairs + + Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net> + +commit ef31143c9decda54b3ab2937d3300fcf5b493fd6 +Author: Walter Harms <wharms@bfs.de> +Date: Mon Jul 29 18:50:19 2019 +0200 + + fix ``fake quotes'' in text + + to remove the fake quotes replace them with propper + predefined macros \*(lq and \*(rq. this will allow + nroff to choose the propper characters when using ps etc. + + Signed-off-by: Walter Harms <wharms@bfs.de> + +commit 705027ea9b17d6552388d2067736ab4b0bf9dfb5 +Author: Walter Harms <wharms@bfs.de> +Date: Mon Jul 29 18:27:12 2019 +0200 + + get rid of ``fake quotes'' + + these fake quotes are inside a comment and can be replaced with + some double quotes + + Signed-off-by: Walter Harms <wharms@bfs.de> + +commit fe46eb287106ad05538e896783a5cf877a4138df +Author: Walter Harms <wharms@bfs.de> +Date: Mon Jul 29 17:57:02 2019 +0200 + + remove all private macro defines + + after converting everything to st. man page macros there is + no need to maintain X11 private nroff macros, so remove them. + + Signed-off-by: Walter Harms <wharms@bfs.de> + +commit b7f09ae19c9a098ecd545b4d4c45a6afe39a8764 +Author: Walter Harms <wharms@bfs.de> +Date: Mon Jul 29 17:47:35 2019 +0200 + + Replace home-grown .Ds .De macro with man page .EX/.EE macro + + Same pages use the man page .EX/.EE macro. Replace all occurences + of .De/.Ds with the std. macros to make the code better to maintain. + + Signed-off-by: Walter Harms <wharms@bfs.de> + +commit 951e772bc8d89bc62c4bbac14adc5d4f5027419f +Author: Walter Harms <wharms@bfs.de> +Date: Wed Jul 3 18:23:51 2019 +0200 + + fix TBL format + + Signed-off-by: Walter Harms <wharms@bfs.de> + +commit 4eb167f5aca4cca05a230c728ffdb4fd382a4e1e +Author: Walter Harms <wharms@bfs.de> +Date: Wed Jul 3 18:18:09 2019 +0200 + + replace home grown .ZN with std, .B and .BR + + Replace the home grown macro .ZN with std. macros + from man macro paket. So we can get rid of the + definition an get a clean header. + + Signed-off-by: Walter Harms <wharms@bfs.de> + +commit 08e6b36292ebf01ba2dcc4a48ec371c6f5d13458 +Author: Walter Harms <wharms@bfs.de> +Date: Sat Jun 22 18:33:48 2019 +0200 + + remove in-text macros + + remove in-text macros an fix a few typos on the way. + hopefuly that will make maintenance more easy. + + Signed-off-by: Walter Harms <wharms@bfs.de> + +commit cb0e894fe9927b07bd9d97c067fd0d007accb105 +Author: Walter Harms <wharms@bfs.de> +Date: Fri Jun 21 18:01:16 2019 +0200 + + note that we can handle kbd==NULL + + Signed-off-by: Walter Harms <wharms@bfs.de> + +commit 0327c427d62f671eced067c6d9b69f4e216a8cac +Author: Adam Jackson <ajax@redhat.com> +Date: Mon Jun 17 13:36:08 2019 -0400 + + makekeys: Detach ourselves from X headers entirely + + Subsequent to a121b7b0c210efe10bf93453b29050282324c906 we are no longer + building makekeys with enough -I/foo/bar to find the X11 headers, so if + they're not in a system include path, things fail. Since this utility is + only needed at build time, there's no real reason to demand the X + headers be installed for both the build and target machines if cross- + compiling, we can just assume a vaguely ANSI environment instead. + + Tested-by: Niclas Zeising <zeising@daemonic.se> + Reviewed-by: Keith Packard <keithp@keithp.com> + Reviewed-by: Matt Turner <mattst88@gmail.com> + commit 57f0d421a1320090d3a4948181fe228d86cc8977 Author: Matt Turner <mattst88@gmail.com> Date: Mon Jun 17 10:45:45 2019 -0400 diff --git a/lib/libX11/configure b/lib/libX11/configure index 2f24c1f72..0a110ff6e 100644 --- a/lib/libX11/configure +++ b/lib/libX11/configure @@ -1,6 +1,6 @@ #! /bin/sh # Guess values for system-dependent variables and create Makefiles. -# Generated by GNU Autoconf 2.69 for libX11 1.6.8. +# Generated by GNU Autoconf 2.69 for libX11 1.6.9. # # Report bugs to <https://gitlab.freedesktop.org/xorg/lib/libx11/issues>. # @@ -651,8 +651,8 @@ MAKEFLAGS= # Identity of this package. PACKAGE_NAME='libX11' PACKAGE_TARNAME='libX11' -PACKAGE_VERSION='1.6.8' -PACKAGE_STRING='libX11 1.6.8' +PACKAGE_VERSION='1.6.9' +PACKAGE_STRING='libX11 1.6.9' PACKAGE_BUGREPORT='https://gitlab.freedesktop.org/xorg/lib/libx11/issues' PACKAGE_URL='' @@ -1512,7 +1512,7 @@ if test "$ac_init_help" = "long"; then # Omit some internal or obsolete options to make the list less imposing. # This message is too long to be a string in the A/UX 3.1 sh. cat <<_ACEOF -\`configure' configures libX11 1.6.8 to adapt to many kinds of systems. +\`configure' configures libX11 1.6.9 to adapt to many kinds of systems. Usage: $0 [OPTION]... [VAR=VALUE]... @@ -1582,7 +1582,7 @@ fi if test -n "$ac_init_help"; then case $ac_init_help in - short | recursive ) echo "Configuration of libX11 1.6.8:";; + short | recursive ) echo "Configuration of libX11 1.6.9:";; esac cat <<\_ACEOF @@ -1749,7 +1749,7 @@ fi test -n "$ac_init_help" && exit $ac_status if $ac_init_version; then cat <<\_ACEOF -libX11 configure 1.6.8 +libX11 configure 1.6.9 generated by GNU Autoconf 2.69 Copyright (C) 2012 Free Software Foundation, Inc. @@ -2275,7 +2275,7 @@ cat >config.log <<_ACEOF This file contains any messages produced by compilers while running configure, to aid debugging if configure makes a mistake. -It was created by libX11 $as_me 1.6.8, which was +It was created by libX11 $as_me 1.6.9, which was generated by GNU Autoconf 2.69. Invocation command line was $ $0 $@ @@ -4493,7 +4493,7 @@ fi # Define the identity of the package. PACKAGE='libX11' - VERSION='1.6.8' + VERSION='1.6.9' cat >>confdefs.h <<_ACEOF @@ -21647,7 +21647,7 @@ cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 # report actual input values of CONFIG_FILES etc. instead of their # values after options handling. ac_log=" -This file was extended by libX11 $as_me 1.6.8, which was +This file was extended by libX11 $as_me 1.6.9, which was generated by GNU Autoconf 2.69. Invocation command line was CONFIG_FILES = $CONFIG_FILES @@ -21713,7 +21713,7 @@ _ACEOF cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`" ac_cs_version="\\ -libX11 config.status 1.6.8 +libX11 config.status 1.6.9 configured by $0, generated by GNU Autoconf 2.69, with options \\"\$ac_cs_config\\" diff --git a/lib/libX11/configure.ac b/lib/libX11/configure.ac index a5fd706f4..3a042bab5 100644 --- a/lib/libX11/configure.ac +++ b/lib/libX11/configure.ac @@ -1,7 +1,7 @@ # Initialize Autoconf AC_PREREQ([2.60]) -AC_INIT([libX11], [1.6.8], +AC_INIT([libX11], [1.6.9], [https://gitlab.freedesktop.org/xorg/lib/libx11/issues], [libX11]) AC_CONFIG_SRCDIR([Makefile.am]) AC_CONFIG_HEADERS([src/config.h include/X11/XlibConf.h]) diff --git a/lib/libX11/include/Makefile.am b/lib/libX11/include/Makefile.am index 067546cf0..4e9fe9dbb 100644 --- a/lib/libX11/include/Makefile.am +++ b/lib/libX11/include/Makefile.am @@ -12,6 +12,11 @@ x11include_HEADERS=\ X11/ImUtil.h \ X11/Xlib-xcb.h +x11extincludedir=${x11includedir}/extensions +x11extinclude_HEADERS = \ + X11/extensions/XKBgeom.h + + nodist_x11include_HEADERS=\ X11/XlibConf.h diff --git a/lib/libX11/include/Makefile.in b/lib/libX11/include/Makefile.in index b93e00fb4..ee0b5658f 100644 --- a/lib/libX11/include/Makefile.in +++ b/lib/libX11/include/Makefile.in @@ -52,7 +52,7 @@ build_triplet = @build@ host_triplet = @host@ subdir = include DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ - $(x11include_HEADERS) + $(x11extinclude_HEADERS) $(x11include_HEADERS) ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/m4/ax_define_dir.m4 \ $(top_srcdir)/m4/libtool.m4 $(top_srcdir)/m4/ltoptions.m4 \ @@ -112,8 +112,9 @@ am__uninstall_files_from_dir = { \ $(am__cd) "$$dir" && rm -f $$files; }; \ } am__installdirs = "$(DESTDIR)$(x11includedir)" \ - "$(DESTDIR)$(x11includedir)" -HEADERS = $(nodist_x11include_HEADERS) $(x11include_HEADERS) + "$(DESTDIR)$(x11extincludedir)" "$(DESTDIR)$(x11includedir)" +HEADERS = $(nodist_x11include_HEADERS) $(x11extinclude_HEADERS) \ + $(x11include_HEADERS) ETAGS = etags CTAGS = ctags DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) @@ -312,6 +313,10 @@ x11include_HEADERS = \ X11/ImUtil.h \ X11/Xlib-xcb.h +x11extincludedir = ${x11includedir}/extensions +x11extinclude_HEADERS = \ + X11/extensions/XKBgeom.h + nodist_x11include_HEADERS = \ X11/XlibConf.h @@ -378,6 +383,27 @@ uninstall-nodist_x11includeHEADERS: @list='$(nodist_x11include_HEADERS)'; test -n "$(x11includedir)" || list=; \ files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \ dir='$(DESTDIR)$(x11includedir)'; $(am__uninstall_files_from_dir) +install-x11extincludeHEADERS: $(x11extinclude_HEADERS) + @$(NORMAL_INSTALL) + @list='$(x11extinclude_HEADERS)'; test -n "$(x11extincludedir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(x11extincludedir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(x11extincludedir)" || exit 1; \ + fi; \ + for p in $$list; do \ + if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; \ + done | $(am__base_list) | \ + while read files; do \ + echo " $(INSTALL_HEADER) $$files '$(DESTDIR)$(x11extincludedir)'"; \ + $(INSTALL_HEADER) $$files "$(DESTDIR)$(x11extincludedir)" || exit $$?; \ + done + +uninstall-x11extincludeHEADERS: + @$(NORMAL_UNINSTALL) + @list='$(x11extinclude_HEADERS)'; test -n "$(x11extincludedir)" || list=; \ + files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \ + dir='$(DESTDIR)$(x11extincludedir)'; $(am__uninstall_files_from_dir) install-x11includeHEADERS: $(x11include_HEADERS) @$(NORMAL_INSTALL) @list='$(x11include_HEADERS)'; test -n "$(x11includedir)" || list=; \ @@ -500,7 +526,7 @@ check-am: all-am check: check-am all-am: Makefile $(HEADERS) installdirs: - for dir in "$(DESTDIR)$(x11includedir)" "$(DESTDIR)$(x11includedir)"; do \ + for dir in "$(DESTDIR)$(x11includedir)" "$(DESTDIR)$(x11extincludedir)" "$(DESTDIR)$(x11includedir)"; do \ test -z "$$dir" || $(MKDIR_P) "$$dir"; \ done install: install-am @@ -554,7 +580,7 @@ info: info-am info-am: install-data-am: install-nodist_x11includeHEADERS \ - install-x11includeHEADERS + install-x11extincludeHEADERS install-x11includeHEADERS install-dvi: install-dvi-am @@ -599,7 +625,7 @@ ps: ps-am ps-am: uninstall-am: uninstall-nodist_x11includeHEADERS \ - uninstall-x11includeHEADERS + uninstall-x11extincludeHEADERS uninstall-x11includeHEADERS .MAKE: install-am install-strip @@ -611,12 +637,13 @@ uninstall-am: uninstall-nodist_x11includeHEADERS \ install-exec-am install-html install-html-am install-info \ install-info-am install-man install-nodist_x11includeHEADERS \ install-pdf install-pdf-am install-ps install-ps-am \ - install-strip install-x11includeHEADERS installcheck \ - installcheck-am installdirs maintainer-clean \ - maintainer-clean-generic mostlyclean mostlyclean-generic \ - mostlyclean-libtool pdf pdf-am ps ps-am tags uninstall \ - uninstall-am uninstall-nodist_x11includeHEADERS \ - uninstall-x11includeHEADERS + install-strip install-x11extincludeHEADERS \ + install-x11includeHEADERS installcheck installcheck-am \ + installdirs maintainer-clean maintainer-clean-generic \ + mostlyclean mostlyclean-generic mostlyclean-libtool pdf pdf-am \ + ps ps-am tags uninstall uninstall-am \ + uninstall-nodist_x11includeHEADERS \ + uninstall-x11extincludeHEADERS uninstall-x11includeHEADERS # Tell versions [3.59,3.63) of GNU make to not export all variables. diff --git a/lib/libX11/include/X11/Xlibint.h b/lib/libX11/include/X11/Xlibint.h index 6b95bcf7d..844571688 100644 --- a/lib/libX11/include/X11/Xlibint.h +++ b/lib/libX11/include/X11/Xlibint.h @@ -202,6 +202,9 @@ struct _XDisplay unsigned long last_request_read_upper32bit; unsigned long request_upper32bit; #endif + + /* avoid recursion on requests sequence number synchronization */ + Bool req_seq_syncing; /* requests syncing is in-progress */ }; #define XAllocIDs(dpy,ids,n) (*(dpy)->idlist_alloc)(dpy,ids,n) diff --git a/lib/libX11/include/X11/extensions/XKBgeom.h b/lib/libX11/include/X11/extensions/XKBgeom.h new file mode 100644 index 000000000..380fa18b3 --- /dev/null +++ b/lib/libX11/include/X11/extensions/XKBgeom.h @@ -0,0 +1,662 @@ +/************************************************************ +Copyright (c) 1993 by Silicon Graphics Computer Systems, Inc. + +Permission to use, copy, modify, and distribute this +software and its documentation for any purpose and without +fee is hereby granted, 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 Silicon Graphics not be +used in advertising or publicity pertaining to distribution +of the software without specific prior written permission. +Silicon Graphics makes no representation about the suitability +of this software for any purpose. It is provided "as is" +without any express or implied warranty. + +SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS +SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON +GRAPHICS 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. + +********************************************************/ + +#ifndef _XKBGEOM_H_ +#define _XKBGEOM_H_ + +#include <X11/extensions/XKBstr.h> + +#ifdef XKB_IN_SERVER +#define XkbAddGeomKeyAlias SrvXkbAddGeomKeyAlias +#define XkbAddGeomColor SrvXkbAddGeomColor +#define XkbAddGeomDoodad SrvXkbAddGeomDoodad +#define XkbAddGeomKey SrvXkbAddGeomKey +#define XkbAddGeomOutline SrvXkbAddGeomOutline +#define XkbAddGeomOverlay SrvXkbAddGeomOverlay +#define XkbAddGeomOverlayRow SrvXkbAddGeomOverlayRow +#define XkbAddGeomOverlayKey SrvXkbAddGeomOverlayKey +#define XkbAddGeomProperty SrvXkbAddGeomProperty +#define XkbAddGeomRow SrvXkbAddGeomRow +#define XkbAddGeomSection SrvXkbAddGeomSection +#define XkbAddGeomShape SrvXkbAddGeomShape +#define XkbAllocGeomKeyAliases SrvXkbAllocGeomKeyAliases +#define XkbAllocGeomColors SrvXkbAllocGeomColors +#define XkbAllocGeomDoodads SrvXkbAllocGeomDoodads +#define XkbAllocGeomKeys SrvXkbAllocGeomKeys +#define XkbAllocGeomOutlines SrvXkbAllocGeomOutlines +#define XkbAllocGeomPoints SrvXkbAllocGeomPoints +#define XkbAllocGeomProps SrvXkbAllocGeomProps +#define XkbAllocGeomRows SrvXkbAllocGeomRows +#define XkbAllocGeomSectionDoodads SrvXkbAllocGeomSectionDoodads +#define XkbAllocGeomSections SrvXkbAllocGeomSections +#define XkbAllocGeomOverlays SrvXkbAllocGeomOverlays +#define XkbAllocGeomOverlayRows SrvXkbAllocGeomOverlayRows +#define XkbAllocGeomOverlayKeys SrvXkbAllocGeomOverlayKeys +#define XkbAllocGeomShapes SrvXkbAllocGeomShapes +#define XkbAllocGeometry SrvXkbAllocGeometry +#define XkbFreeGeomKeyAliases SrvXkbFreeGeomKeyAliases +#define XkbFreeGeomColors SrvXkbFreeGeomColors +#define XkbFreeGeomDoodads SrvXkbFreeGeomDoodads +#define XkbFreeGeomProperties SrvXkbFreeGeomProperties +#define XkbFreeGeomOverlayKeys SrvXkbFreeGeomOverlayKeys +#define XkbFreeGeomOverlayRows SrvXkbFreeGeomOverlayRows +#define XkbFreeGeomOverlays SrvXkbFreeGeomOverlays +#define XkbFreeGeomKeys SrvXkbFreeGeomKeys +#define XkbFreeGeomRows SrvXkbFreeGeomRows +#define XkbFreeGeomSections SrvXkbFreeGeomSections +#define XkbFreeGeomPoints SrvXkbFreeGeomPoints +#define XkbFreeGeomOutlines SrvXkbFreeGeomOutlines +#define XkbFreeGeomShapes SrvXkbFreeGeomShapes +#define XkbFreeGeometry SrvXkbFreeGeometry +#endif + +typedef struct _XkbProperty { + char *name; + char *value; +} XkbPropertyRec,*XkbPropertyPtr; + +typedef struct _XkbColor { + unsigned int pixel; + char * spec; +} XkbColorRec,*XkbColorPtr; + +typedef struct _XkbPoint { + short x; + short y; +} XkbPointRec, *XkbPointPtr; + +typedef struct _XkbBounds { + short x1,y1; + short x2,y2; +} XkbBoundsRec, *XkbBoundsPtr; +#define XkbBoundsWidth(b) (((b)->x2)-((b)->x1)) +#define XkbBoundsHeight(b) (((b)->y2)-((b)->y1)) + +/* + * In the following structs, this pattern is used for dynamically sized arrays: + * foo is an array for which sz_foo entries are allocated & num_foo are used + */ + +typedef struct _XkbOutline { + unsigned short num_points; + unsigned short sz_points; + unsigned short corner_radius; + XkbPointPtr points; +} XkbOutlineRec, *XkbOutlinePtr; + +typedef struct _XkbShape { + Atom name; + unsigned short num_outlines; + unsigned short sz_outlines; + XkbOutlinePtr outlines; + XkbOutlinePtr approx; + XkbOutlinePtr primary; + XkbBoundsRec bounds; +} XkbShapeRec, *XkbShapePtr; +#define XkbOutlineIndex(s,o) ((int)((o)-&(s)->outlines[0])) + +typedef struct _XkbShapeDoodad { + Atom name; + unsigned char type; + unsigned char priority; + short top; + short left; + short angle; + unsigned short color_ndx; + unsigned short shape_ndx; +} XkbShapeDoodadRec, *XkbShapeDoodadPtr; +#define XkbShapeDoodadColor(g,d) (&(g)->colors[(d)->color_ndx]) +#define XkbShapeDoodadShape(g,d) (&(g)->shapes[(d)->shape_ndx]) +#define XkbSetShapeDoodadColor(g,d,c) ((d)->color_ndx= (c)-&(g)->colors[0]) +#define XkbSetShapeDoodadShape(g,d,s) ((d)->shape_ndx= (s)-&(g)->shapes[0]) + +typedef struct _XkbTextDoodad { + Atom name; + unsigned char type; + unsigned char priority; + short top; + short left; + short angle; + short width; + short height; + unsigned short color_ndx; + char * text; + char * font; +} XkbTextDoodadRec, *XkbTextDoodadPtr; +#define XkbTextDoodadColor(g,d) (&(g)->colors[(d)->color_ndx]) +#define XkbSetTextDoodadColor(g,d,c) ((d)->color_ndx= (c)-&(g)->colors[0]) + +typedef struct _XkbIndicatorDoodad { + Atom name; + unsigned char type; + unsigned char priority; + short top; + short left; + short angle; + unsigned short shape_ndx; + unsigned short on_color_ndx; + unsigned short off_color_ndx; +} XkbIndicatorDoodadRec, *XkbIndicatorDoodadPtr; +#define XkbIndicatorDoodadShape(g,d) (&(g)->shapes[(d)->shape_ndx]) +#define XkbIndicatorDoodadOnColor(g,d) (&(g)->colors[(d)->on_color_ndx]) +#define XkbIndicatorDoodadOffColor(g,d) (&(g)->colors[(d)->off_color_ndx]) +#define XkbSetIndicatorDoodadOnColor(g,d,c) \ + ((d)->on_color_ndx= (c)-&(g)->colors[0]) +#define XkbSetIndicatorDoodadOffColor(g,d,c) \ + ((d)->off_color_ndx= (c)-&(g)->colors[0]) +#define XkbSetIndicatorDoodadShape(g,d,s) \ + ((d)->shape_ndx= (s)-&(g)->shapes[0]) + +typedef struct _XkbLogoDoodad { + Atom name; + unsigned char type; + unsigned char priority; + short top; + short left; + short angle; + unsigned short color_ndx; + unsigned short shape_ndx; + char * logo_name; +} XkbLogoDoodadRec, *XkbLogoDoodadPtr; +#define XkbLogoDoodadColor(g,d) (&(g)->colors[(d)->color_ndx]) +#define XkbLogoDoodadShape(g,d) (&(g)->shapes[(d)->shape_ndx]) +#define XkbSetLogoDoodadColor(g,d,c) ((d)->color_ndx= (c)-&(g)->colors[0]) +#define XkbSetLogoDoodadShape(g,d,s) ((d)->shape_ndx= (s)-&(g)->shapes[0]) + +typedef struct _XkbAnyDoodad { + Atom name; + unsigned char type; + unsigned char priority; + short top; + short left; + short angle; +} XkbAnyDoodadRec, *XkbAnyDoodadPtr; + +typedef union _XkbDoodad { + XkbAnyDoodadRec any; + XkbShapeDoodadRec shape; + XkbTextDoodadRec text; + XkbIndicatorDoodadRec indicator; + XkbLogoDoodadRec logo; +} XkbDoodadRec, *XkbDoodadPtr; + +#define XkbUnknownDoodad 0 +#define XkbOutlineDoodad 1 +#define XkbSolidDoodad 2 +#define XkbTextDoodad 3 +#define XkbIndicatorDoodad 4 +#define XkbLogoDoodad 5 + +typedef struct _XkbKey { + XkbKeyNameRec name; + short gap; + unsigned char shape_ndx; + unsigned char color_ndx; +} XkbKeyRec, *XkbKeyPtr; +#define XkbKeyShape(g,k) (&(g)->shapes[(k)->shape_ndx]) +#define XkbKeyColor(g,k) (&(g)->colors[(k)->color_ndx]) +#define XkbSetKeyShape(g,k,s) ((k)->shape_ndx= (s)-&(g)->shapes[0]) +#define XkbSetKeyColor(g,k,c) ((k)->color_ndx= (c)-&(g)->colors[0]) + +typedef struct _XkbRow { + short top; + short left; + unsigned short num_keys; + unsigned short sz_keys; + int vertical; + XkbKeyPtr keys; + XkbBoundsRec bounds; +} XkbRowRec, *XkbRowPtr; + +typedef struct _XkbSection { + Atom name; + unsigned char priority; + short top; + short left; + unsigned short width; + unsigned short height; + short angle; + unsigned short num_rows; + unsigned short num_doodads; + unsigned short num_overlays; + unsigned short sz_rows; + unsigned short sz_doodads; + unsigned short sz_overlays; + XkbRowPtr rows; + XkbDoodadPtr doodads; + XkbBoundsRec bounds; + struct _XkbOverlay *overlays; +} XkbSectionRec, *XkbSectionPtr; + +typedef struct _XkbOverlayKey { + XkbKeyNameRec over; + XkbKeyNameRec under; +} XkbOverlayKeyRec,*XkbOverlayKeyPtr; + +typedef struct _XkbOverlayRow { + unsigned short row_under; + unsigned short num_keys; + unsigned short sz_keys; + XkbOverlayKeyPtr keys; +} XkbOverlayRowRec,*XkbOverlayRowPtr; + +typedef struct _XkbOverlay { + Atom name; + XkbSectionPtr section_under; + unsigned short num_rows; + unsigned short sz_rows; + XkbOverlayRowPtr rows; + XkbBoundsPtr bounds; +} XkbOverlayRec,*XkbOverlayPtr; + +typedef struct _XkbGeometry { + Atom name; + unsigned short width_mm; + unsigned short height_mm; + char * label_font; + XkbColorPtr label_color; + XkbColorPtr base_color; + unsigned short sz_properties; + unsigned short sz_colors; + unsigned short sz_shapes; + unsigned short sz_sections; + unsigned short sz_doodads; + unsigned short sz_key_aliases; + unsigned short num_properties; + unsigned short num_colors; + unsigned short num_shapes; + unsigned short num_sections; + unsigned short num_doodads; + unsigned short num_key_aliases; + XkbPropertyPtr properties; + XkbColorPtr colors; + XkbShapePtr shapes; + XkbSectionPtr sections; + XkbDoodadPtr doodads; + XkbKeyAliasPtr key_aliases; +} XkbGeometryRec; +#define XkbGeomColorIndex(g,c) ((int)((c)-&(g)->colors[0])) + +#define XkbGeomPropertiesMask (1<<0) +#define XkbGeomColorsMask (1<<1) +#define XkbGeomShapesMask (1<<2) +#define XkbGeomSectionsMask (1<<3) +#define XkbGeomDoodadsMask (1<<4) +#define XkbGeomKeyAliasesMask (1<<5) +#define XkbGeomAllMask (0x3f) + +typedef struct _XkbGeometrySizes { + unsigned int which; + unsigned short num_properties; + unsigned short num_colors; + unsigned short num_shapes; + unsigned short num_sections; + unsigned short num_doodads; + unsigned short num_key_aliases; +} XkbGeometrySizesRec,*XkbGeometrySizesPtr; + +_XFUNCPROTOBEGIN + +extern XkbPropertyPtr +XkbAddGeomProperty( + XkbGeometryPtr /* geom */, + char * /* name */, + char * /* value */ +); + +extern XkbKeyAliasPtr +XkbAddGeomKeyAlias( + XkbGeometryPtr /* geom */, + char * /* alias */, + char * /* real */ +); + +extern XkbColorPtr +XkbAddGeomColor( + XkbGeometryPtr /* geom */, + char * /* spec */, + unsigned int /* pixel */ +); + +extern XkbOutlinePtr +XkbAddGeomOutline( + XkbShapePtr /* shape */, + int /* sz_points */ +); + +extern XkbShapePtr +XkbAddGeomShape( + XkbGeometryPtr /* geom */, + Atom /* name */, + int /* sz_outlines */ +); + +extern XkbKeyPtr +XkbAddGeomKey( + XkbRowPtr /* row */ +); + +extern XkbRowPtr +XkbAddGeomRow( + XkbSectionPtr /* section */, + int /* sz_keys */ +); + +extern XkbSectionPtr +XkbAddGeomSection( + XkbGeometryPtr /* geom */, + Atom /* name */, + int /* sz_rows */, + int /* sz_doodads */, + int /* sz_overlays */ +); + +extern XkbOverlayPtr +XkbAddGeomOverlay( + XkbSectionPtr /* section */, + Atom /* name */, + int /* sz_rows */ +); + +extern XkbOverlayRowPtr +XkbAddGeomOverlayRow( + XkbOverlayPtr /* overlay */, + int /* row_under */, + int /* sz_keys */ +); + +extern XkbOverlayKeyPtr +XkbAddGeomOverlayKey( + XkbOverlayPtr /* overlay */, + XkbOverlayRowPtr /* row */, + char * /* over */, + char * /* under */ +); + +extern XkbDoodadPtr +XkbAddGeomDoodad( + XkbGeometryPtr /* geom */, + XkbSectionPtr /* section */, + Atom /* name */ +); + + +extern void +XkbFreeGeomKeyAliases( + XkbGeometryPtr /* geom */, + int /* first */, + int /* count */, + Bool /* freeAll */ +); + +extern void +XkbFreeGeomColors( + XkbGeometryPtr /* geom */, + int /* first */, + int /* count */, + Bool /* freeAll */ +); + +extern void +XkbFreeGeomDoodads( + XkbDoodadPtr /* doodads */, + int /* nDoodads */, + Bool /* freeAll */ +); + + +extern void +XkbFreeGeomProperties( + XkbGeometryPtr /* geom */, + int /* first */, + int /* count */, + Bool /* freeAll */ +); + +extern void +XkbFreeGeomOverlayKeys( + XkbOverlayRowPtr /* row */, + int /* first */, + int /* count */, + Bool /* freeAll */ +); + +extern void +XkbFreeGeomOverlayRows( + XkbOverlayPtr /* overlay */, + int /* first */, + int /* count */, + Bool /* freeAll */ +); + +extern void +XkbFreeGeomOverlays( + XkbSectionPtr /* section */, + int /* first */, + int /* count */, + Bool /* freeAll */ +); + +extern void +XkbFreeGeomKeys( + XkbRowPtr /* row */, + int /* first */, + int /* count */, + Bool /* freeAll */ +); + +extern void +XkbFreeGeomRows( + XkbSectionPtr /* section */, + int /* first */, + int /* count */, + Bool /* freeAll */ +); + +extern void +XkbFreeGeomSections( + XkbGeometryPtr /* geom */, + int /* first */, + int /* count */, + Bool /* freeAll */ +); + + +extern void +XkbFreeGeomPoints( + XkbOutlinePtr /* outline */, + int /* first */, + int /* count */, + Bool /* freeAll */ +); + +extern void +XkbFreeGeomOutlines( + XkbShapePtr /* shape */, + int /* first */, + int /* count */, + Bool /* freeAll */ +); + +extern void +XkbFreeGeomShapes( + XkbGeometryPtr /* geom */, + int /* first */, + int /* count */, + Bool /* freeAll */ +); + +extern void +XkbFreeGeometry( + XkbGeometryPtr /* geom */, + unsigned int /* which */, + Bool /* freeMap */ +); + +extern Status +XkbAllocGeomProps( + XkbGeometryPtr /* geom */, + int /* nProps */ +); + +extern Status +XkbAllocGeomKeyAliases( + XkbGeometryPtr /* geom */, + int /* nAliases */ +); + +extern Status +XkbAllocGeomColors( + XkbGeometryPtr /* geom */, + int /* nColors */ +); + +extern Status +XkbAllocGeomShapes( + XkbGeometryPtr /* geom */, + int /* nShapes */ +); + +extern Status +XkbAllocGeomSections( + XkbGeometryPtr /* geom */, + int /* nSections */ +); + +extern Status +XkbAllocGeomOverlays( + XkbSectionPtr /* section */, + int /* num_needed */ +); + +extern Status +XkbAllocGeomOverlayRows( + XkbOverlayPtr /* overlay */, + int /* num_needed */ +); + +extern Status +XkbAllocGeomOverlayKeys( + XkbOverlayRowPtr /* row */, + int /* num_needed */ +); + +extern Status +XkbAllocGeomDoodads( + XkbGeometryPtr /* geom */, + int /* nDoodads */ +); + +extern Status +XkbAllocGeomSectionDoodads( + XkbSectionPtr /* section */, + int /* nDoodads */ +); + +extern Status +XkbAllocGeomOutlines( + XkbShapePtr /* shape */, + int /* nOL */ +); + +extern Status +XkbAllocGeomRows( + XkbSectionPtr /* section */, + int /* nRows */ +); + +extern Status +XkbAllocGeomPoints( + XkbOutlinePtr /* ol */, + int /* nPts */ +); + +extern Status +XkbAllocGeomKeys( + XkbRowPtr /* row */, + int /* nKeys */ +); + +extern Status +XkbAllocGeometry( + XkbDescPtr /* xkb */, + XkbGeometrySizesPtr /* sizes */ +); + +extern Status +XkbSetGeometry( + Display * /* dpy */, + unsigned /* deviceSpec */, + XkbGeometryPtr /* geom */ +); + +extern Bool +XkbComputeShapeTop( + XkbShapePtr /* shape */, + XkbBoundsPtr /* bounds */ +); + +extern Bool +XkbComputeShapeBounds( + XkbShapePtr /* shape */ +); + +extern Bool +XkbComputeRowBounds( + XkbGeometryPtr /* geom */, + XkbSectionPtr /* section */, + XkbRowPtr /* row */ +); + +extern Bool +XkbComputeSectionBounds( + XkbGeometryPtr /* geom */, + XkbSectionPtr /* section */ +); + +extern char * +XkbFindOverlayForKey( + XkbGeometryPtr /* geom */, + XkbSectionPtr /* wanted */, + char * /* under */ +); + +extern Status +XkbGetGeometry( + Display * /* dpy */, + XkbDescPtr /* xkb */ +); + +extern Status +XkbGetNamedGeometry( + Display * /* dpy */, + XkbDescPtr /* xkb */, + Atom /* name */ +); + +_XFUNCPROTOEND + +#endif /* _XKBSTR_H_ */ diff --git a/lib/libX11/man/AllPlanes.man b/lib/libX11/man/AllPlanes.man index 8766645f4..70d837e87 100644 --- a/lib/libX11/man/AllPlanes.man +++ b/lib/libX11/man/AllPlanes.man @@ -38,78 +38,45 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH AllPlanes __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME AllPlanes, BlackPixel, WhitePixel, ConnectionNumber, DefaultColormap, DefaultDepth, XListDepths, DefaultGC, DefaultRootWindow, DefaultScreenOfDisplay, DefaultScreen, DefaultVisual, DisplayCells, DisplayPlanes, DisplayString, XMaxRequestSize, XExtendedMaxRequestSize, LastKnownRequestProcessed, NextRequest, ProtocolVersion, ProtocolRevision, QLength, RootWindow, ScreenCount, ScreenOfDisplay, ServerVendor, VendorRelease \- Display macros and functions .SH SYNTAX -unsigned long AllPlanes; +unsigned long AllPlanes; .HP unsigned long BlackPixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^); .HP -unsigned long WhitePixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^); +unsigned long WhitePixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^); .HP -int ConnectionNumber\^(\^Display *\fIdisplay\fP\^); +int ConnectionNumber\^(\^Display *\fIdisplay\fP\^); .HP Colormap DefaultColormap\^(\^Display *\fIdisplay\fP\^, -\^int \fIscreen_number\fP\^); +\^int \fIscreen_number\fP\^); .HP -int DefaultDepth\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); +int DefaultDepth\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); .HP int *XListDepths\^(\^Display *\fIdisplay\fP, int \fIscreen_number\fP, int -\fIcount_return\fP\^); +\fIcount_return\fP\^); .HP -GC DefaultGC\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); +GC DefaultGC\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); .HP -Window DefaultRootWindow\^(\^Display *\fIdisplay\fP\^); +Window DefaultRootWindow\^(\^Display *\fIdisplay\fP\^); .HP -Screen *DefaultScreenOfDisplay\^(\^Display *\fIdisplay\fP\^); +Screen *DefaultScreenOfDisplay\^(\^Display *\fIdisplay\fP\^); .HP -int DefaultScreen\^(\^Display *\fIdisplay\fP\^); +int DefaultScreen\^(\^Display *\fIdisplay\fP\^); .HP Visual *DefaultVisual\^(\^Display *\fIdisplay\fP\^, \^int -\fIscreen_number\fP\^); +\fIscreen_number\fP\^); .HP -int DisplayCells\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); +int DisplayCells\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); .HP int DisplayPlanes\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); .HP @@ -119,22 +86,22 @@ long XMaxRequestSize(\^Display *\fIdisplay\fP\^) .HP long XExtendedMaxRequestSize(\^Display *\fIdisplay\fP\^) .HP -unsigned long LastKnownRequestProcessed\^(\^Display *\fIdisplay\fP\^); +unsigned long LastKnownRequestProcessed\^(\^Display *\fIdisplay\fP\^); .HP -unsigned long NextRequest\^(\^Display *\fIdisplay\fP\^); +unsigned long NextRequest\^(\^Display *\fIdisplay\fP\^); .HP -int ProtocolVersion\^(\^Display *\fIdisplay\fP\^); +int ProtocolVersion\^(\^Display *\fIdisplay\fP\^); .HP -int ProtocolRevision\^(\^Display *\fIdisplay\fP\^); +int ProtocolRevision\^(\^Display *\fIdisplay\fP\^); .HP -int QLength\^(\^Display *\fIdisplay\fP\^); +int QLength\^(\^Display *\fIdisplay\fP\^); .HP -Window RootWindow\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); +Window RootWindow\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); .HP -int ScreenCount\^(\^Display *\fIdisplay\fP\^); +int ScreenCount\^(\^Display *\fIdisplay\fP\^); .HP Screen *ScreenOfDisplay\^(\^Display *\fIdisplay\fP, int -\fIscreen_number\fP\^); +\fIscreen_number\fP\^); .HP char *ServerVendor\^(\^Display *\fIdisplay\fP\^) .HP @@ -144,87 +111,86 @@ int VendorRelease\^(\^Display *\fIdisplay\fP\^) Specifies the connection to the X server. .IP \fIscreen_number\fP 1i Specifies the appropriate screen number on the host server. -.ds Cn depths .IP \fIcount_return\fP 1i -Returns the number of \*(Cn. +Returns the number of depths. .SH DESCRIPTION The -.ZN AllPlanes -macro returns a value with all bits set to 1 suitable for use in a plane +.B AllPlanes +macro returns a value with all bits set to 1 suitable for use in a plane argument to a procedure. .LP The -.ZN BlackPixel +.B BlackPixel macro returns the black pixel value for the specified screen. .LP The -.ZN WhitePixel +.B WhitePixel macro returns the white pixel value for the specified screen. .LP The -.ZN ConnectionNumber +.B ConnectionNumber macro returns a connection number for the specified display. .LP The -.ZN DefaultColormap +.B DefaultColormap macro returns the default colormap ID for allocation on the specified screen. .LP The -.ZN DefaultDepth +.B DefaultDepth macro returns the depth (number of planes) of the default root window for the specified screen. .LP The -.ZN XListDepths -function returns the array of depths +.B XListDepths +function returns the array of depths that are available on the specified screen. If the specified screen_number is valid and sufficient memory for the array can be allocated, -.ZN XListDepths +.B XListDepths sets count_return to the number of available depths. Otherwise, it does not set count_return and returns NULL. To release the memory allocated for the array of depths, use -.ZN XFree . +.BR XFree . .LP The -.ZN DefaultGC +.B DefaultGC macro returns the default GC for the root window of the specified screen. .LP The -.ZN DefaultRootWindow +.B DefaultRootWindow macro returns the root window for the default screen. .LP The -.ZN DefaultScreenOfDisplay +.B DefaultScreenOfDisplay macro returns the default screen of the specified display. .LP The -.ZN DefaultScreen +.B DefaultScreen macro returns the default screen number referenced in the -.ZN XOpenDisplay +.B XOpenDisplay routine. .LP The -.ZN DefaultVisual +.B DefaultVisual macro returns the default visual type for the specified screen. .LP The -.ZN DisplayCells +.B DisplayCells macro returns the number of entries in the default colormap. .LP The -.ZN DisplayPlanes +.B DisplayPlanes macro returns the depth of the root window of the specified screen. .LP The -.ZN DisplayString +.B DisplayString macro returns the string that was passed to -.ZN XOpenDisplay +.B XOpenDisplay when the current display was opened. .LP The -.ZN XMaxRequestSize +.B XMaxRequestSize function returns the maximum request size (in 4-byte units) supported by the server without using an extended-length protocol encoding. Single protocol requests to the server can be no larger than this size @@ -233,81 +199,82 @@ The protocol guarantees the size to be no smaller than 4096 units (16384 bytes). Xlib automatically breaks data up into multiple protocol requests as necessary for the following functions: -.ZN XDrawPoints , -.ZN XDrawRectangles , -.ZN XDrawSegments , -.ZN XFillArcs , -.ZN XFillRectangles , -and -.ZN XPutImage . +.BR XDrawPoints , +.BR XDrawRectangles , +.BR XDrawSegments , +.BR XFillArcs , +.BR XFillRectangles , +and +.BR XPutImage . .LP The -.ZN XExtendedMaxRequestSize +.B XExtendedMaxRequestSize function returns zero if the specified display does not support an extended-length protocol encoding; otherwise, it returns the maximum request size (in 4-byte units) supported by the server using the extended-length encoding. The Xlib functions -.ZN XDrawLines , -.ZN XDrawArcs , -.ZN XFillPolygon , -.ZN XChangeProperty , -.ZN XSetClipRectangles , +.BR XDrawLines , +.BR XDrawArcs , +.BR XFillPolygon , +.BR XChangeProperty , +.BR XSetClipRectangles , and -.ZN XSetRegion +.B XSetRegion will use the extended-length encoding as necessary, if supported -by the server. Use of the extended-length encoding in other Xlib +by the server. +Use of the extended-length encoding in other Xlib functions (for example, -.ZN XDrawPoints , -.ZN XDrawRectangles , -.ZN XDrawSegments , -.ZN XFillArcs , -.ZN XFillRectangles , -.ZN XPutImage ) +.BR XDrawPoints , +.BR XDrawRectangles , +.BR XDrawSegments , +.BR XFillArcs , +.BR XFillRectangles , +.BR XPutImage ) is permitted but not required; an Xlib implementation may choose to split the data across multiple smaller requests instead. .LP The -.ZN LastKnownRequestProcessed +.B LastKnownRequestProcessed macro extracts the full serial number of the last request known by Xlib to have been processed by the X server. .LP The -.ZN NextRequest +.B NextRequest macro extracts the full serial number that is to be used for the next request. .LP The -.ZN ProtocolVersion +.B ProtocolVersion macro returns the major version number (11) of the X protocol associated with the connected display. .LP The -.ZN ProtocolRevision +.B ProtocolRevision macro returns the minor protocol revision number of the X server. .LP The -.ZN QLength +.B QLength macro returns the length of the event queue for the connected display. .LP The -.ZN RootWindow +.B RootWindow macro returns the root window. .LP The -.ZN ScreenCount +.B ScreenCount macro returns the number of available screens. .LP The -.ZN ScreenOfDisplay +.B ScreenOfDisplay macro returns a pointer to the screen of the specified display. .LP The -.ZN ServerVendor +.B ServerVendor macro returns a pointer to a null-terminated string that provides some identification of the owner of the X server implementation. .LP The -.ZN VendorRelease +.B VendorRelease macro returns a number related to a vendor's release of the X server. .SH "SEE ALSO" BlackPixelOfScreen(__libmansuffix__), diff --git a/lib/libX11/man/BlackPixelOfScreen.man b/lib/libX11/man/BlackPixelOfScreen.man index 535b4ad44..fdec32d9f 100644 --- a/lib/libX11/man/BlackPixelOfScreen.man +++ b/lib/libX11/man/BlackPixelOfScreen.man @@ -38,72 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.de NT -.ne 7 -.ds NO Note -.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2 -.if \\n(.$ .if !'\\$1'C' .ds NO \\$1 -.ie n .sp -.el .sp 10p -.TB -.ce -\\*(NO -.ie n .sp -.el .sp 5p -.if '\\$1'C' .ce 99 -.if '\\$2'C' .ce 99 -.in +5n -.ll -5n -.R -.. -. \" Note End -- doug kraft 3/85 -.de NE -.ce 0 -.in -5n -.ll +5n -.ie n .sp -.el .sp 10p -.. -.ny0 .TH BlackPixelOfScreen __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME BlackPixelOfScreen, WhitePixelOfScreen, CellsOfScreen, DefaultColormapOfScreen, DefaultDepthOfScreen, DefaultGCOfScreen, DefaultVisualOfScreen, DoesBackingStore, DoesSaveUnders, DisplayOfScreen, XScreenNumberOfScreen, EventMaskOfScreen, HeightOfScreen, HeightMMOfScreen, MaxCmapsOfScreen, MinCmapsOfScreen, PlanesOfScreen, RootWindowOfScreen, WidthOfScreen, WidthMMOfScreen \- screen information functions and macros @@ -150,99 +91,99 @@ int WidthOfScreen\^(\^Screen *\fIscreen\fP\^); int WidthMMOfScreen\^(\^Screen *\fIscreen\fP\^); .SH ARGUMENTS .IP \fIscreen\fP 1i -Specifies the appropriate -.ZN Screen +Specifies the appropriate +.B Screen structure. .SH DESCRIPTION The -.ZN BlackPixelOfScreen +.B BlackPixelOfScreen macro returns the black pixel value of the specified screen. .LP The -.ZN WhitePixelOfScreen +.B WhitePixelOfScreen macro returns the white pixel value of the specified screen. .LP The -.ZN CellsOfScreen +.B CellsOfScreen macro returns the number of colormap cells in the default colormap of the specified screen. .LP The -.ZN DefaultColormapOfScreen +.B DefaultColormapOfScreen macro returns the default colormap of the specified screen. .LP The -.ZN DefaultDepthOfScreen +.B DefaultDepthOfScreen macro returns the default depth of the root window of the specified screen. .LP The -.ZN DefaultGCOfScreen +.B DefaultGCOfScreen macro returns the default GC of the specified screen, which has the same depth as the root window of the screen. .LP The -.ZN DefaultVisualOfScreen +.B DefaultVisualOfScreen macro returns the default visual of the specified screen. .LP The -.ZN DoesBackingStore -macro returns -.ZN WhenMapped , -.ZN NotUseful , +.B DoesBackingStore +macro returns +.BR WhenMapped , +.BR NotUseful , or -.ZN Always , +.BR Always , which indicate whether the screen supports backing stores. .LP The -.ZN DoesSaveUnders +.B DoesSaveUnders macro returns a Boolean value indicating whether the screen supports save unders. .LP The -.ZN DisplayOfScreen +.B DisplayOfScreen macro returns the display of the specified screen. .LP The -.ZN XScreenNumberOfScreen +.B XScreenNumberOfScreen function returns the screen index number of the specified screen. .LP The -.ZN EventMaskOfScreen +.B EventMaskOfScreen macro returns the root event mask of the root window for the specified screen at connection setup. .LP The -.ZN HeightOfScreen +.B HeightOfScreen macro returns the height of the specified screen. .LP The -.ZN HeightMMOfScreen +.B HeightMMOfScreen macro returns the height of the specified screen in millimeters. .LP The -.ZN MaxCmapsOfScreen -macro returns the maximum number of installed colormaps supported +.B MaxCmapsOfScreen +macro returns the maximum number of installed colormaps supported by the specified screen. .LP The -.ZN MinCmapsOfScreen -macro returns the minimum number of installed colormaps supported +.B MinCmapsOfScreen +macro returns the minimum number of installed colormaps supported by the specified screen. .LP The -.ZN PlanesOfScreen +.B PlanesOfScreen macro returns the number of planes in the root window of the specified screen. .LP The -.ZN RootWindowOfScreen +.B RootWindowOfScreen macro returns the root window of the specified screen. .LP The -.ZN WidthOfScreen +.B WidthOfScreen macro returns the width of the specified screen. .LP The -.ZN WidthMMOfScreen +.B WidthMMOfScreen macro returns the width of the specified screen in millimeters. .SH "SEE ALSO" AllPlanes(__libmansuffix__), diff --git a/lib/libX11/man/Compose.man b/lib/libX11/man/Compose.man index 71231698b..aba221ac7 100644 --- a/lib/libX11/man/Compose.man +++ b/lib/libX11/man/Compose.man @@ -46,8 +46,10 @@ file from the list in .PP Compose files can use an .RB \*q include \*q -instruction. This allows local modifications to be made to existing compose -files without including all of the content directly. For example, the +instruction. +This allows local modifications to be made to existing compose +files without including all of the content directly. +For example, the system's iso8859-1 compose file can be included with a line like this: .RS 4 .BI "include \*q" %S/iso8859-1/Compose \*q @@ -74,12 +76,15 @@ by using: .RS .B "include \*q%L\*q" .RE -and then rewrite only the few rules that you need to change. New +and then rewrite only the few rules that you need to change. +New compose rules can be added, and previous ones replaced. .SH FILE FORMAT .\" Based on grammar description in modules/im/ximcp/imLcPrs.c Compose files are plain text files, with a separate line for each compose -sequence. Comments begin with \fB#\fP characters. Each compose sequence +sequence. +Comments begin with \fB#\fP characters. +Each compose sequence specifies one or more events and a resulting input sequence, with an optional comment at the end of the line: .RS @@ -97,7 +102,8 @@ it must match exactly. MODIFIER may be one of Ctrl, Lock, Caps, Shift, Alt or Meta. Each modifier may be preceded by a .RB \*q "~" \*q -character to indicate that the modifier must not be present. If +character to indicate that the modifier must not be present. +If .RB \*q "None" \*q is specified, no modifier may be present. .PP @@ -110,18 +116,21 @@ as input when the sequence of events is input: Keysyms are specified without the \fBXK_\fP prefix. .PP Strings may be direct text encoded in the locale for which the compose file is -to be used, or an escaped octal or hexadecimal character code. Octal codes +to be used, or an escaped octal or hexadecimal character code. +Octal codes are specified as \fB\*q\\123\*q\fP and hexadecimal codes as \fB\*q\\x3a\*q\fP. It is not necessary to specify in the right part of a rule a locale encoded -string in addition to the keysym name. If the string is omitted, Xlib +string in addition to the keysym name. +If the string is omitted, Xlib figures it out from the keysym according to the current locale. I.e., if a rule looks like: .RS \fB<dead_grave> <A> : \*q\\300\*q Agrave\fP .RE the result of the composition is always the letter with the "\\300" -code. But if the rule is: +code. +But if the rule is: .RS \fB<dead_grave> <A> : Agrave\fP .RE diff --git a/lib/libX11/man/DisplayOfCCC.man b/lib/libX11/man/DisplayOfCCC.man index 85bd67203..8d089be87 100644 --- a/lib/libX11/man/DisplayOfCCC.man +++ b/lib/libX11/man/DisplayOfCCC.man @@ -38,109 +38,50 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.de NT -.ne 7 -.ds NO Note -.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2 -.if \\n(.$ .if !'\\$1'C' .ds NO \\$1 -.ie n .sp -.el .sp 10p -.TB -.ce -\\*(NO -.ie n .sp -.el .sp 5p -.if '\\$1'C' .ce 99 -.if '\\$2'C' .ce 99 -.in +5n -.ll -5n -.R -.. -. \" Note End -- doug kraft 3/85 -.de NE -.ce 0 -.in -5n -.ll +5n -.ie n .sp -.el .sp 10p -.. -.ny0 .TH DisplayOfCCC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME DisplayOfCCC, VisualOfCCC, ScreenNumberOfCCC, ScreenWhitePointOfCCC, ClientWhitePointOfCCC \- Color Conversion Context macros .SH SYNTAX .HP -Display *DisplayOfCCC\^(\^XcmsCCC \fIccc\fP\^); +Display *DisplayOfCCC\^(\^XcmsCCC \fIccc\fP\^); .HP -Visual *VisualOfCCC\^(\^XcmsCCC \fIccc\fP\^); +Visual *VisualOfCCC\^(\^XcmsCCC \fIccc\fP\^); .HP -int ScreenNumberOfCCC\^(\^XcmsCCC \fIccc\fP\^); +int ScreenNumberOfCCC\^(\^XcmsCCC \fIccc\fP\^); .HP -XcmsColor *ScreenWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^); +XcmsColor *ScreenWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^); .HP -XcmsColor *ClientWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^); +XcmsColor *ClientWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^); .SH ARGUMENTS .IP \fIccc\fP 1i Specifies the CCC. .SH DESCRIPTION The -.ZN DisplayOfCCC +.B DisplayOfCCC macro returns the display associated with the specified CCC. .LP The -.ZN VisualOfCCC +.B VisualOfCCC macro returns the visual associated with the specified CCC. .LP The -.ZN ScreenNumberOfCCC +.B ScreenNumberOfCCC macro returns the number of the screen associated with the specified CCC. .LP The -.ZN ScreenWhitePointOfCCC +.B ScreenWhitePointOfCCC macro returns the screen white point of the screen associated with the specified CCC. .LP The -.ZN ClientWhitePointOfCCC +.B ClientWhitePointOfCCC macro returns the client white point of the screen associated with the specified CCC. .SH "SEE ALSO" diff --git a/lib/libX11/man/ImageByteOrder.man b/lib/libX11/man/ImageByteOrder.man index bfae68871..90ebfd0c0 100644 --- a/lib/libX11/man/ImageByteOrder.man +++ b/lib/libX11/man/ImageByteOrder.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH ImageByteOrder __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME ImageByteOrder, BitmapBitOrder, BitmapPad, BitmapUnit, DisplayHeight, DisplayHeightMM, DisplayWidth, DisplayWidthMM, XListPixmapFormats, XPixmapFormatValues \- image format functions and macros @@ -103,76 +70,75 @@ int DisplayWidthMM\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. -.ds Cn pixmap formats that are supported by the display .IP \fIcount_return\fP 1i -Returns the number of \*(Cn. +Returns the number of pixmap formats that are supported by the display. .IP \fIscreen_number\fP 1i Specifies the appropriate screen number on the host server. .SH DESCRIPTION The -.ZN XListPixmapFormats +.B XListPixmapFormats function returns an array of -.ZN XPixmapFormatValues +.B XPixmapFormatValues structures that describe the types of Z format images supported by the specified display. If insufficient memory is available, -.ZN XListPixmapFormats +.B XListPixmapFormats returns NULL. To free the allocated storage for the -.ZN XPixmapFormatValues +.B XPixmapFormatValues structures, use -.ZN XFree . +.BR XFree . .LP The -.ZN ImageByteOrder +.B ImageByteOrder macro specifies the required byte order for images for each scanline unit in XY format (bitmap) or for each pixel value in Z format. .LP The -.ZN BitmapBitOrder -macro returns -.ZN LSBFirst +.B BitmapBitOrder +macro returns +.B LSBFirst or -.ZN MSBFirst +.B MSBFirst to indicate whether the leftmost bit in the bitmap as displayed on the screen is the least or most significant bit in the unit. .LP The -.ZN BitmapPad +.B BitmapPad macro returns the number of bits that each scanline must be padded. .LP The -.ZN BitmapUnit +.B BitmapUnit macro returns the size of a bitmap's scanline unit in bits. .LP The -.ZN DisplayHeight +.B DisplayHeight macro returns the height of the specified screen in pixels. .LP The -.ZN DisplayHeightMM +.B DisplayHeightMM macro returns the height of the specified screen in millimeters. .LP The -.ZN DisplayWidth +.B DisplayWidth macro returns the width of the screen in pixels. .LP The -.ZN DisplayWidthMM +.B DisplayWidthMM macro returns the width of the specified screen in millimeters. .SH STRUCTURES The -.ZN XPixmapFormatValues +.B XPixmapFormatValues structure provides an interface to the pixmap format information that is returned at the time of a connection setup. It contains: -.Ds 0 +.EX typedef struct { int depth; int bits_per_pixel; int scanline_pad; } XPixmapFormatValues; -.De +.EE .SH "SEE ALSO" AllPlanes(__libmansuffix__), BlackPixelOfScreen(__libmansuffix__), diff --git a/lib/libX11/man/IsCursorKey.man b/lib/libX11/man/IsCursorKey.man index fdeb4168c..7e0c12c35 100644 --- a/lib/libX11/man/IsCursorKey.man +++ b/lib/libX11/man/IsCursorKey.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH IsCursorKey __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME IsCursorKey, IsFunctionKey, IsKeypadKey, IsMiscFunctionKey, IsModifierKey, IsPFKey, IsPrivateKeypadKey \- keysym classification macros @@ -96,50 +63,49 @@ int IsPFKey\^(\^KeySym \fIkeysym\fP\^); .LP int IsPrivateKeypadKey\^(\^KeySym \fIkeysym\fP\^); .SH ARGUMENTS -.ds Fn tested .IP \fIkeysym\fP 1i -Specifies the KeySym that is to be \*(Fn. +Specifies the KeySym that is to be tested. .SH DESCRIPTION The -.ZN IsCursorKey -macro returns -.ZN True +.B IsCursorKey +macro returns +.B True if the specified KeySym is a cursor key. .LP The -.ZN IsFunctionKey -macro returns -.ZN True +.B IsFunctionKey +macro returns +.B True if the KeySym is a function key. .LP The -.ZN IsKeypadKey +.B IsKeypadKey macro returns -.ZN True +.B True if the specified KeySym is a keypad key. .LP The -.ZN IsMiscFunctionKey +.B IsMiscFunctionKey macro returns -.ZN True +.B True if the specified KeySym is a miscellaneous function key. .LP The -.ZN IsModifierKey +.B IsModifierKey macro returns -.ZN True +.B True if the specified KeySym is a modifier key. .LP The -.ZN IsPFKey +.B IsPFKey macro returns -.ZN True +.B True if the specified KeySym is a PF key. .LP The -.ZN IsPrivateKeypadKey +.B IsPrivateKeypadKey macro returns -.ZN True +.B True if the specified KeySym is a vendor-private keypad key. .SH "SEE ALSO" XkbKeyTypesForCoreSymbols(__libmansuffix__), diff --git a/lib/libX11/man/XAddConnectionWatch.man b/lib/libX11/man/XAddConnectionWatch.man index e58afffc8..7dc66eef2 100644 --- a/lib/libX11/man/XAddConnectionWatch.man +++ b/lib/libX11/man/XAddConnectionWatch.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XAddConnectionWatch __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XAddConnectionWatch, XRemoveConnectionWatch, XProcessInternalConnection, XInternalConnectionNumbers \- handle Xlib internal connections @@ -85,24 +52,23 @@ XAddConnectionWatch, XRemoveConnectionWatch, XProcessInternalConnection, XIntern .HP typedef void (*XConnectionWatchProc)\^(\^Display *\fIdisplay\fP\^, XPointer \fIclient_data\fP\^, int \fIfd\fP\^, Bool \fIopening\fP\^, XPointer -*\fIwatch_data\fP\^); +*\fIwatch_data\fP\^); .HP Status XAddConnectionWatch\^(\^Display *\fIdisplay\fP\^, XWatchProc -\fIprocedure\fP\^, XPointer \fIclient_data\fP\^); +\fIprocedure\fP\^, XPointer \fIclient_data\fP\^); .HP Status XRemoveConnectionWatch\^(\^Display *\fIdisplay\fP\^, XWatchProc -\fIprocedure\fP\^, XPointer \fIclient_data\fP\^); +\fIprocedure\fP\^, XPointer \fIclient_data\fP\^); .HP void XProcessInternalConnection\^(\^Display *\fIdisplay\fP\^, int \fIfd\fP\^); .HP Status XInternalConnectionNumbers\^(\^Display *\fIdisplay\fP\^, int -**\fIfd_return\fP\^, int *\fIcount_return\fP\^); +**\fIfd_return\fP\^, int *\fIcount_return\fP\^); .SH ARGUMENTS .IP \fIclient_data\fP 1i Specifies the additional client data. -.ds Cn file descriptors .IP \fIcount_return\fP 1i -Returns the number of \*(Cn. +Returns the number of file descriptors. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIfd\fP 1i @@ -113,25 +79,27 @@ Returns the file descriptors. Specifies the procedure to be called. .SH DESCRIPTION The -.ZN XAddConnectionWatch +.B XAddConnectionWatch function registers a procedure to be called each time Xlib opens or closes an -internal connection for the specified display. The procedure is passed the +internal connection for the specified display. +The procedure is passed the display, the specified client_data, the file descriptor for the connection, a Boolean indicating whether the connection is being opened or closed, and a -pointer to a location for private watch data. If opening is -.ZN True , +pointer to a location for private watch data. +If opening is +.BR True , the procedure can store a pointer to private data in the location pointed to by watch_data; when the procedure is later called for this same connection and opening is -.ZN False , +.BR False , the location pointed to by watch_data will hold this same private data pointer. .LP This function can be called at any time after a display is opened. If internal connections already exist, the registered procedure will immediately be called for each of them, before -.ZN XAddConnectionWatch +.B XAddConnectionWatch returns. -.ZN XAddConnectionWatch +.B XAddConnectionWatch returns a nonzero status if the procedure is successfully registered; otherwise, it returns zero. .LP @@ -142,33 +110,33 @@ If Xlib has been initialized for threads, the procedure is called with the display locked and the result of a call by the procedure to any Xlib function that locks the display is not defined unless the executing thread has externally locked the display using -.ZN XLockDisplay . +.BR XLockDisplay . .LP The -.ZN XRemoveConnectionWatch +.B XRemoveConnectionWatch function removes a previously registered connection watch procedure. The client_data must match the client_data used when the procedure was initially registered. .LP The -.ZN XProcessInternalConnection +.B XProcessInternalConnection function processes input available on an internal connection. This function should be called for an internal connection only after an operating system facility (for example, -.ZN select +.B select or -.ZN poll ) +.BR poll ) has indicated that input is available; otherwise, the effect is not defined. .LP The -.ZN XInternalConnectionNumbers +.B XInternalConnectionNumbers function returns a list of the file descriptors for all internal connections currently open for the specified display. When the allocated list is no longer needed, free it by using -.ZN XFree . +.BR XFree . This functions returns a nonzero status if the list is successfully allocated; otherwise, it returns zero. .SH "SEE ALSO" diff --git a/lib/libX11/man/XAddHost.man b/lib/libX11/man/XAddHost.man index 44f3dbaac..03b9fd4d6 100644 --- a/lib/libX11/man/XAddHost.man +++ b/lib/libX11/man/XAddHost.man @@ -1,7 +1,7 @@ .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium .\" .\" 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 @@ -11,7 +11,7 @@ .\" 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 @@ -21,12 +21,12 @@ .\" 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. -.\" +.\" .\" X Window System is a trademark of The Open Group. .\" .\" Copyright 2004 Oracle and/or its affiliates. All rights reserved. @@ -64,54 +64,21 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XAddHost __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XAddHost, XAddHosts, XListHosts, XRemoveHost, XRemoveHosts, XSetAccessControl, XEnableAccessControl, XDisableAccessControl, XHostAddress, XServerInterpretedAddress \- control host access and host control structure .SH SYNTAX .HP -int XAddHost\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhost\fP\^); +int XAddHost\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhost\fP\^); .HP -int XAddHosts\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhosts\fP, +int XAddHosts\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhosts\fP, int \fInum_hosts\fP\^); .HP XHostAddress *XListHosts\^(\^Display *\fIdisplay\fP, int *\fInhosts_return\fP, @@ -129,18 +96,16 @@ int XDisableAccessControl\^(\^Display *\fIdisplay\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. -.ds Ho added or removed .IP \fIhost\fP 1i -Specifies the host that is to be \*(Ho. -.ds Ho added or removed +Specifies the host that is to be added or removed. .IP \fIhosts\fP 1i -Specifies each host that is to be \*(Ho. +Specifies each host that is to be added or removed. .IP \fImode\fP 1i Specifies the mode. You can pass -.ZN EnableAccess +.B EnableAccess or -.ZN DisableAccess . +.BR DisableAccess . .IP \fInhosts_return\fP 1i Returns the number of hosts currently in the access control list. .IP \fInum_hosts\fP 1i @@ -149,163 +114,166 @@ Specifies the number of hosts. Returns the state of the access control. .SH DESCRIPTION The -.ZN XAddHost +.B XAddHost function adds the specified host to the access control list for that display. The server must be on the same host as the client issuing the command, or a -.ZN BadAccess +.B BadAccess error results. .LP -.ZN XAddHost +.B XAddHost can generate -.ZN BadAccess +.B BadAccess and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XAddHosts +.B XAddHosts function adds each specified host to the access control list for that display. The server must be on the same host as the client issuing the command, or a -.ZN BadAccess +.B BadAccess error results. .LP -.ZN XAddHosts +.B XAddHosts can generate -.ZN BadAccess +.B BadAccess and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XListHosts -function returns the current access control list as well as whether the use +.B XListHosts +function returns the current access control list as well as whether the use of the list at connection setup was enabled or disabled. -.ZN XListHosts +.B XListHosts allows a program to find out what machines can make connections. It also returns a pointer to a list of host structures that -were allocated by the function. +were allocated by the function. When no longer needed, this memory should be freed by calling -.ZN XFree . +.BR XFree . .LP The -.ZN XRemoveHost -function removes the specified host from the access control list +.B XRemoveHost +function removes the specified host from the access control list for that display. The server must be on the same host as the client process, or a -.ZN BadAccess +.B BadAccess error results. If you remove your machine from the access list, you can no longer connect to that server, and this operation cannot be reversed unless you reset the server. .LP -.ZN XRemoveHost +.B XRemoveHost can generate -.ZN BadAccess +.B BadAccess and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XRemoveHosts -function removes each specified host from the access control list for that -display. +.B XRemoveHosts +function removes each specified host from the access control list for that +display. The X server must be on the same host as the client process, or a -.ZN BadAccess +.B BadAccess error results. -If you remove your machine from the access list, +If you remove your machine from the access list, you can no longer connect to that server, and this operation cannot be reversed unless you reset the server. .LP -.ZN XRemoveHosts +.B XRemoveHosts can generate -.ZN BadAccess +.B BadAccess and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetAccessControl -function either enables or disables the use of the access control list +.B XSetAccessControl +function either enables or disables the use of the access control list at each connection setup. .LP -.ZN XSetAccessControl +.B XSetAccessControl can generate -.ZN BadAccess +.B BadAccess and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XEnableAccessControl +.B XEnableAccessControl function enables the use of the access control list at each connection setup. .LP -.ZN XEnableAccessControl +.B XEnableAccessControl can generate a -.ZN BadAccess +.B BadAccess error. .LP The -.ZN XDisableAccessControl +.B XDisableAccessControl function disables the use of the access control list at each connection setup. .LP -.ZN XDisableAccessControl +.B XDisableAccessControl can generate a -.ZN BadAccess +.B BadAccess error. .SH STRUCTURES The -.ZN XHostAddress +.B XHostAddress structure contains: .LP -.Ds 0 +.EX typedef struct { int family; /\&* for example FamilyInternet */ int length; /\&* length of address, in bytes */ char *address; /\&* pointer to where to find the address */ } XHostAddress; -.De +.EE .LP -The family member specifies which protocol address family to use +The family member specifies which protocol address family to use (for example, TCP/IP or DECnet) and can be -.ZN FamilyInternet , -.ZN FamilyInternet6 , -.ZN FamilyServerInterpreted , -.ZN FamilyDECnet , +.BR FamilyInternet , +.BR FamilyInternet6 , +.BR FamilyServerInterpreted , +.BR FamilyDECnet , or -.ZN FamilyChaos . +.BR FamilyChaos . The length member specifies the length of the address in bytes. The address member specifies a pointer to the address. .LP -For the ServerInterpreted family, the length is ignored and the address -member is a pointer to a -.ZN XServerInterpretedAddress +For the ServerInterpreted family, the length is ignored and the address +member is a pointer to a +.B XServerInterpretedAddress structure which contains: .LP -.Ds 0 +.EX typedef struct { int typelength; /\&* length of type string, in bytes */ int valuelength; /\&* length of value string, in bytes */ char *type; /\&* pointer to where to find the type string */ char *value; /\&* pointer to where to find the address */ } XServerInterpretedAddress; -.De +.EE .LP The type and value members point to strings representing the type and value of -the server interpreted entry. These strings may not be NULL-terminated so care -should be used when accessing them. The typelength and valuelength members +the server interpreted entry. +These strings may not be NULL-terminated so care +should be used when accessing them. +The typelength and valuelength members specify the length in byte of the type and value strings. .SH DIAGNOSTICS .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to modify the access control list from other than the local (or otherwise authorized) host. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XFree(__libmansuffix__) diff --git a/lib/libX11/man/XAllocClassHint.man b/lib/libX11/man/XAllocClassHint.man index 34d0ce778..6fd0214f2 100644 --- a/lib/libX11/man/XAllocClassHint.man +++ b/lib/libX11/man/XAllocClassHint.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XAllocClassHint __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XAllocClassHint, XSetClassHint, XGetClassHint, XClassHint \- allocate class hints structure and set or read a window's WM_CLASS property @@ -93,45 +60,45 @@ Status XGetClassHint\^(\^Display *\fIdisplay\fP, Window \fIw\fP, XClassHint *\fI Specifies the connection to the X server. .IP \fIclass_hints\fP 1i Specifies the -.ZN XClassHint +.B XClassHint structure that is to be used. .IP \fIclass_hints_return\fP 1i -Returns the -.ZN XClassHint +Returns the +.B XClassHint structure. .IP \fIw\fP 1i Specifies the window. .SH DESCRIPTION The -.ZN XAllocClassHint +.B XAllocClassHint function allocates and returns a pointer to a -.ZN XClassHint +.B XClassHint structure. Note that the pointer fields in the -.ZN XClassHint +.B XClassHint structure are initially set to NULL. -If insufficient memory is available, -.ZN XAllocClassHint +If insufficient memory is available, +.B XAllocClassHint returns NULL. To free the memory allocated to this structure, use -.ZN XFree . +.BR XFree . .LP The -.ZN XSetClassHint +.B XSetClassHint function sets the class hint for the specified window. If the strings are not in the Host Portable Character Encoding, the result is implementation-dependent. .LP -.ZN XSetClassHint +.B XSetClassHint can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetClassHint +.B XGetClassHint function returns the class hint of the specified window to the members of the supplied structure. If the data returned by the server is in the Latin Portable Character Encoding, @@ -141,12 +108,12 @@ It returns a nonzero status on success; otherwise, it returns a zero status. To free res_name and res_class when finished with the strings, use -.ZN XFree +.B XFree on each individually. .LP -.ZN XGetClassHint +.B XGetClassHint can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -155,34 +122,35 @@ Set by application programs to allow window and session managers to obtain the application's resources from the resource database. .SH STRUCTURES The -.ZN XClassHint +.B XClassHint structure contains: .LP .IN "XClassHint" "" "@DEF@" -.Ds 0 +.EX typedef struct { char *res_name; char *res_class; } XClassHint; .LP -The res_name member contains the application name, -and the res_class member contains the application class. +The res_name member contains the application name, +and the res_class member contains the application class. Note that the name set in this property may differ from the name set as WM_NAME. That is, WM_NAME specifies what should be displayed in the title bar and, therefore, can contain temporal information (for example, the name of a file currently in an editor's buffer). -On the other hand, +On the other hand, the name specified as part of WM_CLASS is the formal name of the application -that should be used when retrieving the application's resources from the +that should be used when retrieving the application's resources from the resource database. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" +.na XAllocIconSize(__libmansuffix__), XAllocSizeHints(__libmansuffix__), XAllocWMHints(__libmansuffix__), diff --git a/lib/libX11/man/XAllocColor.man b/lib/libX11/man/XAllocColor.man index 7b21b5639..d7ff5e986 100644 --- a/lib/libX11/man/XAllocColor.man +++ b/lib/libX11/man/XAllocColor.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" e .TH XAllocColor __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME @@ -106,7 +73,7 @@ unsigned long *\fIgmask_return\fP\^, unsigned long *\fIbmask_return\fP\^); int XFreeColors\^(\^Display *\fIdisplay\fP, Colormap \fIcolormap\fP\^, unsigned long \fIpixels\fP\^[\^], int \fInpixels\fP\^, unsigned long \fIplanes\fP\^); .IP \fIcolor_name\fP 1i -Specifies the color name string (for example, red) whose color +Specifies the color name string (for example, red) whose color definition structure you want returned. .IP \fIcolormap\fP 1i Specifies the colormap. @@ -117,13 +84,13 @@ Specifies the connection to the X server. .IP \fIexact_def_return\fP 1i Returns the exact RGB values. .IP \fIncolors\fP 1i -Specifies the number of pixel values that are to be returned in the -pixels_return array. +Specifies the number of pixel values that are to be returned in the +pixels_return array. .IP \fInpixels\fP 1i -Specifies the number of pixels. +Specifies the number of pixels. .IP \fInplanes\fP 1i -Specifies the number of plane masks that are to be returned in the plane masks -array. +Specifies the number of plane masks that are to be returned in the plane masks +array. .IP \fInreds\fP 1i .br .ns @@ -134,11 +101,11 @@ array. .br .ns Specify the number of red, green, and blue planes. -The value you pass must be nonnegative. +The value you pass must be nonnegative. .IP \fIpixels\fP 1i -Specifies an array of pixel values. +Specifies an array of pixel values. .IP \fIpixels_return\fP 1i -Returns an array of pixel values. +Returns an array of pixel values. .IP \fIplane_mask_return\fP 1i Returns an array of plane masks. .\" *** JIM: NEED MORE INFO FOR THIS. *** @@ -158,16 +125,16 @@ Returns the closest RGB values provided by the hardware. Specifies and returns the values actually used in the colormap. .SH DESCRIPTION The -.ZN XAllocColor +.B XAllocColor function allocates a read-only colormap entry corresponding to the closest RGB value supported by the hardware. -.ZN XAllocColor +.B XAllocColor returns the pixel value of the color closest to the specified RGB elements supported by the hardware and returns the RGB value actually used. The corresponding colormap cell is read-only. In addition, -.ZN XAllocColor +.B XAllocColor returns nonzero if it succeeded or zero if it failed. .IN "Color map" .IN "Color" "allocation" @@ -176,50 +143,50 @@ returns nonzero if it succeeded or zero if it failed. Multiple clients that request the same effective RGB value can be assigned the same read-only entry, thus allowing entries to be shared. When the last client deallocates a shared cell, it is deallocated. -.ZN XAllocColor +.B XAllocColor does not use or affect the flags in the -.ZN XColor +.B XColor structure. .LP -.ZN XAllocColor +.B XAllocColor can generate a -.ZN BadColor +.B BadColor error. .LP The -.ZN XAllocNamedColor +.B XAllocNamedColor function looks up the named color with respect to the screen that is associated with the specified colormap. It returns both the exact database definition and the closest color supported by the screen. The allocated color cell is read-only. The pixel value is returned in screen_def_return. -If the color name is not in the Host Portable Character Encoding, +If the color name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. If screen_def_return and exact_def_return point to the same structure, the pixel field will be set correctly, but the color values are undefined. -.ZN XAllocNamedColor +.B XAllocNamedColor returns nonzero if a cell is allocated; otherwise, it returns zero. .LP -.ZN XAllocNamedColor +.B XAllocNamedColor can generate a -.ZN BadColor +.B BadColor error. .LP .EQ delim %% .EN The -.ZN XAllocColorCells +.B XAllocColorCells function allocates read/write color cells. The number of colors must be positive and the number of planes nonnegative, or a -.ZN BadValue +.B BadValue error results. -If ncolors and nplanes are requested, +If ncolors and nplanes are requested, then ncolors pixels and nplane plane masks are returned. No mask will have any bits set to 1 in common with @@ -228,107 +195,107 @@ By ORing together each pixel with zero or more masks, ncolors * %2 sup nplanes% distinct pixels can be produced. All of these are allocated writable by the request. -For -.ZN GrayScale -or -.ZN PseudoColor , -each mask has exactly one bit set to 1. -For -.ZN DirectColor , +For +.B GrayScale +or +.BR PseudoColor , +each mask has exactly one bit set to 1. +For +.BR DirectColor , each has exactly three bits set to 1. -If contig is -.ZN True +If contig is +.B True and if all masks are ORed -together, a single contiguous set of bits set to 1 will be formed for -.ZN GrayScale -or -.ZN PseudoColor +together, a single contiguous set of bits set to 1 will be formed for +.B GrayScale +or +.B PseudoColor and three contiguous sets of bits set to 1 (one within each -pixel subfield) for -.ZN DirectColor . +pixel subfield) for +.BR DirectColor . The RGB values of the allocated entries are undefined. -.ZN XAllocColorCells +.B XAllocColorCells returns nonzero if it succeeded or zero if it failed. .LP -.ZN XAllocColorCells +.B XAllocColorCells can generate -.ZN BadColor +.B BadColor and -.ZN BadValue +.B BadValue errors. .LP .EQ delim %% .EN -The specified ncolors must be positive; +The specified ncolors must be positive; and nreds, ngreens, and nblues must be nonnegative, or a -.ZN BadValue +.B BadValue error results. -If ncolors colors, nreds reds, ngreens greens, and nblues blues are requested, -ncolors pixels are returned; and the masks have nreds, ngreens, and +If ncolors colors, nreds reds, ngreens greens, and nblues blues are requested, +ncolors pixels are returned; and the masks have nreds, ngreens, and nblues bits set to 1, respectively. -If contig is -.ZN True , +If contig is +.BR True , each mask will have a contiguous set of bits set to 1. No mask will have any bits set to 1 in common with any other mask or with any of the pixels. -For -.ZN DirectColor , +For +.BR DirectColor , each mask will lie within the corresponding pixel subfield. By ORing together -subsets of masks with each pixel value, -ncolors * %2 sup (nreds+ngreens+nblues)% distinct pixel values can be produced. +subsets of masks with each pixel value, +ncolors * %2 sup (nreds+ngreens+nblues)% distinct pixel values can be produced. All of these are allocated by the request. However, in the -colormap, there are only ncolors * %2 sup nreds% independent red entries, -ncolors * %2 sup ngreens% independent green entries, -and ncolors * %2 sup nblues% independent blue entries. -This is true even for -.ZN PseudoColor . +colormap, there are only ncolors * %2 sup nreds% independent red entries, +ncolors * %2 sup ngreens% independent green entries, +and ncolors * %2 sup nblues% independent blue entries. +This is true even for +.BR PseudoColor . When the colormap entry of a pixel -value is changed (using -.ZN XStoreColors , -.ZN XStoreColor , -or -.ZN XStoreNamedColor ), -the pixel is decomposed according to the masks, +value is changed (using +.BR XStoreColors , +.BR XStoreColor , +or +.BR XStoreNamedColor ), +the pixel is decomposed according to the masks, and the corresponding independent entries are updated. -.ZN XAllocColorPlanes +.B XAllocColorPlanes returns nonzero if it succeeded or zero if it failed. .LP -.ZN XAllocColorPlanes +.B XAllocColorPlanes can generate -.ZN BadColor +.B BadColor and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XFreeColors +.B XFreeColors function frees the cells represented by pixels whose values are in the pixels array. The planes argument should not have any bits set to 1 in common with any of the -pixels. +pixels. The set of all pixels is produced by ORing together subsets of the planes argument with the pixels. The request frees all of these pixels that -were allocated by the client (using +were allocated by the client (using .IN XAllocColor .IN XAllocNamedColor .IN XAllocColorCells .IN XAllocColorPlanes -.ZN XAllocColor , -.ZN XAllocNamedColor , -.ZN XAllocColorCells , -and -.ZN XAllocColorPlanes ). +.BR XAllocColor , +.BR XAllocNamedColor , +.BR XAllocColorCells , +and +.BR XAllocColorPlanes ). Note that freeing an -individual pixel obtained from -.ZN XAllocColorPlanes +individual pixel obtained from +.B XAllocColorPlanes may not actually allow it to be reused until all of its related pixels are also freed. Similarly, @@ -337,50 +304,51 @@ and if a client allocates the same read-only entry multiple times, it must free the entry that many times before the entry is actually freed. .LP All specified pixels that are allocated by the client in the colormap are -freed, even if one or more pixels produce an error. -If a specified pixel is not a valid index into the colormap, a -.ZN BadValue +freed, even if one or more pixels produce an error. +If a specified pixel is not a valid index into the colormap, a +.B BadValue error results. If a specified pixel is not allocated by the client (that is, is unallocated or is only allocated by another client) or if the colormap was created with all entries writable (by passing -.ZN AllocAll +.B AllocAll to -.ZN XCreateColormap ), +.BR XCreateColormap ), a -.ZN BadAccess -error results. -If more than one pixel is in error, +.B BadAccess +error results. +If more than one pixel is in error, the one that gets reported is arbitrary. .LP -.ZN XFreeColors +.B XFreeColors can generate -.ZN BadAccess , -.ZN BadColor , +.BR BadAccess , +.BR BadColor , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to free a color map entry that it did not already allocate. .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to store into a read-only color map entry. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" -XCreateColormap(__libmansuffix__), +XCreateColormap(__libmansuffix__), XQueryColor(__libmansuffix__), -XStoreColors(__libmansuffix__) +XStoreColors(__libmansuffix__) .br \fI\*(xL\fP diff --git a/lib/libX11/man/XAllocIconSize.man b/lib/libX11/man/XAllocIconSize.man index c8b9087fa..ae5162ff2 100644 --- a/lib/libX11/man/XAllocIconSize.man +++ b/lib/libX11/man/XAllocIconSize.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XAllocIconSize __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XAllocIconSize, XSetIconSizes, XGetIconSizes, XIconSize \- allocate icon size structure and set or read a window's WM_ICON_SIZES property @@ -104,80 +71,80 @@ Returns the size list. Specifies the window. .SH DESCRIPTION The -.ZN XAllocIconSize +.B XAllocIconSize function allocates and returns a pointer to a -.ZN XIconSize +.B XIconSize structure. Note that all fields in the -.ZN XIconSize +.B XIconSize structure are initially set to zero. -If insufficient memory is available, -.ZN XAllocIconSize +If insufficient memory is available, +.B XAllocIconSize returns NULL. To free the memory allocated to this structure, use -.ZN XFree . +.BR XFree . .LP The -.ZN XSetIconSizes +.B XSetIconSizes function is used only by window managers to set the supported icon sizes. .LP -.ZN XSetIconSizes +.B XSetIconSizes can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetIconSizes +.B XGetIconSizes function returns zero if a window manager has not set icon sizes; otherwise, it return nonzero. -.ZN XGetIconSizes +.B XGetIconSizes should be called by an application that wants to find out what icon sizes would be most appreciated by the window manager under which the application is running. The application should then use -.ZN XSetWMHints +.B XSetWMHints to supply the window manager with an icon pixmap or window in one of the supported sizes. To free the data allocated in size_list_return, use -.ZN XFree . +.BR XFree . .LP -.ZN XGetIconSizes +.B XGetIconSizes can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i \s-1WM_ICON_SIZES\s+1 The window manager may set this property on the root window to specify the icon sizes it supports. -The C type of this property is -.ZN XIconSize . +The C type of this property is +.BR XIconSize . .SH STRUCTURES The -.ZN XIconSize +.B XIconSize structure contains: .LP .IN "XIconSize" "" "@DEF@" -.Ds 0 +.EX typedef struct { int min_width, min_height; int max_width, max_height; int width_inc, height_inc; } XIconSize; -.De +.EE .LP The width_inc and height_inc members define an arithmetic progression of sizes (minimum to maximum) that represent the supported icon sizes. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/lib/libX11/man/XAllocSizeHints.man b/lib/libX11/man/XAllocSizeHints.man index 9c01736fd..986976cb3 100644 --- a/lib/libX11/man/XAllocSizeHints.man +++ b/lib/libX11/man/XAllocSizeHints.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface -.ds xL Xlib \- C Language X Interface, \fRO'Reilly and Associates, +.ds xL Xlib \- C Language X Interface, \fRO'Reilly and Associates, .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XAllocSizeHints __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME @@ -104,7 +71,7 @@ Specifies the connection to the X server. Specifies the size hints for the window in its normal state. .IP \fIhints\fP 1i Specifies the -.ZN XSizeHints +.B XSizeHints structure to be used. .IP \fIhints_return\fP 1i Returns the size hints for the window in its normal state. @@ -116,158 +83,159 @@ Returns the hints that were supplied by the user. Specifies the window. .SH DESCRIPTION The -.ZN XAllocSizeHints +.B XAllocSizeHints function allocates and returns a pointer to a -.ZN XSizeHints +.B XSizeHints structure. Note that all fields in the -.ZN XSizeHints +.B XSizeHints structure are initially set to zero. -If insufficient memory is available, -.ZN XAllocSizeHints +If insufficient memory is available, +.B XAllocSizeHints returns NULL. To free the memory allocated to this structure, use -.ZN XFree . +.BR XFree . .LP -The -.ZN XSetWMNormalHints -function replaces the size hints for the WM_NORMAL_HINTS property +The +.B XSetWMNormalHints +function replaces the size hints for the WM_NORMAL_HINTS property on the specified window. If the property does not already exist, -.ZN XSetWMNormalHints +.B XSetWMNormalHints sets the size hints for the WM_NORMAL_HINTS property on the specified window. The property is stored with a type of WM_SIZE_HINTS and a format of 32. .LP -.ZN XSetWMNormalHints +.B XSetWMNormalHints can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP -The -.ZN XGetWMNormalHints -function returns the size hints stored in the WM_NORMAL_HINTS property +The +.B XGetWMNormalHints +function returns the size hints stored in the WM_NORMAL_HINTS property on the specified window. If the property is of type WM_SIZE_HINTS, is of format 32, -and is long enough to contain either an old (pre-ICCCM) -or new size hints structure, -.ZN XGetWMNormalHints -sets the various fields of the -.ZN XSizeHints -structure, sets the supplied_return argument to the list of fields +and is long enough to contain either an old (pre-ICCCM) +or new size hints structure, +.B XGetWMNormalHints +sets the various fields of the +.B XSizeHints +structure, sets the supplied_return argument to the list of fields that were supplied by the user (whether or not they contained defined values), and returns a nonzero status. Otherwise, it returns a zero status. .LP -If -.ZN XGetWMNormalHints -returns successfully and a pre-ICCCM size hints property is read, +If +.B XGetWMNormalHints +returns successfully and a pre-ICCCM size hints property is read, the supplied_return argument will contain the following bits: .LP -.Ds +.EX (USPosition|USSize|PPosition|PSize|PMinSize| PMaxSize|PResizeInc|PAspect) -.De +.EE .LP -If the property is large enough to contain the base size -and window gravity fields as well, +If the property is large enough to contain the base size +and window gravity fields as well, the supplied_return argument will also contain the following bits: .LP -.Ds +.EX PBaseSize|PWinGravity -.De +.EE .LP -.ZN XGetWMNormalHints +.B XGetWMNormalHints can generate a PN BadWindow error. .LP -The -.ZN XSetWMSizeHints -function replaces the size hints for the specified property +The +.B XSetWMSizeHints +function replaces the size hints for the specified property on the named window. If the specified property does not already exist, -.ZN XSetWMSizeHints +.B XSetWMSizeHints sets the size hints for the specified property on the named window. The property is stored with a type of WM_SIZE_HINTS and a format of 32. -To set a window's normal size hints, -you can use the -.ZN XSetWMNormalHints +To set a window's normal size hints, +you can use the +.B XSetWMNormalHints function. .LP -.ZN XSetWMSizeHints +.B XSetWMSizeHints can generate -.ZN BadAlloc , -.ZN BadAtom , +.BR BadAlloc , +.BR BadAtom , and -.ZN BadWindow +.B BadWindow errors. .LP -The -.ZN XGetWMSizeHints -function returns the size hints stored in the specified property +The +.B XGetWMSizeHints +function returns the size hints stored in the specified property on the named window. -If the property is of type WM_SIZE_HINTS, is of format 32, -and is long enough to contain either an old (pre-ICCCM) -or new size hints structure, -.ZN XGetWMSizeHints -sets the various fields of the -.ZN XSizeHints +If the property is of type WM_SIZE_HINTS, is of format 32, +and is long enough to contain either an old (pre-ICCCM) +or new size hints structure, +.B XGetWMSizeHints +sets the various fields of the +.B XSizeHints structure, sets the supplied_return argument to the -list of fields that were supplied by the user -(whether or not they contained defined values), +list of fields that were supplied by the user +(whether or not they contained defined values), and returns a nonzero status. Otherwise, it returns a zero status. -To get a window's normal size hints, -you can use the -.ZN XGetWMNormalHints +To get a window's normal size hints, +you can use the +.B XGetWMNormalHints function. .LP -If -.ZN XGetWMSizeHints -returns successfully and a pre-ICCCM size hints property is read, +If +.B XGetWMSizeHints +returns successfully and a pre-ICCCM size hints property is read, the supplied_return argument will contain the following bits: .LP -.Ds +.EX (USPosition|USSize|PPosition|PSize|PMinSize| PMaxSize|PResizeInc|PAspect) -.De +.EE .LP -If the property is large enough to contain the base size -and window gravity fields as well, +If the property is large enough to contain the base size +and window gravity fields as well, the supplied_return argument will also contain the following bits: .LP -.Ds +.EX PBaseSize|PWinGravity -.De +.EE .LP -.ZN XGetWMSizeHints +.B XGetWMSizeHints can generate -.ZN BadAtom +.B BadAtom and -.ZN BadWindow +.B BadWindow errors. .SH PROPERTIES .TP 1i \s-1WM_NORMAL_HINTS\s+1 Size hints for a window in its normal state. The C type of this property is -.ZN XSizeHints . +.BR XSizeHints . .SH STRUCTURES The -.ZN XSizeHints +.B XSizeHints structure contains: .LP +.na /\&* Size hints mask bits */ .TS -lw(.5i) lw(1.1i) lw(1.5i) lw(3.1i). +lw(.4i) lw(1.0i) lw(1.1i) lw(2.8i). T{ \&#define T} T{ -.ZN USPosition +.B USPosition T} T{ (1L << 0) T} T{ @@ -276,7 +244,7 @@ T} T{ \&#define T} T{ -.ZN USSize +.B USSize T} T{ (1L << 1) T} T{ @@ -285,7 +253,7 @@ T} T{ \&#define T} T{ -.ZN PPosition +.B PPosition T} T{ (1L << 2) T} T{ @@ -294,7 +262,7 @@ T} T{ \&#define T} T{ -.ZN PSize +.B PSize T} T{ (1L << 3) T} T{ @@ -303,7 +271,7 @@ T} T{ \&#define T} T{ -.ZN PMinSize +.B PMinSize T} T{ (1L << 4) T} T{ @@ -312,7 +280,7 @@ T} T{ \&#define T} T{ -.ZN PMaxSize +.B PMaxSize T} T{ (1L << 5) T} T{ @@ -321,7 +289,7 @@ T} T{ \&#define T} T{ -.ZN PResizeInc +.B PResizeInc T} T{ (1L << 6) T} T{ @@ -330,7 +298,7 @@ T} T{ \&#define T} T{ -.ZN PAspect +.B PAspect T} T{ (1L << 7) T} T{ @@ -339,32 +307,39 @@ T} T{ \&#define T} T{ -.ZN PBaseSize +.B PBaseSize T} T{ (1L << 8) T} T{ \&#define T} T{ -.ZN PWinGravity +.B PWinGravity T} T{ (1L << 9) T} T{ \&#define T} T{ -.ZN PAllHints +.B PAllHints T} T{ -(PPosition|PSize| +(PPosition| +.br + PSize| +.br + PMinSize| +.br + PMaxSize| .br -PMinSize|PMaxSize| + PResizeInc| .br -PResizeInc|PAspect) + PAspect) T} T{ T} .TE +.ad .IN "XSizeHints" "" "@DEF@" -.Ds 0 +.EX /\&* Values */ typedef struct { @@ -382,7 +357,7 @@ typedef struct { int win_gravity; /\&* this structure may be extended in the future */ } XSizeHints; -.De +.EE .LP The x, y, width, and height members are now obsolete and are left solely for compatibility reasons. @@ -392,33 +367,33 @@ The max_width and max_height members specify the maximum window size. The width_inc and height_inc members define an arithmetic progression of sizes (minimum to maximum) into which the window prefers to be resized. The min_aspect and max_aspect members are expressed -as ratios of x and y, +as ratios of x and y, and they allow an application to specify the range of aspect ratios it prefers. The base_width and base_height members define the desired size of the window. -The window manager will interpret the position of the window -and its border width to position the point of the outer rectangle +The window manager will interpret the position of the window +and its border width to position the point of the outer rectangle of the overall window specified by the win_gravity member. The outer rectangle of the window includes any borders or decorations supplied by the window manager. In other words, if the window manager decides to place the window where the client asked, -the position on the parent window's border named by the win_gravity -will be placed where the client window would have been placed +the position on the parent window's border named by the win_gravity +will be placed where the client window would have been placed in the absence of a window manager. .LP Note that use of the -.ZN PAllHints +.B PAllHints macro is highly discouraged. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/lib/libX11/man/XAllocStandardColormap.man b/lib/libX11/man/XAllocStandardColormap.man index 13cab682e..f042b14d9 100644 --- a/lib/libX11/man/XAllocStandardColormap.man +++ b/lib/libX11/man/XAllocStandardColormap.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XAllocStandardColormap __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME @@ -97,44 +64,42 @@ Atom \fIproperty\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. -.ds Cn colormaps .IP \fIcount\fP 1i -Specifies the number of \*(Cn. -.ds Cn colormaps +Specifies the number of colormaps. .IP \fIcount_return\fP 1i -Returns the number of \*(Cn. +Returns the number of colormaps. .IP \fIproperty\fP 1i Specifies the property name. .IP \fIstd_colormap\fP 1i Specifies the -.ZN XStandardColormap +.B XStandardColormap structure to be used. .IP \fIstd_colormap_return\fP 1i Returns the -.ZN XStandardColormap +.B XStandardColormap structure. .SH DESCRIPTION The -.ZN XAllocStandardColormap +.B XAllocStandardColormap function allocates and returns a pointer to a -.ZN XStandardColormap +.B XStandardColormap structure. Note that all fields in the -.ZN XStandardColormap +.B XStandardColormap structure are initially set to zero. -If insufficient memory is available, -.ZN XAllocStandardColormap +If insufficient memory is available, +.B XAllocStandardColormap returns NULL. To free the memory allocated to this structure, use -.ZN XFree . +.BR XFree . .LP -The -.ZN XSetRGBColormaps -function replaces the RGB colormap definition in the specified property +The +.B XSetRGBColormaps +function replaces the RGB colormap definition in the specified property on the named window. If the property does not already exist, -.ZN XSetRGBColormaps +.B XSetRGBColormaps sets the RGB colormap definition in the specified property on the named window. The property is stored with a type of RGB_COLOR_MAP and a format of 32. @@ -142,9 +107,9 @@ Note that it is the caller's responsibility to honor the ICCCM restriction that only RGB_DEFAULT_MAP contain more than one definition. .LP The -.ZN XSetRGBColormaps +.B XSetRGBColormaps function usually is only used by window or session managers. -To create a standard colormap, +To create a standard colormap, follow this procedure: .IP 1. 5 Open a new connection to the same server. @@ -161,64 +126,64 @@ Create a colormap (unless you are using the default colormap of the screen). Determine the color characteristics of the visual. .IP \(bu 5 Allocate cells in the colormap (or create it with -.ZN AllocAll ). +.BR AllocAll ). .IP \(bu 5 -Call -.ZN XStoreColors +Call +.B XStoreColors to store appropriate color values in the colormap. .IP \(bu 5 -Fill in the descriptive members in the -.ZN XStandardColormap +Fill in the descriptive members in the +.B XStandardColormap structure. .IP \(bu 5 Attach the property to the root window. .IP \(bu 5 Use -.ZN XSetCloseDownMode +.B XSetCloseDownMode to make the resource permanent. .RE .IP 5. 5 Ungrab the server. .LP -.ZN XSetRGBColormaps +.B XSetRGBColormaps can generate -.ZN BadAlloc , -.ZN BadAtom , +.BR BadAlloc , +.BR BadAtom , and -.ZN BadWindow +.B BadWindow errors. .LP -The -.ZN XGetRGBColormaps -function returns the RGB colormap definitions stored +The +.B XGetRGBColormaps +function returns the RGB colormap definitions stored in the specified property on the named window. -If the property exists, is of type RGB_COLOR_MAP, is of format 32, +If the property exists, is of type RGB_COLOR_MAP, is of format 32, and is long enough to contain a colormap definition, -.ZN XGetRGBColormaps +.B XGetRGBColormaps allocates and fills in space for the returned colormaps and returns a nonzero status. -If the visualid is not present, -.ZN XGetRGBColormaps -assumes the default visual for the screen on which the window is located; -if the killid is not present, -.ZN None +If the visualid is not present, +.B XGetRGBColormaps +assumes the default visual for the screen on which the window is located; +if the killid is not present, +.B None is assumed, which indicates that the resources cannot be released. -Otherwise, -none of the fields are set, and -.ZN XGetRGBColormaps +Otherwise, +none of the fields are set, and +.B XGetRGBColormaps returns a zero status. Note that it is the caller's responsibility to honor the ICCCM restriction that only RGB_DEFAULT_MAP contain more than one definition. .LP -.ZN XGetRGBColormaps +.B XGetRGBColormaps can generate -.ZN BadAtom +.B BadAtom and -.ZN BadWindow +.B BadWindow errors. .SH STRUCTURES The -.ZN XStandardColormap +.B XStandardColormap structure contains: .LP /\&* Hints */ @@ -227,14 +192,14 @@ lw(.5i) lw(2i) lw(1i). T{ \&#define T} T{ -.ZN ReleaseByFreeingColormap +.B ReleaseByFreeingColormap T} T{ ( (XID) 1L) T} .TE /\&* Values */ .IN "XStandardColormap" "" "@DEF@" -.Ds 0 +.EX typedef struct { Colormap colormap; unsigned long red_max; @@ -247,56 +212,56 @@ typedef struct { VisualID visualid; XID killid; } XStandardColormap; -.De +.EE .LP The colormap member is the colormap created by the -.ZN XCreateColormap +.B XCreateColormap function. The red_max, green_max, and blue_max members give the maximum -red, green, and blue values, respectively. -Each color coefficient ranges from zero to its max, inclusive. +red, green, and blue values, respectively. +Each color coefficient ranges from zero to its max, inclusive. For example, a common colormap allocation is 3/3/2 (3 planes for red, 3 -planes for green, and 2 planes for blue). -This colormap would have red_max = 7, green_max = 7, -and blue_max = 3. -An alternate allocation that uses only 216 colors is red_max = 5, +planes for green, and 2 planes for blue). +This colormap would have red_max = 7, green_max = 7, +and blue_max = 3. +An alternate allocation that uses only 216 colors is red_max = 5, green_max = 5, and blue_max = 5. .LP The red_mult, green_mult, and blue_mult members give the -scale factors used to compose a full pixel value. +scale factors used to compose a full pixel value. (See the discussion of the base_pixel members for further information.) For a 3/3/2 allocation, red_mult might be 32, -green_mult might be 4, and blue_mult might be 1. -For a 6-colors-each allocation, red_mult might be 36, +green_mult might be 4, and blue_mult might be 1. +For a 6-colors-each allocation, red_mult might be 36, green_mult might be 6, and blue_mult might be 1. .LP The base_pixel member gives the base pixel value used to -compose a full pixel value. -Usually, the base_pixel is obtained from a call to the -.ZN XAllocColorPlanes -function. -Given integer red, green, and blue coefficients in their appropriate +compose a full pixel value. +Usually, the base_pixel is obtained from a call to the +.B XAllocColorPlanes +function. +Given integer red, green, and blue coefficients in their appropriate ranges, one then can compute a corresponding pixel value by using the following expression: .LP -.Ds +.EX (r * red_mult + g * green_mult + b * blue_mult + base_pixel) & 0xFFFFFFFF -.De +.EE .LP -For -.ZN GrayScale -colormaps, -only the colormap, red_max, red_mult, -and base_pixel members are defined. -The other members are ignored. -To compute a -.ZN GrayScale +For +.B GrayScale +colormaps, +only the colormap, red_max, red_mult, +and base_pixel members are defined. +The other members are ignored. +To compute a +.B GrayScale pixel value, use the following expression: .LP -.Ds +.EX (gray * red_mult + base_pixel) & 0xFFFFFFFF -.De +.EE .LP Negative multipliers can be represented by converting the 2's complement representation of the multiplier into an unsigned long and @@ -309,25 +274,25 @@ depending on the size of the integer type used to do the computation, The visualid member gives the ID number of the visual from which the colormap was created. The killid member gives a resource ID that indicates whether -the cells held by this standard colormap are to be released +the cells held by this standard colormap are to be released by freeing the colormap ID or by calling the -.ZN XKillClient +.B XKillClient function on the indicated resource. (Note that this method is necessary for allocating out of an existing colormap.) .LP -The properties containing the -.ZN XStandardColormap -information have +The properties containing the +.B XStandardColormap +information have the type RGB_COLOR_MAP. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocColor(__libmansuffix__), diff --git a/lib/libX11/man/XAllocWMHints.man b/lib/libX11/man/XAllocWMHints.man index f871c36e3..28d5954ad 100644 --- a/lib/libX11/man/XAllocWMHints.man +++ b/lib/libX11/man/XAllocWMHints.man @@ -39,53 +39,20 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface -.ds xL Xlib \- C Language X Interface, \fRO'Reilly and Associates, Sebastopol, 1991. +.ds xL Xlib \- C Language X Interface, \fRO'Reilly and Associates, Sebastopol, 1991. .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XAllocWMHints __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XAllocWMHints, XSetWMHints, XGetWMHints, XWMHints \- allocate window manager hints structure and set or read a window's WM_HINTS property .SH SYNTAX .HP -XWMHints *XAllocWMHints\^(void\^); +XWMHints *XAllocWMHints\^(void\^); .HP int XSetWMHints\^(\^Display *\fIdisplay\fP, Window \fIw\fP, XWMHints *\fIwmhints\fP\^); .HP @@ -96,137 +63,145 @@ Specifies the connection to the X server. .IP \fIw\fP 1i Specifies the window. .IP \fIwmhints\fP 1i -Specifies the -.ZN XWMHints +Specifies the +.B XWMHints structure to be used. .SH DESCRIPTION The -.ZN XAllocWMHints +.B XAllocWMHints function allocates and returns a pointer to a -.ZN XWMHints +.B XWMHints structure. Note that all fields in the -.ZN XWMHints +.B XWMHints structure are initially set to zero. -If insufficient memory is available, -.ZN XAllocWMHints +If insufficient memory is available, +.B XAllocWMHints returns NULL. To free the memory allocated to this structure, use -.ZN XFree . +.BR XFree . .LP The -.ZN XSetWMHints +.B XSetWMHints function sets the window manager hints that include icon information and location, the initial state of the window, and whether the application relies on the window manager to get keyboard input. .LP -.ZN XSetWMHints +.B XSetWMHints can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetWMHints -function reads the window manager hints and -returns NULL if no WM_HINTS property was set on the window -or returns a pointer to a -.ZN XWMHints +.B XGetWMHints +function reads the window manager hints and +returns NULL if no WM_HINTS property was set on the window +or returns a pointer to a +.B XWMHints structure if it succeeds. When finished with the data, free the space used for it by calling -.ZN XFree . +.BR XFree . .LP -.ZN XGetWMHints +.B XGetWMHints can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i \s-1WM_HINTS\s+1 Additional hints set by the client for use by the window manager. -The C type of this property is -.ZN XWMHints . +The C type of this property is +.BR XWMHints . .SH STRUCTURES The -.ZN XWMHints +.B XWMHints structure contains: .LP /\&* Window manager hints mask bits */ .TS -lw(.5i) lw(2.5i) lw(2.5i). +lw(.4i) lw(1.8i) lw(2.5i). T{ \&#define T} T{ -.ZN InputHint +.B InputHint T} T{ (1L << 0) T} T{ \&#define T} T{ -.ZN StateHint +.B StateHint T} T{ (1L << 1) T} T{ \&#define T} T{ -.ZN IconPixmapHint +.B IconPixmapHint T} T{ (1L << 2) T} T{ \&#define T} T{ -.ZN IconWindowHint +.B IconWindowHint T} T{ (1L << 3) T} T{ \&#define T} T{ -.ZN IconPositionHint +.B IconPositionHint T} T{ (1L << 4) T} T{ \&#define T} T{ -.ZN IconMaskHint +.B IconMaskHint T} T{ (1L << 5) T} T{ \&#define T} T{ -.ZN WindowGroupHint +.B WindowGroupHint T} T{ (1L << 6) T} T{ \&#define T} T{ -.ZN XUrgencyHint +.B XUrgencyHint T} T{ (1L << 8) T} T{ \&#define T} T{ -.ZN AllHints +.B AllHints T} T{ -(InputHint|StateHint|IconPixmapHint| +(InputHint| +.br + StateHint| +.br + IconPixmapHint| .br -IconWindowHint|IconPositionHint| + IconWindowHint| .br -IconMaskHint|WindowGroupHint) + IconPositionHint| +.br + IconMaskHint| +.br + WindowGroupHint) T} .TE .IN "XWMHints" "" "@DEF@" -.Ds 0 +.EX /\&* Values */ typedef struct { @@ -241,47 +216,47 @@ typedef struct { XID window_group; /\&* id of related window group */ /\&* this structure may be extended in the future */ } XWMHints; -.De +.EE .LP The input member is used to communicate to the window manager the input focus model used by the application. -Applications that expect input but never explicitly set focus to any -of their subwindows (that is, use the push model of focus management), +Applications that expect input but never explicitly set focus to any +of their subwindows (that is, use the push model of focus management), such as X Version 10 style applications that use real-estate -driven focus, should set this member to -.ZN True . +driven focus, should set this member to +.BR True . Similarly, applications that set input focus to their subwindows only when it is given to their -top-level window by a window manager should also set this member to -.ZN True . +top-level window by a window manager should also set this member to +.BR True . Applications that manage their own input focus by explicitly setting -focus to one of their subwindows whenever they want keyboard input -(that is, use the pull model of focus management) should set this member to -.ZN False . +focus to one of their subwindows whenever they want keyboard input +(that is, use the pull model of focus management) should set this member to +.BR False . Applications that never expect any keyboard input also should set this member -to -.ZN False . +to +.BR False . .LP Pull model window managers should make it possible for push model applications to get input by setting input focus to the top-level windows of -applications whose input member is -.ZN True . +applications whose input member is +.BR True . Push model window managers should -make sure that pull model applications do not break them -by resetting input focus to -.ZN PointerRoot +make sure that pull model applications do not break them +by resetting input focus to +.B PointerRoot when it is appropriate (for example, whenever an application whose -input member is -.ZN False +input member is +.B False sets input focus to one of its subwindows). .LP The definitions for the initial_state flag are: .TS -lw(.5i) lw(2i) lw(.2i) lw(2.8i). +lw(.3i) lw(1.5i) lw(.1i) lw(3.9i). T{ \&#define T} T{ -.ZN WithdrawnState +.B WithdrawnState T} T{ 0 T} T{ @@ -289,7 +264,7 @@ T} T{ \&#define T} T{ -.ZN NormalState +.B NormalState T} T{ 1 T} T{ @@ -298,7 +273,7 @@ T} T{ \&#define T} T{ -.ZN IconicState +.B IconicState T} T{ 3 T} T{ @@ -306,33 +281,35 @@ T} T{ T} .TE The icon_mask specifies which pixels of the icon_pixmap should be used as the -icon. +icon. This allows for nonrectangular icons. Both icon_pixmap and icon_mask must be bitmaps. The icon_window lets an application provide a window for use as an icon for window managers that support such use. The window_group lets you specify that this window belongs to a group of other windows. -For example, if a single application manipulates multiple +For example, if a single application manipulates multiple top-level windows, this allows you to provide enough information that a window manager can iconify all of the windows rather than just the one window. .LP The -.ZN UrgencyHint +.B UrgencyHint flag, if set in the flags field, indicates that the client deems the window -contents to be urgent, requiring the timely response of the user. The +contents to be urgent, requiring the timely response of the user. +The window manager will make some effort to draw the user's attention to this -window while this flag is set. The client must provide some means by which the +window while this flag is set. +The client must provide some means by which the user can cause the urgency flag to be cleared (either mitigating the condition that made the window urgent or merely shutting off the alarm) or the window to be withdrawn. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/lib/libX11/man/XAllowEvents.man b/lib/libX11/man/XAllowEvents.man index cecb0066f..3f1ee9ef8 100644 --- a/lib/libX11/man/XAllowEvents.man +++ b/lib/libX11/man/XAllowEvents.man @@ -38,91 +38,59 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XAllowEvents __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XAllowEvents \- release queued events .SH SYNTAX .HP int XAllowEvents\^(\^Display *\fIdisplay\fP, int \fIevent_mode\fP\^, -Time \fItime\fP\^); +Time \fItime\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIevent_mode\fP 1i Specifies the event mode. -You can pass -.ZN AsyncPointer , -.ZN SyncPointer , -.ZN AsyncKeyboard , -.ZN SyncKeyboard , -.ZN ReplayPointer , -.ZN ReplayKeyboard , -.ZN AsyncBoth , +You can pass +.BR AsyncPointer , +.BR SyncPointer , +.BR AsyncKeyboard , +.BR SyncKeyboard , +.BR ReplayPointer , +.BR ReplayKeyboard , +.BR AsyncBoth , or -.ZN SyncBoth . +.BR SyncBoth . .IP \fItime\fP 1i Specifies the time. You can pass either a timestamp or -.ZN CurrentTime . +.BR CurrentTime . .SH DESCRIPTION The -.ZN XAllowEvents -function releases some queued events if the client has caused a device +.B XAllowEvents +function releases some queued events if the client has caused a device to freeze. It has no effect if the specified time is earlier than the last-grab time of the most recent active grab for the client or if the specified time is later than the current X server time. .LP -.ZN XAllowEvents +.B XAllowEvents can generate a -.ZN BadValue +.B BadValue error. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" \fI\*(xL\fP diff --git a/lib/libX11/man/XAnyEvent.man b/lib/libX11/man/XAnyEvent.man index 651be4263..696f49927 100644 --- a/lib/libX11/man/XAnyEvent.man +++ b/lib/libX11/man/XAnyEvent.man @@ -38,54 +38,21 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XAnyEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XAnyEvent, XEvent \- generic X event structures .SH STRUCTURES -All the event structures declared in +All the event structures declared in .Pn < X11/Xlib.h > have the following common members: -.Ds 0 +.EX typedef struct { int type; unsigned long serial; /\&* # of last request processed by server */ @@ -93,21 +60,21 @@ typedef struct { Display *display; /\&* Display the event was read from */ Window window; } XAnyEvent; -.De +.EE .LP The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -115,9 +82,9 @@ The window member is set to the window that is most useful to toolkit dispatchers. .LP The -.ZN XEvent +.B XEvent structure is a union of the individual structures declared for each event type: -.Ds 0 +.EX typedef union _XEvent { int type; /\&* must not be changed */ XAnyEvent xany; @@ -153,17 +120,17 @@ typedef union _XEvent { XKeymapEvent xkeymap; long pad[24]; } XEvent; -.De +.EE .LP An -.ZN XEvent +.B XEvent structure's first entry always is the type member, which is set to the event type. The second member always is the serial number of the protocol request that generated the event. The third member always is send_event, which is a -.ZN Bool +.B Bool that indicates if the event was sent by a different client. The fourth member always is a display, which is the display that the event was read from. diff --git a/lib/libX11/man/XButtonEvent.man b/lib/libX11/man/XButtonEvent.man index 14a8bc6a7..a55544d9a 100644 --- a/lib/libX11/man/XButtonEvent.man +++ b/lib/libX11/man/XButtonEvent.man @@ -38,66 +38,33 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XButtonEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XButtonEvent, XKeyEvent, XMotionEvent \- KeyPress, KeyRelease, ButtonPress, ButtonRelease, and MotionNotify event structures .SH STRUCTURES The structures for -.ZN KeyPress , -.ZN KeyRelease , -.ZN ButtonPress , -.ZN ButtonRelease , +.BR KeyPress , +.BR KeyRelease , +.BR ButtonPress , +.BR ButtonRelease , and -.ZN MotionNotify +.B MotionNotify events contain: .LP -.Ds 0 +.EX typedef struct { int type; /\&* ButtonPress or ButtonRelease */ unsigned long serial; /\&* # of last request processed by server */ Bool send_event; /\&* true if this came from a SendEvent request */ Display *display; /\&* Display the event was read from */ - Window window; /\&* ``event'' window it is reported relative to */ + Window window; /\&* \*(lqevent\*(rq window it is reported relative to */ Window root; /\&* root window that the event occurred on */ Window subwindow; /\&* child window */ Time time; /\&* milliseconds */ @@ -109,15 +76,15 @@ typedef struct { } XButtonEvent; typedef XButtonEvent XButtonPressedEvent; typedef XButtonEvent XButtonReleasedEvent; -.De +.EE .LP -.Ds 0 +.EX typedef struct { int type; /\&* KeyPress or KeyRelease */ unsigned long serial; /\&* # of last request processed by server */ Bool send_event; /\&* true if this came from a SendEvent request */ Display *display; /\&* Display the event was read from */ - Window window; /\&* ``event'' window it is reported relative to */ + Window window; /\&* \*(lqevent\*(rq window it is reported relative to */ Window root; /\&* root window that the event occurred on */ Window subwindow; /\&* child window */ Time time; /\&* milliseconds */ @@ -129,15 +96,15 @@ typedef struct { } XKeyEvent; typedef XKeyEvent XKeyPressedEvent; typedef XKeyEvent XKeyReleasedEvent; -.De +.EE .LP -.Ds 0 +.EX typedef struct { int type; /\&* MotionNotify */ unsigned long serial; /\&* # of last request processed by server */ Bool send_event; /\&* true if this came from a SendEvent request */ Display *display; /\&* Display the event was read from */ - Window window; /\&* ``event'' window reported relative to */ + Window window; /\&* \*(lqevent\*(rq window reported relative to */ Window root; /\&* root window that the event occurred on */ Window subwindow; /\&* child window */ Time time; /\&* milliseconds */ @@ -148,7 +115,7 @@ typedef struct { Bool same_screen; /\&* same screen flag */ } XMotionEvent; typedef XMotionEvent XPointerMovedEvent; -.De +.EE .LP When you receive these events, their structure members are set as follows. @@ -156,16 +123,16 @@ their structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -175,89 +142,89 @@ dispatchers. These structures have the following common members: window, root, subwindow, time, x, y, x_root, y_root, state, and same_screen. The window member is set to the window on which the -event was generated and is referred to as the event window. +event was generated and is referred to as the event window. As long as the conditions previously discussed are met, this is the window used by the X server to report the event. The root member is set to the source window's root window. The x_root and y_root members are set to the pointer's coordinates relative to the root window's origin at the time of the event. .LP -The same_screen member is set to indicate whether the event +The same_screen member is set to indicate whether the event window is on the same screen as the root window and can be either -.ZN True +.B True or -.ZN False . +.BR False . If -.ZN True , +.BR True , the event and root windows are on the same screen. If -.ZN False , +.BR False , the event and root windows are not on the same screen. .LP -If the source window is an inferior of the event window, +If the source window is an inferior of the event window, the subwindow member of the structure is set to the child of the event window that is the source window or the child of the event window that is an ancestor of the source window. Otherwise, the X server sets the subwindow member to -.ZN None . -The time member is set to the time when the event was generated +.BR None . +The time member is set to the time when the event was generated and is expressed in milliseconds. .LP -If the event window is on the same screen as the root window, +If the event window is on the same screen as the root window, the x and y members are set to the coordinates relative to the event window's origin. Otherwise, these members are set to zero. .LP -The state member is set to indicate the logical state of the pointer buttons +The state member is set to indicate the logical state of the pointer buttons and modifier keys just prior to the event, which is the bitwise inclusive OR of one or more of the button or modifier key masks: -.ZN Button1Mask , -.ZN Button2Mask , -.ZN Button3Mask , -.ZN Button4Mask , -.ZN Button5Mask , -.ZN ShiftMask , -.ZN LockMask , -.ZN ControlMask , -.ZN Mod1Mask , -.ZN Mod2Mask , -.ZN Mod3Mask , -.ZN Mod4Mask , +.BR Button1Mask , +.BR Button2Mask , +.BR Button3Mask , +.BR Button4Mask , +.BR Button5Mask , +.BR ShiftMask , +.BR LockMask , +.BR ControlMask , +.BR Mod1Mask , +.BR Mod2Mask , +.BR Mod3Mask , +.BR Mod4Mask , and -.ZN Mod5Mask . +.BR Mod5Mask . .LP Each of these structures also has a member that indicates the detail. For the -.ZN XKeyPressedEvent +.B XKeyPressedEvent and -.ZN XKeyReleasedEvent +.B XKeyReleasedEvent structures, this member is called a keycode. It is set to a number that represents a physical key on the keyboard. The keycode is an arbitrary representation for any key on the keyboard (see sections 12.7 and 16.1). .LP For the -.ZN XButtonPressedEvent +.B XButtonPressedEvent and -.ZN XButtonReleasedEvent +.B XButtonReleasedEvent structures, this member is called button. It represents the pointer button that changed state and can be the -.ZN Button1 , -.ZN Button2 , -.ZN Button3 , -.ZN Button4 , +.BR Button1 , +.BR Button2 , +.BR Button3 , +.BR Button4 , or -.ZN Button5 +.B Button5 value. For the -.ZN XPointerMovedEvent +.B XPointerMovedEvent structure, this member is called is_hint. -It can be set to -.ZN NotifyNormal +It can be set to +.B NotifyNormal or -.ZN NotifyHint . +.BR NotifyHint . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XCreateWindowEvent(__libmansuffix__), diff --git a/lib/libX11/man/XChangeKeyboardControl.man b/lib/libX11/man/XChangeKeyboardControl.man index efaf0ee41..d1b1775b6 100644 --- a/lib/libX11/man/XChangeKeyboardControl.man +++ b/lib/libX11/man/XChangeKeyboardControl.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XChangeKeyboardControl __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME @@ -86,18 +53,18 @@ XChangeKeyboardControl, XGetKeyboardControl, XAutoRepeatOn, XAutoRepeatOff, XBel .SH SYNTAX .HP int XChangeKeyboardControl\^(\^Display *\fIdisplay\fP, unsigned long -\fIvalue_mask\fP\^, XKeyboardControl *\fIvalues\fP\^); +\fIvalue_mask\fP\^, XKeyboardControl *\fIvalues\fP\^); .HP int XGetKeyboardControl\^(\^Display *\fIdisplay\fP, XKeyboardState -*\fIvalues_return\fP\^); +*\fIvalues_return\fP\^); .HP -int XAutoRepeatOn\^(\^Display *\fIdisplay\fP\^); +int XAutoRepeatOn\^(\^Display *\fIdisplay\fP\^); .HP -int XAutoRepeatOff\^(\^Display *\fIdisplay\fP\^); +int XAutoRepeatOff\^(\^Display *\fIdisplay\fP\^); .HP -int XBell\^(\^Display *\fIdisplay\fP, int \fIpercent\fP\^); +int XBell\^(\^Display *\fIdisplay\fP, int \fIpercent\fP\^); .HP -int XQueryKeymap\^(\^Display *\fIdisplay\fP, char \fIkeys_return\fP[32]\^); +int XQueryKeymap\^(\^Display *\fIdisplay\fP, char \fIkeys_return\fP[32]\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -106,7 +73,7 @@ Returns an array of bytes that identifies which keys are pressed down. Each bit represents one key of the keyboard. .IP \fIpercent\fP 1i Specifies the volume for the bell, -which can range from \-100 to 100 inclusive. +which can range from \-100 to 100 inclusive. .IP \fIvalue_mask\fP 1i Specifies which controls to change. This mask is the bitwise inclusive OR of the valid control mask bits. @@ -114,44 +81,44 @@ This mask is the bitwise inclusive OR of the valid control mask bits. Specifies one value for each bit set to 1 in the mask. .IP \fIvalues_return\fP 1i Returns the current keyboard controls in the specified -.ZN XKeyboardState +.B XKeyboardState structure. .SH DESCRIPTION The -.ZN XChangeKeyboardControl +.B XChangeKeyboardControl function controls the keyboard characteristics defined by the -.ZN XKeyboardControl +.B XKeyboardControl structure. The value_mask argument specifies which values are to be changed. .LP -.ZN XChangeKeyboardControl +.B XChangeKeyboardControl can generate -.ZN BadMatch +.B BadMatch and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XGetKeyboardControl +.B XGetKeyboardControl function returns the current control values for the keyboard to the -.ZN XKeyboardState +.B XKeyboardState structure. .LP The -.ZN XAutoRepeatOn +.B XAutoRepeatOn function turns on auto-repeat for the keyboard on the specified display. .LP The -.ZN XAutoRepeatOff +.B XAutoRepeatOff function turns off auto-repeat for the keyboard on the specified display. .LP The -.ZN XBell +.B XBell function rings the bell on the keyboard on the specified display, if possible. The specified volume is relative to the base volume for the keyboard. If the value for the percent argument is not in the range \-100 to 100 inclusive, a -.ZN BadValue +.B BadValue error results. The volume at which the bell rings when the percent argument is nonnegative is: @@ -164,27 +131,27 @@ when the percent argument is negative is: base + [(base * percent) / 100] .LP To change the base volume of the bell, use -.ZN XChangeKeyboardControl . +.BR XChangeKeyboardControl . .LP -.ZN XBell +.B XBell can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XQueryKeymap -function returns a bit vector for the logical state of the keyboard, -where each bit set to 1 indicates that the corresponding key is currently +.B XQueryKeymap +function returns a bit vector for the logical state of the keyboard, +where each bit set to 1 indicates that the corresponding key is currently pressed down. The vector is represented as 32 bytes. -Byte N (from 0) contains the bits for keys 8N to 8N + 7 +Byte N (from 0) contains the bits for keys 8N to 8N + 7 with the least significant bit in the byte representing key 8N. .LP Note that the logical state of a device (as seen by client applications) may lag the physical state if device event processing is frozen. .SH STRUCTURES The -.ZN XKeyboardControl +.B XKeyboardControl structure contains: .LP .LP @@ -194,62 +161,62 @@ lw(.5i) lw(2.5i) lw(.8i). T{ \&#define T} T{ -.ZN KBKeyClickPercent +.B KBKeyClickPercent T} T{ (1L<<0) T} T{ \&#define T} T{ -.ZN KBBellPercent +.B KBBellPercent T} T{ (1L<<1) T} T{ \&#define T} T{ -.ZN KBBellPitch +.B KBBellPitch T} T{ (1L<<2) T} T{ \&#define T} T{ -.ZN KBBellDuration +.B KBBellDuration T} T{ (1L<<3) T} T{ \&#define T} T{ -.ZN KBLed +.B KBLed T} T{ (1L<<4) T} T{ \&#define T} T{ -.ZN KBLedMode +.B KBLedMode T} T{ (1L<<5) T} T{ \&#define T} T{ -.ZN KBKey +.B KBKey T} T{ (1L<<6) T} T{ \&#define T} T{ -.ZN KBAutoRepeatMode +.B KBAutoRepeatMode T} T{ (1L<<7) T} .TE .IN "XKeyboardControl" "" "@DEF@" -.Ds 0 +.EX /\&* Values */ typedef struct { @@ -260,62 +227,62 @@ typedef struct { int led; int led_mode; /\&* LedModeOn, LedModeOff */ int key; - int auto_repeat_mode; /\&* AutoRepeatModeOff, AutoRepeatModeOn, + int auto_repeat_mode; /\&* AutoRepeatModeOff, AutoRepeatModeOn, AutoRepeatModeDefault */ } XKeyboardControl; -.De +.EE .LP -The key_click_percent member sets the volume for key clicks between 0 (off) -and 100 (loud) inclusive, if possible. +The key_click_percent member sets the volume for key clicks between 0 (off) +and 100 (loud) inclusive, if possible. A setting of \-1 restores the default. Other negative values generate a -.ZN BadValue +.B BadValue error. .LP The bell_percent sets the base volume for the bell between 0 (off) and 100 -(loud) inclusive, if possible. +(loud) inclusive, if possible. A setting of \-1 restores the default. Other negative values generate a -.ZN BadValue +.B BadValue error. The bell_pitch member sets the pitch (specified in Hz) of the bell, if possible. A setting of \-1 restores the default. Other negative values generate a -.ZN BadValue +.B BadValue error. The bell_duration member sets the duration of the -bell specified in milliseconds, if possible. +bell specified in milliseconds, if possible. A setting of \-1 restores the default. Other negative values generate a -.ZN BadValue +.B BadValue error. .LP If both the led_mode and led members are specified, -the state of that LED is changed, if possible. +the state of that LED is changed, if possible. The led_mode member can be set to -.ZN LedModeOn +.B LedModeOn or -.ZN LedModeOff . +.BR LedModeOff . If only led_mode is specified, the state of -all LEDs are changed, if possible. -At most 32 LEDs numbered from one are supported. +all LEDs are changed, if possible. +At most 32 LEDs numbered from one are supported. No standard interpretation of LEDs is defined. If led is specified without led_mode, a -.ZN BadMatch -error results. +.B BadMatch +error results. .LP -If both the auto_repeat_mode and key members are specified, +If both the auto_repeat_mode and key members are specified, the auto_repeat_mode of that key is changed (according to -.ZN AutoRepeatModeOn , -.ZN AutoRepeatModeOff , +.BR AutoRepeatModeOn , +.BR AutoRepeatModeOff , or -.ZN AutoRepeatModeDefault ), +.BR AutoRepeatModeDefault ), if possible. If only auto_repeat_mode is specified, the global auto_repeat_mode for the entire keyboard is changed, if possible, and does not affect the per-key settings. If a key is specified without an auto_repeat_mode, a -.ZN BadMatch +.B BadMatch error results. Each key has an individual mode of whether or not it should auto-repeat and a default setting for the mode. @@ -323,25 +290,25 @@ In addition, there is a global mode of whether auto-repeat should be enabled or not and a default setting for that mode. When global mode is -.ZN AutoRepeatModeOn , +.BR AutoRepeatModeOn , keys should obey their individual auto-repeat modes. When global mode is -.ZN AutoRepeatModeOff , +.BR AutoRepeatModeOff , no keys should auto-repeat. An auto-repeating key generates alternating -.ZN KeyPress +.B KeyPress and -.ZN KeyRelease +.B KeyRelease events. When a key is used as a modifier, it is desirable for the key not to auto-repeat, regardless of its auto-repeat setting. .LP The -.ZN XKeyboardState +.B XKeyboardState structure contains: .LP -.Ds 0 +.EX typedef struct { int key_click_percent; int bell_percent; @@ -350,31 +317,32 @@ typedef struct { int global_auto_repeat; char auto_repeats[32]; } XKeyboardState; -.De +.EE .LP -For the LEDs, +For the LEDs, the least significant bit of led_mask corresponds to LED one, and each bit set to 1 in led_mask indicates an LED that is lit. The global_auto_repeat member can be set to -.ZN AutoRepeatModeOn +.B AutoRepeatModeOn or -.ZN AutoRepeatModeOff . +.BR AutoRepeatModeOff . The auto_repeats member is a bit vector. -Each bit set to 1 indicates that auto-repeat is enabled +Each bit set to 1 indicates that auto-repeat is enabled for the corresponding key. -The vector is represented as 32 bytes. +The vector is represented as 32 bytes. Byte N (from 0) contains the bits for keys 8N to 8N + 7 with the least significant bit in the byte representing key 8N. .SH DIAGNOSTICS .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XChangeKeyboardMapping(__libmansuffix__), diff --git a/lib/libX11/man/XChangeKeyboardMapping.man b/lib/libX11/man/XChangeKeyboardMapping.man index 3cb809514..f93051827 100644 --- a/lib/libX11/man/XChangeKeyboardMapping.man +++ b/lib/libX11/man/XChangeKeyboardMapping.man @@ -38,85 +38,51 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XChangeKeyboardMapping __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XChangeKeyboardMapping, XGetKeyboardMapping, XDisplayKeycodes, XSetModifierMapping, XGetModifierMapping, XNewModifiermap, XInsertModifiermapEntry, XDeleteModifiermapEntry, XFreeModifiermap, XModifierKeymap \- manipulate keyboard encoding and keyboard encoding structure .SH SYNTAX .HP int XChangeKeyboardMapping(\^Display *\fIdisplay\fP, int \fIfirst_keycode\fP, -int \fIkeysyms_per_keycode\fP, KeySym *\fIkeysyms\fP, int \fInum_codes\fP\^); +int \fIkeysyms_per_keycode\fP, KeySym *\fIkeysyms\fP, int \fInum_codes\fP\^); .HP KeySym *XGetKeyboardMapping(\^Display *\fIdisplay\fP, KeyCode \fIfirst_keycode\fP, int \fIkeycode_count\fP, int -*\fIkeysyms_per_keycode_return\fP\^); +*\fIkeysyms_per_keycode_return\fP\^); .HP int XDisplayKeycodes\^(\^Display *\fIdisplay\fP\^, int -*\fImin_keycodes_return\fP\^, int *\fImax_keycodes_return\fP\^); +*\fImin_keycodes_return\fP\^, int *\fImax_keycodes_return\fP\^); .HP int XSetModifierMapping(\^Display *\fIdisplay\fP, XModifierKeymap -*\fImodmap\fP\^); +*\fImodmap\fP\^); .HP -XModifierKeymap *XGetModifierMapping(\^Display *\fIdisplay\fP\^); +XModifierKeymap *XGetModifierMapping(\^Display *\fIdisplay\fP\^); .HP -XModifierKeymap *XNewModifiermap(\^int \fImax_keys_per_mod\fP\^); +XModifierKeymap *XNewModifiermap(\^int \fImax_keys_per_mod\fP\^); .HP XModifierKeymap *XInsertModifiermapEntry\^(\^XModifierKeymap *\fImodmap\fP, -KeyCode \fIkeycode_entry\fP, int \fImodifier\fP\^); +KeyCode \fIkeycode_entry\fP, int \fImodifier\fP\^); .HP XModifierKeymap *XDeleteModifiermapEntry\^(\^XModifierKeymap *\fImodmap\fP, -KeyCode \fIkeycode_entry\fP, int \fImodifier\fP\^); +KeyCode \fIkeycode_entry\fP, int \fImodifier\fP\^); .HP -int XFreeModifiermap(\^XModifierKeymap *\fImodmap\fP\^); +int XFreeModifiermap(\^XModifierKeymap *\fImodmap\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. -.ds Kc changed or returned .IP \fIfirst_keycode\fP 1i -Specifies the first KeyCode that is to be \*(Kc. +Specifies the first KeyCode that is to be changed or returned. .IP \fIkeycode_count\fP 1i Specifies the number of KeyCodes that are to be returned. .IP \fIkeycode_entry\fP 1i -Specifies the KeyCode. +Specifies the KeyCode. .IP \fIkeysyms\fP 1i Specifies an array of KeySyms. .IP \fIkeysyms_per_keycode\fP 1i @@ -133,123 +99,123 @@ Returns the minimum number of KeyCodes. .IP \fImodifier\fP 1i Specifies the modifier. .IP \fImodmap\fP 1i -Specifies the -.ZN XModifierKeymap +Specifies the +.B XModifierKeymap structure. .IP \fInum_codes\fP 1i Specifies the number of KeyCodes that are to be changed. .SH DESCRIPTION The -.ZN XChangeKeyboardMapping +.B XChangeKeyboardMapping function defines the symbols for the specified number of KeyCodes starting with first_keycode. -The symbols for KeyCodes outside this range remain unchanged. +The symbols for KeyCodes outside this range remain unchanged. The number of elements in keysyms must be: .LP -.Ds +.EX num_codes * keysyms_per_keycode -.De +.EE .LP -The specified first_keycode must be greater than or equal to min_keycode +The specified first_keycode must be greater than or equal to min_keycode returned by -.ZN XDisplayKeycodes , -or a -.ZN BadValue +.BR XDisplayKeycodes , +or a +.B BadValue error results. -In addition, the following expression must be less than or equal to +In addition, the following expression must be less than or equal to max_keycode as returned by -.ZN XDisplayKeycodes , +.BR XDisplayKeycodes , or a -.ZN BadValue +.B BadValue error results: .LP -.Ds +.EX first_keycode + num_codes \- 1 -.De +.EE .LP KeySym number N, counting from zero, for KeyCode K has the following index -in keysyms, counting from zero: +in keysyms, counting from zero: .LP -.Ds +.EX (K \- first_keycode) * keysyms_per_keycode + N -.De +.EE .LP The specified keysyms_per_keycode can be chosen arbitrarily by the client -to be large enough to hold all desired symbols. -A special KeySym value of -.ZN NoSymbol -should be used to fill in unused elements -for individual KeyCodes. -It is legal for -.ZN NoSymbol +to be large enough to hold all desired symbols. +A special KeySym value of +.B NoSymbol +should be used to fill in unused elements +for individual KeyCodes. +It is legal for +.B NoSymbol to appear in nontrailing positions of the effective list for a KeyCode. -.ZN XChangeKeyboardMapping -generates a -.ZN MappingNotify +.B XChangeKeyboardMapping +generates a +.B MappingNotify event. .LP -There is no requirement that the X server interpret this mapping. +There is no requirement that the X server interpret this mapping. It is merely stored for reading and writing by clients. .LP -.ZN XChangeKeyboardMapping +.B XChangeKeyboardMapping can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XGetKeyboardMapping +.B XGetKeyboardMapping function returns the symbols for the specified number of KeyCodes starting with first_keycode. -The value specified in first_keycode must be greater than +The value specified in first_keycode must be greater than or equal to min_keycode as returned by -.ZN XDisplayKeycodes , +.BR XDisplayKeycodes , or a -.ZN BadValue +.B BadValue error results. -In addition, the following expression must be less than or equal +In addition, the following expression must be less than or equal to max_keycode as returned by -.ZN XDisplayKeycodes : +.BR XDisplayKeycodes : .LP -.Ds +.EX first_keycode + keycode_count \- 1 -.De +.EE .LP -If this is not the case, a -.ZN BadValue -error results. +If this is not the case, a +.B BadValue +error results. The number of elements in the KeySyms list is: .LP -.Ds +.EX keycode_count * keysyms_per_keycode_return -.De +.EE .LP KeySym number N, counting from zero, for KeyCode K has the following index -in the list, counting from zero: -.Ds +in the list, counting from zero: +.EX (K \- first_code) * keysyms_per_code_return + N -.De +.EE .LP -The X server arbitrarily chooses the keysyms_per_keycode_return value -to be large enough to report all requested symbols. -A special KeySym value of -.ZN NoSymbol +The X server arbitrarily chooses the keysyms_per_keycode_return value +to be large enough to report all requested symbols. +A special KeySym value of +.B NoSymbol is used to fill in unused elements for individual KeyCodes. -To free the storage returned by -.ZN XGetKeyboardMapping , +To free the storage returned by +.BR XGetKeyboardMapping , use -.ZN XFree . +.BR XFree . .LP -.ZN XGetKeyboardMapping +.B XGetKeyboardMapping can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XDisplayKeycodes +.B XDisplayKeycodes function returns the min-keycodes and max-keycodes supported by the specified display. The minimum number of KeyCodes returned is never less than 8, @@ -257,129 +223,130 @@ and the maximum number of KeyCodes returned is never greater than 255. Not all KeyCodes in this range are required to have corresponding keys. .LP The -.ZN XSetModifierMapping -function specifies the KeyCodes of the keys (if any) that are to be used +.B XSetModifierMapping +function specifies the KeyCodes of the keys (if any) that are to be used as modifiers. If it succeeds, the X server generates a -.ZN MappingNotify +.B MappingNotify event, and -.ZN XSetModifierMapping +.B XSetModifierMapping returns -.ZN MappingSuccess . +.BR MappingSuccess . X permits at most 8 modifier keys. If more than 8 are specified in the -.ZN XModifierKeymap +.B XModifierKeymap structure, a -.ZN BadLength +.B BadLength error results. .LP -The modifiermap member of the -.ZN XModifierKeymap -structure contains 8 sets of max_keypermod KeyCodes, -one for each modifier in the order -.ZN Shift , -.ZN Lock , -.ZN Control , -.ZN Mod1 , -.ZN Mod2 , -.ZN Mod3 , -.ZN Mod4 , -and -.ZN Mod5 . -Only nonzero KeyCodes have meaning in each set, +The modifiermap member of the +.B XModifierKeymap +structure contains 8 sets of max_keypermod KeyCodes, +one for each modifier in the order +.BR Shift , +.BR Lock , +.BR Control , +.BR Mod1 , +.BR Mod2 , +.BR Mod3 , +.BR Mod4 , +and +.BR Mod5 . +Only nonzero KeyCodes have meaning in each set, and zero KeyCodes are ignored. -In addition, all of the nonzero KeyCodes must be in the range specified by -min_keycode and max_keycode in the -.ZN Display +In addition, all of the nonzero KeyCodes must be in the range specified by +min_keycode and max_keycode in the +.B Display structure, -or a -.ZN BadValue +or a +.B BadValue error results. .LP -An X server can impose restrictions on how modifiers can be changed, +An X server can impose restrictions on how modifiers can be changed, for example, if certain keys do not generate up transitions in hardware, if auto-repeat cannot be disabled on certain keys, -or if multiple modifier keys are not supported. -If some such restriction is violated, +or if multiple modifier keys are not supported. +If some such restriction is violated, the status reply is -.ZN MappingFailed , +.BR MappingFailed , and none of the modifiers are changed. If the new KeyCodes specified for a modifier differ from those currently defined and any (current or new) keys for that modifier are -in the logically down state, -.ZN XSetModifierMapping +in the logically down state, +.B XSetModifierMapping returns -.ZN MappingBusy , +.BR MappingBusy , and none of the modifiers is changed. .LP -.ZN XSetModifierMapping +.B XSetModifierMapping can generate -.ZN BadAlloc -and -.ZN BadValue +.B BadAlloc +and +.B BadValue errors. .LP The -.ZN XGetModifierMapping +.B XGetModifierMapping function returns a pointer to a newly created -.ZN XModifierKeymap +.B XModifierKeymap structure that contains the keys being used as modifiers. The structure should be freed after use by calling -.ZN XFreeModifiermap . -If only zero values appear in the set for any modifier, +.BR XFreeModifiermap . +If only zero values appear in the set for any modifier, that modifier is disabled. .LP The -.ZN XNewModifiermap +.B XNewModifiermap function returns a pointer to -.ZN XModifierKeymap +.B XModifierKeymap structure for later use. .LP The -.ZN XInsertModifiermapEntry +.B XInsertModifiermapEntry function adds the specified KeyCode to the set that controls the specified modifier and returns the resulting -.ZN XModifierKeymap +.B XModifierKeymap structure (expanded as needed). .LP The -.ZN XDeleteModifiermapEntry +.B XDeleteModifiermapEntry function deletes the specified KeyCode from the set that controls the specified modifier and returns a pointer to the resulting -.ZN XModifierKeymap +.B XModifierKeymap structure. .LP The -.ZN XFreeModifiermap +.B XFreeModifiermap function frees the specified -.ZN XModifierKeymap +.B XModifierKeymap structure. .SH STRUCTURES The -.ZN XModifierKeymap +.B XModifierKeymap structure contains: .LP -.Ds 0 +.EX typedef struct { int max_keypermod; /\&* This server's max number of keys per modifier */ KeyCode *modifiermap; /\&* An 8 by max_keypermod array of the modifiers */ } XModifierKeymap; -.De +.EE .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XFree(__libmansuffix__), XkbGetMap(__libmansuffix__), -XSetPointerMapping(__libmansuffix__) +XSetPointerMapping(__libmansuffix__) .br \fI\*(xL\fP diff --git a/lib/libX11/man/XChangePointerControl.man b/lib/libX11/man/XChangePointerControl.man index 57d46a328..871d3285d 100644 --- a/lib/libX11/man/XChangePointerControl.man +++ b/lib/libX11/man/XChangePointerControl.man @@ -38,49 +38,16 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XChangePointerControl __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME -XChangePointerControl, XGetPointerControl \- control pointer +XChangePointerControl, XGetPointerControl \- control pointer .SH SYNTAX .HP int XChangePointerControl\^(\^Display *\fIdisplay\fP\^, Bool \fIdo_accel\fP\^, @@ -102,10 +69,10 @@ Returns the numerator for the acceleration multiplier. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIdo_accel\fP 1i -Specifies a Boolean value that controls whether the values for +Specifies a Boolean value that controls whether the values for the accel_numerator or accel_denominator are used. .IP \fIdo_threshold\fP 1i -Specifies a Boolean value that controls whether the value for the +Specifies a Boolean value that controls whether the value for the threshold is used. .IP \fIthreshold\fP 1i Specifies the acceleration threshold. @@ -113,41 +80,42 @@ Specifies the acceleration threshold. Returns the acceleration threshold. .SH DESCRIPTION The -.ZN XChangePointerControl +.B XChangePointerControl function defines how the pointing device moves. The acceleration, expressed as a fraction, is a -multiplier for movement. +multiplier for movement. For example, specifying 3/1 means the pointer moves three times as fast as normal. -The fraction may be rounded arbitrarily by the X server. +The fraction may be rounded arbitrarily by the X server. Acceleration only takes effect if the pointer moves more than threshold pixels at once and only applies to the amount beyond the value in the threshold argument. Setting a value to \-1 restores the default. -The values of the do_accel and do_threshold arguments must be -.ZN True +The values of the do_accel and do_threshold arguments must be +.B True for the pointer values to be set, or the parameters are unchanged. Negative values (other than \-1) generate a -.ZN BadValue +.B BadValue error, as does a zero value for the accel_denominator argument. .LP -.ZN XChangePointerControl +.B XChangePointerControl can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XGetPointerControl +.B XGetPointerControl function returns the pointer's current acceleration multiplier and acceleration threshold. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" \fI\*(xL\fP diff --git a/lib/libX11/man/XChangeSaveSet.man b/lib/libX11/man/XChangeSaveSet.man index 0858f0e37..0b7df0c5b 100644 --- a/lib/libX11/man/XChangeSaveSet.man +++ b/lib/libX11/man/XChangeSaveSet.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XChangeSaveSet __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XChangeSaveSet, XAddToSaveSet, XRemoveFromSaveSet \- change a client's save set @@ -92,73 +59,73 @@ int XRemoveFromSaveSet\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .IP \fIchange_mode\fP 1i Specifies the mode. You can pass -.ZN SetModeInsert +.B SetModeInsert or -.ZN SetModeDelete . +.BR SetModeDelete . .IP \fIdisplay\fP 1i Specifies the connection to the X server. -.ds Wi that you want to add or delete from the client's save-set .IP \fIw\fP 1i -Specifies the window \*(Wi. +Specifies the window that you want to add or delete from the client's save-set. .SH DESCRIPTION Depending on the specified mode, -.ZN XChangeSaveSet -either inserts or deletes the specified window from the client's save-set. +.B XChangeSaveSet +either inserts or deletes the specified window from the client's save-set. The specified window must have been created by some other client, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XChangeSaveSet +.B XChangeSaveSet can generate -.ZN BadMatch , -.ZN BadValue , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XAddToSaveSet +.B XAddToSaveSet function adds the specified window to the client's save-set. The specified window must have been created by some other client, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XAddToSaveSet +.B XAddToSaveSet can generate -.ZN BadMatch +.B BadMatch and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XRemoveFromSaveSet +.B XRemoveFromSaveSet function removes the specified window from the client's save-set. The specified window must have been created by some other client, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XRemoveFromSaveSet +.B XRemoveFromSaveSet can generate -.ZN BadMatch +.B BadMatch and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XReparentWindow(__libmansuffix__) diff --git a/lib/libX11/man/XChangeWindowAttributes.man b/lib/libX11/man/XChangeWindowAttributes.man index 9075d557c..395920f1c 100644 --- a/lib/libX11/man/XChangeWindowAttributes.man +++ b/lib/libX11/man/XChangeWindowAttributes.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XChangeWindowAttributes __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XChangeWindowAttributes, XSetWindowBackground, XSetWindowBackgroundPixmap, XSetWindowBorder, XSetWindowBorderPixmap, XSetWindowColormap \- change window attributes @@ -89,7 +56,7 @@ int XSetWindowBackground\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, unsigne .HP int XSetWindowBackgroundPixmap\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Pixmap \fIbackground_pixmap\fP\^); -.HP +.HP int XSetWindowBorder\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, unsigned long \fIborder_pixel\fP\^); .HP int XSetWindowBorderPixmap\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Pixmap \fIborder_pixmap\fP\^); @@ -105,14 +72,14 @@ set to indicate which attributes have been set in the structure. Specifies the pixel that is to be used for the background. .IP \fIbackground_pixmap\fP 1i Specifies the background pixmap, -.ZN ParentRelative , +.BR ParentRelative , or -.ZN None . +.BR None . .IP \fIborder_pixel\fP 1i -Specifies the entry in the colormap. +Specifies the entry in the colormap. .IP \fIborder_pixmap\fP 1i Specifies the border pixmap or -.ZN CopyFromParent . +.BR CopyFromParent . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIvaluemask\fP 1i @@ -128,209 +95,210 @@ Specifies the colormap. .SH DESCRIPTION Depending on the valuemask, the -.ZN XChangeWindowAttributes +.B XChangeWindowAttributes function uses the window attributes in the -.ZN XSetWindowAttributes +.B XSetWindowAttributes structure to change the specified window attributes. Changing the background does not cause the window contents to be changed. -To repaint the window and its background, use -.ZN XClearWindow . +To repaint the window and its background, use +.BR XClearWindow . Setting the border or changing the background such that the border tile origin changes causes the border to be repainted. -Changing the background of a root window to -.ZN None -or -.ZN ParentRelative +Changing the background of a root window to +.B None +or +.B ParentRelative restores the default background pixmap. Changing the border of a root window to -.ZN CopyFromParent +.B CopyFromParent restores the default border pixmap. Changing the win-gravity does not affect the current position of the window. -Changing the backing-store of an obscured window to -.ZN WhenMapped +Changing the backing-store of an obscured window to +.B WhenMapped or -.ZN Always , +.BR Always , or changing the backing-planes, backing-pixel, or save-under of a mapped window may have no immediate effect. Changing the colormap of a window (that is, defining a new map, not -changing the contents of the existing map) generates a -.ZN ColormapNotify +changing the contents of the existing map) generates a +.B ColormapNotify event. Changing the colormap of a visible window may have no immediate effect on the screen because the map may not be installed (see -.ZN XInstallColormap ). -Changing the cursor of a root window to -.ZN None +.BR XInstallColormap ). +Changing the cursor of a root window to +.B None restores the default cursor. Whenever possible, you are encouraged to share colormaps. .LP -Multiple clients can select input on the same window. +Multiple clients can select input on the same window. Their event masks are maintained separately. -When an event is generated, -it is reported to all interested clients. -However, only one client at a time can select for -.ZN SubstructureRedirectMask , -.ZN ResizeRedirectMask , +When an event is generated, +it is reported to all interested clients. +However, only one client at a time can select for +.BR SubstructureRedirectMask , +.BR ResizeRedirectMask , and -.ZN ButtonPressMask . -If a client attempts to select any of these event masks -and some other client has already selected one, +.BR ButtonPressMask . +If a client attempts to select any of these event masks +and some other client has already selected one, a -.ZN BadAccess +.B BadAccess error results. -There is only one do-not-propagate-mask for a window, +There is only one do-not-propagate-mask for a window, not one per client. .LP -.ZN XChangeWindowAttributes +.B XChangeWindowAttributes can generate -.ZN BadAccess , -.ZN BadColor , -.ZN BadCursor , -.ZN BadMatch , -.ZN BadPixmap , -.ZN BadValue , +.BR BadAccess , +.BR BadColor , +.BR BadCursor , +.BR BadMatch , +.BR BadPixmap , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XSetWindowBackground +.B XSetWindowBackground function sets the background of the window to the specified pixel value. Changing the background does not cause the window contents to be changed. -.ZN XSetWindowBackground +.B XSetWindowBackground uses a pixmap of undefined size filled with the pixel value you passed. -If you try to change the background of an -.ZN InputOnly +If you try to change the background of an +.B InputOnly window, a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XSetWindowBackground +.B XSetWindowBackground can generate -.ZN BadMatch +.B BadMatch and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XSetWindowBackgroundPixmap +.B XSetWindowBackgroundPixmap function sets the background pixmap of the window to the specified pixmap. The background pixmap can immediately be freed if no further explicit references to it are to be made. -If -.ZN ParentRelative -is specified, +If +.B ParentRelative +is specified, the background pixmap of the window's parent is used, or on the root window, the default background is restored. -If you try to change the background of an -.ZN InputOnly +If you try to change the background of an +.B InputOnly window, a -.ZN BadMatch +.B BadMatch error results. If the background is set to -.ZN None , +.BR None , the window has no defined background. .LP -.ZN XSetWindowBackgroundPixmap +.B XSetWindowBackgroundPixmap can generate -.ZN BadMatch , -.ZN BadPixmap , +.BR BadMatch , +.BR BadPixmap , and -.ZN BadWindow +.B BadWindow errors. -.LP +.LP The -.ZN XSetWindowBorder +.B XSetWindowBorder function sets the border of the window to the pixel value you specify. If you attempt to perform this on an -.ZN InputOnly +.B InputOnly window, a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XSetWindowBorder +.B XSetWindowBorder can generate -.ZN BadMatch +.B BadMatch and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XSetWindowBorderPixmap +.B XSetWindowBorderPixmap function sets the border pixmap of the window to the pixmap you specify. The border pixmap can be freed immediately if no further explicit references to it are to be made. If you specify -.ZN CopyFromParent , +.BR CopyFromParent , a copy of the parent window's border pixmap is used. If you attempt to perform this on an -.ZN InputOnly +.B InputOnly window, a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XSetWindowBorderPixmap +.B XSetWindowBorderPixmap can generate -.ZN BadMatch , -.ZN BadPixmap , +.BR BadMatch , +.BR BadPixmap , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XSetWindowColormap +.B XSetWindowColormap function sets the specified colormap of the specified window. The colormap must have the same visual type as the window, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XSetWindowColormap +.B XSetWindowColormap can generate -.ZN BadColor , -.ZN BadMatch , +.BR BadColor , +.BR BadMatch , and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to free a color map entry that it did not already allocate. .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to store into a read-only color map entry. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window locks this attribute. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XConfigureWindow(__libmansuffix__), diff --git a/lib/libX11/man/XCirculateEvent.man b/lib/libX11/man/XCirculateEvent.man index e5f41cfea..ae155528d 100644 --- a/lib/libX11/man/XCirculateEvent.man +++ b/lib/libX11/man/XCirculateEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCirculateEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCirculateEvent \- CirculateNotify event structure .SH STRUCTURES The structure for -.ZN CirculateNotify +.B CirculateNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* CirculateNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -96,7 +63,7 @@ typedef struct { Window window; int place; /\&* PlaceOnTop, PlaceOnBottom */ } XCirculateEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -104,16 +71,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -122,21 +89,21 @@ dispatchers. .LP The event member is set either to the restacked window or to its parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify +.B SubstructureNotify was selected. The window member is set to the window that was restacked. The place member is set to the window's position after the restack occurs and is either -.ZN PlaceOnTop +.B PlaceOnTop or -.ZN PlaceOnBottom . +.BR PlaceOnBottom . If it is -.ZN PlaceOnTop , +.BR PlaceOnTop , the window is now on top of all siblings. If it is -.ZN PlaceOnBottom , +.BR PlaceOnBottom , the window is now below all siblings. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/lib/libX11/man/XCirculateRequestEvent.man b/lib/libX11/man/XCirculateRequestEvent.man index 146a71eea..404127384 100644 --- a/lib/libX11/man/XCirculateRequestEvent.man +++ b/lib/libX11/man/XCirculateRequestEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCirculateRequestEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCirculateRequestEvent \- CirculateRequest event structure .SH STRUCTURES The structure for -.ZN CirculateRequest +.B CirculateRequest events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* CirculateRequest */ unsigned long serial; /\&* # of last request processed by server */ @@ -96,7 +63,7 @@ typedef struct { Window window; int place; /\&* PlaceOnTop, PlaceOnBottom */ } XCirculateRequestEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -104,16 +71,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -124,14 +91,14 @@ The parent member is set to the parent window. The window member is set to the subwindow to be restacked. The place member is set to what the new position in the stacking order should be and is either -.ZN PlaceOnTop +.B PlaceOnTop or -.ZN PlaceOnBottom . +.BR PlaceOnBottom . If it is -.ZN PlaceOnTop , +.BR PlaceOnTop , the subwindow should be on top of all siblings. If it is -.ZN PlaceOnBottom , +.BR PlaceOnBottom , the subwindow should be below all siblings. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/lib/libX11/man/XClearArea.man b/lib/libX11/man/XClearArea.man index 64f34bd13..64759c4c0 100644 --- a/lib/libX11/man/XClearArea.man +++ b/lib/libX11/man/XClearArea.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XClearArea __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XClearArea, XClearWindow \- clear area or window @@ -93,102 +60,102 @@ int XClearWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); Specifies the connection to the X server. .IP \fIexposures\fP 1i Specifies a Boolean value that indicates if -.ZN Expose +.B Expose events are to be generated. .IP \fIw\fP 1i Specifies the window. -.ds Wh , which are the dimensions of the rectangle .IP \fIwidth\fP 1i .br .ns .IP \fIheight\fP 1i -Specify the width and height\*(Wh. -.ds Xy , which are relative to the origin of the window \ -and specify the upper-left corner of the rectangle +Specify the width and height, which are the dimensions of the rectangle. +.ds Xy .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which are relative to the origin of the window +and specify the upper-left corner of the rectangle. .SH DESCRIPTION The -.ZN XClearArea +.B XClearArea function paints a rectangular area in the specified window according to the specified dimensions with the window's background pixel or pixmap. The subwindow-mode effectively is -.ZN ClipByChildren . +.BR ClipByChildren . If width is zero, it is replaced with the current width of the window minus x. If height is zero, it is replaced with the current height of the window minus y. -If the window has a defined background tile, +If the window has a defined background tile, the rectangle clipped by any children is filled with this tile. If the window has -background -.ZN None , -the contents of the window are not changed. +background +.BR None , +the contents of the window are not changed. In either -case, if exposures is -.ZN True , -one or more -.ZN Expose +case, if exposures is +.BR True , +one or more +.B Expose events are generated for regions of the rectangle that are either visible or are being retained in a backing store. If you specify a window whose class is -.ZN InputOnly , +.BR InputOnly , a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XClearArea +.B XClearArea can generate -.ZN BadMatch , -.ZN BadValue , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XClearWindow +.B XClearWindow function clears the entire area in the specified window and is equivalent to -.ZN XClearArea -(display, w, 0, 0, 0, 0, -.ZN False ). +.B XClearArea +(display, w, 0, 0, 0, 0, +.BR False ). If the window has a defined background tile, the rectangle is tiled with a -plane-mask of all ones and -.ZN GXcopy +plane-mask of all ones and +.B GXcopy function. If the window has -background -.ZN None , -the contents of the window are not changed. +background +.BR None , +the contents of the window are not changed. If you specify a window whose class is -.ZN InputOnly , +.BR InputOnly , a -.ZN BadMatch -error results. +.B BadMatch +error results. .LP -.ZN XClearWindow +.B XClearWindow can generate -.ZN BadMatch +.B BadMatch and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XCopyArea(__libmansuffix__) diff --git a/lib/libX11/man/XClientMessageEvent.man b/lib/libX11/man/XClientMessageEvent.man index fc421149a..d69f6d54d 100644 --- a/lib/libX11/man/XClientMessageEvent.man +++ b/lib/libX11/man/XClientMessageEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XClientMessageEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XClientMessageEvent \- ClientMessage event structure .SH STRUCTURES The structure for -.ZN ClientMessage +.B ClientMessage events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* ClientMessage */ unsigned long serial; /\&* # of last request processed by server */ @@ -101,7 +68,7 @@ typedef struct { long l[5]; } data; } XClientMessageEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -109,28 +76,28 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. The window member is set to the window that is most useful to toolkit dispatchers. .LP -The message_type member is set to an atom that indicates how the data +The message_type member is set to an atom that indicates how the data should be interpreted by the receiving client. The format member is set to 8, 16, or 32 and specifies whether the data should be viewed as a list of bytes, shorts, or longs. The data member is a union that contains the members b, s, and l. -The b, s, and l members represent data of twenty 8-bit values, +The b, s, and l members represent data of twenty 8-bit values, ten 16-bit values, and five 32-bit values. Particular message types might not make use of all these values. The X server places no interpretation on the values in the window, diff --git a/lib/libX11/man/XColormapEvent.man b/lib/libX11/man/XColormapEvent.man index f793ac755..6295f98a0 100644 --- a/lib/libX11/man/XColormapEvent.man +++ b/lib/libX11/man/XColormapEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XColormapEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XColormapEvent \- ColormapNotify event structure .SH STRUCTURES The structure for -.ZN ColormapNotify +.B ColormapNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* ColormapNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -97,7 +64,7 @@ typedef struct { Bool new; int state; /\&* ColormapInstalled, ColormapUninstalled */ } XColormapEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -105,47 +72,47 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. The window member is set to the window that is most useful to toolkit dispatchers. .LP -The window member is set to the window whose associated +The window member is set to the window whose associated colormap is changed, installed, or uninstalled. For a colormap that is changed, installed, or uninstalled, -the colormap member is set to the colormap associated with the window. +the colormap member is set to the colormap associated with the window. For a colormap that is changed by a call to -.ZN XFreeColormap , +.BR XFreeColormap , the colormap member is set to -.ZN None . -The new member is set to indicate whether the colormap +.BR None . +The new member is set to indicate whether the colormap for the specified window was changed or installed or uninstalled -and can be -.ZN True +and can be +.B True or -.ZN False . +.BR False . If it is -.ZN True , +.BR True , the colormap was changed. If it is -.ZN False , +.BR False , the colormap was installed or uninstalled. The state member is always set to indicate whether the colormap is installed or -uninstalled and can be -.ZN ColormapInstalled +uninstalled and can be +.B ColormapInstalled or -.ZN ColormapUninstalled . +.BR ColormapUninstalled . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/lib/libX11/man/XConfigureEvent.man b/lib/libX11/man/XConfigureEvent.man index 103e3da98..6bb5c7a45 100644 --- a/lib/libX11/man/XConfigureEvent.man +++ b/lib/libX11/man/XConfigureEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XConfigureEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XConfigureEvent \- ConfigureNotify event structure .SH STRUCTURES The structure for -.ZN ConfigureNotify +.B ConfigureNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* ConfigureNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -100,7 +67,7 @@ typedef struct { Window above; Bool override_redirect; } XConfigureEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -108,16 +75,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -126,36 +93,36 @@ dispatchers. .LP The event member is set either to the reconfigured window or to its parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify +.B SubstructureNotify was selected. -The window member is set to the window whose size, position, +The window member is set to the window whose size, position, border, and/or stacking order was changed. .LP -The x and y members are set to the coordinates relative to the parent window's +The x and y members are set to the coordinates relative to the parent window's origin and indicate the position of the upper-left outside corner of the window. -The width and height members are set to the inside size of the window, +The width and height members are set to the inside size of the window, not including the border. The border_width member is set to the width of the window's border, in pixels. .LP -The above member is set to the sibling window and is used +The above member is set to the sibling window and is used for stacking operations. If the X server sets this member to -.ZN None , +.BR None , the window whose state was changed is on the bottom of the stack with respect to sibling windows. -However, if this member is set to a sibling window, +However, if this member is set to a sibling window, the window whose state was changed is placed on top of this sibling window. .LP The override_redirect member is set to the override-redirect attribute of the window. -Window manager clients normally should ignore this window if the +Window manager clients normally should ignore this window if the override_redirect member is -.ZN True . +.BR True . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/lib/libX11/man/XConfigureRequestEvent.man b/lib/libX11/man/XConfigureRequestEvent.man index 520e3f83b..7df666302 100644 --- a/lib/libX11/man/XConfigureRequestEvent.man +++ b/lib/libX11/man/XConfigureRequestEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XConfigureRequestEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XConfigureRequestEvent \- ConfigureRequest event structure .SH STRUCTURES The structure for -.ZN ConfigureRequest +.B ConfigureRequest events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* ConfigureRequest */ unsigned long serial; /\&* # of last request processed by server */ @@ -101,7 +68,7 @@ typedef struct { int detail; /\&* Above, Below, TopIf, BottomIf, Opposite */ unsigned long value_mask; } XConfigureRequestEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -109,16 +76,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -126,18 +93,18 @@ The window member is set to the window that is most useful to toolkit dispatchers. .LP The parent member is set to the parent window. -The window member is set to the window whose size, position, border width, +The window member is set to the window whose size, position, border width, and/or stacking order is to be reconfigured. The value_mask member indicates which components were specified in the -.ZN ConfigureWindow +.B ConfigureWindow protocol request. The corresponding values are reported as given in the request. The remaining values are filled in from the current geometry of the window, except in the case of above (sibling) and detail (stack-mode), which are reported as -.ZN None +.B None and -.ZN Above , +.BR Above , respectively, if they are not given in the request. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/lib/libX11/man/XConfigureWindow.man b/lib/libX11/man/XConfigureWindow.man index 156cbec37..4a00bc38f 100644 --- a/lib/libX11/man/XConfigureWindow.man +++ b/lib/libX11/man/XConfigureWindow.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XConfigureWindow __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME @@ -93,10 +60,10 @@ int XResizeWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, unsigned \fIwidth\fP\^, unsigned \fIheight\fP\^); .HP int XMoveResizeWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, int -\fIx\fP\^, int \fIy\fP\^, unsigned \fIwidth\fP\^, unsigned \fIheight\fP\^); +\fIx\fP\^, int \fIy\fP\^, unsigned \fIwidth\fP\^, unsigned \fIheight\fP\^); .HP int XSetWindowBorderWidth\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -unsigned \fIwidth\fP\^); +unsigned \fIwidth\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -105,169 +72,166 @@ Specifies which values are to be set using information in the values structure. This mask is the bitwise inclusive OR of the valid configure window values bits. .IP \fIvalues\fP 1i -Specifies the -.ZN XWindowChanges +Specifies the +.B XWindowChanges structure. -.ds Wi to be reconfigured, moved, or resized. .IP \fIw\fP 1i -Specifies the window \*(Wi. +Specifies the window to be reconfigured, moved, or resized.. .IP \fIwidth\fP 1i Specifies the width of the window border. -.ds Wh , which are the interior dimensions of the window .IP \fIwidth\fP 1i .br .ns .IP \fIheight\fP 1i -Specify the width and height\*(Wh. -.ds Xy , which define the new location of the top-left pixel \ -of the window's border or the window itself if it has no border \ -or define the new position of the window relative to its parent +Specify the width and height, which are the interior dimensions of the window. .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which define the new location of the top-left pixel +of the window's border or the window itself if it has no border +or define the new position of the window relative to its parent. .SH DESCRIPTION The -.ZN XConfigureWindow +.B XConfigureWindow function uses the values specified in the -.ZN XWindowChanges +.B XWindowChanges structure to reconfigure a window's size, position, border, and stacking order. Values not specified are taken from the existing geometry of the window. .LP If a sibling is specified without a stack_mode or if the window is not actually a sibling, a -.ZN BadMatch -error results. +.B BadMatch +error results. Note that the computations for -.ZN BottomIf , -.ZN TopIf , +.BR BottomIf , +.BR TopIf , and -.ZN Opposite +.B Opposite are performed with respect to the window's final geometry (as controlled by the other arguments passed to -.ZN XConfigureWindow ), +.BR XConfigureWindow ), not its initial geometry. Any backing store contents of the window, its inferiors, and other newly visible windows are either discarded or -changed to reflect the current screen contents +changed to reflect the current screen contents (depending on the implementation). .LP -.ZN XConfigureWindow +.B XConfigureWindow can generate -.ZN BadMatch , -.ZN BadValue , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XMoveWindow +.B XMoveWindow function moves the specified window to the specified x and y coordinates, but it does not change the window's size, raise the window, or change the mapping state of the window. -Moving a mapped window may or may not lose the window's contents -depending on if the window is obscured by nonchildren +Moving a mapped window may or may not lose the window's contents +depending on if the window is obscured by nonchildren and if no backing store exists. -If the contents of the window are lost, +If the contents of the window are lost, the X server generates -.ZN Expose +.B Expose events. Moving a mapped window generates -.ZN Expose -events on any formerly obscured windows. +.B Expose +events on any formerly obscured windows. .LP -If the override-redirect flag of the window is -.ZN False +If the override-redirect flag of the window is +.B False and some -other client has selected -.ZN SubstructureRedirectMask +other client has selected +.B SubstructureRedirectMask on the parent, the X server generates a -.ZN ConfigureRequest +.B ConfigureRequest event, and no further processing is -performed. +performed. Otherwise, the window is moved. .LP -.ZN XMoveWindow +.B XMoveWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XResizeWindow +.B XResizeWindow function changes the inside dimensions of the specified window, not including its borders. This function does not change the window's upper-left coordinate or the origin and does not restack the window. Changing the size of a mapped window may lose its contents and generate -.ZN Expose +.B Expose events. -If a mapped window is made smaller, +If a mapped window is made smaller, changing its size generates -.ZN Expose +.B Expose events on windows that the mapped window formerly obscured. .LP -If the override-redirect flag of the window is -.ZN False +If the override-redirect flag of the window is +.B False and some -other client has selected -.ZN SubstructureRedirectMask +other client has selected +.B SubstructureRedirectMask on the parent, the X server generates a -.ZN ConfigureRequest -event, and no further processing is performed. +.B ConfigureRequest +event, and no further processing is performed. If either width or height is zero, a -.ZN BadValue +.B BadValue error results. .LP -.ZN XResizeWindow +.B XResizeWindow can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XMoveResizeWindow -function changes the size and location of the specified window +.B XMoveResizeWindow +function changes the size and location of the specified window without raising it. Moving and resizing a mapped window may generate an -.ZN Expose +.B Expose event on the window. Depending on the new size and location parameters, -moving and resizing a window may generate -.ZN Expose -events on windows that the window formerly obscured. +moving and resizing a window may generate +.B Expose +events on windows that the window formerly obscured. .LP -If the override-redirect flag of the window is -.ZN False +If the override-redirect flag of the window is +.B False and some -other client has selected -.ZN SubstructureRedirectMask +other client has selected +.B SubstructureRedirectMask on the parent, the X server generates a -.ZN ConfigureRequest -event, and no further processing is performed. +.B ConfigureRequest +event, and no further processing is performed. Otherwise, the window size and location are changed. .LP -.ZN XMoveResizeWindow +.B XMoveResizeWindow can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XSetWindowBorderWidth +.B XSetWindowBorderWidth function sets the specified window's border width to the specified width. .LP -.ZN XSetWindowBorderWidth +.B XSetWindowBorderWidth can generate a -.ZN BadWindow +.B BadWindow error. .SH STRUCTURES The -.ZN XWindowChanges +.B XWindowChanges structure contains: .LP .LP @@ -277,55 +241,55 @@ lw(.5i) lw(2.5i) lw(.8i). T{ \&#define T} T{ -.ZN CWX +.B CWX T} T{ (1<<0) T} T{ \&#define T} T{ -.ZN CWY +.B CWY T} T{ (1<<1) T} T{ \&#define T} T{ -.ZN CWWidth +.B CWWidth T} T{ (1<<2) T} T{ \&#define T} T{ -.ZN CWHeight +.B CWHeight T} T{ (1<<3) T} T{ \&#define T} T{ -.ZN CWBorderWidth +.B CWBorderWidth T} T{ (1<<4) T} T{ \&#define T} T{ -.ZN CWSibling +.B CWSibling T} T{ (1<<5) T} T{ \&#define T} T{ -.ZN CWStackMode +.B CWStackMode T} T{ (1<<6) T} .TE .IN "XWindowChanges" "" "@DEF@" -.Ds 0 +.EX /\&* Values */ typedef struct { @@ -335,14 +299,14 @@ typedef struct { Window sibling; int stack_mode; } XWindowChanges; -.De +.EE .LP The x and y members are used to set the window's x and y coordinates, which are relative to the parent's origin and indicate the position of the upper-left outer corner of the window. The width and height members are used to set the inside size of the window, not including the border, and must be nonzero, or a -.ZN BadValue +.B BadValue error results. Attempts to configure a root window have no effect. .LP @@ -350,38 +314,39 @@ The border_width member is used to set the width of the border in pixels. Note that setting just the border width leaves the outer-left corner of the window in a fixed position but moves the absolute position of the window's origin. If you attempt to set the border-width attribute of an -.ZN InputOnly +.B InputOnly window nonzero, a -.ZN BadMatch -error results. +.B BadMatch +error results. .LP The sibling member is used to set the sibling window for stacking operations. -The stack_mode member is used to set how the window is to be restacked +The stack_mode member is used to set how the window is to be restacked and can be set to -.ZN Above , -.ZN Below , -.ZN TopIf , -.ZN BottomIf , -or -.ZN Opposite . +.BR Above , +.BR Below , +.BR TopIf , +.BR BottomIf , +or +.BR Opposite . .SH DIAGNOSTICS .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/lib/libX11/man/XCopyArea.man b/lib/libX11/man/XCopyArea.man index 86e6ff05e..25f9ed9bc 100644 --- a/lib/libX11/man/XCopyArea.man +++ b/lib/libX11/man/XCopyArea.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCopyArea __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCopyArea, XCopyPlane \- copy areas @@ -91,15 +58,13 @@ int \fIwidth\fP\^, unsigned \fIheight\fP\^, int \fIdest_x\fP\^, int int XCopyPlane\^(\^Display *\fIdisplay\fP\^, Drawable \fIsrc\fP\^, Drawable \fIdest\fP\^, GC \fIgc\fP\^, int \fIsrc_x\fP\^, int \fIsrc_y\fP\^, unsigned \fIwidth\fP\^, int \fIheight\fP\^, int \fIdest_x\fP\^, int \fIdest_y\fP\^, -unsigned long \fIplane\fP\^); +unsigned long \fIplane\fP\^); .SH ARGUMENTS -.ds Dx , which are relative to the origin of the destination rectangle \ -and specify its upper-left corner .IP \fIdest_x\fP 1i .br .ns .IP \fIdest_y\fP 1i -Specify the x and y coordinates\*(Dx. +Specify the x and y coordinates, which are relative to the origin of the destination rectangle and specify its upper-left corner. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i @@ -111,134 +76,135 @@ You must set exactly one bit to 1. .br .ns .IP \fIdest\fP 1i -Specify the source and destination rectangles to be combined. +Specify the source and destination rectangles to be combined. .IP \fIsrc_x\fP 1i .br .ns .IP \fIsrc_y\fP 1i -Specify the x and y coordinates, +Specify the x and y coordinates, which are relative to the origin of the source rectangle and specify its upper-left corner. -.ds Wh , which are the dimensions of both the source and destination rectangles .IP \fIwidth\fP 1i .br .ns .IP \fIheight\fP 1i -Specify the width and height\*(Wh. +Specify the width and height, which are the dimensions +of both the source and destination rectangles. .SH DESCRIPTION The -.ZN XCopyArea -function combines the specified rectangle of src with the specified rectangle +.B XCopyArea +function combines the specified rectangle of src with the specified rectangle of dest. The drawables must have the same root and depth, or a -.ZN BadMatch +.B BadMatch error results. .LP If regions of the source rectangle are obscured and have not been -retained in backing store -or if regions outside the boundaries of the source drawable are specified, -those regions are not copied. -Instead, the +retained in backing store +or if regions outside the boundaries of the source drawable are specified, +those regions are not copied. +Instead, the following occurs on all corresponding destination regions that are either -visible or are retained in backing store. -If the destination is a window with a background other than -.ZN None , +visible or are retained in backing store. +If the destination is a window with a background other than +.BR None , corresponding regions of the destination are tiled with that background (with plane-mask of all ones and -.ZN GXcopy +.B GXcopy function). Regardless of tiling or whether the destination is a window or a pixmap, -if graphics-exposures is -.ZN True , +if graphics-exposures is +.BR True , then -.ZN GraphicsExpose +.B GraphicsExpose events for all corresponding destination regions are generated. -If graphics-exposures is -.ZN True +If graphics-exposures is +.B True but no -.ZN GraphicsExpose +.B GraphicsExpose events are generated, a -.ZN NoExpose +.B NoExpose event is generated. Note that by default graphics-exposures is -.ZN True +.B True in new GCs. .LP -This function uses these GC components: function, plane-mask, +This function uses these GC components: function, plane-mask, subwindow-mode, graphics-exposures, clip-x-origin, clip-y-origin, and clip-mask. .LP -.ZN XCopyArea +.B XCopyArea can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .LP The -.ZN XCopyPlane +.B XCopyPlane function uses a single bit plane of the specified source rectangle combined with the specified GC to modify the specified rectangle of dest. The drawables must have the same root but need not have the same depth. If the drawables do not have the same root, a -.ZN BadMatch +.B BadMatch error results. If plane does not have exactly one bit set to 1 and the value of plane is not less than %2 sup n%, where \fIn\fP is the depth of src, a -.ZN BadValue +.B BadValue error results. .LP -Effectively, -.ZN XCopyPlane +Effectively, +.B XCopyPlane forms a pixmap of the same depth as the rectangle of dest and with a -size specified by the source region. +size specified by the source region. It uses the foreground/background pixels in the GC (foreground everywhere the bit plane in src contains a bit set to 1, background everywhere the bit plane in src contains a bit set to 0) -and the equivalent of a -.ZN CopyArea +and the equivalent of a +.B CopyArea protocol request is performed with all the same exposure semantics. -This can also be thought of as using the specified region of the source +This can also be thought of as using the specified region of the source bit plane as a stipple with a fill-style of -.ZN FillOpaqueStippled +.B FillOpaqueStippled for filling a rectangular area of the destination. .LP This function uses these GC components: function, plane-mask, foreground, background, subwindow-mode, graphics-exposures, clip-x-origin, clip-y-origin, and clip-mask. .LP -.ZN XCopyPlane +.B XCopyPlane can generate -.ZN BadDrawable , -.ZN BadGC , -.ZN BadMatch , +.BR BadDrawable , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XClearArea(__libmansuffix__) diff --git a/lib/libX11/man/XCreateColormap.man b/lib/libX11/man/XCreateColormap.man index 9a75b2693..b9004c557 100644 --- a/lib/libX11/man/XCreateColormap.man +++ b/lib/libX11/man/XCreateColormap.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCreateColormap __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCreateColormap, XCopyColormapAndFree, XFreeColormap, XColor \- create, copy, or destroy colormaps and color structure @@ -87,212 +54,211 @@ Colormap XCreateColormap\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Visual *\fIvisual\fP\^, int \fIalloc\fP\^); .HP Colormap XCopyColormapAndFree\^(\^Display *\fIdisplay\fP\^, Colormap -\fIcolormap\fP\^); +\fIcolormap\fP\^); .HP -int XFreeColormap\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^); +int XFreeColormap\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^); .SH ARGUMENTS .IP \fIalloc\fP 1i Specifies the colormap entries to be allocated. -You can pass -.ZN AllocNone -or -.ZN AllocAll . -.ds Cm that you want to create, copy, set, or destroy +You can pass +.B AllocNone +or +.BR AllocAll . .IP \fIcolormap\fP 1i -Specifies the colormap \*(Cm. +Specifies the colormap that you want to create, copy, set, or destroy. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIvisual\fP 1i Specifies a visual type supported on the screen. -If the visual type is not one supported by the screen, +If the visual type is not one supported by the screen, a -.ZN BadMatch +.B BadMatch error results. -.ds Wi on whose screen you want to create a colormap .IP \fIw\fP 1i -Specifies the window \*(Wi. +Specifies the window on whose screen you want to create a colormap. .SH DESCRIPTION The -.ZN XCreateColormap -function creates a colormap of the specified visual type for the screen -on which the specified window resides and returns the colormap ID +.B XCreateColormap +function creates a colormap of the specified visual type for the screen +on which the specified window resides and returns the colormap ID associated with it. Note that the specified window is only used to determine the screen. .LP -The initial values of the colormap entries are undefined for the +The initial values of the colormap entries are undefined for the visual classes -.ZN GrayScale , -.ZN PseudoColor , +.BR GrayScale , +.BR PseudoColor , and -.ZN DirectColor . +.BR DirectColor . For -.ZN StaticGray , -.ZN StaticColor , +.BR StaticGray , +.BR StaticColor , and -.ZN TrueColor , +.BR TrueColor , the entries have defined values, but those values are specific to the visual and are not defined by X. For -.ZN StaticGray , -.ZN StaticColor , +.BR StaticGray , +.BR StaticColor , and -.ZN TrueColor , +.BR TrueColor , alloc must be -.ZN AllocNone , +.BR AllocNone , or a -.ZN BadMatch +.B BadMatch error results. For the other visual classes, if alloc is -.ZN AllocNone , +.BR AllocNone , the colormap initially has no allocated entries, and clients can allocate them. For information about the visual types, see section 3.1. .LP If alloc is -.ZN AllocAll , +.BR AllocAll , the entire colormap is allocated writable. The initial values of all allocated entries are undefined. For -.ZN GrayScale +.B GrayScale and -.ZN PseudoColor , +.BR PseudoColor , the effect is as if an -.ZN XAllocColorCells +.B XAllocColorCells call returned all pixel values from zero to N \- 1, where N is the colormap entries value in the specified visual. For -.ZN DirectColor , +.BR DirectColor , the effect is as if an -.ZN XAllocColorPlanes -call returned a pixel value of zero and red_mask, green_mask, +.B XAllocColorPlanes +call returned a pixel value of zero and red_mask, green_mask, and blue_mask values containing the same bits as the corresponding masks in the specified visual. However, in all cases, none of these entries can be freed by using -.ZN XFreeColors . +.BR XFreeColors . .LP -.ZN XCreateColormap +.B XCreateColormap can generate -.ZN BadAlloc , -.ZN BadMatch , -.ZN BadValue , +.BR BadAlloc , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XCopyColormapAndFree +.B XCopyColormapAndFree function creates a colormap of the same visual type and for the same screen as the specified colormap and returns the new colormap ID. It also moves all of the client's existing allocation from the specified -colormap to the new colormap with their color values intact -and their read-only or writable characteristics intact and frees those entries +colormap to the new colormap with their color values intact +and their read-only or writable characteristics intact and frees those entries in the specified colormap. Color values in other entries in the new colormap are undefined. If the specified colormap was created by the client with alloc set to -.ZN AllocAll , -the new colormap is also created with -.ZN AllocAll , +.BR AllocAll , +the new colormap is also created with +.BR AllocAll , all color values for all entries are copied from the specified colormap, and then all entries in the specified colormap are freed. If the specified colormap was not created by the client with -.ZN AllocAll , +.BR AllocAll , the allocations to be moved are all those pixels and planes that have been allocated by the client using -.ZN XAllocColor , -.ZN XAllocNamedColor , -.ZN XAllocColorCells , +.BR XAllocColor , +.BR XAllocNamedColor , +.BR XAllocColorCells , or -.ZN XAllocColorPlanes +.B XAllocColorPlanes and that have not been freed since they were allocated. .LP -.ZN XCopyColormapAndFree +.B XCopyColormapAndFree can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadColor +.B BadColor errors. .LP The -.ZN XFreeColormap -function deletes the association between the colormap resource ID +.B XFreeColormap +function deletes the association between the colormap resource ID and the colormap and frees the colormap storage. However, this function has no effect on the default colormap for a screen. If the specified colormap is an installed map for a screen, it is uninstalled (see -.ZN XUninstallColormap ). +.BR XUninstallColormap ). If the specified colormap is defined as the colormap for a window (by -.ZN XCreateWindow , -.ZN XSetWindowColormap , +.BR XCreateWindow , +.BR XSetWindowColormap , or -.ZN XChangeWindowAttributes ), -.ZN XFreeColormap +.BR XChangeWindowAttributes ), +.B XFreeColormap changes the colormap associated with the window to -.ZN None +.B None and generates a -.ZN ColormapNotify +.B ColormapNotify event. X does not define the colors displayed for a window with a colormap of -.ZN None . +.BR None . .LP -.ZN XFreeColormap +.B XFreeColormap can generate a -.ZN BadColor +.B BadColor error. .SH STRUCTURES The -.ZN XColor +.B XColor structure contains: .LP -.Ds 0 +.EX typedef struct { unsigned long pixel; /\&* pixel value */ unsigned short red, green, blue; /\&* rgb values */ - char flags; /\&* DoRed, DoGreen, DoBlue */ + char flags; /\&* DoRed, DoGreen, DoBlue */ char pad; } XColor; -.De +.EE .LP The red, green, and blue values are always in the range 0 to 65535 inclusive, independent of the number of bits actually used in the display hardware. The server scales these values down to the range used by the hardware. -Black is represented by (0,0,0), +Black is represented by (0,0,0), and white is represented by (65535,65535,65535). .IN "Color" In some functions, -the flags member controls which of the red, green, and blue members is used +the flags member controls which of the red, green, and blue members is used and can be the inclusive OR of zero or more of -.ZN DoRed , -.ZN DoGreen , -and -.ZN DoBlue . +.BR DoRed , +.BR DoGreen , +and +.BR DoBlue . .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocColor(__libmansuffix__), diff --git a/lib/libX11/man/XCreateFontCursor.man b/lib/libX11/man/XCreateFontCursor.man index 637d92658..587d1cfd6 100644 --- a/lib/libX11/man/XCreateFontCursor.man +++ b/lib/libX11/man/XCreateFontCursor.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCreateFontCursor __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCreateFontCursor, XCreatePixmapCursor, XCreateGlyphCursor \- create cursors @@ -85,7 +52,7 @@ XCreateFontCursor, XCreatePixmapCursor, XCreateGlyphCursor \- create cursors \&#include <X11/cursorfont.h> .HP Cursor XCreateFontCursor\^(\^Display *\fIdisplay\fP\^, unsigned int -\fIshape\fP\^); +\fIshape\fP\^); .HP Cursor XCreatePixmapCursor\^(\^Display *\fIdisplay\fP\^, Pixmap \fIsource\fP\^, Pixmap \fImask\fP\^, XColor *\fIforeground_color\fP\^, XColor @@ -94,22 +61,22 @@ Cursor XCreatePixmapCursor\^(\^Display *\fIdisplay\fP\^, Pixmap Cursor XCreateGlyphCursor\^(\^Display *\fIdisplay\fP\^, Font \fIsource_font\fP\^, Font \fImask_font\fP\^, unsigned int \fIsource_char\fP\^, unsigned int \fImask_char\fP\^, XColor *\fIforeground_color\fP\^, XColor -*\fIbackground_color\fP\^); +*\fIbackground_color\fP\^); .SH ARGUMENTS .IP \fIbackground_color\fP 1i Specifies the RGB values for the background of the source. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIforeground_color\fP 1i -Specifies the RGB values for the foreground of the source. +Specifies the RGB values for the foreground of the source. .IP \fImask\fP 1i Specifies the cursor's source bits to be displayed or -.ZN None . +.BR None . .IP \fImask_char\fP 1i -Specifies the glyph character for the mask. +Specifies the glyph character for the mask. .IP \fImask_font\fP 1i Specifies the font for the mask glyph or -.ZN None . +.BR None . .IP \fIshape\fP 1i Specifies the shape of the cursor. .IP \fIsource\fP 1i @@ -119,12 +86,12 @@ Specifies the shape of the source cursor. Specifies the character glyph for the source. .IP \fIsource_font\fP 1i Specifies the font for the source glyph. -.ds Xy , which indicate the hotspot relative to the source's origin .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which indicate the +hotspot relative to the source's origin. .SH DESCRIPTION X provides a set of standard cursor shapes in a special font named cursor. @@ -136,42 +103,42 @@ to use. The hotspot comes from the information stored in the cursor font. The initial colors of a cursor are a black foreground and a white background (see -.ZN XRecolorCursor ). +.BR XRecolorCursor ). .LP -.ZN XCreateFontCursor +.B XCreateFontCursor can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XCreatePixmapCursor +.B XCreatePixmapCursor function creates a cursor and returns the cursor ID associated with it. The foreground and background RGB values must be specified using foreground_color and background_color, even if the X server only has a -.ZN StaticGray +.B StaticGray or -.ZN GrayScale +.B GrayScale screen. The foreground color is used for the pixels set to 1 in the source, and the background color is used for the pixels set to 0. -Both source and mask, if specified, must have depth one (or a -.ZN BadMatch +Both source and mask, if specified, must have depth one (or a +.B BadMatch error results) but can have any root. The mask argument defines the shape of the cursor. The pixels set to 1 in the mask define which source pixels are displayed, and the pixels set to 0 define which pixels are ignored. -If no mask is given, +If no mask is given, all pixels of the source are displayed. -The mask, if present, must be the same size as the pixmap defined by the +The mask, if present, must be the same size as the pixmap defined by the source argument, or a -.ZN BadMatch +.B BadMatch error results. The hotspot must be a point within the source, or a -.ZN BadMatch +.B BadMatch error results. .LP The components of the cursor can be transformed arbitrarily to meet @@ -182,70 +149,71 @@ Subsequent drawing in the source or mask pixmap has an undefined effect on the cursor. The X server might or might not make a copy of the pixmap. .LP -.ZN XCreatePixmapCursor +.B XCreatePixmapCursor can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadPixmap +.B BadPixmap errors. .LP The -.ZN XCreateGlyphCursor +.B XCreateGlyphCursor function is similar to -.ZN XCreatePixmapCursor -except that the source and mask bitmaps are obtained from the specified +.B XCreatePixmapCursor +except that the source and mask bitmaps are obtained from the specified font glyphs. -The source_char must be a defined glyph in source_font, +The source_char must be a defined glyph in source_font, or a -.ZN BadValue +.B BadValue error results. -If mask_font is given, +If mask_font is given, mask_char must be a defined glyph in mask_font, or a -.ZN BadValue +.B BadValue error results. The mask_font and character are optional. The origins of the source_char and mask_char (if defined) glyphs are -positioned coincidently and define the hotspot. -The source_char and mask_char need not have the same bounding box metrics, +positioned coincidently and define the hotspot. +The source_char and mask_char need not have the same bounding box metrics, and there is no restriction on the placement of the hotspot relative to the bounding -boxes. +boxes. If no mask_char is given, all pixels of the source are displayed. You can free the fonts immediately by calling -.ZN XFreeFont -if no further explicit references to them are to be made. +.B XFreeFont +if no further explicit references to them are to be made. .LP -For 2-byte matrix fonts, +For 2-byte matrix fonts, the 16-bit value should be formed with the byte1 -member in the most significant byte and the byte2 member in the +member in the most significant byte and the byte2 member in the least significant byte. .LP -.ZN XCreateGlyphCursor +.B XCreateGlyphCursor can generate -.ZN BadAlloc , -.ZN BadFont , +.BR BadAlloc , +.BR BadFont , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadFont +.B BadFont A value for a Font or GContext argument does not name a defined Font. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XDefineCursor(__libmansuffix__), diff --git a/lib/libX11/man/XCreateFontSet.man b/lib/libX11/man/XCreateFontSet.man index 38cb9f3d6..d2111eb35 100644 --- a/lib/libX11/man/XCreateFontSet.man +++ b/lib/libX11/man/XCreateFontSet.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCreateFontSet __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCreateFontSet, XFreeFontSet \- create and free an international text drawing font set @@ -87,7 +54,7 @@ XFontSet XCreateFontSet\^(\^Display *\fIdisplay\fP\^, char *\fIbase_font_name_list\fP\^, char ***\fImissing_charset_list_return\fP\^, int *\fImissing_charset_count_return\fP\^, char **\fIdef_string_return\fP\^); .HP -void XFreeFontSet\^(\^Display *\fIdisplay\fP\^, XFontSet \fIfont_set\fP\^); +void XFreeFontSet\^(\^Display *\fIdisplay\fP\^, XFontSet \fIfont_set\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -102,11 +69,11 @@ Returns the number of missing charsets. .IP \fImissing_charset_list_return\fP 1i Returns the missing charsets. .SH DESCRIPTION -The -.ZN XCreateFontSet +The +.B XCreateFontSet function creates a font set for the specified display. -The font set is bound to the current locale when -.ZN XCreateFontSet +The font set is bound to the current locale when +.B XCreateFontSet is called. The font set may be used in subsequent calls to obtain font and character information and to image text in the locale of the font set. @@ -115,7 +82,7 @@ The base_font_name_list argument is a list of base font names that Xlib uses to load the fonts needed for the locale. The base font names are a comma-separated list. The string is null-terminated -and is assumed to be in the Host Portable Character Encoding; +and is assumed to be in the Host Portable Character Encoding; otherwise, the result is implementation-dependent. White space immediately on either side of a separating comma is ignored. .LP @@ -132,22 +99,22 @@ If a base font name is not an XLFD name, Xlib will attempt to obtain an XLFD name from the font properties for the font. If this action is successful in obtaining an XLFD name, the -.ZN XBaseFontNameListOfFontSet +.B XBaseFontNameListOfFontSet function will return this XLFD name instead of the client-supplied name. .LP Xlib uses the following algorithm to select the fonts -that will be used to display text with the -.ZN XFontSet . +that will be used to display text with the +.BR XFontSet . .LP For each font charset required by the locale, -the base font name list is searched for the first appearance of one +the base font name list is searched for the first appearance of one of the following cases that names a set of fonts that exist at the server: .IP \(bu 5 The first XLFD-conforming base font name that specifies the required -charset or a superset of the required charset in its -.ZN CharSetRegistry -and -.ZN CharSetEncoding +charset or a superset of the required charset in its +.B CharSetRegistry +and +.B CharSetEncoding fields. The implementation may use a base font name whose specified charset is a superset of the required charset, for example, @@ -156,20 +123,20 @@ an ISO8859-1 font for an ASCII charset. The first set of one or more XLFD-conforming base font names that specify one or more charsets that can be remapped to support the required charset. -The Xlib implementation may recognize various mappings +The Xlib implementation may recognize various mappings from a required charset to one or more other charsets and use the fonts for those charsets. -For example, JIS Roman is ASCII with tilde and backslash replaced +For example, JIS Roman is ASCII with tilde and backslash replaced by yen and overbar; Xlib may load an ISO8859-1 font to support this character set if a JIS Roman font is not available. .IP \(bu 5 The first XLFD-conforming font name or the first non-XLFD font name for which an XLFD font name can be obtained, combined with the -required charset (replacing the -.ZN CharSetRegistry +required charset (replacing the +.B CharSetRegistry and -.ZN CharSetEncoding +.B CharSetEncoding fields in the XLFD font name). As in case 1, the implementation may use a charset that is a superset @@ -180,63 +147,63 @@ manner to one or more fonts that support imaging text in the charset. .LP For example, assume that a locale required the charsets: .LP -.Ds 0 +.EX ISO8859-1 JISX0208.1983 JISX0201.1976 GB2312-1980.0 -.De +.EE .LP The user could supply a base_font_name_list that explicitly specifies the charsets, ensuring that specific fonts are used if they exist. For example: .LP -.Ds 0 +.EX "-JIS-Fixed-Medium-R-Normal--26-180-100-100-C-240-JISX0208.1983-0,\\ -JIS-Fixed-Medium-R-Normal--26-180-100-100-C-120-JISX0201.1976-0,\\ -GB-Fixed-Medium-R-Normal--26-180-100-100-C-240-GB2312-1980.0,\\ -Adobe-Courier-Bold-R-Normal--25-180-75-75-M-150-ISO8859-1" -.De +.EE .LP Alternatively, the user could supply a base_font_name_list that omits the charsets, letting Xlib select font charsets required for the locale. For example: .LP -.Ds 0 +.EX "-JIS-Fixed-Medium-R-Normal--26-180-100-100-C-240,\\ -JIS-Fixed-Medium-R-Normal--26-180-100-100-C-120,\\ -GB-Fixed-Medium-R-Normal--26-180-100-100-C-240,\\ -Adobe-Courier-Bold-R-Normal--25-180-100-100-M-150" -.De +.EE .LP Alternatively, the user could simply supply a single base font name that allows Xlib to select from all available fonts that meet certain minimum XLFD property requirements. For example: .LP -.Ds 0 +.EX "-*-*-*-R-Normal--*-180-100-100-*-*" -.De +.EE .LP -If -.ZN XCreateFontSet -is unable to create the font set, +If +.B XCreateFontSet +is unable to create the font set, either because there is insufficient memory or because the current locale is not supported, -.ZN XCreateFontSet +.B XCreateFontSet returns NULL, missing_charset_list_return is set to NULL, and missing_charset_count_return is set to zero. If fonts exist for all of the charsets required by the current locale, -.ZN XCreateFontSet +.B XCreateFontSet returns a valid -.ZN XFontSet , +.BR XFontSet , missing_charset_list_return is set to NULL, and missing_charset_count_return is set to zero. .LP If no font exists for one or more of the required charsets, -.ZN XCreateFontSet +.B XCreateFontSet sets missing_charset_list_return to a list of one or more null-terminated charset names for which no font exists and sets missing_charset_count_return to the number of missing fonts. @@ -246,65 +213,65 @@ may be able to remap a required charset. .LP If no font exists for any of the required charsets or if the locale definition in Xlib requires that a font exist -for a particular charset and a font is not found for that charset, -.ZN XCreateFontSet +for a particular charset and a font is not found for that charset, +.B XCreateFontSet returns NULL. -Otherwise, -.ZN XCreateFontSet -returns a valid -.ZN XFontSet +Otherwise, +.B XCreateFontSet +returns a valid +.B XFontSet to font_set. .LP When an Xmb/wc drawing or measuring function is called with an -.ZN XFontSet +.B XFontSet that has missing charsets, some characters in the locale will not be drawable. If def_string_return is non-NULL, -.ZN XCreateFontSet +.B XCreateFontSet returns a pointer to a string that represents the glyphs -that are drawn with this -.ZN XFontSet +that are drawn with this +.B XFontSet when the charsets of the available fonts do not include all font glyphs required to draw a codepoint. -The string does not necessarily consist of valid characters +The string does not necessarily consist of valid characters in the current locale and is not necessarily drawn with the fonts loaded for the font set, but the client can draw and measure the default glyphs -by including this string in a string being drawn or measured with the -.ZN XFontSet . +by including this string in a string being drawn or measured with the +.BR XFontSet . .LP If the string returned to def_string_return is the empty string ("\^"), no glyphs are drawn, and the escapement is zero. The returned string is null-terminated. It is owned by Xlib and should not be modified or freed by the client. -It will be freed by a call to -.ZN XFreeFontSet -with the associated -.ZN XFontSet . +It will be freed by a call to +.B XFreeFontSet +with the associated +.BR XFontSet . Until freed, its contents will not be modified by Xlib. .LP The client is responsible for constructing an error message from the missing charset and default string information and may choose to continue operation in the case that some fonts did not exist. .LP -The returned -.ZN XFontSet -and missing charset list should be freed with -.ZN XFreeFontSet +The returned +.B XFontSet +and missing charset list should be freed with +.B XFreeFontSet and -.ZN XFreeStringList , +.BR XFreeStringList , respectively. -The client-supplied base_font_name_list may be freed -by the client after calling -.ZN XCreateFontSet . +The client-supplied base_font_name_list may be freed +by the client after calling +.BR XCreateFontSet . .LP The -.ZN XFreeFontSet +.B XFreeFontSet function frees the specified font set. -The associated base font name list, font name list, -.ZN XFontStruct -list, and -.ZN XFontSetExtents , +The associated base font name list, font name list, +.B XFontStruct +list, and +.BR XFontSetExtents , if any, are freed. .SH "SEE ALSO" XExtentsofFontSet(__libmansuffix__), diff --git a/lib/libX11/man/XCreateGC.man b/lib/libX11/man/XCreateGC.man index 5f021a728..e737f98ae 100644 --- a/lib/libX11/man/XCreateGC.man +++ b/lib/libX11/man/XCreateGC.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XCreateGC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME @@ -86,23 +53,23 @@ XCreateGC, XCopyGC, XChangeGC, XGetGCValues, XFreeGC, XGContextFromGC, XGCValues .SH SYNTAX .HP GC XCreateGC\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, unsigned long -\fIvaluemask\fP\^, XGCValues *\^\fIvalues\fP\^); +\fIvaluemask\fP\^, XGCValues *\^\fIvalues\fP\^); .HP int XCopyGC\^(\^Display *\fIdisplay\fP\^, GC \fIsrc\fP\^, -unsigned long \fIvaluemask\fP\^, GC \fIdest\fP\^); +unsigned long \fIvaluemask\fP\^, GC \fIdest\fP\^); .HP int XChangeGC\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned long -\fIvaluemask\fP\^, XGCValues *\^\fIvalues\fP\^); +\fIvaluemask\fP\^, XGCValues *\^\fIvalues\fP\^); .HP Status XGetGCValues\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned long -\fIvaluemask\fP\^, XGCValues *\fIvalues_return\fP\^); +\fIvaluemask\fP\^, XGCValues *\fIvalues_return\fP\^); .HP -int XFreeGC\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^); +int XFreeGC\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^); .HP -GContext XGContextFromGC\^(\^GC \fIgc\fP\^); +GContext XGContextFromGC\^(\^GC \fIgc\fP\^); .SH ARGUMENTS .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdest\fP 1i Specifies the destination GC. .IP \fIdisplay\fP 1i @@ -111,264 +78,263 @@ Specifies the connection to the X server. Specifies the GC. .IP \fIsrc\fP 1i Specifies the components of the source GC. -.ds Vm set, copied, changed, or returned .IP \fIvaluemask\fP 1i -Specifies which components in the GC are to be \*(Vm. +Specifies which components in the GC are to be set, copied, changed, or returned. This argument is the bitwise inclusive OR of zero or more of the valid GC component mask bits. .IP \fIvalues\fP 1i Specifies any values as specified by the valuemask. .IP \fIvalues_return\fP 1i Returns the GC values in the specified -.ZN XGCValues +.B XGCValues structure. .SH DESCRIPTION The -.ZN XCreateGC +.B XCreateGC function creates a graphics context and returns a GC. The GC can be used with any destination drawable having the same root and depth as the specified drawable. Use with other drawables results in a -.ZN BadMatch +.B BadMatch error. .LP -.ZN XCreateGC +.B XCreateGC can generate -.ZN BadAlloc , -.ZN BadDrawable , -.ZN BadFont , -.ZN BadMatch , -.ZN BadPixmap , +.BR BadAlloc , +.BR BadDrawable , +.BR BadFont , +.BR BadMatch , +.BR BadPixmap , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XCopyGC +.B XCopyGC function copies the specified components from the source GC to the destination GC. The source and destination GCs must have the same root and depth, or a -.ZN BadMatch +.B BadMatch error results. The valuemask specifies which component to copy, as for -.ZN XCreateGC . +.BR XCreateGC . .LP -.ZN XCopyGC +.B XCopyGC can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .LP The -.ZN XChangeGC +.B XChangeGC function changes the components specified by valuemask for the specified GC. The values argument contains the values to be set. -The values and restrictions are the same as for -.ZN XCreateGC . -Changing the clip-mask overrides any previous -.ZN XSetClipRectangles -request on the context. +The values and restrictions are the same as for +.BR XCreateGC . +Changing the clip-mask overrides any previous +.B XSetClipRectangles +request on the context. Changing the dash-offset or dash-list -overrides any previous -.ZN XSetDashes +overrides any previous +.B XSetDashes request on the context. The order in which components are verified and altered is server dependent. If an error is generated, a subset of the components may have been altered. .LP -.ZN XChangeGC +.B XChangeGC can generate -.ZN BadAlloc , -.ZN BadFont , -.ZN BadGC , -.ZN BadMatch , -.ZN BadPixmap , +.BR BadAlloc , +.BR BadFont , +.BR BadGC , +.BR BadMatch , +.BR BadPixmap , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XGetGCValues +.B XGetGCValues function returns the components specified by valuemask for the specified GC. If the valuemask contains a valid set of GC mask bits .Pn ( GCFunction , -.ZN GCPlaneMask , -.ZN GCForeground , -.ZN GCBackground , -.ZN GCLineWidth , -.ZN GCLineStyle , -.ZN GCCapStyle , -.ZN GCJoinStyle , -.ZN GCFillStyle , -.ZN GCFillRule , -.ZN GCTile , -.ZN GCStipple , -.ZN GCTileStipXOrigin , -.ZN GCTileStipYOrigin , -.ZN GCFont , -.ZN GCSubwindowMode , -.ZN GCGraphicsExposures , -.ZN GCClipXOrigin , -.ZN GCCLipYOrigin , -.ZN GCDashOffset , +.BR GCPlaneMask , +.BR GCForeground , +.BR GCBackground , +.BR GCLineWidth , +.BR GCLineStyle , +.BR GCCapStyle , +.BR GCJoinStyle , +.BR GCFillStyle , +.BR GCFillRule , +.BR GCTile , +.BR GCStipple , +.BR GCTileStipXOrigin , +.BR GCTileStipYOrigin , +.BR GCFont , +.BR GCSubwindowMode , +.BR GCGraphicsExposures , +.BR GCClipXOrigin , +.BR GCCLipYOrigin , +.BR GCDashOffset , or -.ZN GCArcMode ) +.BR GCArcMode ) and no error occurs, -.ZN XGetGCValues +.B XGetGCValues sets the requested components in values_return and returns a nonzero status. Otherwise, it returns a zero status. Note that the clip-mask and dash-list (represented by the -.ZN GCClipMask -and -.ZN GCDashList +.B GCClipMask +and +.B GCDashList bits, respectively, in the valuemask) cannot be requested. Also note that an invalid resource ID (with one or more of the three most significant bits set to 1) will be returned for -.ZN GCFont , -.ZN GCTile , +.BR GCFont , +.BR GCTile , and -.ZN GCStipple +.B GCStipple if the component has never been explicitly set by the client. .LP The -.ZN XFreeGC +.B XFreeGC function destroys the specified GC as well as all the associated storage. .LP -.ZN XFreeGC +.B XFreeGC can generate a -.ZN BadGC +.B BadGC error. .SH STRUCTURES The -.ZN XGCValues +.B XGCValues structure contains: .LP /\&* GC attribute value mask bits */ .TS lw(.5i) lw(2.5i) lw(.75i). \&#define T{ -.ZN GCFunction +.B GCFunction T} T{ (1L<<0) T} \&#define T{ -.ZN GCPlaneMask +.B GCPlaneMask T} T{ (1L<<1) T} \&#define T{ -.ZN GCForeground +.B GCForeground T} T{ (1L<<2) T} \&#define T{ -.ZN GCBackground +.B GCBackground T} T{ (1L<<3) T} \&#define T{ -.ZN GCLineWidth +.B GCLineWidth T} T{ (1L<<4) T} \&#define T{ -.ZN GCLineStyle +.B GCLineStyle T} T{ (1L<<5) T} \&#define T{ -.ZN GCCapStyle +.B GCCapStyle T} T{ (1L<<6) T} \&#define T{ -.ZN GCJoinStyle +.B GCJoinStyle T} T{ (1L<<7) T} \&#define T{ -.ZN GCFillStyle +.B GCFillStyle T} T{ (1L<<8) T} \&#define T{ -.ZN GCFillRule +.B GCFillRule T} T{ (1L<<9) T} \&#define T{ -.ZN GCTile +.B GCTile T} T{ (1L<<10) T} \&#define T{ -.ZN GCStipple +.B GCStipple T} T{ (1L<<11) T} \&#define T{ -.ZN GCTileStipXOrigin +.B GCTileStipXOrigin T} T{ (1L<<12) T} \&#define T{ -.ZN GCTileStipYOrigin +.B GCTileStipYOrigin T} T{ (1L<<13) T} \&#define T{ -.ZN GCFont +.B GCFont T} T{ (1L<<14) T} \&#define T{ -.ZN GCSubwindowMode +.B GCSubwindowMode T} T{ (1L<<15) T} \&#define T{ -.ZN GCGraphicsExposures +.B GCGraphicsExposures T} T{ (1L<<16) T} \&#define T{ -.ZN GCClipXOrigin +.B GCClipXOrigin T} T{ (1L<<17) T} \&#define T{ -.ZN GCClipYOrigin +.B GCClipYOrigin T} T{ (1L<<18) T} \&#define T{ -.ZN GCClipMask +.B GCClipMask T} T{ (1L<<19) T} \&#define T{ -.ZN GCDashOffset +.B GCDashOffset T} T{ (1L<<20) T} \&#define T{ -.ZN GCDashList +.B GCDashList T} T{ (1L<<21) T} \&#define T{ -.ZN GCArcMode +.B GCArcMode T} T{ (1L<<22) T} .TE .IN "XGCValues" "" "@DEF@" .LP -.Ds 0 +.EX /\&* Values */ typedef struct { @@ -396,20 +362,20 @@ typedef struct { int dash_offset; /\&* patterned/dashed line information */ char dashes; } XGCValues; -.De +.EE .LP The function attributes of a GC are used when you update a section of -a drawable (the destination) with bits from somewhere else (the source). +a drawable (the destination) with bits from somewhere else (the source). The function in a GC defines how the new destination bits are to be computed from the source bits and the old destination bits. -.ZN GXcopy +.B GXcopy is typically the most useful because it will work on a color display, but special applications may use other functions, particularly in concert with particular planes of a color display. -The 16 GC functions, defined in +The 16 GC functions, defined in .hN X11/X.h , are: -.\" are listed in Table 5-1 along with the +.\" are listed in Table 5-1 along with the .\"the associated hexadecimal code .\" and operation. .\".CP T 1 @@ -424,112 +390,112 @@ Function Name Value Operation _ .sp 6p T{ -.ZN GXclear +.B GXclear T} T{ 0x0 T} T{ 0 T} T{ -.ZN GXand +.B GXand T} T{ 0x1 T} T{ src AND dst T} T{ -.ZN GXandReverse +.B GXandReverse T} T{ 0x2 T} T{ src AND NOT dst T} T{ -.ZN GXcopy +.B GXcopy T} T{ 0x3 T} T{ src T} T{ -.ZN GXandInverted +.B GXandInverted T} T{ 0x4 T} T{ (NOT src) AND dst T} T{ -.ZN GXnoop +.B GXnoop T} T{ 0x5 T} T{ dst T} T{ -.ZN GXxor +.B GXxor T} T{ 0x6 T} T{ src XOR dst T} T{ -.ZN GXor +.B GXor T} T{ 0x7 T} T{ src OR dst T} T{ -.ZN GXnor +.B GXnor T} T{ 0x8 T} T{ (NOT src) AND (NOT dst) T} T{ -.ZN GXequiv +.B GXequiv T} T{ 0x9 T} T{ (NOT src) XOR dst T} T{ -.ZN GXinvert +.B GXinvert T} T{ 0xa T} T{ NOT dst T} T{ -.ZN GXorReverse +.B GXorReverse T} T{ 0xb T} T{ src OR (NOT dst) T} T{ -.ZN GXcopyInverted +.B GXcopyInverted T} T{ 0xc T} T{ NOT src T} T{ -.ZN GXorInverted +.B GXorInverted T} T{ 0xd T} T{ (NOT src) OR dst T} T{ -.ZN GXnand +.B GXnand T} T{ 0xe T} T{ (NOT src) OR (NOT dst) T} T{ -.ZN GXset +.B GXset T} T{ 0xf T} T{ @@ -549,18 +515,18 @@ will be the least significant bit of the word. As planes are added to the display hardware, they will occupy more significant bits in the plane mask. .LP -In graphics operations, given a source and destination pixel, +In graphics operations, given a source and destination pixel, the result is computed bitwise on corresponding bits of the pixels. -That is, a Boolean operation is performed in each bit plane. +That is, a Boolean operation is performed in each bit plane. The plane_mask restricts the operation to a subset of planes. A macro constant -.ZN AllPlanes +.B AllPlanes can be used to refer to all planes of the screen simultaneously. The result is computed by the following: .LP -.Ds +.EX ((src FUNC dst) AND plane-mask) OR (dst AND (NOT plane-mask)) -.De +.EE .LP Range checking is not performed on the values for foreground, background, or plane_mask. @@ -574,10 +540,10 @@ Unless otherwise specified by the join-style or cap-style, the bounding box of a wide line with endpoints [x1, y1], [x2, y2] and width w is a rectangle with vertices at the following real coordinates: .LP -.Ds +.EX [x1-(w*sn/2), y1+(w*cs/2)], [x1+(w*sn/2), y1-(w*cs/2)], [x2-(w*sn/2), y2+(w*cs/2)], [x2+(w*sn/2), y2-(w*cs/2)] -.De +.EE .LP Here sn is the sine of the angle of the line, and cs is the cosine of the angle of the line. @@ -588,28 +554,28 @@ If the center of the pixel is exactly on the bounding box, it is part of the line if and only if the interior is immediately to its right (x increasing direction). Pixels with centers on a horizontal edge are a special case and are part of -the line if and only if the interior or the boundary is immediately below +the line if and only if the interior or the boundary is immediately below (y increasing direction) and the interior or the boundary is immediately to the right (x increasing direction). .LP Thin lines (zero line-width) are one-pixel-wide lines drawn using an unspecified, device-dependent algorithm. -There are only two constraints on this algorithm. +There are only two constraints on this algorithm. .IP 1. 5 If a line is drawn unclipped from [x1,y1] to [x2,y2] and if another line is drawn unclipped from [x1+dx,y1+dy] to [x2+dx,y2+dy], -a point [x,y] is touched by drawing the first line +a point [x,y] is touched by drawing the first line if and only if the point [x+dx,y+dy] is touched by drawing the second line. .IP 2. 5 The effective set of points comprising a line cannot be affected by clipping. -That is, a point is touched in a clipped line if and only if the point +That is, a point is touched in a clipped line if and only if the point lies inside the clipping region and the point would be touched by the line when drawn unclipped. .LP -A wide line drawn from [x1,y1] to [x2,y2] always draws the same pixels -as a wide line drawn from [x2,y2] to [x1,y1], not counting cap-style +A wide line drawn from [x1,y1] to [x2,y2] always draws the same pixels +as a wide line drawn from [x2,y2] to [x1,y1], not counting cap-style and join-style. -It is recommended that this property be true for thin lines, +It is recommended that this property be true for thin lines, but this is not required. A line-width of zero may differ from a line-width of one in which pixels are drawn. @@ -617,7 +583,7 @@ This permits the use of many manufacturers' line drawing hardware, which may run many times faster than the more precisely specified wide lines. .LP -In general, +In general, drawing a thin line will be faster than drawing a wide line of width one. However, because of their different drawing algorithms, thin lines may not mix well aesthetically with wide lines. @@ -626,148 +592,148 @@ a client should always use a line-width of one rather than a line-width of zero. .LP The line-style defines which sections of a line are drawn: .TS -lw(1.3i) lw(4.5i). +lw(1.0i) lw(4.5i). T{ -.ZN LineSolid +.B LineSolid T} T{ The full path of the line is drawn. T} .sp 6p T{ -.ZN LineDoubleDash +.B LineDoubleDash T} T{ -The full path of the line is drawn, -but the even dashes are filled differently +The full path of the line is drawn, +but the even dashes are filled differently from the odd dashes (see fill-style) with -.ZN CapButt +.B CapButt style used where even and odd dashes meet. T} .sp 6p T{ -.ZN LineOnOffDash +.B LineOnOffDash T} T{ Only the even dashes are drawn, -and cap-style applies to +and cap-style applies to all internal ends of the individual dashes, -except -.ZN CapNotLast -is treated as -.ZN CapButt . +except +.B CapNotLast +is treated as +.BR CapButt . T} .TE .LP The cap-style defines how the endpoints of a path are drawn: .IN "Graphics context" "path" .TS -lw(1.3i) lw(4.5i). +lw(1.0i) lw(4.5i). T{ -.ZN CapNotLast +.B CapNotLast T} T{ -This is equivalent to -.ZN CapButt +This is equivalent to +.B CapButt except that for a line-width of zero the final endpoint is not drawn. T} .sp 6p T{ -.ZN CapButt +.B CapButt T} T{ The line is square at the endpoint (perpendicular to the slope of the line) with no projection beyond. T} .sp 6p T{ -.ZN CapRound +.B CapRound T} T{ The line has a circular arc with the diameter equal to the line-width, centered on the endpoint. -(This is equivalent to -.ZN CapButt +(This is equivalent to +.B CapButt for line-width of zero). T} .sp 6p T{ -.ZN CapProjecting +.B CapProjecting T} T{ -The line is square at the end, but the path continues beyond the endpoint +The line is square at the end, but the path continues beyond the endpoint for a distance equal to half the line-width. -(This is equivalent to -.ZN CapButt +(This is equivalent to +.B CapButt for line-width of zero). T} .TE .LP The join-style defines how corners are drawn for wide lines: .TS -lw(1.3i) lw(4.5i). +lw(1.0i) lw(4.5i). T{ -.ZN JoinMiter +.B JoinMiter T} T{ The outer edges of two lines extend to meet at an angle. However, if the angle is less than 11 degrees, then a -.ZN JoinBevel +.B JoinBevel join-style is used instead. T} .sp 6p T{ -.ZN JoinRound +.B JoinRound T} T{ -The corner is a circular arc with the diameter equal to the line-width, +The corner is a circular arc with the diameter equal to the line-width, centered on the joinpoint. T} .sp 6p T{ -.ZN JoinBevel +.B JoinBevel T} T{ The corner has -.ZN CapButt +.B CapButt endpoint styles with the triangular notch filled. T} .TE .LP -For a line with coincident endpoints (x1=x2, y1=y2), -when the cap-style is applied to both endpoints, +For a line with coincident endpoints (x1=x2, y1=y2), +when the cap-style is applied to both endpoints, the semantics depends on the line-width and the cap-style: .TS -lw(1.3i) lw(.5i) lw(4i). +lw(1.0i) lw(.5i) lw(4i). T{ -.ZN CapNotLast +.B CapNotLast T} T{ thin T} T{ -The results are device dependent, +The results are device dependent, but the desired effect is that nothing is drawn. T} .sp 6p T{ -.ZN CapButt +.B CapButt T} T{ thin T} T{ -The results are device dependent, +The results are device dependent, but the desired effect is that a single pixel is drawn. T} .sp 6p T{ -.ZN CapRound +.B CapRound T} T{ thin T} T{ The results are the same as for -.ZN CapButt /thin. +.BR CapButt /thin. T} .sp 6p T{ -.ZN CapProjecting +.B CapProjecting T} T{ thin T} T{ The results are the same as for -.ZN CapButt /thin. +.BR CapButt /thin. T} .sp 6p T{ -.ZN CapButt +.B CapButt T} T{ wide T} T{ @@ -775,7 +741,7 @@ Nothing is drawn. T} .sp 6p T{ -.ZN CapRound +.B CapRound T} T{ wide T} T{ @@ -784,7 +750,7 @@ with the diameter equal to the line-width. T} .sp 6p T{ -.ZN CapProjecting +.B CapProjecting T} T{ wide T} T{ @@ -793,8 +759,8 @@ endpoint, and with the sides equal to the line-width. T} .TE .LP -For a line with coincident endpoints (x1=x2, y1=y2), -when the join-style is applied at one or both endpoints, +For a line with coincident endpoints (x1=x2, y1=y2), +when the join-style is applied at one or both endpoints, the effect is as if the line was removed from the overall path. However, if the total path consists of or is reduced to a single point joined with itself, the effect is the same as when the cap-style is applied at both @@ -811,59 +777,59 @@ origin of whatever destination drawable is specified in a graphics request. The tile pixmap must have the same root and depth as the GC, or a -.ZN BadMatch +.B BadMatch error results. The stipple pixmap must have depth one and must have the same root as the -GC, or a -.ZN BadMatch -error results. +GC, or a +.B BadMatch +error results. For stipple operations where the fill-style is -.ZN FillStippled -but not -.ZN FillOpaqueStippled , +.B FillStippled +but not +.BR FillOpaqueStippled , the stipple pattern is tiled in a single plane and acts as an additional clip mask to be ANDed with the clip-mask. Although some sizes may be faster to use than others, any size pixmap can be used for tiling or stippling. .LP The fill-style defines the contents of the source for line, text, and -fill requests. +fill requests. For all text and fill requests (for example, -.ZN XDrawText , -.ZN XDrawText16 , -.ZN XFillRectangle , -.ZN XFillPolygon , +.BR XDrawText , +.BR XDrawText16 , +.BR XFillRectangle , +.BR XFillPolygon , and -.ZN XFillArc ); -for line requests -with line-style -.ZN LineSolid +.BR XFillArc ); +for line requests +with line-style +.B LineSolid (for example, -.ZN XDrawLine , -.ZN XDrawSegments , -.ZN XDrawRectangle , -.ZN XDrawArc ); -and for the even dashes for line requests with line-style -.ZN LineOnOffDash -or -.ZN LineDoubleDash , +.BR XDrawLine , +.BR XDrawSegments , +.BR XDrawRectangle , +.BR XDrawArc ); +and for the even dashes for line requests with line-style +.B LineOnOffDash +or +.BR LineDoubleDash , the following apply: .TS -lw(1.8i) lw(4i). +lw(1.5i) lw(4i). T{ -.ZN FillSolid +.B FillSolid T} T{ Foreground T} .sp 6p T{ -.ZN FillTiled +.B FillTiled T} T{ Tile T} .sp 6p T{ -.ZN FillOpaqueStippled +.B FillOpaqueStippled T} T{ A tile with the same width and height as stipple, but with background everywhere stipple has a zero @@ -871,37 +837,37 @@ and with foreground everywhere stipple has a one T} .sp 6p T{ -.ZN FillStippled +.B FillStippled T} T{ Foreground masked by stipple T} .TE .LP When drawing lines with line-style -.ZN LineDoubleDash , +.BR LineDoubleDash , the odd dashes are controlled by the fill-style in the following manner: .TS -lw(1.8i) lw(4i). +lw(1.5i) lw(4i). T{ -.ZN FillSolid +.B FillSolid T} T{ Background T} .sp 6p T{ -.ZN FillTiled +.B FillTiled T} T{ Same as for even dashes T} .sp 6p T{ -.ZN FillOpaqueStippled +.B FillOpaqueStippled T} T{ Same as for even dashes T} .sp 6p T{ -.ZN FillStippled +.B FillStippled T} T{ Background masked by stipple T} @@ -916,7 +882,7 @@ a destination and as a tile or stipple, the results are undefined. .LP For optimum performance, -you should draw as much as possible with the same GC +you should draw as much as possible with the same GC (without changing its components). The costs of changing GC components relative to using different GCs depend on the display hardware and the server implementation. @@ -925,32 +891,32 @@ cached in display hardware and that such hardware can only cache a small number of GCs. .LP The dashes value is actually a simplified form of the -more general patterns that can be set with -.ZN XSetDashes . +more general patterns that can be set with +.BR XSetDashes . Specifying a -value of N is equivalent to specifying the two-element list [N, N] in -.ZN XSetDashes . +value of N is equivalent to specifying the two-element list [N, N] in +.BR XSetDashes . The value must be nonzero, or a -.ZN BadValue +.B BadValue error results. .LP -The clip-mask restricts writes to the destination drawable. +The clip-mask restricts writes to the destination drawable. If the clip-mask is set to a pixmap, it must have depth one and have the same root as the GC, or a -.ZN BadMatch +.B BadMatch error results. If clip-mask is set to -.ZN None , +.BR None , the pixels are always drawn regardless of the clip origin. The clip-mask also can be set by calling the -.ZN XSetClipRectangles +.B XSetClipRectangles or -.ZN XSetRegion +.B XSetRegion functions. -Only pixels where the clip-mask has a bit set to 1 are drawn. -Pixels are not drawn outside the area covered by the clip-mask +Only pixels where the clip-mask has a bit set to 1 are drawn. +Pixels are not drawn outside the area covered by the clip-mask or where the clip-mask has a bit set to 0. The clip-mask affects all graphics requests. The clip-mask does not clip sources. @@ -958,40 +924,40 @@ The clip-mask origin is interpreted relative to the origin of whatever destination drawable is specified in a graphics request. .LP You can set the subwindow-mode to -.ZN ClipByChildren +.B ClipByChildren or -.ZN IncludeInferiors . -For -.ZN ClipByChildren , +.BR IncludeInferiors . +For +.BR ClipByChildren , both source and destination windows are -additionally clipped by all viewable -.ZN InputOutput -children. -For -.ZN IncludeInferiors , -neither source nor destination window is clipped by inferiors. +additionally clipped by all viewable +.B InputOutput +children. +For +.BR IncludeInferiors , +neither source nor destination window is clipped by inferiors. This will result in including subwindow contents in the source and drawing through subwindow boundaries of the destination. -The use of -.ZN IncludeInferiors +The use of +.B IncludeInferiors on a window of one depth with mapped inferiors of differing depth is not illegal, but the semantics are undefined by the core protocol. .LP The fill-rule defines what pixels are inside (drawn) for -paths given in -.ZN XFillPolygon -requests and can be set to -.ZN EvenOddRule +paths given in +.B XFillPolygon +requests and can be set to +.B EvenOddRule or -.ZN WindingRule . +.BR WindingRule . For -.ZN EvenOddRule , +.BR EvenOddRule , a point is inside if an infinite ray with the point as origin crosses the path an odd number -of times. -For -.ZN WindingRule , +of times. +For +.BR WindingRule , a point is inside if an infinite ray with the point as origin crosses an unequal number of clockwise and counterclockwise directed path segments. @@ -1003,72 +969,73 @@ The case where a directed line segment is coincident with the ray is uninteresting because you can simply choose a different ray that is not coincident with a segment. .LP -For both -.ZN EvenOddRule +For both +.B EvenOddRule and -.ZN WindingRule , -a point is infinitely small, -and the path is an infinitely thin line. +.BR WindingRule , +a point is infinitely small, +and the path is an infinitely thin line. A pixel is inside if the center point of the pixel is inside -and the center point is not on the boundary. +and the center point is not on the boundary. If the center point is on the boundary, the pixel is inside if and only if the polygon interior is immediately to -its right (x increasing direction). -Pixels with centers on a horizontal edge are a special case -and are inside if and only if the polygon interior is immediately below +its right (x increasing direction). +Pixels with centers on a horizontal edge are a special case +and are inside if and only if the polygon interior is immediately below (y increasing direction). .LP -The arc-mode controls filling in the -.ZN XFillArcs +The arc-mode controls filling in the +.B XFillArcs function and can be set to -.ZN ArcPieSlice +.B ArcPieSlice or -.ZN ArcChord . +.BR ArcChord . For -.ZN ArcPieSlice , +.BR ArcPieSlice , the arcs are pie-slice filled. For -.ZN ArcChord , +.BR ArcChord , the arcs are chord filled. .LP -The graphics-exposure flag controls -.ZN GraphicsExpose +The graphics-exposure flag controls +.B GraphicsExpose event generation -for -.ZN XCopyArea -and -.ZN XCopyPlane +for +.B XCopyArea +and +.B XCopyPlane requests (and any similar requests defined by extensions). .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadFont +.B BadFont A value for a Font or GContext argument does not name a defined Font. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" AllPlanes(__libmansuffix__), diff --git a/lib/libX11/man/XCreateIC.man b/lib/libX11/man/XCreateIC.man index 290ea3d8c..bbda029d1 100644 --- a/lib/libX11/man/XCreateIC.man +++ b/lib/libX11/man/XCreateIC.man @@ -38,54 +38,21 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCreateIC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCreateIC, XDestroyIC, XIMOfIC \- create, destroy, and obtain the input method of an input context .SH SYNTAX .HP -XIC XCreateIC\^(\^XIM \fIim\fP\^, ...\^); +XIC XCreateIC\^(\^XIM \fIim\fP\^, ...\^); .HP -void XDestroyIC\^(\^XIC \fIic\fP\^); +void XDestroyIC\^(\^XIC \fIic\fP\^); .HP XIM XIMOfIC\^(\^XIC \fIic\fP\^); .SH ARGUMENTS @@ -93,12 +60,11 @@ XIM XIMOfIC\^(\^XIC \fIic\fP\^); Specifies the input context. .IP \fIim\fP 1i Specifies the input method. -.ds Al \ to set XIC values .IP ... 1i -Specifies the variable length argument list\*(Al. +Specifies the variable length argument list to set XIC values. .SH DESCRIPTION The -.ZN XCreateIC +.B XCreateIC function creates a context within the specified input method. .LP Some of the arguments are mandatory at creation time, and @@ -107,47 +73,47 @@ The mandatory arguments are the input style and the set of text callbacks (if the input style selected requires callbacks). All other input context values can be set later. .LP -.ZN XCreateIC +.B XCreateIC returns a NULL value if no input context could be created. A NULL value could be returned for any of the following reasons: .IP \(bu 5 A required argument was not set. .IP \(bu 5 A read-only argument was set (for example, -.ZN XNFilterEvents ). +.BR XNFilterEvents ). .IP \(bu 5 The argument name is not recognized. .IP \(bu 5 The input method encountered an input method implementation-dependent error. .LP The -.ZN XCreateIC +.B XCreateIC can generate -.ZN BadAtom , -.ZN BadColor , -.ZN BadPixmap , +.BR BadAtom , +.BR BadColor , +.BR BadPixmap , and -.ZN BadWindow +.B BadWindow errors. .LP -.ZN XDestroyIC +.B XDestroyIC destroys the specified input context. .LP The -.ZN XIMOfIC +.B XIMOfIC function returns the input method associated with the specified input context. .SH DIAGNOSTICS .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XOpenIM(__libmansuffix__), diff --git a/lib/libX11/man/XCreateOC.man b/lib/libX11/man/XCreateOC.man index e04a1ef82..8b2644b76 100644 --- a/lib/libX11/man/XCreateOC.man +++ b/lib/libX11/man/XCreateOC.man @@ -38,78 +38,44 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCreateOC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCreateOC, XDestroyOC, XSetOCValues, XGetOCValues, XOMOfOC \- create output contexts .SH SYNTAX .HP -XOC XCreateOC\^(\^XOM \fIom\fP\^); +XOC XCreateOC\^(\^XOM \fIom\fP\^); .HP -void XDestroyOC\^(\^XOC \fIoc\fP\^); +void XDestroyOC\^(\^XOC \fIoc\fP\^); .HP -char * XSetOCValues\^(\^XOC \fIoc\fP\^, ...); +char * XSetOCValues\^(\^XOC \fIoc\fP\^, ...); .HP -char * XGetOCValues\^(\^XOC \fIoc\fP\^, ...); +char * XGetOCValues\^(\^XOC \fIoc\fP\^, ...); .HP -XOM XOMOfOC\^(\^XOC \fIoc\fP\^); +XOM XOMOfOC\^(\^XOC \fIoc\fP\^); .SH ARGUMENTS .IP \fIoc\fP 1i Specifies the output context. .IP \fIom\fP 1i Specifies the output method. -.ds Al \ to set or get XOC values .IP ... 1i -Specifies the variable length argument list\*(Al. +Specifies the variable length argument list to set or get XOC values. .SH DESCRIPTION The -.ZN XCreateOC +.B XCreateOC function creates an output context within the specified output method. .LP The base font names argument is mandatory at creation time, and the output context will not be created unless it is provided. All other output context values can be set later. .LP -.ZN XCreateOC +.B XCreateOC returns NULL if no output context could be created. NULL can be returned for any of the following reasons: .IP \(bu 5 @@ -122,12 +88,12 @@ An argument name is not recognized. The output method encountered an output method implementation-dependent error. .LP The -.ZN XDestroyOC +.B XDestroyOC function destroys the specified output context. .LP The -.ZN XSetOCValues -function returns NULL if no error occurred; +.B XSetOCValues +function returns NULL if no error occurred; otherwise, it returns the name of the first argument that could not be set. An argument might not be set for any of the following reasons: @@ -142,7 +108,7 @@ Each value to be set must be an appropriate datum, matching the data type imposed by the semantics of the argument. .LP The -.ZN XGetOCValues +.B XGetOCValues function returns NULL if no error occurred; otherwise, it returns the name of the first argument that could not be obtained. An argument might not be obtained for any of the following reasons: @@ -155,7 +121,7 @@ Each argument value following a name must point to a location where the value is to be stored. .LP The -.ZN XOMOfOC +.B XOMOfOC function returns the output method associated with the specified output context. .SH "SEE ALSO" diff --git a/lib/libX11/man/XCreatePixmap.man b/lib/libX11/man/XCreatePixmap.man index d9d64225f..39c1c390a 100644 --- a/lib/libX11/man/XCreatePixmap.man +++ b/lib/libX11/man/XCreatePixmap.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCreatePixmap __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCreatePixmap, XFreePixmap \- create or destroy pixmaps @@ -85,83 +52,83 @@ XCreatePixmap, XFreePixmap \- create or destroy pixmaps .HP Pixmap XCreatePixmap\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int -\fIdepth\fP\^); +\fIdepth\fP\^); .HP -int XFreePixmap\^(\^Display *\fIdisplay\fP\^, Pixmap \fIpixmap\fP\^); +int XFreePixmap\^(\^Display *\fIdisplay\fP\^, Pixmap \fIpixmap\fP\^); .SH ARGUMENTS .IP \fId\fP 1i -Specifies which screen the pixmap is created on. +Specifies which screen the pixmap is created on. .IP \fIdepth\fP 1i Specifies the depth of the pixmap. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIpixmap\fP 1i Specifies the pixmap. -.ds Wh , which define the dimensions of the pixmap .IP \fIwidth\fP 1i .br .ns .IP \fIheight\fP 1i -Specify the width and height\*(Wh. +Specify the width and height, which define the dimensions of the pixmap. .SH DESCRIPTION The -.ZN XCreatePixmap +.B XCreatePixmap function creates a pixmap of the width, height, and depth you specified and returns a pixmap ID that identifies it. -It is valid to pass an -.ZN InputOnly +It is valid to pass an +.B InputOnly window to the drawable argument. The width and height arguments must be nonzero, -or a -.ZN BadValue +or a +.B BadValue error results. The depth argument must be one of the depths supported by the screen of the specified drawable, or a -.ZN BadValue +.B BadValue error results. .LP The server uses the specified drawable to determine on which screen to create the pixmap. The pixmap can be used only on this screen and only with other drawables of the same depth (see -.ZN XCopyPlane +.B XCopyPlane for an exception to this rule). The initial contents of the pixmap are undefined. .LP -.ZN XCreatePixmap +.B XCreatePixmap can generate -.ZN BadAlloc , -.ZN BadDrawable , +.BR BadAlloc , +.BR BadDrawable , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XFreePixmap +.B XFreePixmap function first deletes the association between the pixmap ID and the pixmap. Then, the X server frees the pixmap storage when there are no references to it. The pixmap should never be referenced again. .LP -.ZN XFreePixmap +.B XFreePixmap can generate a -.ZN BadPixmap +.B BadPixmap error. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XCopyArea(__libmansuffix__) diff --git a/lib/libX11/man/XCreateRegion.man b/lib/libX11/man/XCreateRegion.man index 7759035ba..d632a6bf2 100644 --- a/lib/libX11/man/XCreateRegion.man +++ b/lib/libX11/man/XCreateRegion.man @@ -38,56 +38,23 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCreateRegion __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCreateRegion, XSetRegion, XDestroyRegion \- create or destroy regions .SH SYNTAX .HP -Region XCreateRegion\^(void\^); +Region XCreateRegion\^(void\^); .HP int XSetRegion\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, Region \fIr\fP\^); .HP -int XDestroyRegion\^(\^Region \fIr\fP\^); +int XDestroyRegion\^(\^Region \fIr\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -97,11 +64,11 @@ Specifies the GC. Specifies the region. .SH DESCRIPTION The -.ZN XCreateRegion +.B XCreateRegion function creates a new empty region. .LP The -.ZN XSetRegion +.B XSetRegion function sets the clip-mask in the GC to the specified region. The region is specified relative to the drawable's origin. The resulting GC clip origin is implementation-dependent. @@ -109,7 +76,7 @@ Once it is set in the GC, the region can be destroyed. .LP The -.ZN XDestroyRegion +.B XDestroyRegion function deallocates the storage associated with a specified region. .SH "SEE ALSO" XEmptyRegion(__libmansuffix__), diff --git a/lib/libX11/man/XCreateWindow.man b/lib/libX11/man/XCreateWindow.man index 16cc7455f..ffdf77b85 100644 --- a/lib/libX11/man/XCreateWindow.man +++ b/lib/libX11/man/XCreateWindow.man @@ -39,55 +39,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XCreateWindow __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCreateWindow, XCreateSimpleWindow, XSetWindowAttributes \- create windows and window attributes structure .SH SYNTAX .HP -Window XCreateWindow\^(\^Display *\fIdisplay\fP\^, Window \fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int \fIborder_width\fP\^, int \fIdepth\fP\^, unsigned int \fIclass\fP\^, Visual *\fIvisual\fP\^, unsigned long \fIvaluemask\fP\^, XSetWindowAttributes *\fIattributes\fP\^); +Window XCreateWindow\^(\^Display *\fIdisplay\fP\^, Window \fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int \fIborder_width\fP\^, int \fIdepth\fP\^, unsigned int \fIclass\fP\^, Visual *\fIvisual\fP\^, unsigned long \fIvaluemask\fP\^, XSetWindowAttributes *\fIattributes\fP\^); .HP -Window XCreateSimpleWindow\^(\^Display *\fIdisplay\fP\^, Window \fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int \fIborder_width\fP\^, unsigned long \fIborder\fP\^, unsigned long \fIbackground\fP\^); +Window XCreateSimpleWindow\^(\^Display *\fIdisplay\fP\^, Window \fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int \fIborder_width\fP\^, unsigned long \fIborder\fP\^, unsigned long \fIbackground\fP\^); .SH ARGUMENTS .IP \fIattributes\fP 1i Specifies the structure from which the values (as specified by the value mask) @@ -104,18 +71,18 @@ Specifies the width of the created window's border in pixels. .IP \fIclass\fP 1i Specifies the created window's class. You can pass -.ZN InputOutput , -.ZN InputOnly , -or -.ZN CopyFromParent . -A class of -.ZN CopyFromParent +.BR InputOutput , +.BR InputOnly , +or +.BR CopyFromParent . +A class of +.B CopyFromParent means the class is taken from the parent. .IP \fIdepth\fP 1i Specifies the window's depth. -A depth of -.ZN CopyFromParent +A depth of +.B CopyFromParent means the depth is taken from the parent. .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -129,33 +96,32 @@ If valuemask is zero, the attributes are ignored and are not referenced. .IP \fIvisual\fP 1i Specifies the visual type. -A visual of -.ZN CopyFromParent -means the visual type is taken from the +A visual of +.B CopyFromParent +means the visual type is taken from the parent. -.ds Wh , which are the created window's inside dimensions \ -and do not include the created window's borders .IP \fIwidth\fP 1i .br .ns .IP \fIheight\fP 1i -Specify the width and height\*(Wh. -.ds Xy , which are the top-left outside corner of the window's \ -borders and are relative to the inside of the parent window's borders +Specify the width and height, which are the created window's inside dimensions +and do not include the created window's borders. .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which are the top-left outside +corner of the window's +borders and are relative to the inside of the parent window's borders. .SH DESCRIPTION The -.ZN XCreateWindow -function creates an unmapped subwindow for a specified parent window, -returns the window ID of the created window, +.B XCreateWindow +function creates an unmapped subwindow for a specified parent window, +returns the window ID of the created window, and causes the X server to generate a -.ZN CreateNotify +.B CreateNotify event. -The created window is placed on top in the stacking order +The created window is placed on top in the stacking order with respect to siblings. .LP The coordinate system has the X axis horizontal and the Y axis vertical @@ -164,95 +130,95 @@ Coordinates are integral, in terms of pixels, and coincide with pixel centers. Each window and pixmap has its own coordinate system. -For a window, +For a window, the origin is inside the border at the inside, upper-left corner. .LP The border_width for an -.ZN InputOnly +.B InputOnly window must be zero, or a -.ZN BadMatch +.B BadMatch error results. For class -.ZN InputOutput , +.BR InputOutput , the visual type and depth must be a combination supported for the screen, or a -.ZN BadMatch +.B BadMatch error results. The depth need not be the same as the parent, -but the parent must not be a window of class -.ZN InputOnly , +but the parent must not be a window of class +.BR InputOnly , or a -.ZN BadMatch +.B BadMatch error results. For an -.ZN InputOnly +.B InputOnly window, the depth must be zero, and the visual must be one supported by the screen. If either condition is not met, a -.ZN BadMatch +.B BadMatch error results. The parent window, however, may have any depth and class. If you specify any invalid window attribute for a window, a -.ZN BadMatch +.B BadMatch error results. .LP The created window is not yet displayed (mapped) on the user's display. To display the window, call -.ZN XMapWindow . +.BR XMapWindow . The new window initially uses the same cursor as -its parent. +its parent. A new cursor can be defined for the new window by calling -.ZN XDefineCursor . +.BR XDefineCursor . .IN "Cursor" "Initial State" -.IN "XDefineCursor" +.IN "XDefineCursor" The window will not be visible on the screen unless it and all of its ancestors are mapped and it is not obscured by any of its ancestors. .LP -.ZN XCreateWindow +.B XCreateWindow can generate -.ZN BadAlloc -.ZN BadColor , -.ZN BadCursor , -.ZN BadMatch , -.ZN BadPixmap , -.ZN BadValue , +.B BadAlloc +.BR BadColor , +.BR BadCursor , +.BR BadMatch , +.BR BadPixmap , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XCreateSimpleWindow +.B XCreateSimpleWindow function creates an unmapped -.ZN InputOutput +.B InputOutput subwindow for a specified parent window, returns the window ID of the created window, and causes the X server to generate a -.ZN CreateNotify +.B CreateNotify event. -The created window is placed on top in the stacking order with respect to +The created window is placed on top in the stacking order with respect to siblings. Any part of the window that extends outside its parent window is clipped. The border_width for an -.ZN InputOnly +.B InputOnly window must be zero, or a -.ZN BadMatch +.B BadMatch error results. -.ZN XCreateSimpleWindow +.B XCreateSimpleWindow inherits its depth, class, and visual from its parent. -All other window attributes, except background and border, +All other window attributes, except background and border, have their default values. .LP -.ZN XCreateSimpleWindow +.B XCreateSimpleWindow can generate -.ZN BadAlloc , -.ZN BadMatch , -.ZN BadValue , +.BR BadAlloc , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .SH STRUCTURES The -.ZN XSetWindow Attributes +.BR XSetWindow Attributes structure contains: .LP .LP @@ -262,111 +228,111 @@ lw(.5i) lw(2.5i) lw(.8i). T{ \&#define T} T{ -.ZN CWBackPixmap +.B CWBackPixmap T} T{ (1L<<0) T} T{ \&#define T} T{ -.ZN CWBackPixel +.B CWBackPixel T} T{ (1L<<1) T} T{ \&#define T} T{ -.ZN CWBorderPixmap +.B CWBorderPixmap T} T{ (1L<<2) T} T{ \&#define T} T{ -.ZN CWBorderPixel +.B CWBorderPixel T} T{ (1L<<3) T} T{ \&#define T} T{ -.ZN CWBitGravity +.B CWBitGravity T} T{ (1L<<4) T} T{ \&#define T} T{ -.ZN CWWinGravity +.B CWWinGravity T} T{ (1L<<5) T} T{ \&#define T} T{ -.ZN CWBackingStore +.B CWBackingStore T} T{ (1L<<6) T} T{ \&#define T} T{ -.ZN CWBackingPlanes +.B CWBackingPlanes T} T{ (1L<<7) T} T{ \&#define T} T{ -.ZN CWBackingPixel +.B CWBackingPixel T} T{ (1L<<8) T} T{ \&#define T} T{ -.ZN CWOverrideRedirect +.B CWOverrideRedirect T} T{ (1L<<9) T} T{ \&#define T} T{ -.ZN CWSaveUnder +.B CWSaveUnder T} T{ (1L<<10) T} T{ \&#define T} T{ -.ZN CWEventMask +.B CWEventMask T} T{ (1L<<11) T} T{ \&#define T} T{ -.ZN CWDontPropagate +.B CWDontPropagate T} T{ (1L<<12) T} T{ \&#define T} T{ -.ZN CWColormap +.B CWColormap T} T{ (1L<<13) T} T{ \&#define T} T{ -.ZN CWCursor +.B CWCursor T} T{ (1L<<14) T} .TE .IN "XSetWindowAttributes" "" "@DEF@" -.Ds 0 +.EX /\&* Values */ typedef struct { @@ -386,47 +352,48 @@ typedef struct { Colormap colormap; /\&* color map to be associated with window */ Cursor cursor; /\&* cursor to be displayed (or None) */ } XSetWindowAttributes; -.De +.EE .LP For a detailed explanation of the members of this structure, see \fI\*(xL\fP\^. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadMatch +.B BadMatch The values do not exist for an -.ZN InputOnly +.B InputOnly window. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), -XConfigureWindow(__libmansuffix__), +XConfigureWindow(__libmansuffix__), XDefineCursor(__libmansuffix__), -XDestroyWindow(__libmansuffix__), -XMapWindow(__libmansuffix__), +XDestroyWindow(__libmansuffix__), +XMapWindow(__libmansuffix__), XRaiseWindow(__libmansuffix__), XUnmapWindow(__libmansuffix__) .br diff --git a/lib/libX11/man/XCreateWindowEvent.man b/lib/libX11/man/XCreateWindowEvent.man index 9322bb57b..c1d0486bb 100644 --- a/lib/libX11/man/XCreateWindowEvent.man +++ b/lib/libX11/man/XCreateWindowEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCreateWindowEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCreateWindowEvent \- CreateNotify event structure .SH STRUCTURES The structure for -.ZN CreateNotify +.B CreateNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* CreateNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -99,7 +66,7 @@ typedef struct { int border_width; /\&* border width */ Bool override_redirect; /\&* creation should be overridden */ } XCreateWindowEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -107,16 +74,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -125,17 +92,17 @@ dispatchers. .LP The parent member is set to the created window's parent. The window member specifies the created window. -The x and y members are set to the created window's coordinates relative -to the parent window's origin and indicate the position of the upper-left +The x and y members are set to the created window's coordinates relative +to the parent window's origin and indicate the position of the upper-left outside corner of the created window. -The width and height members are set to the inside size of the created window +The width and height members are set to the inside size of the created window (not including the border) and are always nonzero. The border_width member is set to the width of the created window's border, in pixels. The override_redirect member is set to the override-redirect attribute of the window. -Window manager clients normally should ignore this window +Window manager clients normally should ignore this window if the override_redirect member is -.ZN True . +.BR True . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/lib/libX11/man/XCrossingEvent.man b/lib/libX11/man/XCrossingEvent.man index 98eaf5542..8a35cf85a 100644 --- a/lib/libX11/man/XCrossingEvent.man +++ b/lib/libX11/man/XCrossingEvent.man @@ -38,63 +38,30 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCrossingEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCrossingEvent \- EnterNotify and LeaveNotify event structure .SH STRUCTURES The structure for -.ZN EnterNotify +.B EnterNotify and -.ZN LeaveNotify +.B LeaveNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* EnterNotify or LeaveNotify */ unsigned long serial; /\&* # of last request processed by server */ Bool send_event; /\&* true if this came from a SendEvent request */ Display *display; /\&* Display the event was read from */ - Window window; /\&* ``event'' window reported relative to */ + Window window; /\&* \*(lqevent\*(rq window reported relative to */ Window root; /\&* root window that the event occurred on */ Window subwindow; /\&* child window */ Time time; /\&* milliseconds */ @@ -103,7 +70,7 @@ typedef struct { int mode; /\&* NotifyNormal, NotifyGrab, NotifyUngrab */ int detail; /\&* - * NotifyAncestor, NotifyVirtual, NotifyInferior, + * NotifyAncestor, NotifyVirtual, NotifyInferior, * NotifyNonlinear,NotifyNonlinearVirtual */ Bool same_screen; /\&* same screen flag */ @@ -112,7 +79,7 @@ typedef struct { } XCrossingEvent; typedef XCrossingEvent XEnterWindowEvent; typedef XCrossingEvent XLeaveWindowEvent; -.De +.EE .LP When you receive these events, the structure members are set as follows. @@ -120,16 +87,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -137,102 +104,102 @@ The window member is set to the window that is most useful to toolkit dispatchers. .LP The window member is set to the window on which the -.ZN EnterNotify +.B EnterNotify or -.ZN LeaveNotify -event was generated and is referred to as the event window. -This is the window used by the X server to report the event, +.B LeaveNotify +event was generated and is referred to as the event window. +This is the window used by the X server to report the event, and is relative to the root -window on which the event occurred. +window on which the event occurred. The root member is set to the root window of the screen on which the event occurred. .LP For a -.ZN LeaveNotify +.B LeaveNotify event, if a child of the event window contains the initial position of the pointer, the subwindow component is set to that child. Otherwise, the X server sets the subwindow member to -.ZN None . +.BR None . For an -.ZN EnterNotify -event, if a child of the event window contains the final pointer position, +.B EnterNotify +event, if a child of the event window contains the final pointer position, the subwindow component is set to that child or -.ZN None . +.BR None . .LP The time member is set to the time when the event was generated and is expressed in milliseconds. -The x and y members are set to the coordinates of the pointer position in +The x and y members are set to the coordinates of the pointer position in the event window. This position is always the pointer's final position, not its initial position. If the event window is on the same screen as the root window, x and y are the pointer coordinates -relative to the event window's origin. +relative to the event window's origin. Otherwise, x and y are set to zero. The x_root and y_root members are set to the pointer's coordinates relative to the root window's origin at the time of the event. .LP The same_screen member is set to indicate whether the event window is on the same screen as the root window and can be either -.ZN True +.B True or -.ZN False . +.BR False . If -.ZN True , +.BR True , the event and root windows are on the same screen. If -.ZN False , +.BR False , the event and root windows are not on the same screen. .LP The focus member is set to indicate whether the event window is the focus window or an inferior of the focus window. The X server can set this member to either -.ZN True +.B True or -.ZN False . +.BR False . If -.ZN True , +.BR True , the event window is the focus window or an inferior of the focus window. If -.ZN False , +.BR False , the event window is not the focus window or an inferior of the focus window. .LP The state member is set to indicate the state of the pointer buttons and modifier keys just prior to the event. -The X server can set this member to the bitwise inclusive OR of one +The X server can set this member to the bitwise inclusive OR of one or more of the button or modifier key masks: -.ZN Button1Mask , -.ZN Button2Mask , -.ZN Button3Mask , -.ZN Button4Mask , -.ZN Button5Mask , -.ZN ShiftMask , -.ZN LockMask , -.ZN ControlMask , -.ZN Mod1Mask , -.ZN Mod2Mask , -.ZN Mod3Mask , -.ZN Mod4Mask , -.ZN Mod5Mask . +.BR Button1Mask , +.BR Button2Mask , +.BR Button3Mask , +.BR Button4Mask , +.BR Button5Mask , +.BR ShiftMask , +.BR LockMask , +.BR ControlMask , +.BR Mod1Mask , +.BR Mod2Mask , +.BR Mod3Mask , +.BR Mod4Mask , +.BR Mod5Mask . .LP -The mode member is set to indicate whether the events are normal events, +The mode member is set to indicate whether the events are normal events, pseudo-motion events when a grab activates, or pseudo-motion events when a grab deactivates. -The X server can set this member to -.ZN NotifyNormal , -.ZN NotifyGrab , +The X server can set this member to +.BR NotifyNormal , +.BR NotifyGrab , or -.ZN NotifyUngrab . +.BR NotifyUngrab . .LP The detail member is set to indicate the notify detail and can be -.ZN NotifyAncestor , -.ZN NotifyVirtual , -.ZN NotifyInferior , -.ZN NotifyNonlinear , +.BR NotifyAncestor , +.BR NotifyVirtual , +.BR NotifyInferior , +.BR NotifyNonlinear , or -.ZN NotifyNonlinearVirtual . +.BR NotifyNonlinearVirtual . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/lib/libX11/man/XDefineCursor.man b/lib/libX11/man/XDefineCursor.man index 4f003cc1b..1195966ae 100644 --- a/lib/libX11/man/XDefineCursor.man +++ b/lib/libX11/man/XDefineCursor.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XDefineCursor __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XDefineCursor, XUndefineCursor \- define cursors @@ -86,11 +53,11 @@ XDefineCursor, XUndefineCursor \- define cursors int XDefineCursor\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Cursor \fIcursor\fP\^); .HP -int XUndefineCursor\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); +int XUndefineCursor\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .SH ARGUMENTS .IP \fIcursor\fP 1i Specifies the cursor that is to be displayed or -.ZN None . +.BR None . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIw\fP 1i @@ -98,40 +65,40 @@ Specifies the window. .SH DESCRIPTION If a cursor is set, it will be used when the pointer is in the window. If the cursor is -.ZN None , +.BR None , it is equivalent to -.ZN XUndefineCursor . +.BR XUndefineCursor . .LP -.ZN XDefineCursor +.B XDefineCursor can generate -.ZN BadCursor +.B BadCursor and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XUndefineCursor +.B XUndefineCursor function undoes the effect of a previous -.ZN XDefineCursor +.B XDefineCursor for this window. When the pointer is in the window, the parent's cursor will now be used. On the root window, the default cursor is restored. .LP -.ZN XUndefineCursor +.B XUndefineCursor can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XCreateFontCursor(__libmansuffix__), diff --git a/lib/libX11/man/XDestroyWindow.man b/lib/libX11/man/XDestroyWindow.man index c2bffb3ba..0d8c77166 100644 --- a/lib/libX11/man/XDestroyWindow.man +++ b/lib/libX11/man/XDestroyWindow.man @@ -38,54 +38,21 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XDestroyWindow __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XDestroyWindow, XDestroySubwindows \- destroy windows .SH SYNTAX .HP -int XDestroyWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); +int XDestroyWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .HP -int XDestroySubwindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); +int XDestroySubwindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -93,57 +60,57 @@ Specifies the connection to the X server. Specifies the window. .SH DESCRIPTION The -.ZN XDestroyWindow +.B XDestroyWindow function destroys the specified window as well as all of its subwindows and causes the X server to generate a -.ZN DestroyNotify +.B DestroyNotify event for each window. The window should never be referenced again. If the window specified by the w argument is mapped, it is unmapped automatically. The ordering of the -.ZN DestroyNotify +.B DestroyNotify events is such that for any given window being destroyed, -.ZN DestroyNotify +.B DestroyNotify is generated on any inferiors of the window before being generated on the window itself. The ordering among siblings and across subhierarchies is not otherwise constrained. If the window you specified is a root window, no windows are destroyed. -Destroying a mapped window will generate -.ZN Expose +Destroying a mapped window will generate +.B Expose events on other windows that were obscured by the window being destroyed. .LP -.ZN XDestroyWindow +.B XDestroyWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XDestroySubwindows -function destroys all inferior windows of the specified window, +.B XDestroySubwindows +function destroys all inferior windows of the specified window, in bottom-to-top stacking order. It causes the X server to generate a -.ZN DestroyNotify +.B DestroyNotify event for each window. If any mapped subwindows were actually destroyed, -.ZN XDestroySubwindows -causes the X server to generate -.ZN Expose +.B XDestroySubwindows +causes the X server to generate +.B Expose events on the specified window. This is much more efficient than deleting many windows one at a time because much of the work need be performed only once for all of the windows, rather than for each window. -The subwindows should never be referenced again. +The subwindows should never be referenced again. .LP -.ZN XDestroySubwindows +.B XDestroySubwindows can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/lib/libX11/man/XDestroyWindowEvent.man b/lib/libX11/man/XDestroyWindowEvent.man index 7d6753be3..36717305e 100644 --- a/lib/libX11/man/XDestroyWindowEvent.man +++ b/lib/libX11/man/XDestroyWindowEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XDestroyWindowEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XDestroyWindowEvent \- DestroyNotify event structure .SH STRUCTURES The structure for -.ZN DestroyNotify +.B DestroyNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* DestroyNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -95,7 +62,7 @@ typedef struct { Window event; Window window; } XDestroyWindowEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -103,16 +70,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -121,9 +88,9 @@ dispatchers. .LP The event member is set either to the destroyed window or to its parent, depending on whether -.ZN StructureNotify -or -.ZN SubstructureNotify +.B StructureNotify +or +.B SubstructureNotify was selected. The window member is set to the window that is destroyed. .SH "SEE ALSO" diff --git a/lib/libX11/man/XDrawArc.man b/lib/libX11/man/XDrawArc.man index e916187bf..fcb67b5a4 100644 --- a/lib/libX11/man/XDrawArc.man +++ b/lib/libX11/man/XDrawArc.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .de EX .sp .nf @@ -97,10 +64,10 @@ XDrawArc, XDrawArcs, XArc \- draw arcs and arc structure .HP int XDrawArc\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int -\fIheight\fP\^, int \fIangle1\fP\^, int \fIangle2\fP\^); +\fIheight\fP\^, int \fIangle1\fP\^, int \fIangle2\fP\^); .HP int XDrawArcs\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, -XArc *\fIarcs\fP\^, int \fInarcs\fP\^); +XArc *\fIarcs\fP\^, int \fInarcs\fP\^); .SH ARGUMENTS .IP \fIangle1\fP 1i Specifies the start of the arc relative to the three-o'clock position @@ -111,58 +78,57 @@ arc, in units of degrees * 64. .IP \fIarcs\fP 1i Specifies an array of arcs. .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i Specifies the GC. .IP \fInarcs\fP 1i Specifies the number of arcs in the array. -.ds Wh , which are the major and minor axes of the arc .IP \fIwidth\fP 1i .br .ns .IP \fIheight\fP 1i -Specify the width and height\*(Wh. -.ds Xy , which are relative to the origin of the drawable \ -and specify the upper-left corner of the bounding rectangle +Specify the width and height, which are the major and minor axes of the arc. .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which are relative to the +origin of the drawable +and specify the upper-left corner of the bounding rectangle. .SH DESCRIPTION .EQ delim %% .EN -.ZN XDrawArc -draws a single circular or elliptical arc, and -.ZN XDrawArcs +.B XDrawArc +draws a single circular or elliptical arc, and +.B XDrawArcs draws multiple circular or elliptical arcs. -Each arc is specified by a rectangle and two angles. +Each arc is specified by a rectangle and two angles. The center of the circle or ellipse is the center of the rectangle, and the major and minor axes are specified by the width and height. -Positive angles indicate counterclockwise motion, -and negative angles indicate clockwise motion. -If the magnitude of angle2 is greater than 360 degrees, -.ZN XDrawArc -or -.ZN XDrawArcs +Positive angles indicate counterclockwise motion, +and negative angles indicate clockwise motion. +If the magnitude of angle2 is greater than 360 degrees, +.B XDrawArc +or +.B XDrawArcs truncates it to 360 degrees. .LP -For an arc specified as %[ ~x, ~y, ~width , ~height, ~angle1, ~angle2 ]%, -the origin of the major and minor axes is at -% [ x +^ {width over 2} , ~y +^ {height over 2} ]%, -and the infinitely thin path describing the entire circle or ellipse -intersects the horizontal axis at % [ x, ~y +^ {height over 2} ]% and +For an arc specified as %[ ~x, ~y, ~width , ~height, ~angle1, ~angle2 ]%, +the origin of the major and minor axes is at +% [ x +^ {width over 2} , ~y +^ {height over 2} ]%, +and the infinitely thin path describing the entire circle or ellipse +intersects the horizontal axis at % [ x, ~y +^ {height over 2} ]% and % [ x +^ width , ~y +^ { height over 2 }] % -and intersects the vertical axis at % [ x +^ { width over 2 } , ~y ]% and +and intersects the vertical axis at % [ x +^ { width over 2 } , ~y ]% and % [ x +^ { width over 2 }, ~y +^ height ]%. These coordinates can be fractional and so are not truncated to discrete coordinates. -The path should be defined by the ideal mathematical path. -For a wide line with line-width lw, -the bounding outlines for filling are given +The path should be defined by the ideal mathematical path. +For a wide line with line-width lw, +the bounding outlines for filling are given by the two infinitely thin paths consisting of all points whose perpendicular distance from the path of the circle/ellipse is equal to lw/2 (which may be a fractional value). @@ -172,15 +138,16 @@ corresponding to the tangent of the circle/ellipse at the endpoint. For an arc specified as % [ ~x, ~y, ~width, ~height, ~angle1, ~angle2 ]%, the angles must be specified in the effectively skewed coordinate system of the ellipse (for a -circle, the angles and coordinate systems are identical). The +circle, the angles and coordinate systems are identical). +The relationship between these angles and angles expressed in the normal coordinate system of the screen (as measured with a protractor) is as follows: .LP -.Ds +.EX % roman "skewed-angle" ~ = ~ atan left ( tan ( roman "normal-angle" ) * width over height right ) +^ adjust% -.De +.EE .LP The skewed-angle and normal-angle are expressed in radians (rather than in degrees scaled by 64) in the range % [ 0 , ~2 pi ]% and where atan @@ -194,51 +161,51 @@ l l. %2 pi% for normal-angle in the range % [ {3 pi} over 2 , ~2 pi ]% .TE .LP -For any given arc, -.ZN XDrawArc +For any given arc, +.B XDrawArc and -.ZN XDrawArcs -do not draw a pixel more than once. -If two arcs join correctly and if the line-width is greater than zero -and the arcs intersect, -.ZN XDrawArc +.B XDrawArcs +do not draw a pixel more than once. +If two arcs join correctly and if the line-width is greater than zero +and the arcs intersect, +.B XDrawArc and -.ZN XDrawArcs +.B XDrawArcs do not draw a pixel more than once. -Otherwise, +Otherwise, the intersecting pixels of intersecting arcs are drawn multiple times. Specifying an arc with one endpoint and a clockwise extent draws the same pixels as specifying the other endpoint and an equivalent counterclockwise extent, except as it affects joins. .LP -If the last point in one arc coincides with the first point in the following -arc, the two arcs will join correctly. -If the first point in the first arc coincides with the last point in the last +If the last point in one arc coincides with the first point in the following +arc, the two arcs will join correctly. +If the first point in the first arc coincides with the last point in the last arc, the two arcs will join correctly. By specifying one axis to be zero, a horizontal or vertical line can be drawn. Angles are computed based solely on the coordinate system and ignore the aspect ratio. .LP -Both functions use these GC components: -function, plane-mask, line-width, line-style, cap-style, join-style, +Both functions use these GC components: +function, plane-mask, line-width, line-style, cap-style, join-style, fill-style, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. -They also use these GC mode-dependent components: -foreground, background, tile, stipple, tile-stipple-x-origin, +They also use these GC mode-dependent components: +foreground, background, tile, stipple, tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, and dash-list. .LP -.ZN XDrawArc +.B XDrawArc and -.ZN XDrawArcs +.B XDrawArcs can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .SH STRUCTURES The -.ZN XArc +.B XArc structure contains: .LP .EX @@ -256,18 +223,18 @@ out of the 16-bit ranges, because the protocol only has 16-bit fields for these values. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .SH "SEE ALSO" diff --git a/lib/libX11/man/XDrawImageString.man b/lib/libX11/man/XDrawImageString.man index 15d6b24ea..9f2cffcad 100644 --- a/lib/libX11/man/XDrawImageString.man +++ b/lib/libX11/man/XDrawImageString.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XDrawImageString __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XDrawImageString, XDrawImageString16 \- draw image text @@ -85,14 +52,14 @@ XDrawImageString, XDrawImageString16 \- draw image text .HP int XDrawImageString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, char *\fIstring\fP\^, int -\fIlength\fP\^); +\fIlength\fP\^); .HP int XDrawImageString16\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, XChar2b *\fIstring\fP\^, int -\fIlength\fP\^); +\fIlength\fP\^); .SH ARGUMENTS .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i @@ -101,20 +68,20 @@ Specifies the GC. Specifies the number of characters in the string argument. .IP \fIstring\fP 1i Specifies the character string. -.ds Xy , which are relative to the origin of the specified drawable \ -and define the origin of the first character .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which are relative to the +origin of the specified drawable +and define the origin of the first character. .SH DESCRIPTION The -.ZN XDrawImageString16 +.B XDrawImageString16 function is similar to -.ZN XDrawImageString +.B XDrawImageString except that it uses 2-byte or 16-bit characters. -Both functions also use both the foreground and background pixels +Both functions also use both the foreground and background pixels of the GC in the destination. .LP The effect is first to fill a @@ -122,64 +89,64 @@ destination rectangle with the background pixel defined in the GC and then to paint the text with the foreground pixel. The upper-left corner of the filled rectangle is at: .LP -.Ds +.EX [x, y \- font-ascent] -.De +.EE .LP The width is: .LP -.Ds +.EX overall-width -.De +.EE .LP The height is: .LP -.Ds +.EX font-ascent + font-descent -.De +.EE .LP The overall-width, font-ascent, and font-descent -are as would be returned by -.ZN XQueryTextExtents +are as would be returned by +.B XQueryTextExtents using gc and string. -The function and fill-style defined in the GC are ignored for these functions. -The effective function is -.ZN GXcopy , +The function and fill-style defined in the GC are ignored for these functions. +The effective function is +.BR GXcopy , and the effective fill-style is -.ZN FillSolid . +.BR FillSolid . .LP For fonts defined with 2-byte matrix indexing and used with -.ZN XDrawImageString , +.BR XDrawImageString , each byte is used as a byte2 with a byte1 of zero. .LP -Both functions use these GC components: -plane-mask, foreground, background, font, subwindow-mode, clip-x-origin, +Both functions use these GC components: +plane-mask, foreground, background, font, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. .LP -.ZN XDrawImageString +.B XDrawImageString and -.ZN XDrawImageString16 +.B XDrawImageString16 can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .SH "SEE ALSO" diff --git a/lib/libX11/man/XDrawLine.man b/lib/libX11/man/XDrawLine.man index 03433aac5..0ca10e867 100644 --- a/lib/libX11/man/XDrawLine.man +++ b/lib/libX11/man/XDrawLine.man @@ -38,72 +38,39 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XDrawLine __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XDrawLine, XDrawLines, XDrawSegments, XSegment \- draw lines, polygons, and line structure .SH SYNTAX .HP int XDrawLine\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, -int \fIx1\fP\^, int \fIy1\fP\^, int \fIx2\fP\^, int \fIy2\fP\^); -.HP +int \fIx1\fP\^, int \fIy1\fP\^, int \fIx2\fP\^, int \fIy2\fP\^); +.HP int XDrawLines\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC -\fIgc\fP\^, XPoint *\fIpoints\fP\^, int \fInpoints\fP\^, int \fImode\fP\^); -.HP +\fIgc\fP\^, XPoint *\fIpoints\fP\^, int \fInpoints\fP\^, int \fImode\fP\^); +.HP int XDrawSegments\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC -\fIgc\fP\^, XSegment *\fIsegments\fP\^, int \fInsegments\fP\^); +\fIgc\fP\^, XSegment *\fIsegments\fP\^, int \fInsegments\fP\^); .SH ARGUMENTS .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i Specifies the GC. .IP \fImode\fP 1i -Specifies the coordinate mode. +Specifies the coordinate mode. You can pass -.ZN CoordModeOrigin +.B CoordModeOrigin or -.ZN CoordModePrevious . +.BR CoordModePrevious . .IP \fInpoints\fP 1i Specifies the number of points in the array. .IP \fInsegments\fP 1i @@ -125,90 +92,90 @@ Specifies an array of segments. Specify the points (x1, y1) and (x2, y2) to be connected. .SH DESCRIPTION The -.ZN XDrawLine +.B XDrawLine function uses the components of the specified GC to draw a line between the specified set of points (x1, y1) and (x2, y2). It does not perform joining at coincident endpoints. -For any given line, -.ZN XDrawLine +For any given line, +.B XDrawLine does not draw a pixel more than once. -If lines intersect, the intersecting pixels are drawn multiple times. +If lines intersect, the intersecting pixels are drawn multiple times. .LP The -.ZN XDrawLines -function uses the components of the specified GC to draw -npoints\-1 lines between each pair of points (point[i], point[i+1]) +.B XDrawLines +function uses the components of the specified GC to draw +npoints\-1 lines between each pair of points (point[i], point[i+1]) in the array of -.ZN XPoint +.B XPoint structures. It draws the lines in the order listed in the array. The lines join correctly at all intermediate points, and if the first and last points coincide, the first and last lines also join correctly. -For any given line, -.ZN XDrawLines +For any given line, +.B XDrawLines does not draw a pixel more than once. -If thin (zero line-width) lines intersect, +If thin (zero line-width) lines intersect, the intersecting pixels are drawn multiple times. If wide lines intersect, the intersecting pixels are drawn only once, as though -the entire -.ZN PolyLine +the entire +.B PolyLine protocol request were a single, filled shape. -.ZN CoordModeOrigin +.B CoordModeOrigin treats all coordinates as relative to the origin, and -.ZN CoordModePrevious +.B CoordModePrevious treats all coordinates after the first as relative to the previous point. .LP The -.ZN XDrawSegments -function draws multiple, unconnected lines. -For each segment, -.ZN XDrawSegments +.B XDrawSegments +function draws multiple, unconnected lines. +For each segment, +.B XDrawSegments draws a line between (x1, y1) and (x2, y2). It draws the lines in the order listed in the array of -.ZN XSegment +.B XSegment structures and does not perform joining at coincident endpoints. -For any given line, -.ZN XDrawSegments -does not draw a pixel more than once. -If lines intersect, the intersecting pixels are drawn multiple times. +For any given line, +.B XDrawSegments +does not draw a pixel more than once. +If lines intersect, the intersecting pixels are drawn multiple times. .LP All three functions use these GC components: function, plane-mask, line-width, line-style, cap-style, fill-style, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. The -.ZN XDrawLines +.B XDrawLines function also uses the join-style GC component. All three functions also use these GC mode-dependent components: -foreground, background, tile, stipple, tile-stipple-x-origin, +foreground, background, tile, stipple, tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, and dash-list. .LP -.ZN XDrawLine , -.ZN XDrawLines , +.BR XDrawLine , +.BR XDrawLines , and -.ZN XDrawSegments +.B XDrawSegments can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. -.ZN XDrawLines +.B XDrawLines can also generate a -.ZN BadValue +.B BadValue error. .SH STRUCTURES The -.ZN XSegment +.B XSegment structure contains: .LP -.Ds 0 +.EX typedef struct { short x1, y1, x2, y2; } XSegment; -.De +.EE .LP All x and y members are signed integers. The width and height members are 16-bit unsigned integers. @@ -217,25 +184,26 @@ out of the 16-bit ranges, because the protocol only has 16-bit fields for these values. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XDrawArc(__libmansuffix__), diff --git a/lib/libX11/man/XDrawPoint.man b/lib/libX11/man/XDrawPoint.man index 05721ca87..7b028c2c8 100644 --- a/lib/libX11/man/XDrawPoint.man +++ b/lib/libX11/man/XDrawPoint.man @@ -38,69 +38,36 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XDrawPoint __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XDrawPoint, XDrawPoints, XPoint \- draw points and points structure .SH SYNTAX .HP int XDrawPoint\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC -\fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^); +\fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^); .HP int XDrawPoints\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC -\fIgc\fP\^, XPoint *\fIpoints\fP\^, int \fInpoints\fP\^, int \fImode\fP\^); +\fIgc\fP\^, XPoint *\fIpoints\fP\^, int \fInpoints\fP\^, int \fImode\fP\^); .SH ARGUMENTS .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i Specifies the GC. .IP \fImode\fP 1i -Specifies the coordinate mode. +Specifies the coordinate mode. You can pass -.ZN CoordModeOrigin +.B CoordModeOrigin or -.ZN CoordModePrevious . +.BR CoordModePrevious . .IP \fInpoints\fP 1i Specifies the number of points in the array. .IP \fIpoints\fP 1i @@ -112,47 +79,47 @@ Specifies an array of points. Specify the x and y coordinates where you want the point drawn. .SH DESCRIPTION The -.ZN XDrawPoint +.B XDrawPoint function uses the foreground pixel and function components of the -GC to draw a single point into the specified drawable; -.ZN XDrawPoints +GC to draw a single point into the specified drawable; +.B XDrawPoints draws multiple points this way. -.ZN CoordModeOrigin +.B CoordModeOrigin treats all coordinates as relative to the origin, and -.ZN CoordModePrevious +.B CoordModePrevious treats all coordinates after the first as relative to the previous point. -.ZN XDrawPoints +.B XDrawPoints draws the points in the order listed in the array. .LP Both functions use these GC components: function, plane-mask, foreground, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. .LP -.ZN XDrawPoint +.B XDrawPoint can generate -.ZN BadDrawable , -.ZN BadGC , -and -.ZN BadMatch +.BR BadDrawable , +.BR BadGC , +and +.B BadMatch errors. -.ZN XDrawPoints +.B XDrawPoints can generate -.ZN BadDrawable , -.ZN BadGC , -.ZN BadMatch , +.BR BadDrawable , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .SH STRUCTURES The -.ZN XPoint +.B XPoint structure contains: .LP -.Ds 0 +.EX typedef struct { short x, y; } XPoint; -.De +.EE .LP All x and y members are signed integers. The width and height members are 16-bit unsigned integers. @@ -161,25 +128,26 @@ out of the 16-bit ranges, because the protocol only has 16-bit fields for these values. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XDrawArc(__libmansuffix__), diff --git a/lib/libX11/man/XDrawRectangle.man b/lib/libX11/man/XDrawRectangle.man index 06fffe4d5..eb829a219 100644 --- a/lib/libX11/man/XDrawRectangle.man +++ b/lib/libX11/man/XDrawRectangle.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XDrawRectangle __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XDrawRectangle, XDrawRectangles, XRectangle \- draw rectangles and rectangles structure @@ -85,13 +52,13 @@ XDrawRectangle, XDrawRectangles, XRectangle \- draw rectangles and rectangles st .HP int XDrawRectangle\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned -int \fIheight\fP\^); +int \fIheight\fP\^); .HP int XDrawRectangles\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC -\fIgc\fP\^, XRectangle \fIrectangles\fP\^[\^]\^, int \fInrectangles\fP\^); +\fIgc\fP\^, XRectangle \fIrectangles\fP\^[\^]\^, int \fInrectangles\fP\^); .SH ARGUMENTS .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i @@ -100,65 +67,63 @@ Specifies the GC. Specifies the number of rectangles in the array. .IP \fIrectangles\fP 1i Specifies an array of rectangles. -.ds Wh , which specify the dimensions of the rectangle .IP \fIwidth\fP 1i .br .ns .IP \fIheight\fP 1i -Specify the width and height\*(Wh. -.ds Xy , which specify the upper-left corner of the rectangle +Specify the width and height, which specify the dimensions of the rectangle. .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which specify the upper-left corner of the rectangle. .SH DESCRIPTION The -.ZN XDrawRectangle +.B XDrawRectangle and -.ZN XDrawRectangles +.B XDrawRectangles functions draw the outlines of the specified rectangle or rectangles as -if a five-point -.ZN PolyLine +if a five-point +.B PolyLine protocol request were specified for each rectangle: .IP [x,y] [x+width,y] [x+width,y+height] [x,y+height] [x,y] -.LP -For the specified rectangle or rectangles, +.LP +For the specified rectangle or rectangles, these functions do not draw a pixel more than once. -.ZN XDrawRectangles +.B XDrawRectangles draws the rectangles in the order listed in the array. If rectangles intersect, the intersecting pixels are drawn multiple times. .LP -Both functions use these GC components: +Both functions use these GC components: function, plane-mask, line-width, -line-style, cap-style, join-style, fill-style, +line-style, cap-style, join-style, fill-style, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. -They also use these GC mode-dependent components: -foreground, background, tile, stipple, tile-stipple-x-origin, +They also use these GC mode-dependent components: +foreground, background, tile, stipple, tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, and dash-list. .LP -.ZN XDrawRectangle +.B XDrawRectangle and -.ZN XDrawRectangles +.B XDrawRectangles can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .SH STRUCTURES The -.ZN XRectangle +.B XRectangle structure contains: .LP -.Ds 0 +.EX typedef struct { short x, y; unsigned short width, height; } XRectangle; -.De +.EE .LP All x and y members are signed integers. The width and height members are 16-bit unsigned integers. @@ -167,18 +132,18 @@ out of the 16-bit ranges, because the protocol only has 16-bit fields for these values. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .SH "SEE ALSO" diff --git a/lib/libX11/man/XDrawString.man b/lib/libX11/man/XDrawString.man index 6c8ec2b73..97844ee16 100644 --- a/lib/libX11/man/XDrawString.man +++ b/lib/libX11/man/XDrawString.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XDrawString __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XDrawString, XDrawString16 \- draw text characters @@ -85,14 +52,14 @@ XDrawString, XDrawString16 \- draw text characters .HP int XDrawString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, char *\fIstring\fP\^, int -\fIlength\fP\^); +\fIlength\fP\^); .HP int XDrawString16\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, XChar2b *\fIstring\fP\^, int -\fIlength\fP\^); +\fIlength\fP\^); .SH ARGUMENTS .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i @@ -101,52 +68,52 @@ Specifies the GC. Specifies the number of characters in the string argument. .IP \fIstring\fP 1i Specifies the character string. -.ds Xy , which are relative to the origin of the specified drawable \ -and define the origin of the first character .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which are relative to the +origin of the specified drawable +and define the origin of the first character. .SH DESCRIPTION Each character image, as defined by the font in the GC, is treated as an additional mask for a fill operation on the drawable. The drawable is modified only where the font character has a bit set to 1. For fonts defined with 2-byte matrix indexing and used with -.ZN XDrawString16 , +.BR XDrawString16 , each byte is used as a byte2 with a byte1 of zero. .LP -Both functions use these GC components: -function, plane-mask, fill-style, font, subwindow-mode, clip-x-origin, +Both functions use these GC components: +function, plane-mask, fill-style, font, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. -They also use these GC mode-dependent components: -foreground, background, tile, stipple, tile-stipple-x-origin, +They also use these GC mode-dependent components: +foreground, background, tile, stipple, tile-stipple-x-origin, and tile-stipple-y-origin. .LP -.ZN XDrawString +.B XDrawString and -.ZN XDrawString16 +.B XDrawString16 can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .SH "SEE ALSO" diff --git a/lib/libX11/man/XDrawText.man b/lib/libX11/man/XDrawText.man index c4cae4e8a..055194d8d 100644 --- a/lib/libX11/man/XDrawText.man +++ b/lib/libX11/man/XDrawText.man @@ -38,60 +38,27 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XDrawText __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XDrawText, XDrawText16, XTextItem, XTextItem16 \- draw polytext text and text drawing structures .SH SYNTAX .HP int XDrawText\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, -int \fIx\fP\^, int \fIy\fP\^, XTextItem *\fIitems\fP\^, int \fInitems\fP\^); +int \fIx\fP\^, int \fIy\fP\^, XTextItem *\fIitems\fP\^, int \fInitems\fP\^); .HP int XDrawText16\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, XTextItem16 *\fIitems\fP\^, int -\fInitems\fP\^); +\fInitems\fP\^); .SH ARGUMENTS .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i @@ -100,87 +67,87 @@ Specifies the GC. Specifies an array of text items. .IP \fInitems\fP 1i Specifies the number of text items in the array. -.ds Xy , which are relative to the origin of the specified drawable \ -and define the origin of the first character .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which are relative to the origin +of the specified drawable +and define the origin of the first character. .SH DESCRIPTION The -.ZN XDrawText16 +.B XDrawText16 function is similar to -.ZN XDrawText +.B XDrawText except that it uses 2-byte or 16-bit characters. Both functions allow complex spacing and font shifts between counted strings. .LP Each text item is processed in turn. -A font member other than -.ZN None +A font member other than +.B None in an item causes the font to be stored in the GC -and used for subsequent text. +and used for subsequent text. A text element delta specifies an additional change -in the position along the x axis before the string is drawn. +in the position along the x axis before the string is drawn. The delta is always added to the character origin and is not dependent on any characteristics of the font. Each character image, as defined by the font in the GC, is treated as an additional mask for a fill operation on the drawable. The drawable is modified only where the font character has a bit set to 1. If a text item generates a -.ZN BadFont +.B BadFont error, the previous text items may have been drawn. .LP For fonts defined with linear indexing rather than 2-byte matrix indexing, -each -.ZN XChar2b -structure is interpreted as a 16-bit number with byte1 as the +each +.B XChar2b +structure is interpreted as a 16-bit number with byte1 as the most significant byte. .LP Both functions use these GC components: -function, plane-mask, fill-style, font, subwindow-mode, +function, plane-mask, fill-style, font, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. -They also use these GC mode-dependent components: -foreground, background, tile, stipple, tile-stipple-x-origin, +They also use these GC mode-dependent components: +foreground, background, tile, stipple, tile-stipple-x-origin, and tile-stipple-y-origin. .LP -.ZN XDrawText +.B XDrawText and -.ZN XDrawText16 +.B XDrawText16 can generate -.ZN BadDrawable , -.ZN BadFont , -.ZN BadGC , +.BR BadDrawable , +.BR BadFont , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .SH STRUCTURES The -.ZN XTextItem +.B XTextItem and -.ZN XTextItem16 +.B XTextItem16 structures contain: .LP -.Ds 0 +.EX typedef struct { char *chars; /\&* pointer to string */ int nchars; /\&* number of characters */ int delta; /\&* delta between strings */ Font font; /\&* Font to print it in, None don't change */ } XTextItem; -.De +.EE .LP -.Ds 0 +.EX typedef struct { XChar2b *chars; /\&* pointer to two-byte characters */ int nchars; /\&* number of characters */ int delta; /\&* delta between strings */ Font font; /\&* font to print it in, None don't change */ } XTextItem16; -.De +.EE .LP If the font member is not -.ZN None , +.BR None , the font is changed before printing and also is stored in the GC. If an error was generated during text drawing, the previous items may have been drawn. @@ -188,33 +155,33 @@ The baseline of the characters are drawn starting at the x and y coordinates that you pass in the text drawing functions. .LP For example, consider the background rectangle drawn by -.ZN XDrawImageString . +.BR XDrawImageString . If you want the upper-left corner of the background rectangle to be at pixel coordinate (x,y), pass the (x,y + ascent) as the baseline origin coordinates to the text functions. The ascent is the font ascent, as given in the -.ZN XFontStruct +.B XFontStruct structure. If you want the lower-left corner of the background rectangle to be at pixel coordinate (x,y), pass the (x,y \- descent + 1) as the baseline origin coordinates to the text functions. The descent is the font descent, as given in the -.ZN XFontStruct +.B XFontStruct structure. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadFont +.B BadFont A value for a Font or GContext argument does not name a defined Font. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .SH "SEE ALSO" XDrawImageString(__libmansuffix__), diff --git a/lib/libX11/man/XEmptyRegion.man b/lib/libX11/man/XEmptyRegion.man index b87687f9b..b00961447 100644 --- a/lib/libX11/man/XEmptyRegion.man +++ b/lib/libX11/man/XEmptyRegion.man @@ -38,59 +38,26 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XEmptyRegion __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XEmptyRegion, XEqualRegion, XPointInRegion, XRectInRegion \- determine if regions are empty or equal .SH SYNTAX .HP -Bool XEmptyRegion\^(\^Region \fIr\fP\^); +Bool XEmptyRegion\^(\^Region \fIr\fP\^); .HP -Bool XEqualRegion\^(\^Region \fIr1\fP\^, Region \fIr2\fP\^); +Bool XEqualRegion\^(\^Region \fIr1\fP\^, Region \fIr2\fP\^); .HP -Bool XPointInRegion\^(\^Region \fIr\fP\^, int \fIx\fP\^, int \fIy\fP\^); +Bool XPointInRegion\^(\^Region \fIr\fP\^, int \fIx\fP\^, int \fIy\fP\^); .HP int XRectInRegion\^(\^Region \fIr\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned -int \fIwidth\fP\^, unsigned int \fIheight\fP\^); +int \fIwidth\fP\^, unsigned int \fIheight\fP\^); .SH ARGUMENTS .IP \fIr\fP 1i Specifies the region. @@ -99,47 +66,47 @@ Specifies the region. .ns .IP \fIr2\fP 1i Specify the two regions. -.ds Wh , which define the rectangle +.ds Wh .IP \fIwidth\fP 1i .br .ns .IP \fIheight\fP 1i -Specify the width and height\*(Wh. -.ds Xy , which define the point \ -or the coordinates of the upper-left corner of the rectangle +Specify the width and height, which define the rectangle. +.ds Xy .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which define the point +or the coordinates of the upper-left corner of the rectangle. .SH DESCRIPTION The -.ZN XEmptyRegion +.B XEmptyRegion function returns -.ZN True +.B True if the region is empty. .LP The -.ZN XEqualRegion +.B XEqualRegion function returns -.ZN True +.B True if the two regions have the same offset, size, and shape. .LP The -.ZN XPointInRegion -function returns -.ZN True +.B XPointInRegion +function returns +.B True if the point (x, y) is contained in the region r. .LP The -.ZN XRectInRegion +.B XRectInRegion function returns -.ZN RectangleIn +.B RectangleIn if the rectangle is entirely in the specified region, -.ZN RectangleOut +.B RectangleOut if the rectangle is entirely out of the specified region, and -.ZN RectanglePart +.B RectanglePart if the rectangle is partially in the specified region. .SH "SEE ALSO" XCreateRegion(__libmansuffix__), diff --git a/lib/libX11/man/XErrorEvent.man b/lib/libX11/man/XErrorEvent.man index 136de6ec3..4e5025b9b 100644 --- a/lib/libX11/man/XErrorEvent.man +++ b/lib/libX11/man/XErrorEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XErrorEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XErrorEvent \- X error event structure .SH STRUCTURES -The -.ZN XErrorEvent +The +.B XErrorEvent structure contains: .LP -.Ds 0 +.EX typedef struct { int type; Display *display; /\&* Display the event was read from */ @@ -96,18 +63,18 @@ typedef struct { unsigned char request_code; /\&* Major op-code of failed request */ unsigned char minor_code; /\&* Minor op-code of failed request */ } XErrorEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. .LP -The serial member is the number of requests, starting from one, -sent over the network connection since it was opened. -It is the number that was the value of -.ZN NextRequest -immediately before the failing call was made. +The serial member is the number of requests, starting from one, +sent over the network connection since it was opened. +It is the number that was the value of +.B NextRequest +immediately before the failing call was made. The request_code member is a protocol request -of the procedure that failed, as defined in +of the procedure that failed, as defined in .hN X11/Xproto.h . .SH "SEE ALSO" AllPlanes(__libmansuffix__), diff --git a/lib/libX11/man/XExposeEvent.man b/lib/libX11/man/XExposeEvent.man index 7bf90cde0..115fc92e7 100644 --- a/lib/libX11/man/XExposeEvent.man +++ b/lib/libX11/man/XExposeEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XExposeEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XExposeEvent \- Expose event structure .SH STRUCTURES The structure for -.ZN Expose +.B Expose events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* Expose */ unsigned long serial; /\&* # of last request processed by server */ @@ -97,7 +64,7 @@ typedef struct { int width, height; int count; /\&* if nonzero, at least this many more */ } XExposeEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -105,16 +72,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -126,17 +93,17 @@ The x and y members are set to the coordinates relative to the window's origin and indicate the upper-left corner of the rectangle. The width and height members are set to the size (extent) of the rectangle. The count member is set to the number of -.ZN Expose +.B Expose events that are to follow. If count is zero, no more -.ZN Expose +.B Expose events follow for this window. -However, if count is nonzero, at least that number of -.ZN Expose +However, if count is nonzero, at least that number of +.B Expose events (and possibly more) follow for this window. Simple applications that do not want to optimize redisplay by distinguishing between subareas of its window can just ignore all -.ZN Expose +.B Expose events with nonzero counts and perform full redisplays on events with zero counts. .SH "SEE ALSO" diff --git a/lib/libX11/man/XExtentsOfFontSet.man b/lib/libX11/man/XExtentsOfFontSet.man index 6200f6044..be59d554b 100644 --- a/lib/libX11/man/XExtentsOfFontSet.man +++ b/lib/libX11/man/XExtentsOfFontSet.man @@ -38,71 +38,38 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XExtentsOfFontSet __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XExtentsOfFontSet \- obtain the maximum extents structure for a font set .SH SYNTAX .HP -XFontSetExtents *XExtentsOfFontSet\^(\^XFontSet \fIfont_set\fP\^); +XFontSetExtents *XExtentsOfFontSet\^(\^XFontSet \fIfont_set\fP\^); .SH ARGUMENTS .IP \fIfont_set\fP 1i Specifies the font set. .SH DESCRIPTION The -.ZN XExtentsOfFontSet +.B XExtentsOfFontSet function returns an -.ZN XFontSetExtents +.B XFontSetExtents structure for the fonts used by the Xmb and Xwc layers for the given font set. .LP -The -.ZN XFontSetExtents +The +.B XFontSetExtents structure is owned by Xlib and should not be modified or freed by the client. -It will be freed by a call to -.ZN XFreeFontSet -with the associated -.ZN XFontSet . +It will be freed by a call to +.B XFreeFontSet +with the associated +.BR XFontSet . Until freed, its contents will not be modified by Xlib. .SH "SEE ALSO" XCreateFontSet(__libmansuffix__), diff --git a/lib/libX11/man/XFillRectangle.man b/lib/libX11/man/XFillRectangle.man index d2d5e56b4..042d106c5 100644 --- a/lib/libX11/man/XFillRectangle.man +++ b/lib/libX11/man/XFillRectangle.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XFillRectangle __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XFillRectangle, XFillRectangles, XFillPolygon, XFillArc, XFillArcs \- fill rectangles, polygons, or arcs @@ -85,21 +52,21 @@ XFillRectangle, XFillRectangles, XFillPolygon, XFillArc, XFillArcs \- fill recta .HP int XFillRectangle\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned -int \fIheight\fP\^); +int \fIheight\fP\^); .HP int XFillRectangles\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC -\fIgc\fP\^, XRectangle *\fIrectangles\fP\^, int \fInrectangles\fP\^); +\fIgc\fP\^, XRectangle *\fIrectangles\fP\^, int \fInrectangles\fP\^); .HP int XFillPolygon\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, XPoint *\fIpoints\fP\^, int \fInpoints\fP\^, int \fIshape\fP\^, int \fImode\fP\^); .HP -int XFillArc\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, +int XFillArc\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int -\fIheight\fP\^, int \fIangle1\fP\^, int \fIangle2\fP\^); +\fIheight\fP\^, int \fIangle1\fP\^, int \fIangle2\fP\^); .HP int XFillArcs\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, -XArc *\fIarcs\fP\^, int \fInarcs\fP\^); +XArc *\fIarcs\fP\^, int \fInarcs\fP\^); .SH ARGUMENTS .IP \fIangle1\fP 1i Specifies the start of the arc relative to the three-o'clock position @@ -110,17 +77,17 @@ arc, in units of degrees * 64. .IP \fIarcs\fP 1i Specifies an array of arcs. .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i Specifies the GC. .IP \fImode\fP 1i -Specifies the coordinate mode. +Specifies the coordinate mode. You can pass -.ZN CoordModeOrigin +.B CoordModeOrigin or -.ZN CoordModePrevious . +.BR CoordModePrevious . .IP \fInarcs\fP 1i Specifies the number of arcs in the array. .IP \fInpoints\fP 1i @@ -133,197 +100,197 @@ Specifies an array of points. Specifies an array of rectangles. .IP \fIshape\fP 1i Specifies a shape that helps the server to improve performance. -You can pass -.ZN Complex , -.ZN Convex , -or -.ZN Nonconvex . -.ds Wh , which are the dimensions of the rectangle to be filled \ -or the major and minor axes of the arc +You can pass +.BR Complex , +.BR Convex , +or +.BR Nonconvex . +.ds Wh .IP \fIwidth\fP 1i .br .ns .IP \fIheight\fP 1i -Specify the width and height\*(Wh. -.ds Xy , which are relative to the origin of the drawable \ -and specify the upper-left corner of the rectangle +Specify the width and height, which are the dimensions of the +rectangle to be filled or the major and minor axes of the arc. .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which are relative to the origin of the drawable \ +and specify the upper-left corner of the rectangle. .SH DESCRIPTION The -.ZN XFillRectangle +.B XFillRectangle and -.ZN XFillRectangles +.B XFillRectangles functions fill the specified rectangle or rectangles -as if a four-point -.ZN FillPolygon +as if a four-point +.B FillPolygon protocol request were specified for each rectangle: .LP -.Ds +.EX [x,y] [x+width,y] [x+width,y+height] [x,y+height] -.De +.EE .LP Each function uses the x and y coordinates, width and height dimensions, and GC you specify. .LP -.ZN XFillRectangles -fills the rectangles in the order listed in the array. +.B XFillRectangles +fills the rectangles in the order listed in the array. For any given rectangle, -.ZN XFillRectangle +.B XFillRectangle and -.ZN XFillRectangles -do not draw a pixel more than once. +.B XFillRectangles +do not draw a pixel more than once. If rectangles intersect, the intersecting pixels are drawn multiple times. .LP -Both functions use these GC components: -function, plane-mask, fill-style, subwindow-mode, +Both functions use these GC components: +function, plane-mask, fill-style, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. -They also use these GC mode-dependent components: -foreground, background, tile, stipple, tile-stipple-x-origin, +They also use these GC mode-dependent components: +foreground, background, tile, stipple, tile-stipple-x-origin, and tile-stipple-y-origin. .LP -.ZN XFillRectangle +.B XFillRectangle and -.ZN XFillRectangles +.B XFillRectangles can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .LP -.ZN XFillPolygon +.B XFillPolygon fills the region closed by the specified path. The path is closed automatically if the last point in the list does not coincide with the first point. -.ZN XFillPolygon +.B XFillPolygon does not draw a pixel of the region more than once. -.ZN CoordModeOrigin +.B CoordModeOrigin treats all coordinates as relative to the origin, and -.ZN CoordModePrevious +.B CoordModePrevious treats all coordinates after the first as relative to the previous point. .LP -Depending on the specified shape, the following occurs: +Depending on the specified shape, the following occurs: .IP \(bu 5 If shape is -.ZN Complex , -the path may self-intersect. -Note that contiguous coincident points in the path are not treated +.BR Complex , +the path may self-intersect. +Note that contiguous coincident points in the path are not treated as self-intersection. .IP \(bu 5 If shape is -.ZN Convex , +.BR Convex , for every pair of points inside the polygon, the line segment connecting them does not intersect the path. If known by the client, -specifying -.ZN Convex -can improve performance. +specifying +.B Convex +can improve performance. If you specify -.ZN Convex -for a path that is not convex, +.B Convex +for a path that is not convex, the graphics results are undefined. .IP \(bu 5 If shape is -.ZN Nonconvex , +.BR Nonconvex , the path does not self-intersect, but the shape is not -wholly convex. -If known by the client, -specifying -.ZN Nonconvex +wholly convex. +If known by the client, +specifying +.B Nonconvex instead of -.ZN Complex -may improve performance. +.B Complex +may improve performance. If you specify -.ZN Nonconvex +.B Nonconvex for a self-intersecting path, the graphics results are undefined. .LP -The fill-rule of the GC controls the filling behavior of +The fill-rule of the GC controls the filling behavior of self-intersecting polygons. .LP -This function uses these GC components: -function, plane-mask, fill-style, fill-rule, subwindow-mode, clip-x-origin, +This function uses these GC components: +function, plane-mask, fill-style, fill-rule, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. -It also uses these GC mode-dependent components: -foreground, background, tile, stipple, tile-stipple-x-origin, +It also uses these GC mode-dependent components: +foreground, background, tile, stipple, tile-stipple-x-origin, and tile-stipple-y-origin. .LP -.ZN XFillPolygon +.B XFillPolygon can generate -.ZN BadDrawable , -.ZN BadGC , -.ZN BadMatch , +.BR BadDrawable , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .LP -For each arc, -.ZN XFillArc +For each arc, +.B XFillArc or -.ZN XFillArcs +.B XFillArcs fills the region closed by the infinitely thin path -described by the specified arc and, depending on the -arc-mode specified in the GC, one or two line segments. -For -.ZN ArcChord , -the single line segment joining the endpoints of the arc is used. -For -.ZN ArcPieSlice , +described by the specified arc and, depending on the +arc-mode specified in the GC, one or two line segments. +For +.BR ArcChord , +the single line segment joining the endpoints of the arc is used. +For +.BR ArcPieSlice , the two line segments joining the endpoints of the arc with the center -point are used. -.ZN XFillArcs -fills the arcs in the order listed in the array. -For any given arc, -.ZN XFillArc +point are used. +.B XFillArcs +fills the arcs in the order listed in the array. +For any given arc, +.B XFillArc and -.ZN XFillArcs -do not draw a pixel more than once. -If regions intersect, +.B XFillArcs +do not draw a pixel more than once. +If regions intersect, the intersecting pixels are drawn multiple times. .LP -Both functions use these GC components: -function, plane-mask, fill-style, arc-mode, subwindow-mode, clip-x-origin, +Both functions use these GC components: +function, plane-mask, fill-style, arc-mode, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. -They also use these GC mode-dependent components: -foreground, background, tile, stipple, tile-stipple-x-origin, +They also use these GC mode-dependent components: +foreground, background, tile, stipple, tile-stipple-x-origin, and tile-stipple-y-origin. .LP -.ZN XFillArc +.B XFillArc and -.ZN XFillArcs +.B XFillArcs can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XDrawArc(__libmansuffix__), diff --git a/lib/libX11/man/XFilterEvent.man b/lib/libX11/man/XFilterEvent.man index 70154fa03..e08fc75c2 100644 --- a/lib/libX11/man/XFilterEvent.man +++ b/lib/libX11/man/XFilterEvent.man @@ -38,86 +38,51 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XFilterEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XFilterEvent \- filter X events for an input method .SH SYNTAX .HP -Bool XFilterEvent\^(\^XEvent *\fIevent\fP\^, Window \fIw\fP\^); +Bool XFilterEvent\^(\^XEvent *\fIevent\fP\^, Window \fIw\fP\^); .SH ARGUMENTS -.ds Ev event to filter .IP \fIevent\fP 1i -Specifies the \*(Ev. -.ds Wi for which the filter is to be applied +Specifies the event to filter. .IP \fIw\fP 1i -Specifies the window \*(Wi. +Specifies the window for which the filter is to be applied. .SH DESCRIPTION If the window argument is -.ZN None , -.ZN XFilterEvent +.BR None , +.B XFilterEvent applies the filter to the window specified in the -.ZN XEvent +.B XEvent structure. The window argument is provided so that layers above Xlib that do event redirection can indicate to which window an event has been redirected. .LP If -.ZN XFilterEvent +.B XFilterEvent returns -.ZN True , +.BR True , then some input method has filtered the event, and the client should discard the event. If -.ZN XFilterEvent +.B XFilterEvent returns -.ZN False , +.BR False , then the client should continue processing the event. .LP If a grab has occurred in the client and -.ZN XFilterEvent +.B XFilterEvent returns -.ZN True , +.BR True , the client should ungrab the keyboard. .SH "SEE ALSO" XNextEvent(__libmansuffix__) diff --git a/lib/libX11/man/XFlush.man b/lib/libX11/man/XFlush.man index 9e1f21e53..5871131d5 100644 --- a/lib/libX11/man/XFlush.man +++ b/lib/libX11/man/XFlush.man @@ -38,161 +38,128 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XFlush __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XFlush, XSync, XEventsQueued, XPending \- handle output buffer or event queue .SH SYNTAX .HP -int XFlush\^(\^Display *\fIdisplay\fP\^); +int XFlush\^(\^Display *\fIdisplay\fP\^); .HP -int XSync\^(\^Display *\fIdisplay\fP\^, Bool \fIdiscard\fP\^); +int XSync\^(\^Display *\fIdisplay\fP\^, Bool \fIdiscard\fP\^); .HP -int XEventsQueued\^(\^Display *\fIdisplay\fP\^, int \fImode\fP\^); +int XEventsQueued\^(\^Display *\fIdisplay\fP\^, int \fImode\fP\^); .HP -int XPending\^(\^Display *\fIdisplay\fP\^); +int XPending\^(\^Display *\fIdisplay\fP\^); .SH ARGUMENTS .IP \fIdiscard\fP 1i -Specifies a Boolean value that indicates whether -.ZN XSync +Specifies a Boolean value that indicates whether +.B XSync discards all events on the event queue. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fImode\fP 1i Specifies the mode. You can pass -.ZN QueuedAlready , -.ZN QueuedAfterFlush , +.BR QueuedAlready , +.BR QueuedAfterFlush , or -.ZN QueuedAfterReading . +.BR QueuedAfterReading . .SH DESCRIPTION The -.ZN XFlush +.B XFlush function flushes the output buffer. Most client applications need not use this function because the output buffer is automatically flushed as needed by calls to -.ZN XPending , -.ZN XNextEvent , +.BR XPending , +.BR XNextEvent , and -.ZN XWindowEvent . +.BR XWindowEvent . .IN "XPending" .IN "XNextEvent" .IN "XWindowEvent" Events generated by the server may be enqueued into the library's event queue. .LP The -.ZN XSync +.B XSync function flushes the output buffer and then waits until all requests have been received and processed by the X server. Any errors generated must be handled by the error handler. For each protocol error received by Xlib, -.ZN XSync +.B XSync calls the client application's error handling routine (see section 11.8.2). -Any events generated by the server are enqueued into the library's +Any events generated by the server are enqueued into the library's event queue. .LP -Finally, if you passed -.ZN False , -.ZN XSync +Finally, if you passed +.BR False , +.B XSync does not discard the events in the queue. -If you passed -.ZN True , -.ZN XSync +If you passed +.BR True , +.B XSync discards all events in the queue, including those events that were on the queue before -.ZN XSync +.B XSync was called. Client applications seldom need to call -.ZN XSync . +.BR XSync . .LP -If mode is -.ZN QueuedAlready , -.ZN XEventsQueued +If mode is +.BR QueuedAlready , +.B XEventsQueued returns the number of events already in the event queue (and never performs a system call). -If mode is -.ZN QueuedAfterFlush , -.ZN XEventsQueued +If mode is +.BR QueuedAfterFlush , +.B XEventsQueued returns the number of events already in the queue if the number is nonzero. -If there are no events in the queue, -.ZN XEventsQueued -flushes the output buffer, +If there are no events in the queue, +.B XEventsQueued +flushes the output buffer, attempts to read more events out of the application's connection, and returns the number read. -If mode is -.ZN QueuedAfterReading , -.ZN XEventsQueued -returns the number of events already in the queue if the number is nonzero. -If there are no events in the queue, -.ZN XEventsQueued -attempts to read more events out of the application's connection +If mode is +.BR QueuedAfterReading , +.B XEventsQueued +returns the number of events already in the queue if the number is nonzero. +If there are no events in the queue, +.B XEventsQueued +attempts to read more events out of the application's connection without flushing the output buffer and returns the number read. .LP -.ZN XEventsQueued +.B XEventsQueued always returns immediately without I/O if there are events already in the queue. -.ZN XEventsQueued -with mode -.ZN QueuedAfterFlush +.B XEventsQueued +with mode +.B QueuedAfterFlush is identical in behavior to -.ZN XPending . -.ZN XEventsQueued +.BR XPending . +.B XEventsQueued with mode -.ZN QueuedAlready +.B QueuedAlready is identical to the -.ZN XQLength +.B XQLength function. .LP The -.ZN XPending +.B XPending function returns the number of events that have been received from the X server but have not been removed from the event queue. -.ZN XPending +.B XPending is identical to -.ZN XEventsQueued +.B XEventsQueued with the mode -.ZN QueuedAfterFlush +.B QueuedAfterFlush specified. .SH "SEE ALSO" AllPlanes(__libmansuffix__), diff --git a/lib/libX11/man/XFocusChangeEvent.man b/lib/libX11/man/XFocusChangeEvent.man index 0dfaee5e3..fdf21bece 100644 --- a/lib/libX11/man/XFocusChangeEvent.man +++ b/lib/libX11/man/XFocusChangeEvent.man @@ -38,57 +38,24 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XFocusChangeEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XFocusChangeEvent \- FocusIn and FocusOut event structure .SH STRUCTURES The structure for -.ZN FocusIn +.B FocusIn and -.ZN FocusOut +.B FocusOut events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* FocusIn or FocusOut */ unsigned long serial; /\&* # of last request processed by server */ @@ -98,14 +65,14 @@ typedef struct { int mode; /\&* NotifyNormal, NotifyGrab, NotifyUngrab */ int detail; /\&* - * NotifyAncestor, NotifyVirtual, NotifyInferior, + * NotifyAncestor, NotifyVirtual, NotifyInferior, * NotifyNonlinear,NotifyNonlinearVirtual, NotifyPointer, - * NotifyPointerRoot, NotifyDetailNone + * NotifyPointerRoot, NotifyDetailNone */ } XFocusChangeEvent; typedef XFocusChangeEvent XFocusInEvent; typedef XFocusChangeEvent XFocusOutEvent; -.De +.EE .LP When you receive these events, the structure members are set as follows. @@ -113,16 +80,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -130,49 +97,49 @@ The window member is set to the window that is most useful to toolkit dispatchers. .LP The window member is set to the window on which the -.ZN FocusIn +.B FocusIn or -.ZN FocusOut +.B FocusOut event was generated. -This is the window used by the X server to report the event. -The mode member is set to indicate whether the focus events -are normal focus events, +This is the window used by the X server to report the event. +The mode member is set to indicate whether the focus events +are normal focus events, focus events while grabbed, focus events when a grab activates, or focus events when a grab deactivates. -The X server can set the mode member to -.ZN NotifyNormal , -.ZN NotifyWhileGrabbed , -.ZN NotifyGrab , +The X server can set the mode member to +.BR NotifyNormal , +.BR NotifyWhileGrabbed , +.BR NotifyGrab , or -.ZN NotifyUngrab . +.BR NotifyUngrab . .LP -All -.ZN FocusOut +All +.B FocusOut events caused by a window unmap are generated after any -.ZN UnmapNotify -event; however, the X protocol does not constrain the ordering of -.ZN FocusOut +.B UnmapNotify +event; however, the X protocol does not constrain the ordering of +.B FocusOut events with respect to -generated -.ZN EnterNotify , -.ZN LeaveNotify , -.ZN VisibilityNotify , +generated +.BR EnterNotify , +.BR LeaveNotify , +.BR VisibilityNotify , and -.ZN Expose +.B Expose events. .LP Depending on the event mode, the detail member is set to indicate the notify detail and can be -.ZN NotifyAncestor , -.ZN NotifyVirtual , -.ZN NotifyInferior , -.ZN NotifyNonlinear , -.ZN NotifyNonlinearVirtual , -.ZN NotifyPointer , -.ZN NotifyPointerRoot , +.BR NotifyAncestor , +.BR NotifyVirtual , +.BR NotifyInferior , +.BR NotifyNonlinear , +.BR NotifyNonlinearVirtual , +.BR NotifyPointer , +.BR NotifyPointerRoot , or -.ZN NotifyDetailNone . +.BR NotifyDetailNone . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/lib/libX11/man/XFontSetExtents.man b/lib/libX11/man/XFontSetExtents.man index d78db7dc9..7d0b266da 100644 --- a/lib/libX11/man/XFontSetExtents.man +++ b/lib/libX11/man/XFontSetExtents.man @@ -38,88 +38,55 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XFontSetExtents __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XFontSetExtents \- XFontSetExtents structure .SH STRUCTURES The -.ZN XFontSetExtents +.B XFontSetExtents structure contains: .LP -.Ds 0 +.EX typedef struct { XRectangle max_ink_extent; /\&* over all drawable characters */ XRectangle max_logical_extent; /\&* over all drawable characters */ } XFontSetExtents; -.De +.EE .LP -The -.ZN XRectangle -structures used to return font set metrics are the usual Xlib screen-oriented +The +.B XRectangle +structures used to return font set metrics are the usual Xlib screen-oriented rectangles with x, y giving the upper left corner, and width and height always positive. .LP The max_ink_extent member gives the maximum extent, over all drawable characters, of the rectangles that bound the character glyph image drawn in the foreground color, relative to a constant origin. -See -.ZN XmbTextExtents +See +.B XmbTextExtents and -.ZN XwcTextExtents +.B XwcTextExtents for detailed semantics. .LP The max_logical_extent member gives the maximum extent, -over all drawable characters, of the rectangles +over all drawable characters, of the rectangles that specify minimum spacing to other graphical features, relative to a constant origin. Other graphical features drawn by the client, for example, a border surrounding the text, should not intersect this rectangle. -The max_logical_extent member should be used to compute minimum +The max_logical_extent member should be used to compute minimum interline spacing and the minimum area that must be allowed in a text field to draw a given number of arbitrary characters. .LP Due to context-dependent rendering, -appending a given character to a string may change +appending a given character to a string may change the string's extent by an amount other than that character's individual extent. .SH "SEE ALSO" diff --git a/lib/libX11/man/XFontsOfFontSet.man b/lib/libX11/man/XFontsOfFontSet.man index 845599dca..a0b1a5654 100644 --- a/lib/libX11/man/XFontsOfFontSet.man +++ b/lib/libX11/man/XFontsOfFontSet.man @@ -38,63 +38,30 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XFontsOfFontSet __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XFontsOfFontSet, XBaseFontNameListOfFontSet, XLocaleOfFontSet, XContextDependentDrawing, XContextualDrawing, XDirectionalDependentDrawing \- obtain fontset information .SH SYNTAX .HP int XFontsOfFontSet\^(\^XFontSet \fIfont_set\fP\^, XFontStruct -***\fIfont_struct_list_return\fP\^, char ***\fIfont_name_list_return\fP\^); +***\fIfont_struct_list_return\fP\^, char ***\fIfont_name_list_return\fP\^); .HP -char *XBaseFontNameListOfFontSet\^(\^XFontSet \fIfont_set\fP\^); +char *XBaseFontNameListOfFontSet\^(\^XFontSet \fIfont_set\fP\^); .HP -char *XLocaleOfFontSet\^(\^XFontSet \fIfont_set\fP\^); +char *XLocaleOfFontSet\^(\^XFontSet \fIfont_set\fP\^); .HP -Bool XContextDependentDrawing\^(\^XFontSet \fIfont_set\fP\^); +Bool XContextDependentDrawing\^(\^XFontSet \fIfont_set\fP\^); .HP -Bool XContextualDrawing\^(\^XFontSet \fIfont_set\fP\^); +Bool XContextualDrawing\^(\^XFontSet \fIfont_set\fP\^); .HP -Bool XDirectionalDependentDrawing\^(\^XFontSet \fIfont_set\fP\^); +Bool XDirectionalDependentDrawing\^(\^XFontSet \fIfont_set\fP\^); .SH ARGUMENTS .IP \fIfont_set\fP 1i Specifies the font set. @@ -104,119 +71,119 @@ Returns the list of font names. Returns the list of font structs. .SH DESCRIPTION The -.ZN XFontsOfFontSet -function returns a list of one or more -.ZN XFontStructs +.B XFontsOfFontSet +function returns a list of one or more +.B XFontStructs and font names for the fonts used by the Xmb and Xwc layers for the given font set. A list of pointers to the -.ZN XFontStruct +.B XFontStruct structures is returned to font_struct_list_return. A list of pointers to null-terminated, fully specified font name strings in the locale of the font set is returned to font_name_list_return. The font_name_list order corresponds to the font_struct_list order. The number of -.ZN XFontStruct +.B XFontStruct structures and font names is returned as the value of the function. .LP Because it is not guaranteed that a given character will be imaged using a single font glyph, -there is no provision for mapping a character or default string -to the font properties, font ID, or direction hint for the font +there is no provision for mapping a character or default string +to the font properties, font ID, or direction hint for the font for the character. -The client may access the -.ZN XFontStruct +The client may access the +.B XFontStruct list to obtain these values for all the fonts currently in use. .LP Xlib does not guarantee that fonts are loaded from the server -at the creation of an -.ZN XFontSet . -Xlib may choose to cache font data, loading it only as needed to draw text +at the creation of an +.BR XFontSet . +Xlib may choose to cache font data, loading it only as needed to draw text or compute text dimensions. -Therefore, existence of the per_char metrics in the -.ZN XFontStruct +Therefore, existence of the per_char metrics in the +.B XFontStruct structures in the -.ZN XFontStructSet +.B XFontStructSet is undefined. -Also, note that all properties in the -.ZN XFontStruct +Also, note that all properties in the +.B XFontStruct structures are in the STRING encoding. .LP -The -.ZN XFontStruct -and font name lists are owned by Xlib +The +.B XFontStruct +and font name lists are owned by Xlib and should not be modified or freed by the client. They will be freed by a call to -.ZN XFreeFontSet +.B XFreeFontSet with the associated -.ZN XFontSet . +.BR XFontSet . Until freed, their contents will not be modified by Xlib. .LP The -.ZN XBaseFontNameListOfFontSet +.B XBaseFontNameListOfFontSet function returns the original base font name list supplied -by the client when the -.ZN XFontSet +by the client when the +.B XFontSet was created. A null-terminated string containing a list of comma-separated font names is returned as the value of the function. White space may appear immediately on either side of separating commas. .LP -If -.ZN XCreateFontSet +If +.B XCreateFontSet obtained an XLFD name from the font properties for the font specified by a non-XLFD base name, the -.ZN XBaseFontNameListOfFontSet +.B XBaseFontNameListOfFontSet function will return the XLFD name instead of the non-XLFD base name. .LP The base font name list is owned by Xlib and should not be modified or freed by the client. -It will be freed by a call to -.ZN XFreeFontSet -with the associated -.ZN XFontSet . +It will be freed by a call to +.B XFreeFontSet +with the associated +.BR XFontSet . Until freed, its contents will not be modified by Xlib. .LP The -.ZN XLocaleOfFontSet +.B XLocaleOfFontSet function returns the name of the locale bound to the specified -.ZN XFontSet , +.BR XFontSet , as a null-terminated string. .LP The returned locale name string is owned by Xlib and should not be modified or freed by the client. It may be freed by a call to -.ZN XFreeFontSet -with the associated -.ZN XFontSet . +.B XFreeFontSet +with the associated +.BR XFontSet . Until freed, it will not be modified by Xlib. .LP The -.ZN XContextDependentDrawing +.B XContextDependentDrawing function returns -.ZN True +.B True if the drawing functions implement implicit text directionality or if text drawn with the font_set might include context-dependent drawing; otherwise, it returns -.ZN False . +.BR False . .LP The -.ZN XContextualDrawing +.B XContextualDrawing function returns -.ZN True +.B True if text drawn with the font set might include context-dependent drawing; otherwise, it returns -.ZN False . +.BR False . .LP The -.ZN XDirectionalDependentDrawing +.B XDirectionalDependentDrawing function returns -.ZN True +.B True if the drawing functions implement implicit text directionality; otherwise, it returns -.ZN False . +.BR False . .SH "SEE ALSO" XCreateFontSet(__libmansuffix__), XCreateOM(__libmansuffix__), diff --git a/lib/libX11/man/XFree.man b/lib/libX11/man/XFree.man index 89b640884..02326b663 100644 --- a/lib/libX11/man/XFree.man +++ b/lib/libX11/man/XFree.man @@ -38,57 +38,24 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XFree __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XFree \- free client data .SH SYNTAX -int XFree\^(\^void *\fIdata\fP\^); +int XFree\^(\^void *\fIdata\fP\^); .SH ARGUMENTS .IP \fIdata\fP 1i Specifies the data that are to be freed. .SH DESCRIPTION The -.ZN XFree +.B XFree function is a general-purpose Xlib routine that frees the specified data. You must use it to free any objects that were allocated by Xlib, unless an alternate function is explicitly specified for the object. diff --git a/lib/libX11/man/XGetEventData.man b/lib/libX11/man/XGetEventData.man index 6d1f2dbb9..393ee53ee 100644 --- a/lib/libX11/man/XGetEventData.man +++ b/lib/libX11/man/XGetEventData.man @@ -23,39 +23,6 @@ .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XGetEventData __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XGetEventData, XFreeEventData, XGenericEventCookie \- retrieve and free additional event data through cookies. @@ -72,7 +39,7 @@ Specifies the connection to the X server. Specifies the cookie to free or retrieve the data for. .SH STRUCTURES -.Ds 0 +.EX typedef struct { int type; unsigned long serial; @@ -83,48 +50,54 @@ typedef struct { unsigned int cookie; void *data; } XGenericEventCookie; -.De +.EE .SH DESCRIPTION Some extension -.ZN XGenericEvents +.B XGenericEvents require additional memory to store information. For these events, the library returns a -.ZN XGenericEventCookie -with a token ('cookie') unique to this event. The -.ZN XGenericEventCookie 's +.B XGenericEventCookie +with a token ('cookie') unique to this event. +The +.BR XGenericEventCookie 's data pointer is undefined until -.ZN XGetEventData +.B XGetEventData is called. The -.ZN XGetEventData -function retrieves this extra data for the given cookie. No round-trip to -the server is required. If the cookie is invalid or the +.B XGetEventData +function retrieves this extra data for the given cookie. +No round-trip to +the server is required. +If the cookie is invalid or the event is not an event handled by cookie handlers, -.ZN False -is returned. If -.ZN XGetEventData +.B False +is returned. +If +.B XGetEventData returns -.ZN True , +.BR True , the cookie's data pointer points to the memory containing the event -information. A client must call -.ZN XFreeEventData +information. +A client must call +.B XFreeEventData to free this memory. -.ZN XGetEventData +.B XGetEventData returns -.ZN False +.B False for multiple calls for the same event cookie. The -.ZN XFreeEventData -function frees the data associated with a cookie. A client must call -.ZN XFreeEventData +.B XFreeEventData +function frees the data associated with a cookie. +A client must call +.B XFreeEventData for each cookie claimed with -.ZN XGetEventData . +.BR XGetEventData . .SH EXAMPLE CODE -.Ds 0 +.EX XEvent event; XGenericEventCookie *cookie = &ev; @@ -135,21 +108,21 @@ if (XGetEventData(display, cookie)) { handle_event(&event); } XFreeEventData(display, cookie); -.De +.EE .SH NOTES A cookie is defined as unclaimed if it has been returned to the client through -.ZN XNextEvent +.B XNextEvent but its data has not been retrieved via -.ZN XGetEventData . +.BR XGetEventData . Subsequent calls to -.ZN XNextEvent +.B XNextEvent may free memory associated with unclaimed cookies. Multi-threaded X clients must ensure that -.ZN XGetEventData +.B XGetEventData is called before the next call to -.ZN XNextEvent . +.BR XNextEvent . .SH "SEE ALSO" XNextEvent(__libmansuffix__), diff --git a/lib/libX11/man/XGetVisualInfo.man b/lib/libX11/man/XGetVisualInfo.man index 5c5d226c2..3cc20a7a4 100644 --- a/lib/libX11/man/XGetVisualInfo.man +++ b/lib/libX11/man/XGetVisualInfo.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XGetVisualInfo __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME @@ -87,12 +54,12 @@ XGetVisualInfo, XMatchVisualInfo, XVisualIDFromVisual, XVisualInfo \- obtain vis .HP XVisualInfo *XGetVisualInfo\^(\^Display *\fIdisplay\fP\^, long \fIvinfo_mask\fP\^, XVisualInfo *\fIvinfo_template\fP\^, int -*\fInitems_return\fP\^); +*\fInitems_return\fP\^); .HP Status XMatchVisualInfo\^(\^Display *\fIdisplay\fP\^, int \fIscreen\fP\^, int -\fIdepth\fP\^, int \fIclass\fP\^, XVisualInfo *\fIvinfo_return\fP\^); +\fIdepth\fP\^, int \fIclass\fP\^, XVisualInfo *\fIvinfo_return\fP\^); .HP -VisualID XVisualIDFromVisual\^(\^Visual *\^\fIvisual\fP\^); +VisualID XVisualIDFromVisual\^(\^Visual *\^\fIvisual\fP\^); .SH ARGUMENTS .IP \fIclass\fP 1i Specifies the class of the screen. @@ -115,34 +82,34 @@ Specifies the visual attributes that are to be used in matching the visual structures. .SH DESCRIPTION The -.ZN XGetVisualInfo -function returns a list of visual structures that have attributes +.B XGetVisualInfo +function returns a list of visual structures that have attributes equal to the attributes specified by vinfo_template. If no visual structures match the template using the specified vinfo_mask, -.ZN XGetVisualInfo +.B XGetVisualInfo returns a NULL. To free the data returned by this function, use -.ZN XFree . +.BR XFree . .LP The -.ZN XMatchVisualInfo +.B XMatchVisualInfo function returns the visual information for a visual that matches the specified depth and class for a screen. Because multiple visuals that match the specified depth and class can exist, the exact visual chosen is undefined. If a visual is found, -.ZN XMatchVisualInfo +.B XMatchVisualInfo returns nonzero and the information on the visual to vinfo_return. Otherwise, when a visual is not found, -.ZN XMatchVisualInfo +.B XMatchVisualInfo returns zero. .LP The -.ZN XVisualIDFromVisual +.B XVisualIDFromVisual function returns the visual ID for the specified visual type. .SH STRUCTURES The -.ZN XVisualInfo +.B XVisualInfo structure contains: .LP .LP @@ -152,83 +119,83 @@ lw(.5i) lw(2.5i) lw(.8i). T{ \&#define T} T{ -.ZN VisualNoMask +.B VisualNoMask T} T{ 0x0 T} T{ \&#define T} T{ -.ZN VisualIDMask +.B VisualIDMask T} T{ 0x1 T} T{ \&#define T} T{ -.ZN VisualScreenMask +.B VisualScreenMask T} T{ 0x2 T} T{ \&#define T} T{ -.ZN VisualDepthMask +.B VisualDepthMask T} T{ 0x4 T} T{ \&#define T} T{ -.ZN VisualClassMask +.B VisualClassMask T} T{ 0x8 T} T{ \&#define T} T{ -.ZN VisualRedMaskMask +.B VisualRedMaskMask T} T{ 0x10 T} T{ \&#define T} T{ -.ZN VisualGreenMaskMask +.B VisualGreenMaskMask T} T{ 0x20 T} T{ \&#define T} T{ -.ZN VisualBlueMaskMask +.B VisualBlueMaskMask T} T{ 0x40 T} T{ \&#define T} T{ -.ZN VisualColormapSizeMask +.B VisualColormapSizeMask T} T{ 0x80 T} T{ \&#define T} T{ -.ZN VisualBitsPerRGBMask +.B VisualBitsPerRGBMask T} T{ 0x100 T} T{ \&#define T} T{ -.ZN VisualAllMask +.B VisualAllMask T} T{ 0x1FF T} .TE .IN "XVisualInfo" "" "@DEF@" -.Ds 0 +.EX /\&* Values */ typedef struct { @@ -243,7 +210,7 @@ typedef struct { int colormap_size; int bits_per_rgb; } XVisualInfo; -.De +.EE .SH "SEE ALSO" XFree(__libmansuffix__) .br diff --git a/lib/libX11/man/XGetWindowAttributes.man b/lib/libX11/man/XGetWindowAttributes.man index 953aeed4e..47357af1e 100644 --- a/lib/libX11/man/XGetWindowAttributes.man +++ b/lib/libX11/man/XGetWindowAttributes.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XGetWindowAttributes __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME @@ -86,27 +53,26 @@ XGetWindowAttributes, XGetGeometry, XWindowAttributes \- get current window attr .SH SYNTAX .HP Status XGetWindowAttributes\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -XWindowAttributes *\fIwindow_attributes_return\fP\^); +XWindowAttributes *\fIwindow_attributes_return\fP\^); .HP Status XGetGeometry\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, Window *\fIroot_return\fP\^, int *\fIx_return\fP\^, int *\fIy_return\fP\^, unsigned int *\fIwidth_return\fP\^, unsigned int *\fIheight_return\fP\^, unsigned int -*\fIborder_width_return\fP\^, unsigned int *\fIdepth_return\fP\^); +*\fIborder_width_return\fP\^, unsigned int *\fIdepth_return\fP\^); .SH ARGUMENTS .IP \fIborder_width_return\fP 1i -Returns the border width in pixels. -.ds Dr , which can be a window or a pixmap +Returns the border width in pixels. .IP \fId\fP 1i -Specifies the drawable\*(Dr. +Specifies the drawable, which can be a window or a pixmap. .IP \fIdepth_return\fP 1i Returns the depth of the drawable (bits per pixel for the object). .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIroot_return\fP 1i Returns the root window. -.ds Wi whose current attributes you want to obtain +.ds Wi .IP \fIw\fP 1i -Specifies the window \*(Wi. +Specifies the window whose current attributes you want to obtain. .IP \fIwidth_return\fP 1i .br .ns @@ -114,48 +80,49 @@ Specifies the window \*(Wi. Return the drawable's dimensions (width and height). .IP \fIwindow_attributes_return\fP 1i Returns the specified window's attributes in the -.ZN XWindowAttributes +.B XWindowAttributes structure. .IP \fIx_return\fP 1i .br .ns .IP \fIy_return\fP 1i Return the x and y coordinates that define the location of the drawable. -For a window, +For a window, these coordinates specify the upper-left outer corner relative to its parent's origin. For pixmaps, these coordinates are always zero. .SH DESCRIPTION The -.ZN XGetWindowAttributes +.B XGetWindowAttributes function returns the current attributes for the specified window to an -.ZN XWindowAttributes -structure. It returns a nonzero status on success; otherwise, it returns a +.B XWindowAttributes +structure. +It returns a nonzero status on success; otherwise, it returns a zero status. .LP -.ZN XGetWindowAttributes +.B XGetWindowAttributes can generate -.ZN BadDrawable +.B BadDrawable and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetGeometry +.B XGetGeometry function returns the root window and the current geometry of the drawable. The geometry of the drawable includes the x and y coordinates, width and height, border width, and depth. These are described in the argument list. It is legal to pass to this function a window whose class is -.ZN InputOnly . +.BR InputOnly . It returns a nonzero status on success; otherwise, it returns a zero status. .SH STRUCTURES The -.ZN XWindowAttributes +.B XWindowAttributes structure contains: .LP -.Ds 0 +.EX typedef struct { int x, y; /\&* location of window */ int width, height; /\&* width and height of window */ @@ -179,23 +146,23 @@ typedef struct { Bool override_redirect; /\&* boolean value for override-redirect */ Screen *screen; /\&* back pointer to correct screen */ } XWindowAttributes; -.De +.EE .LP The x and y members are set to the upper-left outer corner relative to the parent window's origin. -The width and height members are set to the inside size of the window, +The width and height members are set to the inside size of the window, not including the border. The border_width member is set to the window's border width in pixels. -The depth member is set to the depth of the window +The depth member is set to the depth of the window (that is, bits per pixel for the object). The visual member is a pointer to the screen's associated -.ZN Visual +.B Visual structure. The root member is set to the root window of the screen containing the window. The class member is set to the window's class and can be either -.ZN InputOutput +.B InputOutput or -.ZN InputOnly . +.BR InputOnly . .LP The bit_gravity member is set to the window's bit gravity and can be one of the following: @@ -203,31 +170,31 @@ and can be one of the following: .TS lw(1.5i) lw(1.5i). T{ -.ZN ForgetGravity +.B ForgetGravity T} T{ -.ZN EastGravity +.B EastGravity T} T{ -.ZN NorthWestGravity +.B NorthWestGravity T} T{ -.ZN SouthWestGravity +.B SouthWestGravity T} T{ -.ZN NorthGravity +.B NorthGravity T} T{ -.ZN SouthGravity +.B SouthGravity T} T{ -.ZN NorthEastGravity +.B NorthEastGravity T} T{ -.ZN SouthEastGravity +.B SouthEastGravity T} T{ -.ZN WestGravity +.B WestGravity T} T{ -.ZN StaticGravity +.B StaticGravity T} -.ZN CenterGravity +.B CenterGravity .TE .LP The win_gravity member is set to the window's window gravity @@ -236,94 +203,94 @@ and can be one of the following: .TS lw(1.5i) lw(1.5i). T{ -.ZN UnmapGravity +.B UnmapGravity T} T{ -.ZN EastGravity +.B EastGravity T} T{ -.ZN NorthWestGravity +.B NorthWestGravity T} T{ -.ZN SouthWestGravity +.B SouthWestGravity T} T{ -.ZN NorthGravity +.B NorthGravity T} T{ -.ZN SouthGravity +.B SouthGravity T} T{ -.ZN NorthEastGravity +.B NorthEastGravity T} T{ -.ZN SouthEastGravity +.B SouthEastGravity T} T{ -.ZN WestGravity +.B WestGravity T} T{ -.ZN StaticGravity +.B StaticGravity T} -.ZN CenterGravity +.B CenterGravity .TE .LP For additional information on gravity, see section 3.3. .LP The backing_store member is set to indicate how the X server should maintain -the contents of a window -and can be -.ZN WhenMapped , -.ZN Always , +the contents of a window +and can be +.BR WhenMapped , +.BR Always , or -.ZN NotUseful . -The backing_planes member is set to indicate (with bits set to 1) which bit -planes of the window hold dynamic data that must be preserved in backing_stores +.BR NotUseful . +The backing_planes member is set to indicate (with bits set to 1) which bit +planes of the window hold dynamic data that must be preserved in backing_stores and during save_unders. -The backing_pixel member is set to indicate what values to use +The backing_pixel member is set to indicate what values to use for planes not set in backing_planes. .LP -The save_under member is set to -.ZN True +The save_under member is set to +.B True or -.ZN False . +.BR False . The colormap member is set to the colormap for the specified window and can be -a colormap ID or -.ZN None . -The map_installed member is set to indicate whether the colormap is -currently installed and can be -.ZN True +a colormap ID or +.BR None . +The map_installed member is set to indicate whether the colormap is +currently installed and can be +.B True or -.ZN False . +.BR False . The map_state member is set to indicate the state of the window and can be -.ZN IsUnmapped , -.ZN IsUnviewable , +.BR IsUnmapped , +.BR IsUnviewable , or -.ZN IsViewable . -.ZN IsUnviewable +.BR IsViewable . +.B IsUnviewable is used if the window is mapped but some ancestor is unmapped. .LP -The all_event_masks member is set to the bitwise inclusive OR of all event +The all_event_masks member is set to the bitwise inclusive OR of all event masks selected on the window by all clients. -The your_event_mask member is set to the bitwise inclusive OR of all event +The your_event_mask member is set to the bitwise inclusive OR of all event masks selected by the querying client. -The do_not_propagate_mask member is set to the bitwise inclusive OR of the +The do_not_propagate_mask member is set to the bitwise inclusive OR of the set of events that should not propagate. .LP The override_redirect member is set to indicate whether this window overrides -structure control facilities and can be -.ZN True +structure control facilities and can be +.B True or -.ZN False . +.BR False . Window manager clients should ignore the window if this member is -.ZN True . +.BR True . .LP -The screen member is set to a screen pointer that gives you a back pointer +The screen member is set to a screen pointer that gives you a back pointer to the correct screen. This makes it easier to obtain the screen information without having to loop over the root window fields to see which field matches. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XQueryPointer(__libmansuffix__), diff --git a/lib/libX11/man/XGetWindowProperty.man b/lib/libX11/man/XGetWindowProperty.man index 33e6e3de4..70df32498 100644 --- a/lib/libX11/man/XGetWindowProperty.man +++ b/lib/libX11/man/XGetWindowProperty.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XGetWindowProperty __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XGetWindowProperty, XListProperties, XChangeProperty, XRotateWindowProperties, XDeleteProperty \- obtain and change window properties @@ -87,27 +54,27 @@ int XGetWindowProperty\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Atom \fIproperty\fP\^, long \fIlong_offset\fP\^, long \fIlong_length\fP\^, Bool \fIdelete\fP\^, Atom \fIreq_type\fP\^, Atom *\fIactual_type_return\fP\^, int *\fIactual_format_return\fP\^, unsigned long *\fInitems_return\fP\^, unsigned -long *\fIbytes_after_return\fP\^, unsigned char **\fIprop_return\fP\^); +long *\fIbytes_after_return\fP\^, unsigned char **\fIprop_return\fP\^); .HP Atom *XListProperties\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, int -*\fInum_prop_return\fP\^); +*\fInum_prop_return\fP\^); .HP int XChangeProperty\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Atom \fIproperty\fP\^, Atom \fItype\fP\^, int \fIformat\fP\^, int \fImode\fP\^, -unsigned char *\fIdata\fP\^, int \fInelements\fP\^); +unsigned char *\fIdata\fP\^, int \fInelements\fP\^); .HP int XRotateWindowProperties\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -Atom \fIproperties\fP\^[]\^, int \fInum_prop\fP\^, int \fInpositions\fP\^); +Atom \fIproperties\fP\^[]\^, int \fInum_prop\fP\^, int \fInpositions\fP\^); .HP int XDeleteProperty\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Atom -\fIproperty\fP\^); +\fIproperty\fP\^); .SH ARGUMENTS .IP \fIactual_format_return\fP 1i Returns the actual format of the property. .IP \fIactual_type_return\fP 1i Returns the atom identifier that defines the actual type of the property. .IP \fIbytes_after_return\fP 1i -Returns the number of bytes remaining to be read in the property if +Returns the number of bytes remaining to be read in the property if a partial read was performed. .IP \fIdata\fP 1i Specifies the property data. @@ -123,25 +90,25 @@ This information allows the X server to correctly perform byte-swap operations as necessary. If the format is 16-bit or 32-bit, you must explicitly cast your data pointer to an (unsigned char *) in the call -to -.ZN XChangeProperty . +to +.BR XChangeProperty . .IP \fIlong_length\fP 1i Specifies the length in 32-bit multiples of the data to be retrieved. .IP \fIlong_offset\fP 1i -Specifies the offset in the specified property (in 32-bit quantities) +Specifies the offset in the specified property (in 32-bit quantities) where the data is to be retrieved. .\" Changed name of this file to prop_mode.a on 1/13/87 .IP \fImode\fP 1i Specifies the mode of the operation. You can pass -.ZN PropModeReplace , -.ZN PropModePrepend , +.BR PropModeReplace , +.BR PropModePrepend , or -.ZN PropModeAppend . +.BR PropModeAppend . .IP \fInelements\fP 1i Specifies the number of elements of the specified data format. .IP \fInitems_return\fP 1i -Returns the actual number of 8-bit, 16-bit, or 32-bit items +Returns the actual number of 8-bit, 16-bit, or 32-bit items stored in the prop_return data. .IP \fInum_prop\fP 1i Specifies the length of the properties array. @@ -152,9 +119,11 @@ Specifies the rotation amount. .IP \fIprop_return\fP 1i Returns the data in the specified format. If the returned format is 8, the returned data is represented as a -char array. If the returned format is 16, the returned data is +char array. +If the returned format is 16, the returned data is represented as a array of short int type and should be cast to that -type to obtain the elements. If the returned format is 32, the +type to obtain the elements. +If the returned format is 32, the property data will be stored as an array of longs (which in a 64-bit application will be 64-bit values that are padded in the upper 4 bytes). .IP \fIproperty\fP 1i @@ -163,51 +132,50 @@ Specifies the property name. Specifies the array of properties that are to be rotated. .IP \fIreq_type\fP 1i Specifies the atom identifier associated with the property type or -.ZN AnyPropertyType . +.BR AnyPropertyType . .IP \fItype\fP 1i Specifies the type of the property. The X server does not interpret the type but simply -passes it back to an application that later calls -.ZN XGetWindowProperty . -.ds Wi whose property you want to obtain, change, rotate or delete +passes it back to an application that later calls +.BR XGetWindowProperty . .IP \fIw\fP 1i -Specifies the window \*(Wi. +Specifies the window whose property you want to obtain, change, rotate or delete. .SH DESCRIPTION The -.ZN XGetWindowProperty +.B XGetWindowProperty function returns the actual type of the property; the actual format of the property; the number of 8-bit, 16-bit, or 32-bit items transferred; the number of bytes remaining to be read in the property; and a pointer to the data actually returned. -.ZN XGetWindowProperty +.B XGetWindowProperty sets the return arguments as follows: .IP \(bu 5 If the specified property does not exist for the specified window, -.ZN XGetWindowProperty -returns -.ZN None -to actual_type_return and the value zero to +.B XGetWindowProperty +returns +.B None +to actual_type_return and the value zero to actual_format_return and bytes_after_return. The nitems_return argument is empty. In this case, the delete argument is ignored. .IP \(bu 5 -If the specified property exists +If the specified property exists but its type does not match the specified type, -.ZN XGetWindowProperty -returns the actual property type to actual_type_return, -the actual property format (never zero) to actual_format_return, +.B XGetWindowProperty +returns the actual property type to actual_type_return, +the actual property format (never zero) to actual_format_return, and the property length in bytes -(even if the actual_format_return is 16 or 32) +(even if the actual_format_return is 16 or 32) to bytes_after_return. It also ignores the delete argument. The nitems_return argument is empty. .IP \(bu 5 -If the specified property exists and either you assign -.ZN AnyPropertyType +If the specified property exists and either you assign +.B AnyPropertyType to the req_type argument or the specified type matches the actual property type, -.ZN XGetWindowProperty +.B XGetWindowProperty 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 to bytes_after_return and nitems_return, by +property format (never zero) to actual_format_return. +It also returns a value to bytes_after_return and nitems_return, by defining the following values: .IP @@ -224,189 +192,190 @@ The returned value starts at byte index I in the property (indexing from zero), and its length in bytes is L. If the value for long_offset causes L to be negative, a -.ZN BadValue -error results. -The value of bytes_after_return is A, +.B BadValue +error results. +The value of bytes_after_return is A, giving the number of trailing unread bytes in the stored property. .LP If the returned format is 8, the returned data is represented as a -.ZN char +.B char array. If the returned format is 16, the returned data is represented as a -.ZN short +.B short array and should be cast to that type to obtain the elements. If the returned format is 32, the returned data is represented as a -.ZN long +.B long array and should be cast to that type to obtain the elements. .LP -.ZN XGetWindowProperty -always allocates one extra byte in prop_return -(even if the property is zero length) +.B XGetWindowProperty +always allocates one extra byte in prop_return +(even if the property is zero length) and sets it to zero so that simple properties consisting of characters do not have to be copied into yet another string before use. .LP -If delete is -.ZN True -and bytes_after_return is zero, -.ZN XGetWindowProperty -deletes the property -from the window and generates a -.ZN PropertyNotify +If delete is +.B True +and bytes_after_return is zero, +.B XGetWindowProperty +deletes the property +from the window and generates a +.B PropertyNotify event on the window. .LP The function returns -.ZN Success +.B Success if it executes successfully. To free the resulting data, use -.ZN XFree . +.BR XFree . .LP -.ZN XGetWindowProperty +.B XGetWindowProperty can generate -.ZN BadAtom , -.ZN BadValue , +.BR BadAtom , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XListProperties -function returns a pointer to an array of atom properties that are defined for +.B XListProperties +function returns a pointer to an array of atom properties that are defined for the specified window or returns NULL if no properties were found. To free the memory allocated by this function, use -.ZN XFree . +.BR XFree . .LP -.ZN XListProperties +.B XListProperties can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XChangeProperty +.B XChangeProperty function alters the property for the specified window and causes the X server to generate a -.ZN PropertyNotify +.B PropertyNotify event on that window. -.ZN XChangeProperty +.B XChangeProperty performs the following: .IP \(bu 5 If mode is -.ZN PropModeReplace , -.ZN XChangeProperty +.BR PropModeReplace , +.B XChangeProperty discards the previous property value and stores the new data. .IP \(bu 5 If mode is -.ZN PropModePrepend +.B PropModePrepend or -.ZN PropModeAppend , -.ZN XChangeProperty +.BR PropModeAppend , +.B XChangeProperty 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 -.ZN BadMatch +.B BadMatch error results. -If the property is undefined, +If the property is undefined, it is treated as defined with the correct type and format with zero-length data. .LP If the specified format is 8, the property data must be a -.ZN char +.B char array. If the specified format is 16, the property data must be a -.ZN short +.B short array. If the specified format is 32, the property data must be a -.ZN long +.B long array. .LP The lifetime of a property is not tied to the storing client. Properties remain until explicitly deleted, until the window is destroyed, or until the server resets. For a discussion of what happens when the connection to the X server is closed, -see section 2.6. +see section 2.6. The maximum size of a property is server dependent and can vary dynamically depending on the amount of memory the server has available. (If there is insufficient space, a -.ZN BadAlloc +.B BadAlloc error results.) .LP -.ZN XChangeProperty +.B XChangeProperty can generate -.ZN BadAlloc , -.ZN BadAtom , -.ZN BadMatch , -.ZN BadValue , +.BR BadAlloc , +.BR BadAtom , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XRotateWindowProperties +.B XRotateWindowProperties function allows you to rotate properties on a window and causes the X server to generate -.ZN PropertyNotify +.B PropertyNotify events. -If the property names in the properties array are viewed as being numbered +If the property names in the properties array are viewed as being numbered starting from zero and if there are num_prop property names in the list, -then the value associated with property name I becomes the value associated +then the value associated with property name I becomes the value associated with property name (I + npositions) mod N for all I from zero to N \- 1. The effect is to rotate the states by npositions places around the virtual ring -of property names (right for positive npositions, +of property names (right for positive npositions, left for negative npositions). If npositions mod N is nonzero, the X server generates a -.ZN PropertyNotify +.B PropertyNotify event for each property in the order that they are listed in the array. -If an atom occurs more than once in the list or no property with that +If an atom occurs more than once in the list or no property with that name is defined for the window, -a -.ZN BadMatch +a +.B BadMatch error results. -If a -.ZN BadAtom -or -.ZN BadMatch +If a +.B BadAtom +or +.B BadMatch error results, no properties are changed. .LP -.ZN XRotateWindowProperties +.B XRotateWindowProperties can generate -.ZN BadAtom , -.ZN BadMatch , +.BR BadAtom , +.BR BadMatch , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XDeleteProperty +.B XDeleteProperty function deletes the specified property only if the property was defined on the specified window and causes the X server to generate a -.ZN PropertyNotify +.B PropertyNotify event on the window unless the property does not exist. .LP -.ZN XDeleteProperty +.B XDeleteProperty can generate -.ZN BadAtom +.B BadAtom and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XFree(__libmansuffix__), diff --git a/lib/libX11/man/XGetXCBConnection.man b/lib/libX11/man/XGetXCBConnection.man index 7488b6ee7..9c3696a11 100644 --- a/lib/libX11/man/XGetXCBConnection.man +++ b/lib/libX11/man/XGetXCBConnection.man @@ -26,13 +26,14 @@ XGetXCBConnection \- get the XCB connection for an Xlib Display .HP #include <X11/Xlib-xcb.h> .HP -xcb_connection_t *XGetXCBConnection(Display *\fIdpy\fP); +xcb_connection_t *XGetXCBConnection(Display *\fIdpy\fP); .SH ARGUMENTS .IP \fIdpy\fP 1i Specifies the connection to the X server. .SH DESCRIPTION The \fIXGetXCBConnection\fP function returns the XCB connection associated with -an Xlib Display. Clients can use this XCB connection with functions from the +an Xlib Display. +Clients can use this XCB connection with functions from the XCB library, just as they would with an XCB connection created with XCB. Callers of this function must link to libX11-xcb and a version of Xlib built with XCB support. diff --git a/lib/libX11/man/XGrabButton.man b/lib/libX11/man/XGrabButton.man index a96b39824..0244961a2 100644 --- a/lib/libX11/man/XGrabButton.man +++ b/lib/libX11/man/XGrabButton.man @@ -38,70 +38,36 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XGrabButton __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XGrabButton, XUngrabButton \- grab pointer buttons .SH SYNTAX -.HP +.HP int XGrabButton\^(\^Display *\fIdisplay\fP\^, unsigned int \fIbutton\fP\^, unsigned int \fImodifiers\fP\^, Window \fIgrab_window\fP\^, Bool \fIowner_events\fP\^, unsigned int \fIevent_mask\fP\^, int \fIpointer_mode\fP\^, \fIkeyboard_mode\fP\^, Window \fIconfine_to\fP\^, Cursor -\fIcursor\fP\^); +\fIcursor\fP\^); .HP int XUngrabButton\^(\^Display *\fIdisplay\fP\^, unsigned int \fIbutton\fP\^, -unsigned int \fImodifiers\fP\^, Window \fIgrab_window\fP\^); +unsigned int \fImodifiers\fP\^, Window \fIgrab_window\fP\^); .SH ARGUMENTS -.ds Bu grabbed or released .IP \fIbutton\fP 1i -Specifies the pointer button that is to be \*(Bu or -.ZN AnyButton . +Specifies the pointer button that is to be grabbed or released or +.BR AnyButton . .IP \fIconfine_to\fP 1i Specifies the window to confine the pointer in or -.ZN None . +.BR None . .IP \fIcursor\fP 1i Specifies the cursor that is to be displayed or -.ZN None . +.BR None . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIevent_mask\fP 1i @@ -111,36 +77,36 @@ The mask is the bitwise inclusive OR of the valid pointer event mask bits. Specifies the grab window. .IP \fIkeyboard_mode\fP 1i Specifies further processing of keyboard events. -You can pass -.ZN GrabModeSync +You can pass +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .IP \fImodifiers\fP 1i Specifies the set of keymasks or -.ZN AnyModifier . +.BR AnyModifier . The mask is the bitwise inclusive OR of the valid keymask bits. .IP \fIowner_events\fP 1i -Specifies a Boolean value that indicates whether the pointer -events are to be reported as usual or reported with respect to the grab window +Specifies a Boolean value that indicates whether the pointer +events are to be reported as usual or reported with respect to the grab window if selected by the event mask. .IP \fIpointer_mode\fP 1i Specifies further processing of pointer events. -You can pass -.ZN GrabModeSync +You can pass +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .SH DESCRIPTION The -.ZN XGrabButton +.B XGrabButton function establishes a passive grab. In the future, the pointer is actively grabbed (as for -.ZN XGrabPointer ), +.BR XGrabPointer ), the last-pointer-grab time is set to the time at which the button was pressed (as transmitted in the -.ZN ButtonPress +.B ButtonPress event), and the -.ZN ButtonPress +.B ButtonPress event is reported if all of the following conditions are true: .IP \(bu 5 The pointer is not grabbed, and the specified button is logically pressed @@ -155,12 +121,12 @@ A passive grab on the same button/key combination does not exist on any ancestor of grab_window. .LP The interpretation of the remaining arguments is as for -.ZN XGrabPointer . +.BR XGrabPointer . The active grab is terminated automatically when the logical state of the pointer has all buttons released (independent of the state of the logical modifier keys), -at which point a -.ZN ButtonRelease +at which point a +.B ButtonRelease event is reported to the grabbing window. .LP Note that the logical state of a device (as seen by client applications) @@ -168,79 +134,80 @@ may lag the physical state if device event processing is frozen. .LP This request overrides all previous grabs by the same client on the same button/key combinations on the same window. -A modifiers of -.ZN AnyModifier +A modifiers of +.B AnyModifier is equivalent to issuing the grab request for all -possible modifier combinations (including the combination of no modifiers). -It is not required that all modifiers specified have currently assigned +possible modifier combinations (including the combination of no modifiers). +It is not required that all modifiers specified have currently assigned KeyCodes. -A button of -.ZN AnyButton +A button of +.B AnyButton is equivalent to issuing the request for all possible buttons. Otherwise, it is not required that the specified button currently be assigned to a physical button. .LP -If some other client has already issued a -.ZN XGrabButton +If some other client has already issued a +.B XGrabButton with the same button/key combination on the same window, a -.ZN BadAccess +.B BadAccess error results. -When using -.ZN AnyModifier -or -.ZN AnyButton , +When using +.B AnyModifier +or +.BR AnyButton , the request fails completely, and a -.ZN BadAccess +.B BadAccess error results (no grabs are established) if there is a conflicting grab for any combination. -.ZN XGrabButton +.B XGrabButton has no effect on an active grab. .LP -.ZN XGrabButton +.B XGrabButton can generate -.ZN BadCursor , -.ZN BadValue , +.BR BadCursor , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XUngrabButton +.B XUngrabButton function releases the passive button/key combination on the specified window if it was grabbed by this client. -A modifiers of -.ZN AnyModifier +A modifiers of +.B AnyModifier is -equivalent to issuing -the ungrab request for all possible modifier combinations, including +equivalent to issuing +the ungrab request for all possible modifier combinations, including the combination of no modifiers. -A button of -.ZN AnyButton +A button of +.B AnyButton is equivalent to issuing the request for all possible buttons. -.ZN XUngrabButton +.B XUngrabButton has no effect on an active grab. .LP -.ZN XUngrabButton +.B XUngrabButton can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllowEvents(__libmansuffix__), diff --git a/lib/libX11/man/XGrabKey.man b/lib/libX11/man/XGrabKey.man index 0ffc66613..2bc231fbd 100644 --- a/lib/libX11/man/XGrabKey.man +++ b/lib/libX11/man/XGrabKey.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XGrabKey __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XGrabKey, XUngrabKey \- grab keyboard keys @@ -85,10 +52,10 @@ XGrabKey, XUngrabKey \- grab keyboard keys .HP int XGrabKey\^(\^Display *\fIdisplay\fP\^, int \fIkeycode\fP\^, unsigned int \fImodifiers\fP\^, Window \fIgrab_window\fP\^, Bool \fIowner_events\fP\^, int -\fIpointer_mode\fP\^, int \fIkeyboard_mode\fP\^); +\fIpointer_mode\fP\^, int \fIkeyboard_mode\fP\^); .HP int XUngrabKey\^(\^Display *\fIdisplay\fP\^, int \fIkeycode\fP\^, unsigned int -\fImodifiers\fP\^, Window \fIgrab_window\fP\^); +\fImodifiers\fP\^, Window \fIgrab_window\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -96,38 +63,38 @@ Specifies the connection to the X server. Specifies the grab window. .IP \fIkeyboard_mode\fP 1i Specifies further processing of keyboard events. -You can pass -.ZN GrabModeSync +You can pass +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .IP \fIkeycode\fP 1i Specifies the KeyCode or -.ZN AnyKey . +.BR AnyKey . .IP \fImodifiers\fP 1i Specifies the set of keymasks or -.ZN AnyModifier . +.BR AnyModifier . The mask is the bitwise inclusive OR of the valid keymask bits. .IP \fIowner_events\fP 1i -Specifies a Boolean value that indicates whether the keyboard events +Specifies a Boolean value that indicates whether the keyboard events are to be reported as usual. .IP \fIpointer_mode\fP 1i Specifies further processing of pointer events. -You can pass -.ZN GrabModeSync +You can pass +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .SH DESCRIPTION The -.ZN XGrabKey +.B XGrabKey function establishes a passive grab on the keyboard. In the future, the keyboard is actively grabbed (as for -.ZN XGrabKeyboard ), +.BR XGrabKeyboard ), the last-keyboard-grab time is set to the time at which the key was pressed (as transmitted in the -.ZN KeyPress +.B KeyPress event), and the -.ZN KeyPress +.B KeyPress event is reported if all of the following conditions are true: .IP \(bu 5 The keyboard is not grabbed and the specified key @@ -141,92 +108,93 @@ or the grab_window is a descendant of the focus window and contains the pointer. A passive grab on the same key combination does not exist on any ancestor of grab_window. .LP -The interpretation of the remaining arguments is as for -.ZN XGrabKeyboard . +The interpretation of the remaining arguments is as for +.BR XGrabKeyboard . The active grab is terminated automatically when the logical state of the keyboard has the specified key released (independent of the logical state of the modifier keys), -at which point a -.ZN KeyRelease +at which point a +.B KeyRelease event is reported to the grabbing window. .LP Note that the logical state of a device (as seen by client applications) may lag the physical state if device event processing is frozen. .LP -A modifiers argument of -.ZN AnyModifier +A modifiers argument of +.B AnyModifier is equivalent to issuing the request for all possible modifier combinations (including the combination of no -modifiers). +modifiers). It is not required that all modifiers specified have currently assigned KeyCodes. -A keycode argument of -.ZN AnyKey +A keycode argument of +.B AnyKey is equivalent to issuing the request for all possible KeyCodes. Otherwise, the specified keycode must be in the range specified by min_keycode and max_keycode in the connection -setup, +setup, or a -.ZN BadValue +.B BadValue error results. .LP -If some other client has issued a -.ZN XGrabKey -with the same key combination on the same window, a -.ZN BadAccess +If some other client has issued a +.B XGrabKey +with the same key combination on the same window, a +.B BadAccess error results. When using -.ZN AnyModifier -or -.ZN AnyKey , +.B AnyModifier +or +.BR AnyKey , the request fails completely, and a -.ZN BadAccess -error results (no grabs are established) +.B BadAccess +error results (no grabs are established) if there is a conflicting grab for any combination. .LP -.ZN XGrabKey +.B XGrabKey can generate -.ZN BadAccess , -.ZN BadValue , +.BR BadAccess , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XUngrabKey +.B XUngrabKey function releases the key combination on the specified window if it was grabbed by this client. It has no effect on an active grab. A modifiers of -.ZN AnyModifier +.B AnyModifier is equivalent to issuing the request for all possible modifier combinations (including the combination of no modifiers). A keycode argument of -.ZN AnyKey +.B AnyKey is equivalent to issuing the request for all possible key codes. .LP -.ZN XUngrabKey +.B XUngrabKey can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to grab a key/button combination already grabbed by another client. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllowEvents(__libmansuffix__), diff --git a/lib/libX11/man/XGrabKeyboard.man b/lib/libX11/man/XGrabKeyboard.man index 875fe3e5a..60cad6686 100644 --- a/lib/libX11/man/XGrabKeyboard.man +++ b/lib/libX11/man/XGrabKeyboard.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XGrabKeyboard __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XGrabKeyboard, XUngrabKeyboard \- grab the keyboard @@ -85,9 +52,9 @@ XGrabKeyboard, XUngrabKeyboard \- grab the keyboard .HP int XGrabKeyboard\^(\^Display *\fIdisplay\fP\^, Window \fIgrab_window\fP\^, Bool \fIowner_events\fP\^, int \fIpointer_mode\fP\^, int -\fIkeyboard_mode\fP\^, Time \fItime\fP\^); +\fIkeyboard_mode\fP\^, Time \fItime\fP\^); .HP -int XUngrabKeyboard\^(\^Display *\fIdisplay\fP\^, Time \fItime\fP\^); +int XUngrabKeyboard\^(\^Display *\fIdisplay\fP\^, Time \fItime\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -95,137 +62,138 @@ Specifies the connection to the X server. Specifies the grab window. .IP \fIkeyboard_mode\fP 1i Specifies further processing of keyboard events. -You can pass -.ZN GrabModeSync +You can pass +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .IP \fIowner_events\fP 1i -Specifies a Boolean value that indicates whether the keyboard events +Specifies a Boolean value that indicates whether the keyboard events are to be reported as usual. .IP \fIpointer_mode\fP 1i Specifies further processing of pointer events. -You can pass -.ZN GrabModeSync +You can pass +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .IP \fItime\fP 1i Specifies the time. You can pass either a timestamp or -.ZN CurrentTime . +.BR CurrentTime . .SH DESCRIPTION The -.ZN XGrabKeyboard +.B XGrabKeyboard function actively grabs control of the keyboard and generates -.ZN FocusIn +.B FocusIn and -.ZN FocusOut +.B FocusOut events. Further key events are reported only to the grabbing client. -.ZN XGrabKeyboard +.B XGrabKeyboard overrides any active keyboard grab by this client. -If owner_events is -.ZN False , +If owner_events is +.BR False , all generated key events are reported with -respect to grab_window. -If owner_events is -.ZN True +respect to grab_window. +If owner_events is +.B True and if a generated key event would normally be reported to this client, it is reported normally; otherwise, the event is reported with respect to the -grab_window. -Both -.ZN KeyPress -and -.ZN KeyRelease +grab_window. +Both +.B KeyPress +and +.B KeyRelease events are always reported, independent of any event selection made by the client. .LP -If the keyboard_mode argument is -.ZN GrabModeAsync , +If the keyboard_mode argument is +.BR GrabModeAsync , keyboard event processing continues -as usual. -If the keyboard is currently frozen by this client, +as usual. +If the keyboard is currently frozen by this client, then processing of keyboard events is resumed. If the keyboard_mode argument is -.ZN GrabModeSync , +.BR GrabModeSync , the state of the keyboard (as seen by client applications) appears to freeze, and the X server generates no further keyboard events until the -grabbing client issues a releasing -.ZN XAllowEvents +grabbing client issues a releasing +.B XAllowEvents call or until the keyboard grab is released. -Actual keyboard changes are not lost while the keyboard is frozen; +Actual keyboard changes are not lost while the keyboard is frozen; they are simply queued in the server for later processing. .LP -If pointer_mode is -.ZN GrabModeAsync , +If pointer_mode is +.BR GrabModeAsync , pointer event processing is unaffected -by activation of the grab. -If pointer_mode is -.ZN GrabModeSync , -the state of the pointer (as seen by client applications) appears to freeze, -and the X server generates no further pointer events -until the grabbing client issues a releasing -.ZN XAllowEvents +by activation of the grab. +If pointer_mode is +.BR GrabModeSync , +the state of the pointer (as seen by client applications) appears to freeze, +and the X server generates no further pointer events +until the grabbing client issues a releasing +.B XAllowEvents call or until the keyboard grab is released. -Actual pointer changes are not lost while the pointer is frozen; +Actual pointer changes are not lost while the pointer is frozen; they are simply queued in the server for later processing. .LP If the keyboard is actively grabbed by some other client, -.ZN XGrabKeyboard +.B XGrabKeyboard fails and returns -.ZN AlreadyGrabbed . +.BR AlreadyGrabbed . If grab_window is not viewable, it fails and returns -.ZN GrabNotViewable . +.BR GrabNotViewable . If the keyboard is frozen by an active grab of another client, it fails and returns -.ZN GrabFrozen . -If the specified time is earlier than the last-keyboard-grab time +.BR GrabFrozen . +If the specified time is earlier than the last-keyboard-grab time or later than the current X server time, it fails and returns -.ZN GrabInvalidTime . +.BR GrabInvalidTime . Otherwise, the last-keyboard-grab time is set to the specified time -.Pn ( CurrentTime +.Pn ( CurrentTime is replaced by the current X server time). .LP -.ZN XGrabKeyboard +.B XGrabKeyboard can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XUngrabKeyboard +.B XUngrabKeyboard function releases the keyboard and any queued events if this client has it actively grabbed from either -.ZN XGrabKeyboard +.B XGrabKeyboard or -.ZN XGrabKey . -.ZN XUngrabKeyboard +.BR XGrabKey . +.B XUngrabKeyboard does not release the keyboard and any queued events if the specified time is earlier than the last-keyboard-grab time or is later than the current X server time. It also generates -.ZN FocusIn -and -.ZN FocusOut +.B FocusIn +and +.B FocusOut events. -The X server automatically performs an -.ZN UngrabKeyboard +The X server automatically performs an +.B UngrabKeyboard request if the event window for an active keyboard grab becomes not viewable. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllowEvents(__libmansuffix__), diff --git a/lib/libX11/man/XGrabPointer.man b/lib/libX11/man/XGrabPointer.man index b29d0c9d7..fb10a6a50 100644 --- a/lib/libX11/man/XGrabPointer.man +++ b/lib/libX11/man/XGrabPointer.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XGrabPointer __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XGrabPointer, XUngrabPointer, XChangeActivePointerGrab \- grab the pointer @@ -86,19 +53,19 @@ XGrabPointer, XUngrabPointer, XChangeActivePointerGrab \- grab the pointer int XGrabPointer\^(\^Display *\fIdisplay\fP\^, Window \fIgrab_window\fP\^, Bool \fIowner_events\fP\^, unsigned int \fIevent_mask\fP\^, int \fIpointer_mode\fP\^, int \fIkeyboard_mode\fP\^, Window \fIconfine_to\fP\^, -Cursor \fIcursor\fP\^, Time \fItime\fP\^); +Cursor \fIcursor\fP\^, Time \fItime\fP\^); .HP -int XUngrabPointer\^(\^Display *\fIdisplay\fP\^, Time \fItime\fP\^); +int XUngrabPointer\^(\^Display *\fIdisplay\fP\^, Time \fItime\fP\^); .HP int XChangeActivePointerGrab\^(\^Display *\fIdisplay\fP\^, unsigned int -\fIevent_mask\fP\^, Cursor \fIcursor\fP\^, Time \fItime\fP\^); +\fIevent_mask\fP\^, Cursor \fIcursor\fP\^, Time \fItime\fP\^); .SH ARGUMENTS .IP \fIconfine_to\fP 1i Specifies the window to confine the pointer in or -.ZN None . +.BR None . .IP \fIcursor\fP 1i Specifies the cursor that is to be displayed during the grab or -.ZN None . +.BR None . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIevent_mask\fP 1i @@ -108,81 +75,81 @@ The mask is the bitwise inclusive OR of the valid pointer event mask bits. Specifies the grab window. .IP \fIkeyboard_mode\fP 1i Specifies further processing of keyboard events. -You can pass -.ZN GrabModeSync +You can pass +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .IP \fIowner_events\fP 1i -Specifies a Boolean value that indicates whether the pointer -events are to be reported as usual or reported with respect to the grab window +Specifies a Boolean value that indicates whether the pointer +events are to be reported as usual or reported with respect to the grab window if selected by the event mask. .IP \fIpointer_mode\fP 1i Specifies further processing of pointer events. -You can pass -.ZN GrabModeSync +You can pass +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .IP \fItime\fP 1i Specifies the time. You can pass either a timestamp or -.ZN CurrentTime . +.BR CurrentTime . .SH DESCRIPTION The -.ZN XGrabPointer +.B XGrabPointer function actively grabs control of the pointer and returns -.ZN GrabSuccess +.B GrabSuccess if the grab was successful. Further pointer events are reported only to the grabbing client. -.ZN XGrabPointer +.B XGrabPointer overrides any active pointer grab by this client. -If owner_events is -.ZN False , +If owner_events is +.BR False , all generated pointer events are reported with respect to grab_window and are reported only if selected by event_mask. -If owner_events is -.ZN True +If owner_events is +.B True and if a generated -pointer event would normally be reported to this client, -it is reported as usual. +pointer event would normally be reported to this client, +it is reported as usual. Otherwise, the event is reported with respect to the grab_window and is reported only if selected by event_mask. For either value of owner_events, unreported events are discarded. .LP -If the pointer_mode is -.ZN GrabModeAsync , +If the pointer_mode is +.BR GrabModeAsync , pointer event processing continues as usual. -If the pointer is currently frozen by this client, +If the pointer is currently frozen by this client, the processing of events for the pointer is resumed. -If the pointer_mode is -.ZN GrabModeSync , +If the pointer_mode is +.BR GrabModeSync , the state of the pointer, as seen by client applications, appears to freeze, and the X server generates no further pointer events -until the grabbing client calls -.ZN XAllowEvents +until the grabbing client calls +.B XAllowEvents or until the pointer grab is released. Actual pointer changes are not lost while the pointer is frozen; they are simply queued in the server for later processing. .LP -If the keyboard_mode is -.ZN GrabModeAsync , +If the keyboard_mode is +.BR GrabModeAsync , keyboard event processing is unaffected by activation of the grab. -If the keyboard_mode is -.ZN GrabModeSync , +If the keyboard_mode is +.BR GrabModeSync , the state of the keyboard, as seen by client applications, appears to freeze, and the X server generates no further keyboard events -until the grabbing client calls -.ZN XAllowEvents +until the grabbing client calls +.B XAllowEvents or until the pointer grab is released. Actual keyboard changes are not lost while the pointer is frozen; they are simply queued in the server for later processing. .LP If a cursor is specified, it is displayed regardless of what -window the pointer is in. -If -.ZN None +window the pointer is in. +If +.B None is specified, the normal cursor for that window is displayed when the pointer is in grab_window or one of its subwindows; @@ -191,11 +158,11 @@ otherwise, the cursor for grab_window is displayed. If a confine_to window is specified, the pointer is restricted to stay contained in that window. The confine_to window need have no relationship to the grab_window. -If the pointer is not initially in the confine_to window, -it is warped automatically to the closest edge -just before the grab activates and enter/leave events are generated as usual. -If the confine_to window is subsequently reconfigured, -the pointer is warped automatically, as necessary, +If the pointer is not initially in the confine_to window, +it is warped automatically to the closest edge +just before the grab activates and enter/leave events are generated as usual. +If the confine_to window is subsequently reconfigured, +the pointer is warped automatically, as necessary, to keep it contained in the window. .LP The time argument allows you to avoid certain circumstances that come up @@ -203,97 +170,98 @@ if applications take a long time to respond or if there are long network delays. Consider a situation where you have two applications, both of which normally grab the pointer when clicked on. -If both applications specify the timestamp from the event, +If both applications specify the timestamp from the event, the second application may wake up faster and successfully grab the pointer -before the first application. -The first application then will get an indication that the other application +before the first application. +The first application then will get an indication that the other application grabbed the pointer before its request was processed. .LP -.ZN XGrabPointer +.B XGrabPointer generates -.ZN EnterNotify +.B EnterNotify and -.ZN LeaveNotify +.B LeaveNotify events. .LP Either if grab_window or confine_to window is not viewable or if the confine_to window lies completely outside the boundaries of the root window, -.ZN XGrabPointer +.B XGrabPointer fails and returns -.ZN GrabNotViewable . +.BR GrabNotViewable . If the pointer is actively grabbed by some other client, it fails and returns -.ZN AlreadyGrabbed . +.BR AlreadyGrabbed . If the pointer is frozen by an active grab of another client, it fails and returns -.ZN GrabFrozen . -If the specified time is earlier than the last-pointer-grab time or later +.BR GrabFrozen . +If the specified time is earlier than the last-pointer-grab time or later than the current X server time, it fails and returns -.ZN GrabInvalidTime . +.BR GrabInvalidTime . Otherwise, the last-pointer-grab time is set to the specified time -.Pn ( CurrentTime +.Pn ( CurrentTime is replaced by the current X server time). .LP -.ZN XGrabPointer +.B XGrabPointer can generate -.ZN BadCursor , -.ZN BadValue , +.BR BadCursor , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XUngrabPointer +.B XUngrabPointer function releases the pointer and any queued events if this client has actively grabbed the pointer from -.ZN XGrabPointer , -.ZN XGrabButton , +.BR XGrabPointer , +.BR XGrabButton , or from a normal button press. -.ZN XUngrabPointer +.B XUngrabPointer does not release the pointer if the specified time is earlier than the last-pointer-grab time or is later than the current X server time. -It also generates -.ZN EnterNotify -and -.ZN LeaveNotify +It also generates +.B EnterNotify +and +.B LeaveNotify events. -The X server performs an -.ZN UngrabPointer -request automatically if the event window or confine_to window +The X server performs an +.B UngrabPointer +request automatically if the event window or confine_to window for an active pointer grab becomes not viewable or if window reconfiguration causes the confine_to window to lie completely outside the boundaries of the root window. .LP The -.ZN XChangeActivePointerGrab +.B XChangeActivePointerGrab function changes the specified dynamic parameters if the pointer is actively grabbed by the client and if the specified time is no earlier than the last-pointer-grab time and no later than the current X server time. This function has no effect on the passive parameters of a -.ZN XGrabButton . +.BR XGrabButton . The interpretation of event_mask and cursor is the same as described in -.ZN XGrabPointer . +.BR XGrabPointer . .LP -.ZN XChangeActivePointerGrab +.B XChangeActivePointerGrab can generate a -.ZN BadCursor +.B BadCursor and -.ZN BadValue +.B BadValue error. .SH DIAGNOSTICS .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllowEvents(__libmansuffix__), diff --git a/lib/libX11/man/XGrabServer.man b/lib/libX11/man/XGrabServer.man index c0502313f..549d83e4d 100644 --- a/lib/libX11/man/XGrabServer.man +++ b/lib/libX11/man/XGrabServer.man @@ -38,52 +38,19 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XGrabServer __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XGrabServer, XUngrabServer \- grab the server .SH SYNTAX .HP -int XGrabServer\^(\^Display *\fIdisplay\fP\^); +int XGrabServer\^(\^Display *\fIdisplay\fP\^); .HP int XUngrabServer\^(\^Display *\fIdisplay\fP\^); .SH ARGUMENTS @@ -91,13 +58,13 @@ int XUngrabServer\^(\^Display *\fIdisplay\fP\^); Specifies the connection to the X server. .SH DESCRIPTION The -.ZN XGrabServer -function disables processing of requests and close downs on all other +.B XGrabServer +function disables processing of requests and close downs on all other connections than the one this request arrived on. You should not grab the X server any more than is absolutely necessary. .LP The -.ZN XUngrabServer +.B XUngrabServer function restarts processing of requests and close downs on other connections. You should avoid grabbing the X server as much as possible. .SH "SEE ALSO" diff --git a/lib/libX11/man/XGraphicsExposeEvent.man b/lib/libX11/man/XGraphicsExposeEvent.man index 9961f8c3d..840aed26d 100644 --- a/lib/libX11/man/XGraphicsExposeEvent.man +++ b/lib/libX11/man/XGraphicsExposeEvent.man @@ -38,57 +38,24 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XGraphicsExposeEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XGraphicsExposeEvent, XNoExposeEvent \- GraphicsExpose and NoExpose event structures .SH STRUCTURES The structures for -.ZN GraphicsExpose +.B GraphicsExpose and -.ZN NoExpose +.B NoExpose events contain: .LP -.Ds 0 +.EX typedef struct { int type; /\&* GraphicsExpose */ unsigned long serial; /\&* # of last request processed by server */ @@ -101,9 +68,9 @@ typedef struct { int major_code; /\&* core is CopyArea or CopyPlane */ int minor_code; /\&* not defined in the core */ } XGraphicsExposeEvent; -.De +.EE .LP -.Ds 0 +.EX typedef struct { int type; /\&* NoExpose */ unsigned long serial; /\&* # of last request processed by server */ @@ -113,7 +80,7 @@ typedef struct { int major_code; /\&* core is CopyArea or CopyPlane */ int minor_code; /\&* not defined in the core */ } XNoExposeEvent; -.De +.EE .LP When you receive these events, their structure members are set as follows. @@ -121,16 +88,16 @@ their structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -138,47 +105,47 @@ The window member is set to the window that is most useful to toolkit dispatchers. .LP Both structures have these common members: drawable, major_code, and minor_code. -The drawable member is set to the drawable of the destination region on +The drawable member is set to the drawable of the destination region on which the graphics request was to be performed. The major_code member is set to the graphics request initiated by the client and can be either -.ZN X_CopyArea +.B X_CopyArea or -.ZN X_CopyPlane . +.BR X_CopyPlane . If it is -.ZN X_CopyArea , +.BR X_CopyArea , a call to -.ZN XCopyArea +.B XCopyArea initiated the request. If it is -.ZN X_CopyPlane , +.BR X_CopyPlane , a call to -.ZN XCopyPlane +.B XCopyPlane initiated the request. -These constants are defined in +These constants are defined in .hN X11/Xproto.h . The minor_code member, -like the major_code member, +like the major_code member, indicates which graphics request was initiated by -the client. +the client. However, the minor_code member is not defined by the core -X protocol and will be zero in these cases, +X protocol and will be zero in these cases, although it may be used by an extension. .LP -The -.ZN XGraphicsExposeEvent -structure has these additional members: x, y, width, height, and count. +The +.B XGraphicsExposeEvent +structure has these additional members: x, y, width, height, and count. The x and y members are set to the coordinates relative to the drawable's origin and indicate the upper-left corner of the rectangle. The width and height members are set to the size (extent) of the rectangle. The count member is set to the number of -.ZN GraphicsExpose +.B GraphicsExpose events to follow. If count is zero, no more -.ZN GraphicsExpose +.B GraphicsExpose events follow for this window. However, if count is nonzero, at least that number of -.ZN GraphicsExpose +.B GraphicsExpose events (and possibly more) are to follow for this window. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/lib/libX11/man/XGravityEvent.man b/lib/libX11/man/XGravityEvent.man index afdacc74d..a6809ff55 100644 --- a/lib/libX11/man/XGravityEvent.man +++ b/lib/libX11/man/XGravityEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XGravityEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XGravityEvent \- GravityNotify event structure .SH STRUCTURES The structure for -.ZN GravityNotify +.B GravityNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* GravityNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -96,7 +63,7 @@ typedef struct { Window window; int x, y; } XGravityEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -104,16 +71,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -122,14 +89,14 @@ dispatchers. .LP The event member is set either to the window that was moved or to its parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify +.B SubstructureNotify was selected. The window member is set to the child window that was moved. -The x and y members are set to the coordinates relative to the +The x and y members are set to the coordinates relative to the new parent window's origin -and indicate the position of the upper-left outside corner of the +and indicate the position of the upper-left outside corner of the window. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/lib/libX11/man/XIconifyWindow.man b/lib/libX11/man/XIconifyWindow.man index b11776e03..29908669c 100644 --- a/lib/libX11/man/XIconifyWindow.man +++ b/lib/libX11/man/XIconifyWindow.man @@ -38,60 +38,27 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XIconifyWindow __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XIconifyWindow, XWithdrawWindow, XReconfigureWMWindow \- manipulate top-level windows .SH SYNTAX .HP Status XIconifyWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP, int -\fIscreen_number\fP\^); +\fIscreen_number\fP\^); .HP Status XWithdrawWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, int -\fIscreen_number\fP\^); +\fIscreen_number\fP\^); .HP Status XReconfigureWMWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, int \fIscreen_number\fP\^, unsigned int \fIvalue_mask\fP\^, XWindowChanges -*\fIvalues\fP); +*\fIvalues\fP); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -102,86 +69,87 @@ Specifies which values are to be set using information in the values structure. This mask is the bitwise inclusive OR of the valid configure window values bits. .IP \fIvalues\fP 1i -Specifies the -.ZN XWindowChanges +Specifies the +.B XWindowChanges structure. .IP \fIw\fP 1i Specifies the window. .SH DESCRIPTION -The -.ZN XIconifyWindow -function sends a WM_CHANGE_STATE -.ZN ClientMessage -event with a format of 32 and a first data element of -.ZN IconicState -(as described in section 4.1.4 of the +The +.B XIconifyWindow +function sends a WM_CHANGE_STATE +.B ClientMessage +event with a format of 32 and a first data element of +.B IconicState +(as described in section 4.1.4 of the \fIInter-Client Communication Conventions Manual\fP) and a window of w to the root window of the specified screen with an event mask set to -.ZN SubstructureNotifyMask | -.ZN SubstructureRedirectMask . +.BR SubstructureNotifyMask | +.BR SubstructureRedirectMask . Window managers may elect to receive this message and -if the window is in its normal state, +if the window is in its normal state, may treat it as a request to change the window's state from normal to iconic. -If the WM_CHANGE_STATE property cannot be interned, -.ZN XIconifyWindow +If the WM_CHANGE_STATE property cannot be interned, +.B XIconifyWindow does not send a message and returns a zero status. It returns a nonzero status if the client message is sent successfully; otherwise, it returns a zero status. .LP -The -.ZN XWithdrawWindow -function unmaps the specified window -and sends a synthetic -.ZN UnmapNotify +The +.B XWithdrawWindow +function unmaps the specified window +and sends a synthetic +.B UnmapNotify event to the root window of the specified screen. -Window managers may elect to receive this message +Window managers may elect to receive this message and may treat it as a request to change the window's state to withdrawn. -When a window is in the withdrawn state, +When a window is in the withdrawn state, neither its normal nor its iconic representations is visible. -It returns a nonzero status if the -.ZN UnmapNotify -event is successfully sent; +It returns a nonzero status if the +.B UnmapNotify +event is successfully sent; otherwise, it returns a zero status. .LP -.ZN XWithdrawWindow +.B XWithdrawWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP -The -.ZN XReconfigureWMWindow -function issues a -.ZN ConfigureWindow +The +.B XReconfigureWMWindow +function issues a +.B ConfigureWindow request on the specified top-level window. -If the stacking mode is changed and the request fails with a -.ZN BadMatch -error, -the error is trapped by Xlib and a synthetic -.ZN ConfigureRequestEvent -containing the same configuration parameters is sent to the root +If the stacking mode is changed and the request fails with a +.B BadMatch +error, +the error is trapped by Xlib and a synthetic +.B ConfigureRequestEvent +containing the same configuration parameters is sent to the root of the specified window. -Window managers may elect to receive this event +Window managers may elect to receive this event and treat it as a request to reconfigure the indicated window. It returns a nonzero status if the request or event is successfully sent; otherwise, it returns a zero status. .LP -.ZN XReconfigureWMWindow +.B XReconfigureWMWindow can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/lib/libX11/man/XIfEvent.man b/lib/libX11/man/XIfEvent.man index 1cfc571ae..20a202c83 100644 --- a/lib/libX11/man/XIfEvent.man +++ b/lib/libX11/man/XIfEvent.man @@ -38,115 +38,81 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XIfEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XIfEvent, XCheckIfEvent, XPeekIfEvent \- check the event queue with a predicate procedure .SH SYNTAX .HP int XIfEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^, Bool -(\^*\fIpredicate\fP\^)\^(\^)\^, XPointer \fIarg\fP\^); +(\^*\fIpredicate\fP\^)\^(\^)\^, XPointer \fIarg\fP\^); .HP Bool XCheckIfEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^, -Bool (\^*\fIpredicate\fP\^)\^(\^)\^, XPointer \fIarg\fP\^); +Bool (\^*\fIpredicate\fP\^)\^(\^)\^, XPointer \fIarg\fP\^); .HP int XPeekIfEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^, -Bool (\^*\fIpredicate\fP\^)\^(\^)\^, XPointer \fIarg\fP\^); +Bool (\^*\fIpredicate\fP\^)\^(\^)\^, XPointer \fIarg\fP\^); .SH ARGUMENTS .IP \fIarg\fP 1i Specifies the user-supplied argument that will be passed to the predicate procedure. .IP \fIdisplay\fP 1i Specifies the connection to the X server. -.ds Ev \ either a copy of or .IP \fIevent_return\fP 1i -Returns\*(Ev the matched event's associated structure. +Returns either a copy of or the matched event's associated structure. .IP \fIpredicate\fP 1i Specifies the procedure that is to be called to determine if the next event in the queue matches what you want. .SH DESCRIPTION The -.ZN XIfEvent +.B XIfEvent function completes only when the specified predicate -procedure returns -.ZN True -for an event, +procedure returns +.B True +for an event, which indicates an event in the queue matches. -.ZN XIfEvent +.B XIfEvent flushes the output buffer if it blocks waiting for additional events. -.ZN XIfEvent -removes the matching event from the queue +.B XIfEvent +removes the matching event from the queue and copies the structure into the client-supplied -.ZN XEvent +.B XEvent structure. .LP When the predicate procedure finds a match, -.ZN XCheckIfEvent +.B XCheckIfEvent copies the matched event into the client-supplied -.ZN XEvent -structure and returns -.ZN True . +.B XEvent +structure and returns +.BR True . (This event is removed from the queue.) If the predicate procedure finds no match, -.ZN XCheckIfEvent +.B XCheckIfEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. All earlier events stored in the queue are not discarded. .LP The -.ZN XPeekIfEvent +.B XPeekIfEvent function returns only when the specified predicate -procedure returns -.ZN True +procedure returns +.B True for an event. After the predicate procedure finds a match, -.ZN XPeekIfEvent +.B XPeekIfEvent copies the matched event into the client-supplied -.ZN XEvent +.B XEvent structure without removing the event from the queue. -.ZN XPeekIfEvent +.B XPeekIfEvent flushes the output buffer if it blocks waiting for additional events. .LP -Each of these functions requires you to pass a predicate procedure that +Each of these functions requires you to pass a predicate procedure that determines if an event matches what you want. Your predicate procedure must decide if the event is useful without calling any Xlib functions. @@ -156,7 +122,7 @@ If Xlib has been initialized for threads, the predicate is called with the display locked and the result of a call by the predicate to any Xlib function that locks the display is not defined unless the caller has first called -.ZN XLockDisplay . +.BR XLockDisplay . .LP The predicate procedure and its associated arguments are: .HP @@ -165,22 +131,22 @@ Bool (\^*\fIpredicate\fP\^)\^(\^Display *\fIdisplay\fP, XEvent *\fIevent\fP, XPo Specifies the connection to the X server. .IP \fIevent\fP 1i Specifies the -.ZN XEvent +.B XEvent structure. .IP \fIarg\fP 1i -Specifies the argument passed in from the -.ZN XIfEvent , -.ZN XCheckIfEvent , +Specifies the argument passed in from the +.BR XIfEvent , +.BR XCheckIfEvent , or -.ZN XPeekIfEvent +.B XPeekIfEvent function. .LP The predicate procedure is called once for each -event in the queue until it finds a match. -After finding a match, the predicate procedure must return -.ZN True . +event in the queue until it finds a match. +After finding a match, the predicate procedure must return +.BR True . If it did not find a match, it must return -.ZN False . +.BR False . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XNextEvent(__libmansuffix__), diff --git a/lib/libX11/man/XInitImage.man b/lib/libX11/man/XInitImage.man index efd9478fa..beb6b0ee3 100644 --- a/lib/libX11/man/XInitImage.man +++ b/lib/libX11/man/XInitImage.man @@ -38,78 +38,45 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XCreateImage __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XInitImage, XCreateImage, XGetPixel, XPutPixel, XSubImage, XAddPixel, XDestroyImage \- image utilities .SH SYNTAX .HP -Status XInitImage\^(\^XImage *\fIimage\fP\^); +Status XInitImage\^(\^XImage *\fIimage\fP\^); .HP XImage *XCreateImage\^(\^Display *\fIdisplay\fP\^, Visual *\fIvisual\fP\^, unsigned int \fIdepth\fP\^, int \fIformat\fP\^, int \fIoffset\fP\^, char *\fIdata\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, int -\fIbitmap_pad\fP\^, int \fIbytes_per_line\fP\^); +\fIbitmap_pad\fP\^, int \fIbytes_per_line\fP\^); .HP unsigned long XGetPixel\^(\^XImage *\fIximage\fP\^, int \fIx\fP\^, int -\fIy\fP\^); +\fIy\fP\^); .HP int XPutPixel\^(\^XImage *\fIximage\fP\^, int \fIx\fP\^, int \fIy\fP\^, -unsigned long \fIpixel\fP\^); +unsigned long \fIpixel\fP\^); .HP XImage *XSubImage\^(\^XImage *\fIximage\fP\^, int \fIx\fP\^, int \fIy\fP\^, -unsigned int \fIsubimage_width\fP\^, unsigned int \fIsubimage_height\fP\^); +unsigned int \fIsubimage_width\fP\^, unsigned int \fIsubimage_height\fP\^); .HP -int XAddPixel\^(\^XImage *\fIximage\fP\^, long \fIvalue\fP\^); +int XAddPixel\^(\^XImage *\fIximage\fP\^, long \fIvalue\fP\^); .HP -int XDestroyImage\^(\^XImage *\^\fIximage\fP\^); +int XDestroyImage\^(\^XImage *\^\fIximage\fP\^); .SH ARGUMENTS .IP \fIbitmap_pad\fP 1i Specifies the quantum of a scanline (8, 16, or 32). -In other words, the start of one scanline is separated in client memory from -the start of the next scanline by an integer multiple of this many bits. +In other words, the start of one scanline is separated in client memory from +the start of the next scanline by an integer multiple of this many bits. .IP \fIbytes_per_line\fP 1i Specifies the number of bytes in the client image between -the start of one scanline and the start of the next. +the start of one scanline and the start of the next. .IP \fIdata\fP 1i Specifies the image data. .IP \fIdepth\fP 1i @@ -119,10 +86,10 @@ Specifies the connection to the X server. .IP \fIformat\fP 1i Specifies the format for the image. You can pass -.ZN XYBitmap , -.ZN XYPixmap , -or -.ZN ZPixmap . +.BR XYBitmap , +.BR XYPixmap , +or +.BR ZPixmap . .IP \fIheight\fP 1i Specifies the height of the image, in pixels. .IP \fIoffset\fP 1i @@ -137,7 +104,7 @@ Specifies the width of the new subimage, in pixels. Specifies the constant value that is to be added. .IP \fIvisual\fP 1i Specifies the -.ZN Visual +.B Visual structure. .IP \fIwidth\fP 1i Specifies the width of the image, in pixels. @@ -150,12 +117,12 @@ Specifies the image. Specify the x and y coordinates. .SH DESCRIPTION The -.ZN XInitImage +.B XInitImage function initializes the internal image manipulation routines of an image structure, based on the values of the various structure members. All fields other than the manipulation routines must already be initialized. If the bytes_per_line member is zero, -.ZN XInitImage +.B XInitImage will assume the image data is contiguous in memory and set the bytes_per_line member to an appropriate value based on the other members; otherwise, the value of bytes_per_line is not changed. @@ -169,38 +136,39 @@ Image structures created or returned by Xlib do not need to be initialized in this fashion. .LP This function returns a nonzero status if initialization of the -structure is successful. It returns zero if it detected some error +structure is successful. +It returns zero if it detected some error or inconsistency in the structure, in which case the image is not changed. .LP The -.ZN XCreateImage +.B XCreateImage function allocates the memory needed for an -.ZN XImage +.B XImage structure for the specified display but does not allocate space for the image itself. Rather, it initializes the structure byte-order, bit-order, and bitmap-unit -values from the display and returns a pointer to the -.ZN XImage +values from the display and returns a pointer to the +.B XImage structure. The red, green, and blue mask values are defined for Z format images only -and are derived from the -.ZN Visual +and are derived from the +.B Visual structure passed in. Other values also are passed in. -The offset permits the rapid displaying of the image without requiring each +The offset permits the rapid displaying of the image without requiring each scanline to be shifted into position. If you pass a zero value in bytes_per_line, Xlib assumes that the scanlines are contiguous in memory and calculates the value of bytes_per_line itself. .LP Note that when the image is created using -.ZN XCreateImage , -.ZN XGetImage , +.BR XCreateImage , +.BR XGetImage , or -.ZN XSubImage , -the destroy procedure that the -.ZN XDestroyImage -function calls frees both the image structure +.BR XSubImage , +the destroy procedure that the +.B XDestroyImage +function calls frees both the image structure and the data pointed to by the image structure. .LP The basic functions used to get a pixel, set a pixel, create a subimage, @@ -210,7 +178,7 @@ in the image object and are defined in .hN X11/Xutil.h . .LP The -.ZN XGetPixel +.B XGetPixel function returns the specified pixel from the named image. The pixel value is returned in normalized format (that is, the least significant byte of the long is the least significant byte @@ -218,7 +186,7 @@ of the pixel). The image must contain the x and y coordinates. .LP The -.ZN XPutPixel +.B XPutPixel function overwrites the pixel in the named image with the specified pixel value. The input pixel value must be in normalized format (that is, the least significant byte of the long is the least significant @@ -226,10 +194,10 @@ byte of the pixel). The image must contain the x and y coordinates. .LP The -.ZN XSubImage +.B XSubImage function creates a new image that is a subsection of an existing one. It allocates the memory necessary for the new -.ZN XImage +.B XImage structure and returns a pointer to the new image. The data is copied from the source image, @@ -237,15 +205,15 @@ and the image must contain the rectangle defined by x, y, subimage_width, and subimage_height. .LP The -.ZN XAddPixel +.B XAddPixel function adds a constant value to every pixel in an image. It is useful when you have a base pixel value from allocating color resources and need to manipulate the image to that form. .LP The -.ZN XDestroyImage +.B XDestroyImage function deallocates the memory associated with the -.ZN XImage +.B XImage structure. .SH "SEE ALSO" XPutImage(__libmansuffix__) diff --git a/lib/libX11/man/XInitThreads.man b/lib/libX11/man/XInitThreads.man index 2ca980299..4ae952287 100644 --- a/lib/libX11/man/XInitThreads.man +++ b/lib/libX11/man/XInitThreads.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XInitThreads __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XInitThreads, XLockDisplay, XUnlockDisplay \- multi-threading support @@ -85,15 +52,15 @@ XInitThreads, XLockDisplay, XUnlockDisplay \- multi-threading support .HP Status XInitThreads\^(void); .HP -void XLockDisplay\^(\^Display *\fIdisplay\fP\^); +void XLockDisplay\^(\^Display *\fIdisplay\fP\^); .HP -void XUnlockDisplay\^(\^Display *\fIdisplay\fP\^); +void XUnlockDisplay\^(\^Display *\fIdisplay\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. .SH DESCRIPTION The -.ZN XInitThreads +.B XInitThreads function initializes Xlib support for concurrent threads. This function must be the first Xlib function a multi-threaded program calls, and it must complete @@ -103,7 +70,8 @@ successful; otherwise, it returns zero. On systems that do not support threads, this function always returns zero. .LP It is only necessary to call this function if multiple threads -might use Xlib concurrently. If all calls to Xlib functions +might use Xlib concurrently. +If all calls to Xlib functions are protected by some other access mechanism (for example, a mutual exclusion lock in a toolkit or through explicit client programming), Xlib thread initialization is not required. @@ -111,32 +79,32 @@ It is recommended that single-threaded programs not call this function. .LP The -.ZN XLockDisplay +.B XLockDisplay function locks out all other threads from using the specified display. Other threads attempting to use the display will block until the display is unlocked by this thread. Nested calls to -.ZN XLockDisplay +.B XLockDisplay work correctly; the display will not actually be unlocked until -.ZN XUnlockDisplay +.B XUnlockDisplay has been called the same number of times as -.ZN XLockDisplay . +.BR XLockDisplay . This function has no effect unless Xlib was successfully initialized for threads using -.ZN XInitThreads . +.BR XInitThreads . .LP The -.ZN XUnlockDisplay +.B XUnlockDisplay function allows other threads to use the specified display again. Any threads that have blocked on the display are allowed to continue. Nested locking works correctly; if -.ZN XLockDisplay +.B XLockDisplay has been called multiple times by a thread, then -.ZN XUnlockDisplay +.B XUnlockDisplay must be called an equal number of times before the display is actually unlocked. This function has no effect unless Xlib was successfully initialized for threads using -.ZN XInitThreads . +.BR XInitThreads . .SH "SEE ALSO" \fI\*(xL\fP diff --git a/lib/libX11/man/XInstallColormap.man b/lib/libX11/man/XInstallColormap.man index b3570cb50..6f46f024f 100644 --- a/lib/libX11/man/XInstallColormap.man +++ b/lib/libX11/man/XInstallColormap.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XInstallColormap __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XInstallColormap, XUninstallColormap, XListInstalledColormaps \- control colormaps @@ -86,10 +53,10 @@ XInstallColormap, XUninstallColormap, XListInstalledColormaps \- control colorma int XInstallColormap\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^); .HP int XUninstallColormap\^(\^Display *\fIdisplay\fP\^, Colormap -\fIcolormap\fP\^); +\fIcolormap\fP\^); .HP Colormap *XListInstalledColormaps\^(\^Display *\fIdisplay\fP\^, Window -\fIw\fP\^, int *\fInum_return\fP\^); +\fIw\fP\^, int *\fInum_return\fP\^); .SH ARGUMENTS .IP \fIcolormap\fP 1i Specifies the colormap. @@ -97,84 +64,83 @@ Specifies the colormap. Specifies the connection to the X server. .IP \fInum_return\fP 1i Returns the number of currently installed colormaps. -.ds Wi that determines the screen .IP \fIw\fP 1i -Specifies the window \*(Wi. +Specifies the window that determines the screen. .SH DESCRIPTION The -.ZN XInstallColormap +.B XInstallColormap function installs the specified colormap for its associated screen. All windows associated with this colormap immediately display with true colors. You associated the windows with this colormap when you created them by calling -.ZN XCreateWindow , -.ZN XCreateSimpleWindow , -.ZN XChangeWindowAttributes , +.BR XCreateWindow , +.BR XCreateSimpleWindow , +.BR XChangeWindowAttributes , or -.ZN XSetWindowColormap . +.BR XSetWindowColormap . .LP -If the specified colormap is not already an installed colormap, +If the specified colormap is not already an installed colormap, the X server generates a -.ZN ColormapNotify +.B ColormapNotify event on each window that has that colormap. -In addition, for every other colormap that is installed as +In addition, for every other colormap that is installed as a result of a call to -.ZN XInstallColormap , +.BR XInstallColormap , the X server generates a -.ZN ColormapNotify +.B ColormapNotify event on each window that has that colormap. .LP -.ZN XInstallColormap +.B XInstallColormap can generate a -.ZN BadColor +.B BadColor error. .LP The -.ZN XUninstallColormap +.B XUninstallColormap function removes the specified colormap from the required list for its screen. As a result, -the specified colormap might be uninstalled, +the specified colormap might be uninstalled, and the X server might implicitly install or uninstall additional colormaps. Which colormaps get installed or uninstalled is server dependent except that the required list must remain installed. .LP -If the specified colormap becomes uninstalled, +If the specified colormap becomes uninstalled, the X server generates a -.ZN ColormapNotify +.B ColormapNotify event on each window that has that colormap. -In addition, for every other colormap that is installed or uninstalled as a -result of a call to -.ZN XUninstallColormap , +In addition, for every other colormap that is installed or uninstalled as a +result of a call to +.BR XUninstallColormap , the X server generates a -.ZN ColormapNotify +.B ColormapNotify event on each window that has that colormap. .LP -.ZN XUninstallColormap +.B XUninstallColormap can generate a -.ZN BadColor +.B BadColor error. .LP The -.ZN XListInstalledColormaps -function returns a list of the currently installed colormaps for the screen +.B XListInstalledColormaps +function returns a list of the currently installed colormaps for the screen of the specified window. The order of the colormaps in the list is not significant and is no explicit indication of the required list. When the allocated list is no longer needed, free it by using -.ZN XFree . +.BR XFree . .LP -.ZN XListInstalledColormaps +.B XListInstalledColormaps can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/lib/libX11/man/XInternAtom.man b/lib/libX11/man/XInternAtom.man index 3c0039bf0..6cd6374d6 100644 --- a/lib/libX11/man/XInternAtom.man +++ b/lib/libX11/man/XInternAtom.man @@ -38,61 +38,28 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XInternAtom __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XInternAtom, XInternAtoms, XGetAtomName, XGetAtomNames \- create or return atom names .SH SYNTAX .HP Atom XInternAtom\^(\^Display *\fIdisplay\fP\^, char *\fIatom_name\fP\^, Bool -\fIonly_if_exists\fP\^); +\fIonly_if_exists\fP\^); .HP Status XInternAtoms\^(\^Display *\fIdisplay\fP\^, char **\fInames\fP\^, int -\fIcount\fP\^, Bool \fIonly_if_exists\fP\^, Atom *\fIatoms_return\fP\^); +\fIcount\fP\^, Bool \fIonly_if_exists\fP\^, Atom *\fIatoms_return\fP\^); .HP -char *XGetAtomName\^(\^Display *\fIdisplay\fP\^, Atom \fIatom\fP\^); +char *XGetAtomName\^(\^Display *\fIdisplay\fP\^, Atom \fIatom\fP\^); .HP Status XGetAtomNames\^(\^Display *\fIdisplay\fP\^, Atom *\fIatoms\fP\^, int -\fIcount\fP\^, char **\fInames_return\fP\^); +\fIcount\fP\^, char **\fInames_return\fP\^); .SH ARGUMENTS .IP \fIatom\fP 1i Specifies the atom for the property name you want returned. @@ -102,12 +69,8 @@ Specifies the array of atoms. Specifies the name associated with the atom you want returned. .IP \fIatoms_return\fP 1i Returns the atoms. -.ds Cn atom names in the array -.IP \fIcount\fP 1i -Specifies the number of \*(Cn. -.ds Cn atoms in the array .IP \fIcount\fP 1i -Specifies the number of \*(Cn. +Specifies the number of atom names in the array. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fInames\fP 1i @@ -118,38 +81,38 @@ Returns the atom names. Specifies a Boolean value that indicates whether the atom must be created. .SH DESCRIPTION The -.ZN XInternAtom +.B XInternAtom function returns the atom identifier associated with the specified atom_name string. -If only_if_exists is -.ZN False , +If only_if_exists is +.BR False , the atom is created if it does not exist. Therefore, -.ZN XInternAtom +.B XInternAtom can return -.ZN None . -If the atom name is not in the Host Portable Character Encoding, +.BR None . +If the atom name is not in the Host Portable Character Encoding, the result is implementation-dependent. Uppercase and lowercase matter; -the strings ``thing'', ``Thing'', and ``thinG'' -all designate different atoms. +the strings \*(lqthing\*(rq, \*(lqThing\*(rq, and \*(lqthinG\*(rq +all designate different atoms. The atom will remain defined even after the client's connection closes. It will become undefined only when the last connection to the X server closes. .LP -.ZN XInternAtom +.B XInternAtom can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XInternAtoms +.B XInternAtoms function returns the atom identifiers associated with the specified names. The atoms are stored in the atoms_return array supplied by the caller. Calling this function is equivalent to calling -.ZN XInternAtom +.B XInternAtom for each of the names in turn with the specified value of only_if_exists, but this function minimizes the number of round-trip protocol exchanges between the client and the X server. @@ -158,34 +121,34 @@ This function returns a nonzero status if atoms are returned for all of the names; otherwise, it returns zero. .LP -.ZN XInternAtoms +.B XInternAtoms can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XGetAtomName +.B XGetAtomName function returns the name associated with the specified atom. If the data returned by the server is in the Latin Portable Character Encoding, then the returned string is in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. To free the resulting string, call -.ZN XFree . +.BR XFree . .LP -.ZN XGetAtomName +.B XGetAtomName can generate a -.ZN BadAtom +.B BadAtom error. .LP The -.ZN XGetAtomNames +.B XGetAtomNames function returns the names associated with the specified atoms. The names are stored in the names_return array supplied by the caller. Calling this function is equivalent to calling -.ZN XGetAtomName +.B XGetAtomName for each of the atoms in turn, but this function minimizes the number of round-trip protocol exchanges between the client and the X server. @@ -194,22 +157,23 @@ This function returns a nonzero status if names are returned for all of the atoms; otherwise, it returns zero. .LP -.ZN XGetAtomNames +.B XGetAtomNames can generate a -.ZN BadAtom +.B BadAtom error. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XFree(__libmansuffix__), diff --git a/lib/libX11/man/XIntersectRegion.man b/lib/libX11/man/XIntersectRegion.man index 0686935ba..54cff3567 100644 --- a/lib/libX11/man/XIntersectRegion.man +++ b/lib/libX11/man/XIntersectRegion.man @@ -38,81 +38,47 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XIntersectRegion __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XIntersectRegion, XUnionRegion, XUnionRectWithRegion, XSubtractRegion, XXorRegion, XOffsetRegion, XShrinkRegion \- region arithmetic .SH SYNTAX .HP int XIntersectRegion\^(\^Region \fIsra\fP\^, Region \fIsrb\fP\^, Region -\fIdr_return\fP\^); +\fIdr_return\fP\^); .HP int XUnionRegion\^(\^Region \fIsra\fP\^, Region \fIsrb\fP\^, Region -\fIdr_return\fP\^); +\fIdr_return\fP\^); .HP int XUnionRectWithRegion\^(\^XRectangle *\fIrectangle\fP\^, Region -\fIsrc_region\fP\^, Region \fIdest_region_return\fP\^); +\fIsrc_region\fP\^, Region \fIdest_region_return\fP\^); .HP int XSubtractRegion\^(\^Region \fIsra\fP\^, Region \fIsrb\fP\^, Region -\fIdr_return\fP\^); +\fIdr_return\fP\^); .HP int XXorRegion\^(\^Region \fIsra\fP\^, Region \fIsrb\fP\^, Region -\fIdr_return\fP\^); +\fIdr_return\fP\^); .HP -int XOffsetRegion\^(\^Region \fIr\fP\^, int \fIdx\fP\^, int \fIdy\fP\^); +int XOffsetRegion\^(\^Region \fIr\fP\^, int \fIdx\fP\^, int \fIdy\fP\^); .HP -int XShrinkRegion\^(\^Region \fIr\fP\^, int \fIdx\fP\^, int \fIdy\fP\^); +int XShrinkRegion\^(\^Region \fIr\fP\^, int \fIdx\fP\^, int \fIdy\fP\^); .SH ARGUMENTS .IP \fIdest_region_return\fP 1i Returns the destination region. .IP \fIdr_return\fP 1i Returns the result of the computation. -ds Dy move or shrink .IP \fIdx\fP 1i .br .ns .IP \fIdy\fP 1i Specify the x and y coordinates, -which define the amount you want to \*(Dy the specified region. +which define the amount you want to move or shrink the specified region. .IP \fIr\fP 1i Specifies the region. .IP \fIrectangle\fP 1i @@ -126,33 +92,33 @@ Specify the two regions with which you want to perform the computation. Specifies the source region to be used. .SH DESCRIPTION The -.ZN XIntersectRegion +.B XIntersectRegion function computes the intersection of two regions. .LP The -.ZN XUnionRegion +.B XUnionRegion function computes the union of two regions. .LP The -.ZN XUnionRectWithRegion +.B XUnionRectWithRegion function updates the destination region from a union of the specified rectangle and the specified source region. .LP The -.ZN XSubtractRegion +.B XSubtractRegion function subtracts srb from sra and stores the results in dr_return. .LP The -.ZN XXorRegion +.B XXorRegion function calculates the difference between the union and intersection of two regions. .LP The -.ZN XOffsetRegion +.B XOffsetRegion function moves the specified region by a specified amount. .LP The -.ZN XShrinkRegion +.B XShrinkRegion function reduces the specified region by a specified amount. Positive values shrink the size of the region, and negative values expand the region. diff --git a/lib/libX11/man/XKeymapEvent.man b/lib/libX11/man/XKeymapEvent.man index 1fdb5165f..000c03a06 100644 --- a/lib/libX11/man/XKeymapEvent.man +++ b/lib/libX11/man/XKeymapEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XKeymapEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XKeymapEvent \- KeymapNotify event structure .SH STRUCTURES The structure for -.ZN KeymapNotify +.B KeymapNotify events contains: .LP -.Ds 0 +.EX /\&* generated on EnterWindow and FocusIn when KeymapState selected */ typedef struct { int type; /\&* KeymapNotify */ @@ -95,8 +62,8 @@ typedef struct { Display *display; /\&* Display the event was read from */ Window window; char key_vector[32]; -} XKeymapEvent; -.De +} XKeymapEvent; +.EE .LP When you receive this event, the structure members are set as follows. @@ -104,16 +71,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -122,10 +89,10 @@ dispatchers. .LP The window member is not used but is present to aid some toolkits. The key_vector member is set to the bit vector of the keyboard. -Each bit set to 1 indicates that the corresponding key +Each bit set to 1 indicates that the corresponding key is currently pressed. The vector is represented as 32 bytes. -Byte N (from 0) contains the bits for keys 8N to 8N + 7 +Byte N (from 0) contains the bits for keys 8N to 8N + 7 with the least significant bit in the byte representing key 8N. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/lib/libX11/man/XListFonts.man b/lib/libX11/man/XListFonts.man index b386ae8a4..6dd1c9e9c 100644 --- a/lib/libX11/man/XListFonts.man +++ b/lib/libX11/man/XListFonts.man @@ -38,62 +38,29 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XListFonts __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XListFonts, XFreeFontNames, XListFontsWithInfo, XFreeFontInfo \- obtain or free font names and information .SH SYNTAX .HP char **XListFonts\^(\^Display *\^\fIdisplay\fP\^, char *\^\fIpattern\fP\^, int -\fImaxnames\fP\^, int *\^\fIactual_count_return\fP\^); +\fImaxnames\fP\^, int *\^\fIactual_count_return\fP\^); .HP -int XFreeFontNames\^(\^char *\fIlist\fP\^[\^]\^); +int XFreeFontNames\^(\^char *\fIlist\fP\^[\^]\^); .HP char **XListFontsWithInfo\^(\^Display *\fIdisplay\fP\^, char *\fIpattern\fP\^, int \fImaxnames\fP\^, int *\fIcount_return\fP\^, XFontStruct -**\fIinfo_return\fP\^); +**\fIinfo_return\fP\^); .HP int XFreeFontInfo(\^char **\fInames\fP\^, XFontStruct *\fIfree_info\fP, int -\fIactual_count\fP\^); +\fIactual_count\fP\^); .SH ARGUMENTS .IP \fIactual_count\fP 1i Specifies the actual number of font names. @@ -117,14 +84,14 @@ Specifies the maximum number of names to be returned. Specifies the list of font names. .IP \fIpattern\fP 1i -Specifies the null-terminated pattern string that can contain wildcard +Specifies the null-terminated pattern string that can contain wildcard characters. .SH DESCRIPTION The -.ZN XListFonts -function returns an array of available font names +.B XListFonts +function returns an array of available font names (as controlled by the font search path; see -.ZN XSetFontPath ) +.BR XSetFontPath ) that match the string you passed to the pattern argument. The pattern string can contain any characters, but each asterisk (*) is a wildcard for any number of characters, @@ -137,26 +104,26 @@ If the data returned by the server is in the Latin Portable Character Encoding, then the returned strings are in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. If there are no matching font names, -.ZN XListFonts +.B XListFonts returns NULL. The client should call -.ZN XFreeFontNames +.B XFreeFontNames when finished with the result to free the memory. .LP The -.ZN XFreeFontNames +.B XFreeFontNames function frees the array and strings returned by -.ZN XListFonts +.B XListFonts or -.ZN XListFontsWithInfo . +.BR XListFontsWithInfo . .LP The -.ZN XListFontsWithInfo +.B XListFontsWithInfo function returns a list of font names that match the specified pattern and their associated font information. The list of names is limited to size specified by maxnames. The information returned for each font is identical to what -.ZN XLoadQueryFont +.B XLoadQueryFont would return except that the per-character metrics are not returned. The pattern string can contain any characters, but each asterisk (*) is a wildcard for any number of characters, @@ -169,33 +136,34 @@ If the data returned by the server is in the Latin Portable Character Encoding, then the returned strings are in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. If there are no matching font names, -.ZN XListFontsWithInfo +.B XListFontsWithInfo returns NULL. .LP To free only the allocated name array, the client should call -.ZN XFreeFontNames . +.BR XFreeFontNames . To free both the name array and the font information array or to free just the font information array, the client should call -.ZN XFreeFontInfo . +.BR XFreeFontInfo . .LP The -.ZN XFreeFontInfo +.B XFreeFontInfo function frees a font structure or an array of font structures and optionally an array of font names. If NULL is passed for names, no font names are freed. If a font structure for an open font (returned by -.ZN XLoadQueryFont ) +.BR XLoadQueryFont ) is passed, the structure is freed, but the font is not closed; use -.ZN XUnloadFont +.B XUnloadFont to close the font. .LP Note that -.ZN XListFontsWithInfo -is not thread-safe. If other threads make X requests on the same -.ZN Display , +.B XListFontsWithInfo +is not thread-safe. +If other threads make X requests on the same +.BR Display , then this function's behavior is undefined. .SH "SEE ALSO" XLoadFont(__libmansuffix__), diff --git a/lib/libX11/man/XLoadFont.man b/lib/libX11/man/XLoadFont.man index 2d2d1422d..b4c023ef6 100644 --- a/lib/libX11/man/XLoadFont.man +++ b/lib/libX11/man/XLoadFont.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .de EX .sp .nf @@ -93,19 +60,19 @@ XLoadFont, XQueryFont, XLoadQueryFont, XFreeFont, XGetFontProperty, XUnloadFont, XCharStruct, XFontProp, XChar2b, XFontStruct \- load or unload fonts and font metric structures .SH SYNTAX .HP -Font XLoadFont\^(\^Display *\fIdisplay\fP\^, char *\fIname\fP\^); +Font XLoadFont\^(\^Display *\fIdisplay\fP\^, char *\fIname\fP\^); .HP -XFontStruct *XQueryFont\^(\^Display *\fIdisplay\fP\^, XID \fIfont_ID\fP\^); +XFontStruct *XQueryFont\^(\^Display *\fIdisplay\fP\^, XID \fIfont_ID\fP\^); .HP XFontStruct *XLoadQueryFont\^(\^Display *\fIdisplay\fP\^, char -*\fIname\fP\^); +*\fIname\fP\^); .HP int XFreeFont\^(\^Display *\fIdisplay\fP\^, XFontStruct *\fIfont_struct\fP\^); .HP Bool XGetFontProperty\^(\^XFontStruct *\fIfont_struct\fP\^, Atom \fIatom\fP\^, -unsigned long *\fIvalue_return\fP\^); +unsigned long *\fIvalue_return\fP\^); .HP -int XUnloadFont\^(\^Display *\fIdisplay\fP\^, Font \fIfont\fP\^); +int XUnloadFont\^(\^Display *\fIdisplay\fP\^, Font \fIfont\fP\^); .SH ARGUMENTS .IP \fIatom\fP 1i Specifies the atom for the property name you want returned. @@ -114,8 +81,8 @@ Specifies the connection to the X server. .IP \fIfont\fP 1i Specifies the font. .IP \fIfont_ID\fP 1i -Specifies the font ID or the -.ZN GContext +Specifies the font ID or the +.B GContext ID. .IP \fIfont_struct\fP 1i Specifies the storage associated with the font. @@ -128,98 +95,98 @@ which is a null-terminated string. Returns the value of the font property. .SH DESCRIPTION The -.ZN XLoadFont +.B XLoadFont function loads the specified font and returns its associated font ID. If the font name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. -When the characters ``?'' and ``*'' are used in a font name, a +When the characters \*(lq?\*(rq and \*(lq\*(rq are used in a font name, a pattern match is performed and any matching font is used. -In the pattern, -the ``?'' character will match any single character, -and the ``*'' character will match any number of characters. -A structured format for font names is specified in the X Consortium standard +In the pattern, +the \*(lq?\*(rq character will match any single character, +and the \*(lq*\*(rq character will match any number of characters. +A structured format for font names is specified in the X Consortium standard \fIX Logical Font Description Conventions\fP. -If -.ZN XLoadFont -was unsuccessful at loading the specified font, -a -.ZN BadName +If +.B XLoadFont +was unsuccessful at loading the specified font, +a +.B BadName error results. -Fonts are not associated with a particular screen +Fonts are not associated with a particular screen and can be stored as a component of any GC. -When the font is no longer needed, call -.ZN XUnloadFont . +When the font is no longer needed, call +.BR XUnloadFont . .LP -.ZN XLoadFont +.B XLoadFont can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadName +.B BadName errors. .LP The -.ZN XQueryFont +.B XQueryFont function returns a pointer to the -.ZN XFontStruct +.B XFontStruct structure, which contains information associated with the font. You can query a font or the font stored in a GC. -The font ID stored in the -.ZN XFontStruct -structure will be the -.ZN GContext +The font ID stored in the +.B XFontStruct +structure will be the +.B GContext ID, and you need to be careful when using this ID in other functions (see -.ZN XGContextFromGC ). +.BR XGContextFromGC ). If the font does not exist, -.ZN XQueryFont +.B XQueryFont returns NULL. To free this data, use -.ZN XFreeFontInfo . +.BR XFreeFontInfo . .LP -.ZN XLoadQueryFont +.B XLoadQueryFont can generate a -.ZN BadAlloc +.B BadAlloc error. .LP The -.ZN XLoadQueryFont +.B XLoadQueryFont function provides the most common way for accessing a font. -.ZN XLoadQueryFont +.B XLoadQueryFont both opens (loads) the specified font and returns a pointer to the appropriate -.ZN XFontStruct +.B XFontStruct structure. If the font name is not in the Host Portable Character Encoding, the result is implementation-dependent. If the font does not exist, -.ZN XLoadQueryFont +.B XLoadQueryFont returns NULL. .LP The -.ZN XFreeFont -function deletes the association between the font resource ID and the specified +.B XFreeFont +function deletes the association between the font resource ID and the specified font and frees the -.ZN XFontStruct +.B XFontStruct structure. The font itself will be freed when no other resource references it. The data and the font should not be referenced again. .LP -.ZN XFreeFont +.B XFreeFont can generate a -.ZN BadFont +.B BadFont error. .LP Given the atom for that property, the -.ZN XGetFontProperty -function returns the value of the specified font property. -.ZN XGetFontProperty -also returns -.ZN False -if the property was not defined or -.ZN True +.B XGetFontProperty +function returns the value of the specified font property. +.B XGetFontProperty +also returns +.B False +if the property was not defined or +.B True if it was defined. A set of predefined atoms exists for font properties, which can be found in @@ -230,29 +197,29 @@ Although it is not guaranteed, it is likely that the predefined font properties will be present. .LP The -.ZN XUnloadFont +.B XUnloadFont function deletes the association between the font resource ID and the specified font. The font itself will be freed when no other resource references it. The font should not be referenced again. .LP -.ZN XUnloadFont +.B XUnloadFont can generate a -.ZN BadFont +.B BadFont error. .SH STRUCTURES The -.ZN XFontStruct +.B XFontStruct structure contains all of the information for the font and consists of the font-specific information as well as a pointer to an array of -.ZN XCharStruct +.B XCharStruct structures for the characters contained in the font. The -.ZN XFontStruct , -.ZN XFontProp , +.BR XFontStruct , +.BR XFontProp , and -.ZN XCharStruct +.B XCharStruct structures contain: .LP .IN "XCharStruct" "" "@DEF@" @@ -316,32 +283,32 @@ byte2 defines the range of defined columns of the font. Single byte/character fonts have one row defined, and the byte2 range specified in the structure defines a range of characters. .LP -The bounding box of a character is defined by the -.ZN XCharStruct +The bounding box of a character is defined by the +.B XCharStruct of that character. When characters are absent from a font, the default_char is used. When fonts have all characters of the same size, only the information in the -.ZN XFontStruct +.B XFontStruct min and max bounds are used. .LP -The members of the -.ZN XFontStruct +The members of the +.B XFontStruct have the following semantics: .IP \(bu 5 -The direction member can be either -.ZN FontLeftToRight -or -.ZN FontRightToLeft . -It is just a hint as to whether most -.ZN XCharStruct -elements -have a positive -.Pn ( FontLeftToRight ) -or a negative +The direction member can be either +.B FontLeftToRight +or +.BR FontRightToLeft . +It is just a hint as to whether most +.B XCharStruct +elements +have a positive +.Pn ( FontLeftToRight ) +or a negative .Pn ( FontRightToLeft ) -character width +character width metric. The core protocol defines no support for vertical text. .IP \(bu 5 @@ -351,7 +318,7 @@ of the per_char array, and max_char_or_byte2 specifies the linear character index of the last element. .IP If either min_byte1 or max_byte1 are nonzero, both -min_char_or_byte2 and max_char_or_byte2 are less than 256, +min_char_or_byte2 and max_char_or_byte2 are less than 256, and the 2-byte character index values corresponding to the per_char array element N (counting from 0) are: .IP @@ -366,45 +333,45 @@ where: \e\e = integer modulus .EE .IP \(bu 5 -If the per_char pointer is NULL, +If the per_char pointer is NULL, all glyphs between the first and last character indexes inclusive have the same information, as given by both min_bounds and max_bounds. .IP \(bu 5 -If all_chars_exist is -.ZN True , +If all_chars_exist is +.BR True , all characters in the per_char array have nonzero bounding boxes. .IP \(bu 5 The default_char member specifies the character that will be used when an -undefined or nonexistent character is printed. +undefined or nonexistent character is printed. The default_char is a 16-bit character (not a 2-byte character). -For a font using 2-byte matrix format, +For a font using 2-byte matrix format, the default_char has byte1 in the most-significant byte and byte2 in the least significant byte. -If the default_char itself specifies an undefined or nonexistent character, +If the default_char itself specifies an undefined or nonexistent character, no printing is performed for an undefined or nonexistent character. .IP \(bu 5 The min_bounds and max_bounds members contain the most extreme values of -each individual -.ZN XCharStruct +each individual +.B XCharStruct component over all elements of this array (and ignore nonexistent characters). The bounding box of the font (the smallest rectangle enclosing the shape obtained by superimposing all of the characters at the same origin [x,y]) has its upper-left coordinate at: -.Ds +.EX [x + min_bounds.lbearing, y \- max_bounds.ascent] -.De +.EE .IP Its width is: -.Ds +.EX max_bounds.rbearing \- min_bounds.lbearing -.De +.EE .IP Its height is: -.Ds +.EX max_bounds.ascent + max_bounds.descent -.De +.EE .IP \(bu 5 The ascent member is the logical extent of the font above the baseline that is used for determining line spacing. @@ -416,40 +383,40 @@ baseline that is used for determining line spacing. Specific characters may extend beyond this. .IP \(bu 5 If the baseline is at Y-coordinate y, -the logical extent of the font is inclusive between the Y-coordinate +the logical extent of the font is inclusive between the Y-coordinate values (y \- font.ascent) and (y + font.descent \- 1). Typically, the minimum interline spacing between rows of text is given by ascent + descent. .LP For a character origin at [x,y], -the bounding box of a character (that is, +the bounding box of a character (that is, the smallest rectangle that encloses the character's shape) -described in terms of -.ZN XCharStruct +described in terms of +.B XCharStruct components is a rectangle with its upper-left corner at: .LP -.Ds +.EX [x + lbearing, y \- ascent] -.De +.EE .LP Its width is: .LP -.Ds +.EX rbearing \- lbearing -.De +.EE .LP Its height is: .LP -.Ds +.EX ascent + descent -.De +.EE .LP The origin for the next character is defined to be: .LP -.Ds +.EX [x + width, y] -.De +.EE .LP The lbearing member defines the extent of the left edge of the character ink from the origin. @@ -462,13 +429,13 @@ from the origin. The width member defines the logical width of the character. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadFont +.B BadFont A value for a Font or GContext argument does not name a defined Font. .TP 1i -.ZN BadName +.B BadName A font or color of the specified name does not exist. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/lib/libX11/man/XLookupKeysym.man b/lib/libX11/man/XLookupKeysym.man index 0ec8f4fda..2f54a49e6 100644 --- a/lib/libX11/man/XLookupKeysym.man +++ b/lib/libX11/man/XLookupKeysym.man @@ -38,62 +38,29 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XLookupKeysym __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XLookupKeysym, XRefreshKeyboardMapping, XLookupString, XRebindKeysym \- handle keyboard input events in Latin-1 .SH SYNTAX .HP -KeySym XLookupKeysym(\^XKeyEvent *\fIkey_event\fP\^, int \fIindex\fP\^); +KeySym XLookupKeysym(\^XKeyEvent *\fIkey_event\fP\^, int \fIindex\fP\^); .HP -int XRefreshKeyboardMapping(\^XMappingEvent *\fIevent_map\fP\^); +int XRefreshKeyboardMapping(\^XMappingEvent *\fIevent_map\fP\^); .HP int XLookupString(\^XKeyEvent *\fIevent_struct\fP\^, char *\fIbuffer_return\fP\^, int \fIbytes_buffer\fP\^, KeySym -*\fIkeysym_return\fP\^, XComposeStatus *\fIstatus_in_out\fP\^); +*\fIkeysym_return\fP\^, XComposeStatus *\fIstatus_in_out\fP\^); .HP int XRebindKeysym(\^Display *\fIdisplay\fP\^, KeySym \fIkeysym\fP\^, KeySym \fIlist\fP\^[\^]\^, int \fImod_count\fP\^, unsigned char *\fIstring\fP\^, int -\fInum_bytes\fP\^); +\fInum_bytes\fP\^); .SH ARGUMENTS .IP \fIbuffer_return\fP 1i Returns the translated characters. @@ -109,19 +76,19 @@ Specifies the mapping event that is to be used. .IP \fIevent_struct\fP 1i Specifies the key event structure to be used. You can pass -.ZN XKeyPressedEvent +.B XKeyPressedEvent or -.ZN XKeyReleasedEvent . +.BR XKeyReleasedEvent . .IP \fIindex\fP 1i Specifies the index into the KeySyms list for the event's KeyCode. .IP \fIkey_event\fP 1i -Specifies the -.ZN KeyPress +Specifies the +.B KeyPress or -.ZN KeyRelease +.B KeyRelease event. .IP \fIkeysym\fP 1i -Specifies the KeySym that is to be \*(Fn. +Specifies the KeySym that is to be returned. .IP \fIkeysym_return\fP 1i Returns the KeySym computed from the event if this argument is not NULL. .IP \fIlist\fP 1i @@ -129,73 +96,73 @@ Specifies the KeySyms to be used as modifiers. .IP \fImod_count\fP 1i Specifies the number of modifiers in the modifier list. .IP \fIstatus_in_out\fP 1i -Specifies or returns the -.ZN XComposeStatus +Specifies or returns the +.B XComposeStatus structure or NULL. .IP \fIstring\fP 1i -Specifies the string that is copied and will be returned by -.ZN XLookupString . +Specifies the string that is copied and will be returned by +.BR XLookupString . .SH DESCRIPTION The -.ZN XLookupKeysym +.B XLookupKeysym function uses a given keyboard event and the index you specified to return the KeySym from the list that corresponds to the KeyCode member in the -.ZN XKeyPressedEvent +.B XKeyPressedEvent or -.ZN XKeyReleasedEvent +.B XKeyReleasedEvent structure. If no KeySym is defined for the KeyCode of the event, -.ZN XLookupKeysym +.B XLookupKeysym returns -.ZN NoSymbol . +.BR NoSymbol . .LP The -.ZN XRefreshKeyboardMapping +.B XRefreshKeyboardMapping function refreshes the stored modifier and keymap information. You usually call this function when a -.ZN MappingNotify +.B MappingNotify event with a request member of -.ZN MappingKeyboard +.B MappingKeyboard or -.ZN MappingModifier +.B MappingModifier occurs. The result is to update Xlib's knowledge of the keyboard. .LP The -.ZN XLookupString +.B XLookupString function translates a key event to a KeySym and a string. The KeySym is obtained by using the standard interpretation of the -.ZN Shift , -.ZN Lock , +.BR Shift , +.BR Lock , group, and numlock modifiers as defined in the X Protocol specification. If the KeySym has been rebound (see -.ZN XRebindKeysym ), +.BR XRebindKeysym ), the bound string will be stored in the buffer. Otherwise, the KeySym is mapped, if possible, to an ISO Latin-1 character or (if the Control modifier is on) to an ASCII control character, and that character is stored in the buffer. -.ZN XLookupString +.B XLookupString returns the number of characters that are stored in the buffer. .LP If present (non-NULL), the -.ZN XComposeStatus +.B XComposeStatus structure records the state, which is private to Xlib, that needs preservation across calls to -.ZN XLookupString +.B XLookupString to implement compose processing. The creation of -.ZN XComposeStatus +.B XComposeStatus structures is implementation-dependent; a portable program must pass NULL for this argument. .LP The -.ZN XRebindKeysym +.B XRebindKeysym function can be used to rebind the meaning of a KeySym for the client. It does not redefine any key in the X server but merely provides an easy way for long strings to be attached to keys. -.ZN XLookupString +.B XLookupString returns this string when the appropriate set of modifier keys are pressed and when the KeySym would have been used for the translation. diff --git a/lib/libX11/man/XMapEvent.man b/lib/libX11/man/XMapEvent.man index 1251c24d9..2d54e98cc 100644 --- a/lib/libX11/man/XMapEvent.man +++ b/lib/libX11/man/XMapEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XMapEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XMapEvent, XMappingEvent \- MapNotify and MappingNotify event structures .SH STRUCTURES The structure for -.ZN MapNotify +.B MapNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* MapNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -96,7 +63,7 @@ typedef struct { Window window; Bool override_redirect; /\&* boolean, is override set... */ } XMapEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -104,16 +71,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -122,24 +89,24 @@ dispatchers. .LP The event member is set either to the window that was mapped or to its parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify +.B SubstructureNotify was selected. The window member is set to the window that was mapped. The override_redirect member is set to the override-redirect attribute of the window. -Window manager clients normally should ignore this window +Window manager clients normally should ignore this window if the override-redirect attribute is -.ZN True , +.BR True , because these events usually are generated from pop-ups, which override structure control. .LP The structure for -.ZN MappingNotify +.B MappingNotify events is: .LP -.Ds 0 +.EX typedef struct { int type; /\&* MappingNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -149,9 +116,9 @@ typedef struct { int request; /\&* one of MappingModifier, MappingKeyboard, MappingPointer */ int first_keycode; /\&* first keycode */ - int count; /\&* defines range of change w. first_keycode*/ + int count; /\&* defines range of change with first_keycode*/ } XMappingEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -159,16 +126,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -177,23 +144,23 @@ dispatchers. .LP The request member is set to indicate the kind of mapping change that occurred and can be -.ZN MappingModifier , -.ZN MappingKeyboard , -.ZN MappingPointer . +.BR MappingModifier , +.BR MappingKeyboard , +.BR MappingPointer . If it is -.ZN MappingModifier , +.BR MappingModifier , the modifier mapping was changed. If it is -.ZN MappingKeyboard , +.BR MappingKeyboard , the keyboard mapping was changed. If it is -.ZN MappingPointer , -the pointer button mapping was changed. -The first_keycode and count members are set only +.BR MappingPointer , +the pointer button mapping was changed. +The first_keycode and count members are set only if the request member was set to -.ZN MappingKeyboard . -The number in first_keycode represents the first number in the range -of the altered mapping, +.BR MappingKeyboard . +The number in first_keycode represents the first number in the range +of the altered mapping, and count represents the number of keycodes altered. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/lib/libX11/man/XMapRequestEvent.man b/lib/libX11/man/XMapRequestEvent.man index 30fc860aa..b0c789908 100644 --- a/lib/libX11/man/XMapRequestEvent.man +++ b/lib/libX11/man/XMapRequestEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XMapRequestEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XMapRequestEvent \- MapRequest event structure .SH STRUCTURES The structure for -.ZN MapRequest +.B MapRequest events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* MapRequest */ unsigned long serial; /\&* # of last request processed by server */ @@ -95,7 +62,7 @@ typedef struct { Window parent; Window window; } XMapRequestEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -103,16 +70,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. diff --git a/lib/libX11/man/XMapWindow.man b/lib/libX11/man/XMapWindow.man index 94d28f18d..07913f537 100644 --- a/lib/libX11/man/XMapWindow.man +++ b/lib/libX11/man/XMapWindow.man @@ -38,56 +38,23 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XMapWindow __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XMapWindow, XMapRaised, XMapSubwindows \- map windows .SH SYNTAX .HP -int XMapWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); +int XMapWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .HP -int XMapRaised\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); +int XMapRaised\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .HP -int XMapSubwindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); +int XMapSubwindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -95,7 +62,7 @@ Specifies the connection to the X server. Specifies the window. .SH DESCRIPTION The -.ZN XMapWindow +.B XMapWindow function maps the window and all of its subwindows that have had map requests. @@ -109,101 +76,101 @@ and will be visible on the screen if it is not obscured by another window. This function has no effect if the window is already mapped. .LP If the override-redirect of the window is -.ZN False +.B False and if some other client has selected -.ZN SubstructureRedirectMask +.B SubstructureRedirectMask on the parent window, then the X server generates a -.ZN MapRequest +.B MapRequest event, and the -.ZN XMapWindow +.B XMapWindow function does not map the window. Otherwise, the window is mapped, and the X server generates a -.ZN MapNotify +.B MapNotify event. .LP If the window becomes viewable and no earlier contents for it are remembered, the X server tiles the window with its background. If the window's background is undefined, the existing screen contents are not -altered, and the X server generates zero or more -.ZN Expose +altered, and the X server generates zero or more +.B Expose events. -If backing-store was maintained while the window was unmapped, no -.ZN Expose +If backing-store was maintained while the window was unmapped, no +.B Expose events are generated. -If backing-store will now be maintained, +If backing-store will now be maintained, a full-window exposure is always generated. Otherwise, only visible regions may be reported. Similar tiling and exposure take place for any newly viewable inferiors. .LP .IN "XMapWindow" If the window is an -.ZN InputOutput +.B InputOutput window, -.ZN XMapWindow -generates -.ZN Expose -events on each -.ZN InputOutput +.B XMapWindow +generates +.B Expose +events on each +.B InputOutput window that it causes to be displayed. -If the client maps and paints the window -and if the client begins processing events, +If the client maps and paints the window +and if the client begins processing events, the window is painted twice. To avoid this, -first ask for -.ZN Expose +first ask for +.B Expose events and then map the window, so the client processes input events as usual. -The event list will include -.ZN Expose +The event list will include +.B Expose for each -window that has appeared on the screen. +window that has appeared on the screen. The client's normal response to -an -.ZN Expose +an +.B Expose event should be to repaint the window. This method usually leads to simpler programs and to proper interaction with window managers. .LP -.ZN XMapWindow +.B XMapWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XMapRaised +.B XMapRaised function essentially is similar to -.ZN XMapWindow +.B XMapWindow in that it maps the window and all of its subwindows that have had map requests. However, it also raises the specified window to the top of the stack. .LP -.ZN XMapRaised +.B XMapRaised can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XMapSubwindows +.B XMapSubwindows .IN "XMapSubwindows" -function maps all subwindows for a specified window in top-to-bottom stacking +function maps all subwindows for a specified window in top-to-bottom stacking order. The X server generates -.ZN Expose +.B Expose events on each newly displayed window. This may be much more efficient than mapping many windows one at a time because the server needs to perform much of the work only once, for all of the windows, rather than for each window. .LP -.ZN XMapSubwindows +.B XMapSubwindows can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/lib/libX11/man/XNextEvent.man b/lib/libX11/man/XNextEvent.man index 2435789e5..f1bfac935 100644 --- a/lib/libX11/man/XNextEvent.man +++ b/lib/libX11/man/XNextEvent.man @@ -38,72 +38,39 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XNextEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XNextEvent, XPeekEvent, XWindowEvent, XCheckWindowEvent, XMaskEvent, XCheckMaskEvent, XCheckTypedEvent, XCheckTypedWindowEvent \- select events by type .SH SYNTAX .HP -int XNextEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^); +int XNextEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^); .HP -int XPeekEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^); +int XPeekEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^); .HP int XWindowEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, long -\fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^); +\fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^); .HP Bool XCheckWindowEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, long -\fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^); +\fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^); .HP int XMaskEvent\^(\^Display *\fIdisplay\fP\^, long \fIevent_mask\fP\^, XEvent -*\fIevent_return\fP\^); +*\fIevent_return\fP\^); .HP Bool XCheckMaskEvent\^(\^Display *\fIdisplay\fP\^, long \fIevent_mask\fP\^, -XEvent *\fIevent_return\fP\^); +XEvent *\fIevent_return\fP\^); .HP Bool XCheckTypedEvent\^(\^Display *\fIdisplay\fP\^, int \fIevent_type\fP\^, -XEvent *\fIevent_return\fP\^); +XEvent *\fIevent_return\fP\^); .HP Bool XCheckTypedWindowEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -int \fIevent_type\fP\^, XEvent *\fIevent_return\fP\^); +int \fIevent_type\fP\^, XEvent *\fIevent_return\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -117,127 +84,125 @@ Returns the next event in the queue. Returns a copy of the matched event's associated structure. .IP \fIevent_type\fP 1i Specifies the event type to be compared. - -.ds Wi \ whose event uou are interested in .IP \fIw\fP 1i -Specifies the window \*(Wi. +Specifies the window whose event you are interested in. .SH DESCRIPTION The -.ZN XNextEvent +.B XNextEvent function copies the first event from the event queue into the specified -.ZN XEvent +.B XEvent structure and then removes it from the queue. If the event queue is empty, -.ZN XNextEvent +.B XNextEvent flushes the output buffer and blocks until an event is received. .LP The -.ZN XPeekEvent +.B XPeekEvent function returns the first event from the event queue, but it does not remove the event from the queue. If the queue is empty, -.ZN XPeekEvent +.B XPeekEvent flushes the output buffer and blocks until an event is received. It then copies the event into the client-supplied -.ZN XEvent +.B XEvent structure without removing it from the event queue. .LP The -.ZN XWindowEvent +.B XWindowEvent function searches the event queue for an event that matches both the specified window and event mask. When it finds a match, -.ZN XWindowEvent +.B XWindowEvent removes that event from the queue and copies it into the specified -.ZN XEvent +.B XEvent structure. The other events stored in the queue are not discarded. If a matching event is not in the queue, -.ZN XWindowEvent +.B XWindowEvent flushes the output buffer and blocks until one is received. .LP The -.ZN XCheckWindowEvent -function searches the event queue and then the events available +.B XCheckWindowEvent +function searches the event queue and then the events available on the server connection for the first event that matches the specified window and event mask. If it finds a match, -.ZN XCheckWindowEvent +.B XCheckWindowEvent removes that event, copies it into the specified -.ZN XEvent +.B XEvent structure, and returns -.ZN True . +.BR True . The other events stored in the queue are not discarded. If the event you requested is not available, -.ZN XCheckWindowEvent +.B XCheckWindowEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. .LP The -.ZN XMaskEvent -function searches the event queue for the events associated with the +.B XMaskEvent +function searches the event queue for the events associated with the specified mask. When it finds a match, -.ZN XMaskEvent +.B XMaskEvent removes that event and copies it into the specified -.ZN XEvent +.B XEvent structure. The other events stored in the queue are not discarded. If the event you requested is not in the queue, -.ZN XMaskEvent +.B XMaskEvent flushes the output buffer and blocks until one is received. .LP The -.ZN XCheckMaskEvent +.B XCheckMaskEvent function searches the event queue and then any events available on the server connection for the first event that matches the specified mask. If it finds a match, -.ZN XCheckMaskEvent +.B XCheckMaskEvent removes that event, copies it into the specified -.ZN XEvent +.B XEvent structure, and returns -.ZN True . +.BR True . The other events stored in the queue are not discarded. If the event you requested is not available, -.ZN XCheckMaskEvent +.B XCheckMaskEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. .LP The -.ZN XCheckTypedEvent -function searches the event queue and then any events available +.B XCheckTypedEvent +function searches the event queue and then any events available on the server connection for the first event that matches the specified type. If it finds a match, -.ZN XCheckTypedEvent +.B XCheckTypedEvent removes that event, copies it into the specified -.ZN XEvent +.B XEvent structure, and returns -.ZN True . +.BR True . The other events in the queue are not discarded. If the event is not available, -.ZN XCheckTypedEvent +.B XCheckTypedEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. .LP The -.ZN XCheckTypedWindowEvent -function searches the event queue and then any events available +.B XCheckTypedWindowEvent +function searches the event queue and then any events available on the server connection for the first event that matches the specified type and window. If it finds a match, -.ZN XCheckTypedWindowEvent +.B XCheckTypedWindowEvent removes the event from the queue, copies it into the specified -.ZN XEvent +.B XEvent structure, and returns -.ZN True . +.BR True . The other events in the queue are not discarded. If the event is not available, -.ZN XCheckTypedWindowEvent +.B XCheckTypedWindowEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/lib/libX11/man/XNoOp.man b/lib/libX11/man/XNoOp.man index 6851ff3e9..2062cc3af 100644 --- a/lib/libX11/man/XNoOp.man +++ b/lib/libX11/man/XNoOp.man @@ -38,59 +38,26 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XNoOp __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XNoOp \- No Operation .SH SYNTAX -int XNoOp\^(\^Display *\fIdisplay\fP\^); +int XNoOp\^(\^Display *\fIdisplay\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. .SH DESCRIPTION The -.ZN XNoOp -function sends a -.ZN NoOperation +.B XNoOp +function sends a +.B NoOperation protocol request to the X server, thereby exercising the connection. .SH "SEE ALSO" diff --git a/lib/libX11/man/XOpenDisplay.man b/lib/libX11/man/XOpenDisplay.man index 30859b21f..68faefbec 100644 --- a/lib/libX11/man/XOpenDisplay.man +++ b/lib/libX11/man/XOpenDisplay.man @@ -38,86 +38,53 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XOpenDisplay __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XOpenDisplay, XCloseDisplay \- connect or disconnect to X server .SH SYNTAX .HP -Display *XOpenDisplay\^(\^char *\fIdisplay_name\fP\^); +Display *XOpenDisplay\^(\^char *\fIdisplay_name\fP\^); .HP -int XCloseDisplay\^(Display *\fIdisplay\fP\^); +int XCloseDisplay\^(Display *\fIdisplay\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIdisplay_name\fP 1i Specifies the hardware display name, which determines the display and communications domain to be used. -On a POSIX-conformant system, if the display_name is NULL, -it defaults to the value of the DISPLAY environment variable. +On a POSIX-conformant system, if the display_name is NULL, +it defaults to the value of the DISPLAY environment variable. .IN "Environment" "DISPLAY" .SH DESCRIPTION The -.ZN XOpenDisplay -function returns a -.ZN Display +.B XOpenDisplay +function returns a +.B Display structure that serves as the connection to the X server and that contains all the information about that X server. -.ZN XOpenDisplay -connects your application to the X server through TCP +.B XOpenDisplay +connects your application to the X server through TCP or DECnet communications protocols, or through some local inter-process communication protocol. .IN "Protocol" "TCP" .IN "Protocol" "DECnet" If the hostname is a host machine name and a single colon (:) separates the hostname and display number, -.ZN XOpenDisplay +.B XOpenDisplay connects using TCP streams. If the hostname is not specified, Xlib uses whatever it believes is the fastest transport. If the hostname is a host machine name and a double colon (::) separates the hostname and display number, -.ZN XOpenDisplay +.B XOpenDisplay connects using DECnet. A single X server can support any or all of these transport mechanisms simultaneously. @@ -125,67 +92,67 @@ A particular Xlib implementation can support many more of these transport mechanisms. .LP .IN "Display" -If successful, -.ZN XOpenDisplay -returns a pointer to a -.ZN Display +If successful, +.B XOpenDisplay +returns a pointer to a +.B Display structure, -which is defined in +which is defined in .hN X11/Xlib.h . -If -.ZN XOpenDisplay +If +.B XOpenDisplay does not succeed, it returns NULL. After a successful call to -.ZN XOpenDisplay , +.BR XOpenDisplay , all of the screens in the display can be used by the client. -The screen number specified in the display_name argument is returned -by the -.ZN DefaultScreen +The screen number specified in the display_name argument is returned +by the +.B DefaultScreen macro (or the -.ZN XDefaultScreen +.B XDefaultScreen function). You can access elements of the -.ZN Display +.B Display and -.ZN Screen +.B Screen structures only by using the information macros or functions. -For information about using macros and functions to obtain information from +For information about using macros and functions to obtain information from the -.ZN Display +.B Display structure, see section 2.2.1. .LP The -.ZN XCloseDisplay +.B XCloseDisplay function closes the connection to the X server for the display specified in the -.ZN Display +.B Display structure and destroys all windows, resource IDs .Pn ( Window , -.ZN Font , -.ZN Pixmap , -.ZN Colormap , -.ZN Cursor , +.BR Font , +.BR Pixmap , +.BR Colormap , +.BR Cursor , and -.ZN GContext ), +.BR GContext ), or other resources that the client has created on this display, unless the close-down mode of the resource has been changed (see -.ZN XSetCloseDownMode ). -Therefore, these windows, resource IDs, and other resources should never be +.BR XSetCloseDownMode ). +Therefore, these windows, resource IDs, and other resources should never be referenced again or an error will be generated. Before exiting, you should call -.ZN XCloseDisplay +.B XCloseDisplay explicitly so that any pending errors are reported as -.ZN XCloseDisplay +.B XCloseDisplay performs a final -.ZN XSync +.B XSync operation. .IN "Resource IDs" .IN "XCloseDisplay" .LP -.ZN XCloseDisplay +.B XCloseDisplay can generate a -.ZN BadGC +.B BadGC error. .SH "SEE ALSO" AllPlanes(__libmansuffix__), diff --git a/lib/libX11/man/XOpenIM.man b/lib/libX11/man/XOpenIM.man index 50e84d0e9..cfc978819 100644 --- a/lib/libX11/man/XOpenIM.man +++ b/lib/libX11/man/XOpenIM.man @@ -38,71 +38,38 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XOpenIM __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XOpenIM, XCloseIM, XSetIMValues, XGetIMValues, XDisplayOfIM, XLocaleOfIM, XRegisterIMInstantiateCallback, XUnregisterIMInstantiateCallback \- open, close, and obtain input method information .SH SYNTAX .HP XIM XOpenIM\^(\^Display *\fIdisplay\fP\^, XrmDatabase \fIdb\fP\^, char -*\fIres_name\fP\^, char *\fIres_class\fP\^); +*\fIres_name\fP\^, char *\fIres_class\fP\^); .HP -Status XCloseIM\^(\^XIM \fIim\fP\^); +Status XCloseIM\^(\^XIM \fIim\fP\^); .HP -char *XSetIMValues\^(\^XIM \fIim\fP\^, ...); +char *XSetIMValues\^(\^XIM \fIim\fP\^, ...); .HP -char *XGetIMValues\^(\^XIM \fIim\fP\^, ...); +char *XGetIMValues\^(\^XIM \fIim\fP\^, ...); .HP -Display *XDisplayOfIM\^(\^XIM \fIim\fP\^); +Display *XDisplayOfIM\^(\^XIM \fIim\fP\^); .HP -char *XLocaleOfIM\^(\^XIM \fIim\fP\^); +char *XLocaleOfIM\^(\^XIM \fIim\fP\^); .HP Bool XRegisterIMInstantiateCallback\^(\^Display *\fIdisplay\fP\^, XrmDatabase \fIdb\fP\^, char *\fIres_name\fP\^, char *\fIres_class\fP\^, XIDProc -\fIcallback\fP\^, XPointer \fIclient_data\fP\^); +\fIcallback\fP\^, XPointer \fIclient_data\fP\^); .HP Bool XUnregisterIMInstantiateCallback\^(\^Display *\fIdisplay\fP\^, XrmDatabase \fIdb\fP\^, char *\fIres_name\fP\^, char *\fIres_class\fP\^, -XIDProc \fIcallback\fP\^, XPointer \fIclient_data\fP\^); +XIDProc \fIcallback\fP\^, XPointer \fIclient_data\fP\^); .LP .SH ARGUMENTS .IP \fIcallback\fP 1i @@ -119,30 +86,29 @@ Specifies the input method. Specifies the full class name of the application. .IP \fIres_name\fP 1i Specifies the full resource name of the application. -.ds Al \ to set or get XIM values .IP ... 1i -Specifies the variable length argument list\*(Al. +Specifies the variable length argument list to set or get XIM values. .SH DESCRIPTION The -.ZN XOpenIM -function opens an input method, +.B XOpenIM +function opens an input method, matching the current locale and modifiers specification. Current locale and modifiers are bound to the input method at opening time. The locale associated with an input method cannot be changed dynamically. This implies that the strings returned by -.ZN XmbLookupString +.B XmbLookupString or -.ZN XwcLookupString , +.BR XwcLookupString , for any input context affiliated with a given input method will be encoded in the locale current at the time the input method is opened. .LP The specific input method to which this call will be routed -is identified on the basis of the current locale. -.ZN XOpenIM +is identified on the basis of the current locale. +.B XOpenIM will identify a default input method corresponding to the current locale. -That default can be modified using -.ZN XSetLocaleModifiers +That default can be modified using +.B XSetLocaleModifiers for the input method modifier. .LP The db argument is the resource database to be used by the input method @@ -152,8 +118,8 @@ up values that can be set as IC values in an input context. If db is NULL, no database is passed to the input method. .LP -The res_name and res_class arguments specify the resource name -and class of the application. +The res_name and res_class arguments specify the resource name +and class of the application. They are intended to be used as prefixes by the input method when looking up resources that are common to all input contexts that may be created for this input method. @@ -164,19 +130,19 @@ if res_name or res_class is NULL. .LP The res_name and res_class arguments are not assumed to exist beyond the call to -.ZN XOpenIM . +.BR XOpenIM . The specified resource database is assumed to exist for the lifetime of the input method. .LP -.ZN XOpenIM +.B XOpenIM returns NULL if no input method could be opened. .LP The -.ZN XCloseIM +.B XCloseIM function closes the specified input method. .LP The -.ZN XSetIMValues +.B XSetIMValues function presents a variable argument list programming interface for setting attributes of the specified input method. It returns NULL if it succeeds; @@ -188,7 +154,7 @@ all arguments in the list preceding the failed argument have been set correctly. .LP The -.ZN XGetIMValues +.B XGetIMValues function presents a variable argument list programming interface for querying properties or features of the specified input method. This function returns NULL if it succeeds; @@ -201,39 +167,39 @@ That is, if the XIM value is of type T, the argument must be of type T*. If T itself is a pointer type, then -.ZN XGetIMValues +.B XGetIMValues allocates memory to store the actual data, and the client is responsible for freeing this data by calling -.ZN XFree +.B XFree with the returned pointer. .LP The -.ZN XDisplayOfIM +.B XDisplayOfIM function returns the display associated with the specified input method. .LP The -.ZN XLocaleOfIM +.B XLocaleOfIM function returns the locale associated with the specified input method. .LP The -.ZN XRegisterIMInstantiateCallback +.B XRegisterIMInstantiateCallback function registers a callback to be invoked whenever a new input method becomes available for the specified display that matches the current locale and modifiers. .LP -The function returns -.ZN True -if it succeeds; otherwise, it returns -.ZN False . +The function returns +.B True +if it succeeds; otherwise, it returns +.BR False . .LP The -.ZN XUnregisterIMInstantiateCallback +.B XUnregisterIMInstantiateCallback function removes an input method instantiation callback previously registered. The function returns -.ZN True -if it succeeds; otherwise, it returns -.ZN False . +.B True +if it succeeds; otherwise, it returns +.BR False . .SH "SEE ALSO" XCreateIC(__libmansuffix__), XSetICFocus(__libmansuffix__), diff --git a/lib/libX11/man/XOpenOM.man b/lib/libX11/man/XOpenOM.man index e91159901..275589c9e 100644 --- a/lib/libX11/man/XOpenOM.man +++ b/lib/libX11/man/XOpenOM.man @@ -39,63 +39,30 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. +.\" It is provided "as is" without express or implied warranty. .\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XOpenOM __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XOpenOM, XCloseOM, XSetOMValues, XGetOMValues, XDisplayOfOM, XLocaleOfOM \- open output methods .SH SYNTAX .HP XOM XOpenOM\^(\^Display *\fIdisplay\fP\^, XrmDatabase \fIdb\fP\^, char -*\fIres_name\fP\^, char *\fIres_class\fP\^); +*\fIres_name\fP\^, char *\fIres_class\fP\^); .HP -Status XCloseOM\^(\^XOM \fIom\fP\^); +Status XCloseOM\^(\^XOM \fIom\fP\^); .HP -char *XSetOMValues\^(\^XOM \fIom\fP\^); +char *XSetOMValues\^(\^XOM \fIom\fP\^); .HP -char *XGetOMValues\^(\^XOM \fIom\fP\^); +char *XGetOMValues\^(\^XOM \fIom\fP\^); .HP -Display *XDisplayOfOM\^(\^XOM \fIom\fP\^); +Display *XDisplayOfOM\^(\^XOM \fIom\fP\^); .HP -char *XLocaleOfOM\^(\^XOM \fIom\fP\^); +char *XLocaleOfOM\^(\^XOM \fIom\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -107,27 +74,26 @@ Specifies the full resource name of the application. Specifies the full class name of the application. .IP \fIom\fP 1i Specifies the output method. -.ds Al \ to set or get XOM values .IP ... 1i -Specifies the variable length argument list\*(Al. +Specifies the variable length argument list to set or get XOM values. .SH DESCRIPTION The -.ZN XOpenOM +.B XOpenOM function opens an output method matching the current locale and modifiers specification. The current locale and modifiers are bound to the output method when -.ZN XOpenOM +.B XOpenOM is called. The locale associated with an output method cannot be changed. .LP The specific output method to which this call will be routed is identified on the basis of the current locale and modifiers. -.ZN XOpenOM +.B XOpenOM will identify a default output method corresponding to the current locale. -That default can be modified using -.ZN XSetLocaleModifiers +That default can be modified using +.B XSetLocaleModifiers to set the output method modifier. .LP The db argument is the resource database to be used by the output method @@ -137,8 +103,8 @@ up values that can be set as OC values in an output context. If db is NULL, no database is passed to the output method. .LP -The res_name and res_class arguments specify the resource name -and class of the application. +The res_name and res_class arguments specify the resource name +and class of the application. They are intended to be used as prefixes by the output method when looking up resources that are common to all output contexts that may be created for this output method. @@ -149,19 +115,19 @@ if res_name or res_class is NULL. .LP The res_name and res_class arguments are not assumed to exist beyond the call to -.ZN XOpenOM . +.BR XOpenOM . The specified resource database is assumed to exist for the lifetime of the output method. .LP -.ZN XOpenOM +.B XOpenOM returns NULL if no output method could be opened. .LP The -.ZN XCloseOM +.B XCloseOM function closes the specified output method. .LP The -.ZN XSetOMValues +.B XSetOMValues function presents a variable argument list programming interface for setting properties or features of the specified output method. This function returns NULL if it succeeds; @@ -175,7 +141,7 @@ correctly. No standard arguments are currently defined by Xlib. .LP The -.ZN XGetOMValues +.B XGetOMValues function presents a variable argument list programming interface for querying properties or features of the specified output method. This function returns NULL if it succeeds; @@ -183,11 +149,11 @@ otherwise, it returns the name of the first argument that could not be obtained. .LP The -.ZN XDisplayOfOM +.B XDisplayOfOM function returns the display associated with the specified output method. .LP The -.ZN XLocaleOfOM +.B XLocaleOfOM returns the locale associated with the specified output method. .SH "SEE ALSO" XCreateOC(__libmansuffix__), diff --git a/lib/libX11/man/XParseGeometry.man b/lib/libX11/man/XParseGeometry.man index 50a95aba5..ed4a9070c 100644 --- a/lib/libX11/man/XParseGeometry.man +++ b/lib/libX11/man/XParseGeometry.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XParseGeometry __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XParseGeometry, XWMGeometry \- parse window geometry @@ -85,13 +52,13 @@ XParseGeometry, XWMGeometry \- parse window geometry .HP int XParseGeometry\^(\^char *\fIparsestring\fP\^, int *\fIx_return\fP\^, int *\fIy_return\fP\^, unsigned int *\fIwidth_return\fP\^, unsigned int -*\fIheight_return\fP\^); +*\fIheight_return\fP\^); .HP int XWMGeometry\^(\^Display *\fIdisplay\fP\^, int \fIscreen\fP\^, char *\fIuser_geom\fP\^, char *\fIdef_geom\fP\^, unsigned int \fIbwidth\fP\^, XSizeHints *\fIhints\fP\^, int *\fIx_return\fP, int *\fIy_return\fP\^, int *\fIwidth_return\fP\^, int *\fIheight_return\fP\^, int -*\fIgravity_return\fP\^); +*\fIgravity_return\fP\^); .SH ARGUMENTS .IP \fIposition\fP 1i .br @@ -137,84 +104,84 @@ Specifies the user-specified geometry or NULL. .SH DESCRIPTION By convention, X applications use a standard string to indicate window size and placement. -.ZN XParseGeometry +.B XParseGeometry makes it easier to conform to this standard because it allows you to parse the standard window geometry. Specifically, this function lets you parse strings of the form: .LP .\" Start marker code here -.Ds -[=][<\fIwidth\fP>{xX}<\fIheight\fP>][{+-}<\fIxoffset\fP>{+-}<\fIyoffset\fP>] -.De +.EX +[=][<\fIwidth\fP>{xX}<\fIheight\fP>][{+-}<\fIxoffset\fP>{+-}<\fIyoffset\fP>] +.EE .\" End marker code here .LP The fields map into the arguments associated with this function. (Items enclosed in <\^> are integers, items in [\^] are optional, and -items enclosed in {\^} indicate ``choose one of.'' +items enclosed in {\^} indicate \*(lqchoose one of.\*(rq Note that the brackets should not appear in the actual string.) If the string is not in the Host Portable Character Encoding, the result is implementation-dependent. .LP The -.ZN XParseGeometry +.B XParseGeometry function returns a bitmask that indicates which of the four values (width, -height, xoffset, and yoffset) were actually found in the string -and whether the x and y values are negative. +height, xoffset, and yoffset) were actually found in the string +and whether the x and y values are negative. By convention, \-0 is not equal to +0, because the user needs to -be able to say ``position the window relative to the right or bottom edge.'' +be able to say \*(lqposition the window relative to the right or bottom edge.\*(rq For each value found, the corresponding argument is updated. For each value not found, the argument is left unchanged. The bits are represented by -.ZN XValue , -.ZN YValue , -.ZN WidthValue , -.ZN HeightValue , -.ZN XNegative , +.BR XValue , +.BR YValue , +.BR WidthValue , +.BR HeightValue , +.BR XNegative , or -.ZN YNegative -and are defined in +.B YNegative +and are defined in .hN X11/Xutil.h . -They will be set whenever one of the values is defined +They will be set whenever one of the values is defined or one of the signs is set. .LP -If the function returns either the -.ZN XValue -or -.ZN YValue +If the function returns either the +.B XValue +or +.B YValue flag, you should place the window at the requested position. .LP -The -.ZN XWMGeometry -function combines any geometry information (given in the format used by -.ZN XParseGeometry ) -specified by the user and by the calling program with size hints -(usually the ones to be stored in WM_NORMAL_HINTS) and returns the position, +The +.B XWMGeometry +function combines any geometry information (given in the format used by +.BR XParseGeometry ) +specified by the user and by the calling program with size hints +(usually the ones to be stored in WM_NORMAL_HINTS) and returns the position, size, and gravity -.Pn ( NorthWestGravity , -.ZN NorthEastGravity , -.ZN SouthEastGravity , +.Pn ( NorthWestGravity , +.BR NorthEastGravity , +.BR SouthEastGravity , or -.ZN SouthWestGravity ) +.BR SouthWestGravity ) that describe the window. -If the base size is not set in the -.ZN XSizeHints -structure, +If the base size is not set in the +.B XSizeHints +structure, the minimum size is used if set. Otherwise, a base size of zero is assumed. -If no minimum size is set in the hints structure, +If no minimum size is set in the hints structure, the base size is used. -A mask (in the form returned by -.ZN XParseGeometry ) -that describes which values came from the user specification +A mask (in the form returned by +.BR XParseGeometry ) +that describes which values came from the user specification and whether or not the position coordinates are relative to the right and bottom edges is returned. -Note that these coordinates will have already been accounted for +Note that these coordinates will have already been accounted for in the x_return and y_return values. .LP -Note that invalid geometry specifications can cause a width or height +Note that invalid geometry specifications can cause a width or height of zero to be returned. -The caller may pass the address of the hints win_gravity field +The caller may pass the address of the hints win_gravity field as gravity_return to update the hints directly. .SH "SEE ALSO" XSetWMProperties(__libmansuffix__) diff --git a/lib/libX11/man/XPolygonRegion.man b/lib/libX11/man/XPolygonRegion.man index 81bb1439d..6434adc8d 100644 --- a/lib/libX11/man/XPolygonRegion.man +++ b/lib/libX11/man/XPolygonRegion.man @@ -38,64 +38,31 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XPolygonRegion __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XPolygonRegion, XClipBox \- generate regions .SH SYNTAX .HP Region XPolygonRegion\^(\^XPoint \fIpoints\fP[]\^, int \fIn\fP\^, int -\fIfill_rule\fP\^); +\fIfill_rule\fP\^); .HP -int XClipBox\^(\^Region \fIr\fP\^, XRectangle *\fIrect_return\fP\^); +int XClipBox\^(\^Region \fIr\fP\^, XRectangle *\fIrect_return\fP\^); .SH ARGUMENTS .IP \fIfill_rule\fP 1i Specifies the fill-rule you want to set for the specified GC. -You can pass -.ZN EvenOddRule +You can pass +.B EvenOddRule or -.ZN WindingRule . +.BR WindingRule . .IP \fIn\fP 1i -Specifies the number of points in the polygon. +Specifies the number of points in the polygon. .IP \fIpoints\fP 1i Specifies an array of points. .IP \fIr\fP 1i @@ -104,14 +71,14 @@ Specifies the region. Returns the smallest enclosing rectangle. .SH DESCRIPTION The -.ZN XPolygonRegion +.B XPolygonRegion function returns a region for the polygon defined by the points array. For an explanation of fill_rule, see -.ZN XCreateGC . +.BR XCreateGC . .LP The -.ZN XClipBox +.B XClipBox function returns the smallest rectangle enclosing the specified region. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/lib/libX11/man/XPropertyEvent.man b/lib/libX11/man/XPropertyEvent.man index e9a40c25d..8287faede 100644 --- a/lib/libX11/man/XPropertyEvent.man +++ b/lib/libX11/man/XPropertyEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XPropertyEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XPropertyEvent \- PropertyNotify event structure .SH STRUCTURES The structure for -.ZN PropertyNotify +.B PropertyNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* PropertyNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -97,7 +64,7 @@ typedef struct { Time time; int state; /\&* PropertyNewValue or PropertyDelete */ } XPropertyEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -105,51 +72,51 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. The window member is set to the window that is most useful to toolkit dispatchers. .LP -The window member is set to the window whose associated +The window member is set to the window whose associated property was changed. The atom member is set to the property's atom and indicates which property was changed or desired. The time member is set to the server time when the property was changed. -The state member is set to indicate whether the property was changed +The state member is set to indicate whether the property was changed to a new value or deleted and can be -.ZN PropertyNewValue +.B PropertyNewValue or -.ZN PropertyDelete . +.BR PropertyDelete . The state member is set to -.ZN PropertyNewValue +.B PropertyNewValue when a property of the window is changed using -.ZN XChangeProperty +.B XChangeProperty or -.ZN XRotateWindowProperties +.B XRotateWindowProperties (even when adding zero-length data using -.ZN XChangeProperty ) +.BR XChangeProperty ) and when replacing all or part of a property with identical data using -.ZN XChangeProperty -or -.ZN XRotateWindowProperties . +.B XChangeProperty +or +.BR XRotateWindowProperties . The state member is set to -.ZN PropertyDelete +.B PropertyDelete when a property of the window is deleted using -.ZN XDeleteProperty -or, if the delete argument is -.ZN True , -.ZN XGetWindowProperty . +.B XDeleteProperty +or, if the delete argument is +.BR True , +.BR XGetWindowProperty . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/lib/libX11/man/XPutBackEvent.man b/lib/libX11/man/XPutBackEvent.man index 9360ebe1f..fe7bd802c 100644 --- a/lib/libX11/man/XPutBackEvent.man +++ b/lib/libX11/man/XPutBackEvent.man @@ -38,52 +38,19 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XPutBackEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XPutBackEvent \- put events back on the queue .SH SYNTAX .HP -XPutBackEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent\fP\^); +XPutBackEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -91,13 +58,13 @@ Specifies the connection to the X server. Specifies the event. .SH DESCRIPTION The -.ZN XPutBackEvent +.B XPutBackEvent function pushes an event back onto the head of the display's event queue by copying the event into the queue. This can be useful if you read an event and then decide that you would rather deal with it later. There is no limit to the number of times in succession that you can call -.ZN XPutBackEvent . +.BR XPutBackEvent . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XIfEvent(__libmansuffix__), diff --git a/lib/libX11/man/XPutImage.man b/lib/libX11/man/XPutImage.man index 3fec85092..d88bd2686 100644 --- a/lib/libX11/man/XPutImage.man +++ b/lib/libX11/man/XPutImage.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XPutImage __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XPutImage, XGetImage, XGetSubImage \- transfer images @@ -86,257 +53,257 @@ XPutImage, XGetImage, XGetSubImage \- transfer images int XPutImage\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, XImage *\fIimage\fP\^, int \fIsrc_x\fP\^, int \fIsrc_y\fP\^, int \fIdest_x\fP\^, int \fIdest_y\fP\^, unsigned int \fIwidth\fP\^, unsigned int -\fIheight\fP\^); +\fIheight\fP\^); .HP XImage *XGetImage\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int -\fIheight\fP\^, unsigned long \fIplane_mask\fP\^, int \fIformat\fP\^); +\fIheight\fP\^, unsigned long \fIplane_mask\fP\^, int \fIformat\fP\^); .HP XImage *XGetSubImage\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned long \fIplane_mask\fP\^, int \fIformat\fP\^, XImage -*\fIdest_image\fP\^, int \fIdest_x\fP\^, \fIdest_y\fP\^); +*\fIdest_image\fP\^, int \fIdest_x\fP\^, \fIdest_y\fP\^); .SH ARGUMENTS .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdest_image\fP 1i Specifies the destination image. -.ds Dx , which are relative to the origin of the drawable \ -and are the coordinates of the subimage \ -or which are relative to the origin of the destination rectangle, \ -specify its upper-left corner, and determine where the subimage \ -is placed in the destination image +.ds Dx .IP \fIdest_x\fP 1i .br .ns .IP \fIdest_y\fP 1i -Specify the x and y coordinates\*(Dx. +Specify the x and y coordinates, which are relative to the origin of the drawable +and are the coordinates of the subimage +or which are relative to the origin of the destination rectangle, +specify its upper-left corner, and determine where the subimage +is placed in the destination image. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIformat\fP 1i Specifies the format for the image. You can pass -.ZN XYPixmap -or -.ZN ZPixmap . +.B XYPixmap +or +.BR ZPixmap . .IP \fIgc\fP 1i Specifies the GC. .IP \fIimage\fP 1i -Specifies the image you want combined with the rectangle. +Specifies the image you want combined with the rectangle. .IP \fIplane_mask\fP 1i Specifies the plane mask. .\" *** JIM: NEED MORE INFO FOR THIS. *** .IP \fIsrc_x\fP 1i Specifies the offset in X from the left edge of the image defined -by the -.ZN XImage +by the +.B XImage structure. .IP \fIsrc_y\fP 1i Specifies the offset in Y from the top edge of the image defined -by the -.ZN XImage +by the +.B XImage structure. -.ds Wh \ of the subimage, which define the dimensions of the rectangle .IP \fIwidth\fP 1i .br .ns .IP \fIheight\fP 1i -Specify the width and height\*(Wh. -.ds Xy , which are relative to the origin of the drawable \ -and define the upper-left corner of the rectangle +Specify the width and height of the subimage, which define +the dimensions of the rectangle. .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which are relative to the origin of the drawable +and define the upper-left corner of the rectangle. .SH DESCRIPTION The -.ZN XPutImage +.B XPutImage function combines an image with a rectangle of the specified drawable. -The section of the image defined by the src_x, src_y, width, and height +The section of the image defined by the src_x, src_y, width, and height arguments is drawn on the specified part of the drawable. -If -.ZN XYBitmap +If +.B XYBitmap format is used, the depth of the image must be one, or a -.ZN BadMatch +.B BadMatch error results. The foreground pixel in the GC defines the source for the one bits in the image, and the background pixel defines the source for the zero bits. -For -.ZN XYPixmap -and -.ZN ZPixmap , +For +.B XYPixmap +and +.BR ZPixmap , the depth of the image must match the depth of the drawable, or a -.ZN BadMatch +.B BadMatch error results. .LP If the characteristics of the image (for example, byte_order and bitmap_unit) differ from what the server requires, -.ZN XPutImage +.B XPutImage automatically makes the appropriate conversions. .LP -This function uses these GC components: -function, plane-mask, subwindow-mode, clip-x-origin, clip-y-origin, +This function uses these GC components: +function, plane-mask, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. It also uses these GC mode-dependent components: foreground and background. .LP -.ZN XPutImage +.B XPutImage can generate -.ZN BadDrawable , -.ZN BadGC , -.ZN BadMatch , +.BR BadDrawable , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XGetImage +.B XGetImage function returns a pointer to an -.ZN XImage +.B XImage structure. This structure provides you with the contents of the specified rectangle of the drawable in the format you specify. -If the format argument is -.ZN XYPixmap , +If the format argument is +.BR XYPixmap , the image contains only the bit planes you passed to the plane_mask argument. If the plane_mask argument only requests a subset of the planes of the display, the depth of the returned image will be the number of planes requested. -If the format argument is -.ZN ZPixmap , -.ZN XGetImage -returns as zero the bits in all planes not +If the format argument is +.BR ZPixmap , +.B XGetImage +returns as zero the bits in all planes not specified in the plane_mask argument. The function performs no range checking on the values in plane_mask and ignores extraneous bits. .LP -.ZN XGetImage +.B XGetImage returns the depth of the image to the depth member of the -.ZN XImage +.B XImage structure. The depth of the image is as specified when the drawable was created, -except when getting a subset of the planes in -.ZN XYPixmap +except when getting a subset of the planes in +.B XYPixmap format, when the depth is given by the number of bits set to 1 in plane_mask. .LP -If the drawable is a pixmap, -the given rectangle must be wholly contained within the pixmap, +If the drawable is a pixmap, +the given rectangle must be wholly contained within the pixmap, or a -.ZN BadMatch +.B BadMatch error results. -If the drawable is a window, -the window must be viewable, +If the drawable is a window, +the window must be viewable, and it must be the case that if there were no inferiors or overlapping windows, the specified rectangle of the window would be fully visible on the screen and wholly contained within the outside edges of the window, or a -.ZN BadMatch +.B BadMatch error results. Note that the borders of the window can be included and read with this request. If the window has backing-store, the backing-store contents are returned for regions of the window that are obscured by noninferior -windows. +windows. If the window does not have backing-store, the returned contents of such obscured regions are undefined. The returned contents of visible regions of inferiors of a different depth than the specified window's depth are also undefined. The pointer cursor image is not included in the returned contents. If a problem occurs, -.ZN XGetImage +.B XGetImage returns NULL. .LP -.ZN XGetImage +.B XGetImage can generate -.ZN BadDrawable , -.ZN BadMatch , +.BR BadDrawable , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .LP -The -.ZN XGetSubImage -function updates dest_image with the specified subimage in the same manner as -.ZN XGetImage . -If the format argument is -.ZN XYPixmap , +The +.B XGetSubImage +function updates dest_image with the specified subimage in the same manner as +.BR XGetImage . +If the format argument is +.BR XYPixmap , the image contains only the bit planes you passed to the plane_mask argument. -If the format argument is -.ZN ZPixmap , -.ZN XGetSubImage -returns as zero the bits in all planes not +If the format argument is +.BR ZPixmap , +.B XGetSubImage +returns as zero the bits in all planes not specified in the plane_mask argument. The function performs no range checking on the values in plane_mask and ignores extraneous bits. As a convenience, -.ZN XGetSubImage +.B XGetSubImage returns a pointer to the same -.ZN XImage +.B XImage structure specified by dest_image. .LP The depth of the destination -.ZN XImage +.B XImage structure must be the same as that of the drawable. If the specified subimage does not fit at the specified location on the destination image, the right and bottom edges are clipped. If the drawable is a pixmap, the given rectangle must be wholly contained within the pixmap, or a -.ZN BadMatch +.B BadMatch error results. -If the drawable is a window, -the window must be viewable, +If the drawable is a window, +the window must be viewable, and it must be the case that if there were no inferiors or overlapping windows, the specified rectangle of the window would be fully visible on the screen and wholly contained within the outside edges of the window, or a -.ZN BadMatch +.B BadMatch error results. -If the window has backing-store, -then the backing-store contents are returned for regions of the window -that are obscured by noninferior windows. -If the window does not have backing-store, +If the window has backing-store, +then the backing-store contents are returned for regions of the window +that are obscured by noninferior windows. +If the window does not have backing-store, the returned contents of such obscured regions are undefined. The returned contents of visible regions of inferiors of a different depth than the specified window's depth are also undefined. If a problem occurs, -.ZN XGetSubImage +.B XGetSubImage returns NULL. .LP -.ZN XGetSubImage +.B XGetSubImage can generate -.ZN BadDrawable , -.ZN BadGC , -.ZN BadMatch , +.BR BadDrawable , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" \fI\*(xL\fP diff --git a/lib/libX11/man/XQueryBestSize.man b/lib/libX11/man/XQueryBestSize.man index d6c450466..db950ac21 100644 --- a/lib/libX11/man/XQueryBestSize.man +++ b/lib/libX11/man/XQueryBestSize.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XQueryBestSize __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XQueryBestSize, XQueryBestTile, XQueryBestStipple \- determine efficient sizes @@ -86,7 +53,7 @@ XQueryBestSize, XQueryBestTile, XQueryBestStipple \- determine efficient sizes Status XQueryBestSize\^(\^Display *\fIdisplay\fP\^, int \fIclass\fP\^, Drawable \fIwhich_screen\fP\^, unsigned int \fIwidth\fP, unsigned int \fIheight\fP\^, unsigned int *\fIwidth_return\fP, unsigned int -*\fIheight_return\fP\^); +*\fIheight_return\fP\^); .HP Status XQueryBestTile\^(\^Display *\fIdisplay\fP\^, Drawable \fIwhich_screen\fP\^, unsigned int \fIwidth\fP, unsigned int \fIheight\fP\^, @@ -94,15 +61,15 @@ unsigned int *\fIwidth_return\fP, unsigned int *\fIheight_return\fP\^); .HP Status XQueryBestStipple\^(\^Display *\fIdisplay\fP\^, Drawable \fIwhich_screen\fP\^, unsigned int \fIwidth\fP, unsigned int \fIheight\fP\^, -unsigned int *\fIwidth_return\fP, unsigned int *\fIheight_return\fP\^); +unsigned int *\fIwidth_return\fP, unsigned int *\fIheight_return\fP\^); .SH ARGUMENTS .IP \fIclass\fP 1i Specifies the class that you are interested in. -You can pass -.ZN TileShape , -.ZN CursorShape , -or -.ZN StippleShape . +You can pass +.BR TileShape , +.BR CursorShape , +or +.BR StippleShape . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIwidth\fP 1i @@ -116,102 +83,103 @@ Specifies any drawable on the screen. .br .ns .IP \fIheight_return\fP 1i -Return the width and height of the object best supported +Return the width and height of the object best supported by the display hardware. .SH DESCRIPTION The -.ZN XQueryBestSize +.B XQueryBestSize function returns the best or closest size to the specified size. -For -.ZN CursorShape , +For +.BR CursorShape , this is the largest size that can be fully displayed on the screen specified by which_screen. -For -.ZN TileShape , +For +.BR TileShape , this is the size that can be tiled fastest. -For -.ZN StippleShape , +For +.BR StippleShape , this is the size that can be stippled fastest. -For -.ZN CursorShape , +For +.BR CursorShape , the drawable indicates the desired screen. -For -.ZN TileShape -and -.ZN StippleShape , +For +.B TileShape +and +.BR StippleShape , the drawable indicates the screen and possibly the window class and depth. -An -.ZN InputOnly -window cannot be used as the drawable for -.ZN TileShape -or -.ZN StippleShape , +An +.B InputOnly +window cannot be used as the drawable for +.B TileShape +or +.BR StippleShape , or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XQueryBestSize +.B XQueryBestSize can generate -.ZN BadDrawable , -.ZN BadMatch , +.BR BadDrawable , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XQueryBestTile +.B XQueryBestTile function returns the best or closest size, that is, the size that can be tiled fastest on the screen specified by which_screen. The drawable indicates the screen and possibly the window class and depth. -If an -.ZN InputOnly -window is used as the drawable, a -.ZN BadMatch +If an +.B InputOnly +window is used as the drawable, a +.B BadMatch error results. .LP -.ZN XQueryBestTile +.B XQueryBestTile can generate -.ZN BadDrawable +.B BadDrawable and -.ZN BadMatch +.B BadMatch errors. .LP The -.ZN XQueryBestStipple +.B XQueryBestStipple function returns the best or closest size, that is, the size that can be stippled fastest on the screen specified by which_screen. The drawable indicates the screen and possibly the window class and depth. If an -.ZN InputOnly +.B InputOnly window is used as the drawable, a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XQueryBestStipple +.B XQueryBestStipple can generate -.ZN BadDrawable +.B BadDrawable and -.ZN BadMatch +.B BadMatch errors. .SH DIAGNOSTICS .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadMatch +.B BadMatch The values do not exist for an -.ZN InputOnly +.B InputOnly window. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/lib/libX11/man/XQueryColor.man b/lib/libX11/man/XQueryColor.man index f1fa461f1..c25dbc577 100644 --- a/lib/libX11/man/XQueryColor.man +++ b/lib/libX11/man/XQueryColor.man @@ -39,68 +39,35 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XQueryColor __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XQueryColor, XQueryColors, XLookupColor, XParseColor \- obtain color values .SH SYNTAX .HP int XQueryColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, XColor -*\fIdef_in_out\fP\^); +*\fIdef_in_out\fP\^); .HP int XQueryColors\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, -XColor \fIdefs_in_out\fP[\^]\^, int \fIncolors\fP\^); +XColor \fIdefs_in_out\fP[\^]\^, int \fIncolors\fP\^); .HP Status XLookupColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, char *\fIcolor_name\fP\^, XColor *\fIexact_def_return\fP\^, XColor -*\fIscreen_def_return\fP\^); +*\fIscreen_def_return\fP\^); .HP Status XParseColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, -char *\fIspec\fP\^, XColor *\fIexact_def_return\fP\^); +char *\fIspec\fP\^, XColor *\fIexact_def_return\fP\^); .SH ARGUMENTS .IP \fIcolormap\fP 1i Specifies the colormap. .IP \fIcolor_name\fP 1i -Specifies the color name string (for example, red) whose color +Specifies the color name string (for example, red) whose color definition structure you want returned. .IP \fIdef_in_out\fP 1i Specifies and returns the RGB values for the pixel specified in the structure. @@ -112,9 +79,9 @@ Specifies the connection to the X server. .IP \fIexact_def_return\fP 1i Returns the exact RGB values. .IP \fIncolors\fP 1i -.\"Specifies the number of color definition structures. -Specifies the number of -.ZN XColor +.\"Specifies the number of color definition structures. +Specifies the number of +.B XColor structures in the color definition array. .IP \fIscreen_def_return\fP 1i Returns the closest RGB values provided by the hardware. @@ -123,89 +90,89 @@ Specifies the color name string; case is ignored. .IP \fIexact_def_return\fP 1i Returns the exact color value for later use and sets the -.ZN DoRed , -.ZN DoGreen , +.BR DoRed , +.BR DoGreen , and -.ZN DoBlue +.B DoBlue flags. .SH DESCRIPTION The -.ZN XQueryColor +.B XQueryColor function returns the current RGB value for the pixel in the -.ZN XColor +.B XColor structure and sets the -.ZN DoRed , -.ZN DoGreen , +.BR DoRed , +.BR DoGreen , and -.ZN DoBlue +.B DoBlue flags. The -.ZN XQueryColors +.B XQueryColors function returns the RGB value for each pixel in each -.ZN XColor +.B XColor structure and sets the -.ZN DoRed , -.ZN DoGreen , +.BR DoRed , +.BR DoGreen , and -.ZN DoBlue +.B DoBlue flags in each structure. .LP -.ZN XQueryColor +.B XQueryColor and -.ZN XQueryColors +.B XQueryColors can generate -.ZN BadColor +.B BadColor and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XLookupColor +.B XLookupColor function looks up the string name of a color with respect to the screen associated with the specified colormap. It returns both the exact color values and -the closest values provided by the screen +the closest values provided by the screen with respect to the visual type of the specified colormap. -If the color name is not in the Host Portable Character Encoding, +If the color name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. -.ZN XLookupColor +.B XLookupColor returns nonzero if the name is resolved; otherwise, it returns zero. .LP The -.ZN XParseColor +.B XParseColor function looks up the string name of a color with respect to the screen associated with the specified colormap. It returns the exact color value. -If the color name is not in the Host Portable Character Encoding, +If the color name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. -.ZN XParseColor +.B XParseColor returns nonzero if the name is resolved; otherwise, it returns zero. .LP -.ZN XLookupColor +.B XLookupColor and -.ZN XParseColor +.B XParseColor can generate -.ZN BadColor +.B BadColor error. .SH "COLOR NAMES" An RGB Device specification is identified by -the prefix ``rgb:'' and conforms to the following syntax: +the prefix \*(lqrgb:\*(rq and conforms to the following syntax: .LP .\" Start marker code here -.Ds 0 +.EX rgb:\fI<red>/<green>/<blue>\fP \fI<red>\fP, \fI<green>\fP, \fI<blue>\fP := \fIh\fP | \fIhh\fP | \fIhhh\fP | \fIhhhh\fP \fIh\fP := single hexadecimal digits (case insignificant) -.De +.EE .\" End marker code here .LP -Note that \fIh\fP indicates the value scaled in 4 bits, +Note that \fIh\fP indicates the value scaled in 4 bits, \fIhh\fP the value scaled in 8 bits, \fIhhh\fP the value scaled in 12 bits, and \fIhhhh\fP the value scaled in 16 bits, respectively. @@ -224,56 +191,57 @@ l l. .TE .LP The R, G, and B represent single hexadecimal digits. -When fewer than 16 bits each are specified, +When fewer than 16 bits each are specified, they represent the most significant bits of the value -(unlike the ``rgb:'' syntax, in which values are scaled). -For example, the string ``#3a7'' is the same as ``#3000a0007000''. +(unlike the \*(lqrgb:\*(rq syntax, in which values are scaled). +For example, the string \*(lq#3a7\*(rq is the same as \*(lq#3000a0007000\*(rq. .LP An RGB intensity specification is identified -by the prefix ``rgbi:'' and conforms to the following syntax: +by the prefix \*(lqrgbi:\*(rq and conforms to the following syntax: .LP .\" Start marker code here -.Ds 0 +.EX rgbi:\fI<red>/<green>/<blue>\fP -.De +.EE .\" End marker code here .LP Note that red, green, and blue are floating-point values between 0.0 and 1.0, inclusive. The input format for these values is an optional sign, a string of numbers possibly containing a decimal point, -and an optional exponent field containing an E or e +and an optional exponent field containing an E or e followed by a possibly signed integer string. .LP The standard device-independent string specifications have the following syntax: .LP .\" Start marker code here -.Ds 0 +.EX CIEXYZ:\fI<X>/<Y>/<Z>\fP CIEuvY:\fI<u>/<v>/<Y>\fP CIExyY:\fI<x>/<y>/<Y>\fP CIELab:\fI<L>/<a>/<b>\fP CIELuv:\fI<L>/<u>/<v>\fP TekHVC:\fI<H>/<V>/<C>\fP -.De +.EE .\" End marker code here .LP All of the values (C, H, V, X, Y, Z, a, b, u, v, y, x) are floating-point values. The syntax for these values is an optional plus or minus sign, a string of digits possibly containing a decimal point, -and an optional exponent field consisting of an ``E'' or ``e'' +and an optional exponent field consisting of an \*(lqE\*(rq or \*(lqe\*(rq followed by an optional plus or minus followed by a string of digits. .SH DIAGNOSTICS .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XAllocColor(__libmansuffix__), diff --git a/lib/libX11/man/XQueryExtension.man b/lib/libX11/man/XQueryExtension.man index bfc096498..4331fe37c 100644 --- a/lib/libX11/man/XQueryExtension.man +++ b/lib/libX11/man/XQueryExtension.man @@ -7,11 +7,11 @@ .\" .\" Rewritten for X.org by Chris Lee <clee@freedesktop.org> .\" -.\" Permission to use, copy, modify, distribute, and sell this documentation +.\" Permission to use, copy, modify, distribute, and sell this documentation .\" for any purpose and without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. .\" Chris Lee makes no representations about the suitability for any purpose -.\" of the information in this document. It is provided \`\`as-is'' without +.\" of the information in this document. It is provided \`\`as-is\*(rq without .\" express or implied warranty. .\" .ds xL Programming with Xlib @@ -43,25 +43,35 @@ Specifies the list of extension names. .SH DESCRIPTION .LP The \fIXQueryExtension\fP function determines if the named extension is -present. If the extension is not present, \fIXQueryExtension\fP returns +present. +If the extension is not present, \fIXQueryExtension\fP returns \fIFalse\fP; otherwise, it returns \fITrue\fP. If the extension is present, \fIXQueryExtension\fP returns the major opcode for the extension to -major_opcode_return; otherwise, it returns zero. Any minor opcode and the -request formats are specific to the extension. If the extension involves +major_opcode_return; otherwise, it returns zero. +Any minor opcode and the +request formats are specific to the extension. +If the extension involves additional event types, \fIXQueryExtension\fP returns the base event type code -to first_event_return; otherwise, it returns zero. The format of the events is -specific to the extension. If the extension involves additional error codes, +to first_event_return; otherwise, it returns zero. +The format of the events is +specific to the extension. +If the extension involves additional error codes, \fIXQueryExtension\fP returns the base error code to first_error_return; -otherwise, it returns zero. The format of additional data in the errors is -specific to the extension. If the extension name is not in the Host Portable -Character Encoding the result is implementation-dependent. Uppercase and -lowercase matter; the strings ``thing'', ``Thing'', and ``thinG'' are all +otherwise, it returns zero. +The format of additional data in the errors is +specific to the extension. +If the extension name is not in the Host Portable +Character Encoding the result is implementation-dependent. +Uppercase and +lowercase matter; the strings \*(lqthing\*(rq, \*(lqThing\*(rq, and \*(lqthinG\*(rq are all considered different names. .LP The \fIXListExtensions\fP function returns a list of all extensions supported -by the server. If the data returned by the server is in the Latin Portable +by the server. +If the data returned by the server is in the Latin Portable Character Encoding, then the returned strings are in the Host Portable -Character Encoding. Otherwise, the result is implementation-dependent. +Character Encoding. +Otherwise, the result is implementation-dependent. .LP The \fIXFreeExtensionList\fP function frees the memory allocated by \fIXListExtensions\fP. diff --git a/lib/libX11/man/XQueryPointer.man b/lib/libX11/man/XQueryPointer.man index dd25486da..460295c53 100644 --- a/lib/libX11/man/XQueryPointer.man +++ b/lib/libX11/man/XQueryPointer.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XQueryPointer __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XQueryPointer \- get pointer coordinates @@ -86,7 +53,7 @@ XQueryPointer \- get pointer coordinates Bool XQueryPointer\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Window *\fIroot_return\fP\^, Window *\fIchild_return\fP\^, int *\fIroot_x_return\fP\^, int *\fIroot_y_return\fP\^, int *\fIwin_x_return\fP\^, -int *\fIwin_y_return\fP\^, unsigned int *\fImask_return\fP\^); +int *\fIwin_y_return\fP\^, unsigned int *\fImask_return\fP\^); .SH ARGUMENTS .IP \fIchild_return\fP 1i Returns the child window that the pointer is located in, if any. @@ -94,9 +61,8 @@ Returns the child window that the pointer is located in, if any. Specifies the connection to the X server. .IP \fImask_return\fP 1i Returns the current state of the modifier keys and pointer buttons. -.ds Ro that the pointer is in .IP \fIroot_return\fP 1i -Returns the root window \*(Ro. +Returns the root window that the pointer is in. .IP \fIroot_x_return\fP 1i .br .ns @@ -111,45 +77,45 @@ Specifies the window. Return the pointer coordinates relative to the specified window. .SH DESCRIPTION The -.ZN XQueryPointer +.B XQueryPointer function returns the root window the pointer is logically on and the pointer coordinates relative to the root window's origin. If -.ZN XQueryPointer -returns -.ZN False , +.B XQueryPointer +returns +.BR False , the pointer is not on the same screen as the specified window, and -.ZN XQueryPointer -returns -.ZN None +.B XQueryPointer +returns +.B None to child_return and zero to win_x_return and win_y_return. -If -.ZN XQueryPointer -returns -.ZN True , +If +.B XQueryPointer +returns +.BR True , the pointer coordinates returned to win_x_return and win_y_return are relative to the origin of the specified window. -In this case, -.ZN XQueryPointer +In this case, +.B XQueryPointer returns the child that contains the pointer, if any, or else -.ZN None +.B None to child_return. .LP -.ZN XQueryPointer -returns the current logical state of the keyboard buttons +.B XQueryPointer +returns the current logical state of the keyboard buttons and the modifier keys in mask_return. It sets mask_return to the bitwise inclusive OR of one or more -of the button or modifier key bitmasks to match +of the button or modifier key bitmasks to match the current state of the mouse buttons and the modifier keys. .LP -.ZN XQueryPointer +.B XQueryPointer can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XGetWindowAttributes(__libmansuffix__), diff --git a/lib/libX11/man/XQueryTree.man b/lib/libX11/man/XQueryTree.man index 24ca96558..63a05516e 100644 --- a/lib/libX11/man/XQueryTree.man +++ b/lib/libX11/man/XQueryTree.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XQueryTree __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XQueryTree \- query window tree information @@ -85,7 +52,7 @@ XQueryTree \- query window tree information .HP Status XQueryTree\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Window *\fIroot_return\fP\^, Window *\fIparent_return\fP\^, Window -**\fIchildren_return\fP\^, unsigned int *\fInchildren_return\fP\^); +**\fIchildren_return\fP\^, unsigned int *\fInchildren_return\fP\^); .SH ARGUMENTS .IP \fIchildren_return\fP 1i Returns the list of children. @@ -97,33 +64,32 @@ Returns the number of children. Returns the parent window. .IP \fIroot_return\fP 1i Returns the root window. -.ds Wi whose list of children, root, parent, and number of children \ -you want to obtain .IP \fIw\fP 1i -Specifies the window \*(Wi. +Specifies the window whose list of children, root, parent, and number of children +you want to obtain. .SH DESCRIPTION The -.ZN XQueryTree -function returns the root ID, the parent window ID, +.B XQueryTree +function returns the root ID, the parent window ID, a pointer to the list of children windows -(NULL when there are no children), +(NULL when there are no children), and the number of children in the list for the specified window. -The children are listed in current stacking order, from bottom-most +The children are listed in current stacking order, from bottom-most (first) to top-most (last). -.ZN XQueryTree +.B XQueryTree returns zero if it fails and nonzero if it succeeds. -To free a non-NULL children list when it is no longer needed, use -.ZN XFree . +To free a non-NULL children list when it is no longer needed, use +.BR XFree . .LP -.ZN XQueryTree +.B XQueryTree can generate a -.ZN BadWindow +.B BadWindow error. .SH BUGS This really should return a screen *, not a root window ID. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XFree(__libmansuffix__), diff --git a/lib/libX11/man/XRaiseWindow.man b/lib/libX11/man/XRaiseWindow.man index 4dcd6a756..70190e7b7 100644 --- a/lib/libX11/man/XRaiseWindow.man +++ b/lib/libX11/man/XRaiseWindow.man @@ -38,72 +38,39 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XRaiseWindow __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XRaiseWindow, XLowerWindow, XCirculateSubwindows, XCirculateSubwindowsUp, XCirculateSubwindowsDown, XRestackWindows \- change window stacking order .SH SYNTAX .HP -int XRaiseWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); +int XRaiseWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .HP -int XLowerWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); +int XLowerWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .HP int XCirculateSubwindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, int -\fIdirection\fP\^); +\fIdirection\fP\^); .HP -int XCirculateSubwindowsUp\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); +int XCirculateSubwindowsUp\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .HP -int XCirculateSubwindowsDown\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); +int XCirculateSubwindowsDown\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .HP int XRestackWindows\^(\^Display *\fIdisplay\fP\^, Window \fIwindows\fP\^[], int -\fInwindows\fP\^); +\fInwindows\fP\^); .SH ARGUMENTS .IP \fIdirection\fP 1i Specifies the direction (up or down) that you want to circulate -the window. -You can pass -.ZN RaiseLowest +the window. +You can pass +.B RaiseLowest or -.ZN LowerHighest . +.BR LowerHighest . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fInwindows\fP 1i @@ -114,35 +81,35 @@ Specifies the window. Specifies an array containing the windows to be restacked. .SH DESCRIPTION The -.ZN XRaiseWindow +.B XRaiseWindow function raises the specified window to the top of the stack so that no sibling window obscures it. -If the windows are regarded as overlapping sheets of paper stacked +If the windows are regarded as overlapping sheets of paper stacked on a desk, then raising a window is analogous to moving the sheet to the top of the stack but leaving its x and y location on the desk constant. -Raising a mapped window may generate -.ZN Expose -events for the window and any mapped subwindows that were formerly obscured. +Raising a mapped window may generate +.B Expose +events for the window and any mapped subwindows that were formerly obscured. .LP -If the override-redirect attribute of the window is -.ZN False +If the override-redirect attribute of the window is +.B False and some -other client has selected -.ZN SubstructureRedirectMask +other client has selected +.B SubstructureRedirectMask on the parent, the X server generates a -.ZN ConfigureRequest +.B ConfigureRequest event, and no processing is performed. Otherwise, the window is raised. .LP -.ZN XRaiseWindow +.B XRaiseWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XLowerWindow +.B XLowerWindow function lowers the specified window to the bottom of the stack so that it does not obscure any sibling windows. @@ -150,94 +117,94 @@ If the windows are regarded as overlapping sheets of paper stacked on a desk, then lowering a window is analogous to moving the sheet to the bottom of the stack but leaving its x and y location on the desk constant. -Lowering a mapped window will generate -.ZN Expose +Lowering a mapped window will generate +.B Expose events on any windows it formerly obscured. .LP -If the override-redirect attribute of the window is -.ZN False +If the override-redirect attribute of the window is +.B False and some -other client has selected -.ZN SubstructureRedirectMask +other client has selected +.B SubstructureRedirectMask on the parent, the X server generates a -.ZN ConfigureRequest -event, and no processing is performed. +.B ConfigureRequest +event, and no processing is performed. Otherwise, the window is lowered to the bottom of the stack. .LP -.ZN XLowerWindow +.B XLowerWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XCirculateSubwindows -function circulates children of the specified window in the specified +.B XCirculateSubwindows +function circulates children of the specified window in the specified direction. If you specify -.ZN RaiseLowest , -.ZN XCirculateSubwindows -raises the lowest mapped child (if any) that is occluded +.BR RaiseLowest , +.B XCirculateSubwindows +raises the lowest mapped child (if any) that is occluded by another child to the top of the stack. If you specify -.ZN LowerHighest , -.ZN XCirculateSubwindows +.BR LowerHighest , +.B XCirculateSubwindows lowers the highest mapped child (if any) that occludes another child to the bottom of the stack. Exposure processing is then performed on formerly obscured windows. -If some other client has selected -.ZN SubstructureRedirectMask -on the window, the X server generates a -.ZN CirculateRequest +If some other client has selected +.B SubstructureRedirectMask +on the window, the X server generates a +.B CirculateRequest event, and no further processing is performed. If a child is actually restacked, the X server generates a -.ZN CirculateNotify -event. +.B CirculateNotify +event. .LP -.ZN XCirculateSubwindows +.B XCirculateSubwindows can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XCirculateSubwindowsUp +.B XCirculateSubwindowsUp function raises the lowest mapped child of the specified window that is partially or completely occluded by another child. Completely unobscured children are not affected. This is a convenience function equivalent to -.ZN XCirculateSubwindows +.B XCirculateSubwindows with -.ZN RaiseLowest +.B RaiseLowest specified. .LP -.ZN XCirculateSubwindowsUp +.B XCirculateSubwindowsUp can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XCirculateSubwindowsDown +.B XCirculateSubwindowsDown function lowers the highest mapped child of the specified window that partially or completely occludes another child. Completely unobscured children are not affected. This is a convenience function equivalent to -.ZN XCirculateSubwindows +.B XCirculateSubwindows with -.ZN LowerHighest +.B LowerHighest specified. .LP -.ZN XCirculateSubwindowsDown +.B XCirculateSubwindowsDown can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XRestackWindows +.B XRestackWindows function restacks the windows in the order specified, from top to bottom. The stacking order of the first window in the windows array is unaffected, @@ -246,33 +213,34 @@ in the order of the array. The stacking order of the other windows is not affected. For each window in the window array that is not a sibling of the first window, a -.ZN BadMatch +.B BadMatch error results. .LP -If the override-redirect attribute of a window is -.ZN False +If the override-redirect attribute of a window is +.B False and some -other client has selected -.ZN SubstructureRedirectMask -on the parent, the X server generates -.ZN ConfigureRequest -events for each window whose override-redirect flag is not set, +other client has selected +.B SubstructureRedirectMask +on the parent, the X server generates +.B ConfigureRequest +events for each window whose override-redirect flag is not set, and no further processing is performed. Otherwise, the windows will be restacked in top-to-bottom order. .LP -.ZN XRestackWindows +.B XRestackWindows can generate -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/lib/libX11/man/XReadBitmapFile.man b/lib/libX11/man/XReadBitmapFile.man index 163c80394..4d43ef4fc 100644 --- a/lib/libX11/man/XReadBitmapFile.man +++ b/lib/libX11/man/XReadBitmapFile.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XReadBitmapFile __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XReadBitmapFile, XReadBitmapFileData, XWriteBitmapFile, XCreatePixmapFromBitmapData, XCreateBitmapFromData \- manipulate bitmaps @@ -86,31 +53,30 @@ XReadBitmapFile, XReadBitmapFileData, XWriteBitmapFile, XCreatePixmapFromBitmapD int XReadBitmapFile(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, char *\fIfilename\fP\^, unsigned int *\fIwidth_return\fP, unsigned int *\fIheight_return\fP\^, Pixmap *\fIbitmap_return\fP\^, int -*\fIx_hot_return\fP, int *\fIy_hot_return\fP\^); +*\fIx_hot_return\fP, int *\fIy_hot_return\fP\^); .HP int XReadBitmapFileData(\^char *\fIfilename\fP\^, unsigned int *\fIwidth_return\fP, unsigned int *\fIheight_return\fP\^, unsigned char -*\fIdata_return\fP\^, int *\fIx_hot_return\fP, int *\fIy_hot_return\fP\^); +*\fIdata_return\fP\^, int *\fIx_hot_return\fP, int *\fIy_hot_return\fP\^); .HP int XWriteBitmapFile(\^Display *\fIdisplay\fP\^, char *\fIfilename\fP\^, Pixmap \fIbitmap\fP\^, unsigned int \fIwidth\fP, unsigned int \fIheight\fP\^, -int \fIx_hot\fP, int \fIy_hot\fP\^); +int \fIx_hot\fP, int \fIy_hot\fP\^); .HP Pixmap XCreatePixmapFromBitmapData\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, char *\fIdata\fP\^, unsigned int \fIwidth\fP, unsigned int \fIheight\fP\^, unsigned long \fIfg\fP, unsigned long \fIbg\fP\^, unsigned int -\fIdepth\fP\^); +\fIdepth\fP\^); .HP Pixmap XCreateBitmapFromData(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, -char *\fIdata\fP\^, unsigned int \fIwidth\fP, unsigned int \fIheight\fP\^); +char *\fIdata\fP\^, unsigned int \fIwidth\fP, unsigned int \fIheight\fP\^); .SH ARGUMENTS .IP \fIbitmap\fP 1i Specifies the bitmap. .IP \fIbitmap_return\fP 1i Returns the bitmap that is created. -.ds Dr \ that indicates the screen .IP \fId\fP 1i -Specifies the drawable\*(Dr. +Specifies the drawable that indicates the screen. .IP \fIdata\fP 1i Specifies the data in bitmap format. .IP \fIdata\fP 1i @@ -152,141 +118,141 @@ in the file. Return the hotspot coordinates. .SH DESCRIPTION The -.ZN XReadBitmapFile +.B XReadBitmapFile function reads in a file containing a bitmap. The file is parsed in the encoding of the current locale. -The ability to read other than the standard format +The ability to read other than the standard format is implementation-dependent. -If the file cannot be opened, -.ZN XReadBitmapFile -returns -.ZN BitmapOpenFailed . -If the file can be opened but does not contain valid bitmap data, -it returns -.ZN BitmapFileInvalid . +If the file cannot be opened, +.B XReadBitmapFile +returns +.BR BitmapOpenFailed . +If the file can be opened but does not contain valid bitmap data, +it returns +.BR BitmapFileInvalid . If insufficient working storage is allocated, it returns -.ZN BitmapNoMemory . +.BR BitmapNoMemory . If the file is readable and valid, -it returns -.ZN BitmapSuccess . +it returns +.BR BitmapSuccess . .LP -.ZN XReadBitmapFile +.B XReadBitmapFile returns the bitmap's height and width, as read from the file, to width_return and height_return. -It then creates a pixmap of the appropriate size, +It then creates a pixmap of the appropriate size, reads the bitmap data from the file into the pixmap, -and assigns the pixmap to the caller's variable bitmap. -The caller must free the bitmap using -.ZN XFreePixmap +and assigns the pixmap to the caller's variable bitmap. +The caller must free the bitmap using +.B XFreePixmap when finished. If \fIname\fP_x_hot and \fIname\fP_y_hot exist, -.ZN XReadBitmapFile +.B XReadBitmapFile returns them to x_hot_return and y_hot_return; otherwise, it returns \-1,\-1. .LP -.ZN XReadBitmapFile +.B XReadBitmapFile can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadDrawable +.B BadDrawable errors. .LP The -.ZN XReadBitmapFileData +.B XReadBitmapFileData function reads in a file containing a bitmap, in the same manner as -.ZN XReadBitmapFile , +.BR XReadBitmapFile , but returns the data directly rather than creating a pixmap in the server. The bitmap data is returned in data_return; the client must free this storage when finished with it by calling -.ZN XFree . +.BR XFree . The status and other return values are the same as for -.ZN XReadBitmapFile . +.BR XReadBitmapFile . .LP The -.ZN XWriteBitmapFile +.B XWriteBitmapFile function writes a bitmap out to a file in the X Version 11 format. The name used in the output file is derived from the file name by deleting the directory prefix. The file is written in the encoding of the current locale. -If the file cannot be opened for writing, -it returns -.ZN BitmapOpenFailed . +If the file cannot be opened for writing, +it returns +.BR BitmapOpenFailed . If insufficient memory is allocated, -.ZN XWriteBitmapFile +.B XWriteBitmapFile returns -.ZN BitmapNoMemory ; +.BR BitmapNoMemory ; otherwise, on no error, it returns -.ZN BitmapSuccess . -If x_hot and y_hot are not \-1, \-1, -.ZN XWriteBitmapFile +.BR BitmapSuccess . +If x_hot and y_hot are not \-1, \-1, +.B XWriteBitmapFile writes them out as the hotspot coordinates for the bitmap. .LP -.ZN XWriteBitmapFile +.B XWriteBitmapFile can generate -.ZN BadDrawable +.B BadDrawable and -.ZN BadMatch +.B BadMatch errors. .LP The -.ZN XCreatePixmapFromBitmapData +.B XCreatePixmapFromBitmapData function creates a pixmap of the given depth and then does a bitmap-format -.ZN XPutImage +.B XPutImage of the data into it. The depth must be supported by the screen of the specified drawable, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XCreatePixmapFromBitmapData +.B XCreatePixmapFromBitmapData can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadMatch +.B BadMatch errors. .LP The -.ZN XCreateBitmapFromData +.B XCreateBitmapFromData function allows you to include in your C program (using -.ZN #include ) +.BR #include ) a bitmap file that was written out by -.ZN XWriteBitmapFile +.B XWriteBitmapFile (X version 11 format only) without reading in the bitmap file. The following example creates a gray bitmap: .LP -.Ds 0 +.EX \&#include "gray.bitmap" .sp 6p Pixmap bitmap; bitmap = XCreateBitmapFromData(display, window, gray_bits, gray_width, gray_height); -.De +.EE .LP If insufficient working storage was allocated, -.ZN XCreateBitmapFromData +.B XCreateBitmapFromData returns -.ZN None . +.BR None . It is your responsibility to free the bitmap using -.ZN XFreePixmap +.B XFreePixmap when finished. .LP -.ZN XCreateBitmapFromData +.B XCreateBitmapFromData can generate a -.ZN BadAlloc +.B BadAlloc error. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .SH "SEE ALSO" XCreatePixmap(__libmansuffix__), diff --git a/lib/libX11/man/XRecolorCursor.man b/lib/libX11/man/XRecolorCursor.man index dfaec988a..670e26f0f 100644 --- a/lib/libX11/man/XRecolorCursor.man +++ b/lib/libX11/man/XRecolorCursor.man @@ -38,130 +38,95 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XRecolorCursor __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XRecolorCursor, XFreeCursor, XQueryBestCursor \- manipulate cursors .SH SYNTAX .HP int XRecolorCursor\^(\^Display *\fIdisplay\fP\^, Cursor \fIcursor\fP\^, XColor -*\fIforeground_color\fP\^, XColor *\fIbackground_color\fP\^); +*\fIforeground_color\fP\^, XColor *\fIbackground_color\fP\^); .HP -int XFreeCursor\^(\^Display *\fIdisplay\fP\^, Cursor \fIcursor\fP\^); +int XFreeCursor\^(\^Display *\fIdisplay\fP\^, Cursor \fIcursor\fP\^); .HP Status XQueryBestCursor\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int -*\fIwidth_return\fP\^, unsigned int *\fIheight_return\fP\^); +*\fIwidth_return\fP\^, unsigned int *\fIheight_return\fP\^); .SH ARGUMENTS .IP \fIbackground_color\fP 1i Specifies the RGB values for the background of the source. .IP \fIcursor\fP 1i -Specifies the cursor. -.ds Dr , which indicates the screen +Specifies the cursor. .IP \fId\fP 1i -Specifies the drawable\*(Dr. +Specifies the drawable, which indicates the screen. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIforeground_color\fP 1i -Specifies the RGB values for the foreground of the source. -.ds Wh of the cursor that you want the size information for +Specifies the RGB values for the foreground of the source. .IP \fIwidth\fP 1i .br .ns .IP \fIheight\fP 1i -Specify the width and height\*(Wh. +Specify the width and height of the cursor that you want the size information for. .IP \fIwidth_return\fP 1i .br .ns .IP \fIheight_return\fP 1i -Return the best width and height that is closest to the specified width +Return the best width and height that is closest to the specified width and height. .SH DESCRIPTION The -.ZN XRecolorCursor +.B XRecolorCursor function changes the color of the specified cursor, and if the cursor is being displayed on a screen, the change is visible immediately. The pixel members of the -.ZN XColor +.B XColor structures are ignored; only the RGB values are used. .LP -.ZN XRecolorCursor +.B XRecolorCursor can generate a -.ZN BadCursor +.B BadCursor error. .LP The -.ZN XFreeCursor -function deletes the association between the cursor resource ID +.B XFreeCursor +function deletes the association between the cursor resource ID and the specified cursor. The cursor storage is freed when no other resource references it. The specified cursor ID should not be referred to again. .LP -.ZN XFreeCursor +.B XFreeCursor can generate a -.ZN BadCursor +.B BadCursor error. .LP Some displays allow larger cursors than other displays. The -.ZN XQueryBestCursor +.B XQueryBestCursor function provides a way to find out what size cursors are actually possible on the display. -.IN "Cursor" "limitations" +.IN "Cursor" "limitations" It returns the largest size that can be displayed. Applications should be prepared to use smaller cursors on displays that cannot support large ones. .LP -.ZN XQueryBestCursor +.B XQueryBestCursor can generate a -.ZN BadDrawable +.B BadDrawable error. .SH DIAGNOSTICS .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .SH "SEE ALSO" XCreateColormap(__libmansuffix__), diff --git a/lib/libX11/man/XReparentEvent.man b/lib/libX11/man/XReparentEvent.man index 459391c75..81290f2b5 100644 --- a/lib/libX11/man/XReparentEvent.man +++ b/lib/libX11/man/XReparentEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XReparentEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XReparentEvent \- ReparentNotify event structure .SH STRUCTURES The structure for -.ZN ReparentNotify +.B ReparentNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* ReparentNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -98,7 +65,7 @@ typedef struct { int x, y; Bool override_redirect; } XReparentEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -106,16 +73,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -124,20 +91,20 @@ dispatchers. .LP The event member is set either to the reparented window or to the old or the new parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify -was selected. +.B SubstructureNotify +was selected. The window member is set to the window that was reparented. The parent member is set to the new parent window. -The x and y members are set to the reparented window's coordinates relative +The x and y members are set to the reparented window's coordinates relative to the new parent window's origin and define the upper-left outer corner of the reparented window. The override_redirect member is set to the override-redirect attribute of the window specified by the window member. -Window manager clients normally should ignore this window +Window manager clients normally should ignore this window if the override_redirect member is -.ZN True . +.BR True . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/lib/libX11/man/XReparentWindow.man b/lib/libX11/man/XReparentWindow.man index 4b66ed50a..a25225ea9 100644 --- a/lib/libX11/man/XReparentWindow.man +++ b/lib/libX11/man/XReparentWindow.man @@ -38,53 +38,20 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XReparentWindow __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XReparentWindow \- reparent windows .SH SYNTAX .HP int XReparentWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Window -\fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^); +\fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -92,48 +59,47 @@ Specifies the connection to the X server. Specifies the parent window. .IP \fIw\fP 1i Specifies the window. -.ds Xy of the position in the new parent window .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates of the position in the new parent window. .SH DESCRIPTION If the specified window is mapped, -.ZN XReparentWindow +.B XReparentWindow automatically performs an -.ZN UnmapWindow +.B UnmapWindow request on it, removes it from its current position in the hierarchy, and inserts it as the child of the specified parent. The window is placed in the stacking order on top with respect to sibling windows. .LP After reparenting the specified window, -.ZN XReparentWindow +.B XReparentWindow causes the X server to generate a -.ZN ReparentNotify +.B ReparentNotify event. The override_redirect member returned in this event is set to the window's corresponding attribute. Window manager clients usually should ignore this window if this member is set to -.ZN True . +.BR True . Finally, if the specified window was originally mapped, the X server automatically performs a -.ZN MapWindow +.B MapWindow request on it. .LP The X server performs normal exposure processing on formerly obscured windows. -The X server might not generate -.ZN Expose +The X server might not generate +.B Expose events for regions from the initial -.ZN UnmapWindow +.B UnmapWindow request that are immediately obscured by the final -.ZN MapWindow +.B MapWindow request. A -.ZN BadMatch +.B BadMatch error results if: .IP \(bu 5 The new parent window is not on the same screen as @@ -143,23 +109,23 @@ The new parent window is the specified window or an inferior of the specified window. .IP \(bu 5 The new parent is -.ZN InputOnly , +.BR InputOnly , and the window is not. .IP \(bu 5 The specified window has a -.ZN ParentRelative +.B ParentRelative background, and the new parent window is not the same depth as the specified window. .LP -.ZN XReparentWindow +.B XReparentWindow can generate -.ZN BadMatch +.B BadMatch and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeSaveSet(__libmansuffix__) diff --git a/lib/libX11/man/XResizeRequestEvent.man b/lib/libX11/man/XResizeRequestEvent.man index 36ea8cfd2..b9aa265cd 100644 --- a/lib/libX11/man/XResizeRequestEvent.man +++ b/lib/libX11/man/XResizeRequestEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XResizeRequestEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XResizeRequestEvent \- ResizeRequest event structure .SH STRUCTURES The structure for -.ZN ResizeRequest +.B ResizeRequest events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* ResizeRequest */ unsigned long serial; /\&* # of last request processed by server */ @@ -95,7 +62,7 @@ typedef struct { Window window; int width, height; } XResizeRequestEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -103,25 +70,25 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. The window member is set to the window that is most useful to toolkit dispatchers. .LP -The window member is set to the window whose size another +The window member is set to the window whose size another client attempted to change. -The width and height members are set to the inside size of the window, +The width and height members are set to the inside size of the window, excluding the border. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/lib/libX11/man/XResourceManagerString.man b/lib/libX11/man/XResourceManagerString.man index 7d4884b5d..e4d83d384 100644 --- a/lib/libX11/man/XResourceManagerString.man +++ b/lib/libX11/man/XResourceManagerString.man @@ -38,54 +38,21 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XResourceManagerString __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XResourceManagerString, XScreenResourceString \- obtain server resource properties .SH SYNTAX .HP -char *XResourceManagerString\^(\^Display *\fIdisplay\fP\^); +char *XResourceManagerString\^(\^Display *\fIdisplay\fP\^); .HP -char *XScreenResourceString\^(\^Screen *\fIscreen\fP\^); +char *XScreenResourceString\^(\^Screen *\fIscreen\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -93,31 +60,31 @@ Specifies the connection to the X server. Specifies the screen. .SH DESCRIPTION The -.ZN XResourceManagerString +.B XResourceManagerString function returns the RESOURCE_MANAGER property from the server's root window of screen zero, which was returned when the connection was opened using -.ZN XOpenDisplay . +.BR XOpenDisplay . The property is converted from type STRING to the current locale. -The conversion is identical to that produced by -.ZN XmbTextPropertyToTextList +The conversion is identical to that produced by +.B XmbTextPropertyToTextList for a single element STRING property. The returned string is owned by Xlib and should not be freed by the client. The property value must be in a format that is acceptable to -.ZN XrmGetStringDatabase . +.BR XrmGetStringDatabase . If no property exists, NULL is returned. .LP The -.ZN XScreenResourceString +.B XScreenResourceString function returns the SCREEN_RESOURCES property from the root window of the specified screen. The property is converted from type STRING to the current locale. -The conversion is identical to that produced by -.ZN XmbTextPropertyToTextList +The conversion is identical to that produced by +.B XmbTextPropertyToTextList for a single element STRING property. The property value must be in a format that is acceptable to -.ZN XrmGetStringDatabase . +.BR XrmGetStringDatabase . If no property exists, NULL is returned. The caller is responsible for freeing the returned string by using -.ZN XFree . +.BR XFree . .SH "SEE ALSO" \fI\*(xL\fP diff --git a/lib/libX11/man/XSaveContext.man b/lib/libX11/man/XSaveContext.man index de7482b24..58782811a 100644 --- a/lib/libX11/man/XSaveContext.man +++ b/lib/libX11/man/XSaveContext.man @@ -38,64 +38,31 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSaveContext __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSaveContext, XFindContext, XDeleteContext, XUniqueContext \- associative look-up routines .SH SYNTAX .HP int XSaveContext(\^Display *\fIdisplay\fP\^, XID \fIrid\fP\^, XContext -\fIcontext\fP\^, XPointer \fIdata\fP\^); +\fIcontext\fP\^, XPointer \fIdata\fP\^); .HP int XFindContext(\^Display *\fIdisplay\fP\^, XID \fIrid\fP\^, XContext -\fIcontext\fP\^, XPointer *\fIdata_return\fP\^); +\fIcontext\fP\^, XPointer *\fIdata_return\fP\^); .HP int XDeleteContext(\^Display *\fIdisplay\fP\^, XID \fIrid\fP, XContext -\fIcontext\fP); +\fIcontext\fP); .LP -XContext XUniqueContext(void); +XContext XUniqueContext(void); .SH ARGUMENTS .IP \fIcontext\fP 1i -Specifies the context type to which the data belongs. +Specifies the context type to which the data belongs. .IP \fIdata\fP 1i Specifies the data to be associated with the window and type. .IP \fIdata_return\fP 1i @@ -106,39 +73,39 @@ Specifies the connection to the X server. Specifies the resource ID with which the data is associated. .SH DESCRIPTION If an entry with the specified resource ID and type already exists, -.ZN XSaveContext +.B XSaveContext overrides it with the specified context. The -.ZN XSaveContext +.B XSaveContext function returns a nonzero error code if an error has occurred and zero otherwise. Possible errors are -.ZN XCNOMEM +.B XCNOMEM (out of memory). .LP Because it is a return value, the data is a pointer. The -.ZN XFindContext +.B XFindContext function returns a nonzero error code if an error has occurred and zero otherwise. Possible errors are -.ZN XCNOENT +.B XCNOENT (context-not-found). .LP The -.ZN XDeleteContext -function deletes the entry for the given resource ID +.B XDeleteContext +function deletes the entry for the given resource ID and type from the data structure. This function returns the same error codes that -.ZN XFindContext +.B XFindContext returns if called with the same arguments. -.ZN XDeleteContext +.B XDeleteContext does not free the data whose address was saved. .LP The -.ZN XUniqueContext +.B XUniqueContext function creates a unique context type that may be used in subsequent calls to -.ZN XSaveContext . +.BR XSaveContext . .SH "SEE ALSO" \fI\*(xL\fP diff --git a/lib/libX11/man/XSelectInput.man b/lib/libX11/man/XSelectInput.man index 6913c35ef..1fcb1692e 100644 --- a/lib/libX11/man/XSelectInput.man +++ b/lib/libX11/man/XSelectInput.man @@ -38,65 +38,31 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSelectInput __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSelectInput \- select input events .SH SYNTAX .HP int XSelectInput\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, long -\fIevent_mask\fP\^); +\fIevent_mask\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIevent_mask\fP 1i Specifies the event mask. -.ds Wi whose events you are interested in .IP \fIw\fP 1i -Specifies the window \*(Wi. +Specifies the window whose events you are interested in. .SH DESCRIPTION The -.ZN XSelectInput -function requests that the X server report the events associated with the +.B XSelectInput +function requests that the X server report the events associated with the specified event mask. Initially, X will not report any of these events. Events are reported relative to a window. @@ -116,36 +82,36 @@ When the X server generates an event, it reports it to all interested clients. .IP \(bu 5 Only one client at a time can select -.ZN CirculateRequest , -.ZN ConfigureRequest , +.BR CirculateRequest , +.BR ConfigureRequest , or -.ZN MapRequest +.B MapRequest events, which are associated with the event mask -.ZN SubstructureRedirectMask . +.BR SubstructureRedirectMask . .IP \(bu 5 Only one client at a time can select a -.ZN ResizeRequest +.B ResizeRequest event, which is associated with the event mask -.ZN ResizeRedirectMask . +.BR ResizeRedirectMask . .IP \(bu 5 -Only one client at a time can select a -.ZN ButtonPress +Only one client at a time can select a +.B ButtonPress event, which is associated with the event mask -.ZN ButtonPressMask . +.BR ButtonPressMask . .LP The server reports the event to all interested clients. .LP -.ZN XSelectInput +.B XSelectInput can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" \fI\*(xL\fP diff --git a/lib/libX11/man/XSelectionClearEvent.man b/lib/libX11/man/XSelectionClearEvent.man index d8db1fc16..b3e08480d 100644 --- a/lib/libX11/man/XSelectionClearEvent.man +++ b/lib/libX11/man/XSelectionClearEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSelectionClearEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSelectionClearEvent \- SelectionClear event structure .SH STRUCTURES The structure for -.ZN SelectionClear +.B SelectionClear events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* SelectionClear */ unsigned long serial; /\&* # of last request processed by server */ @@ -96,7 +63,7 @@ typedef struct { Atom selection; Time time; } XSelectionClearEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -104,16 +71,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -121,11 +88,11 @@ The window member is set to the window that is most useful to toolkit dispatchers. .LP The selection member is set to the selection atom. -The time member is set to the last change time recorded for the +The time member is set to the last change time recorded for the selection. The window member is the window that was specified by the current owner (the owner losing the selection) in its -.ZN XSetSelectionOwner +.B XSetSelectionOwner call. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/lib/libX11/man/XSelectionEvent.man b/lib/libX11/man/XSelectionEvent.man index feb5dfcd4..797db1f5f 100644 --- a/lib/libX11/man/XSelectionEvent.man +++ b/lib/libX11/man/XSelectionEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSelectionEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSelectionEvent \- SelectionNotify event structure .SH STRUCTURES The structure for -.ZN SelectionNotify +.B SelectionNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* SelectionNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -98,7 +65,7 @@ typedef struct { Atom property; /\&* atom or None */ Time time; } XSelectionEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -106,16 +73,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -130,12 +97,12 @@ The target member is set to the atom that indicates the converted type. For example, PIXMAP is used for a pixmap. The property member is set to the atom that indicates which property the result was stored on. -If the conversion failed, +If the conversion failed, the property member is set to -.ZN None . +.BR None . The time member is set to the time the conversion took place and can be a timestamp or -.ZN CurrentTime . +.BR CurrentTime . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/lib/libX11/man/XSelectionRequestEvent.man b/lib/libX11/man/XSelectionRequestEvent.man index 35454c3df..7a7e497e4 100644 --- a/lib/libX11/man/XSelectionRequestEvent.man +++ b/lib/libX11/man/XSelectionRequestEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSelectionRequestEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSelectionRequestEvent \- SelectionRequest event structure .SH STRUCTURES The structure for -.ZN SelectionRequest +.B SelectionRequest events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* SelectionRequest */ unsigned long serial; /\&* # of last request processed by server */ @@ -99,7 +66,7 @@ typedef struct { Atom property; Time time; } XSelectionRequestEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -107,16 +74,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -125,19 +92,19 @@ dispatchers. .LP The owner member is set to the window that was specified by the current owner in its -.ZN XSetSelectionOwner +.B XSetSelectionOwner call. The requestor member is set to the window requesting the selection. The selection member is set to the atom that names the selection. For example, PRIMARY is used to indicate the primary selection. The target member is set to the atom that indicates the type the selection is desired in. -The property member can be a property name or -.ZN None . -The time member is set to the timestamp or -.ZN CurrentTime +The property member can be a property name or +.BR None . +The time member is set to the timestamp or +.B CurrentTime value from the -.ZN ConvertSelection +.B ConvertSelection request. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/lib/libX11/man/XSendEvent.man b/lib/libX11/man/XSendEvent.man index 2b21cdd3e..a1aa493ef 100644 --- a/lib/libX11/man/XSendEvent.man +++ b/lib/libX11/man/XSendEvent.man @@ -38,58 +38,25 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSendEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSendEvent, XDisplayMotionBufferSize, XGetMotionEvents, XTimeCoord \- send events and pointer motion history structure .SH SYNTAX .HP Status XSendEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Bool -\fIpropagate\fP\^, long \fIevent_mask\fP\^, XEvent *\fIevent_send\fP\^); +\fIpropagate\fP\^, long \fIevent_mask\fP\^, XEvent *\fIevent_send\fP\^); .HP -unsigned long XDisplayMotionBufferSize\^(\^Display *\fIdisplay\fP\^); +unsigned long XDisplayMotionBufferSize\^(\^Display *\fIdisplay\fP\^); .HP XTimeCoord *XGetMotionEvents\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -Time \fIstart\fP\^, Time \fIstop\fP\^, int *\fInevents_return\fP\^); +Time \fIstart\fP\^, Time \fIstop\fP\^, int *\fInevents_return\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -108,18 +75,17 @@ Specifies a Boolean value. Specify the time interval in which the events are returned from the motion history buffer. You can pass a timestamp or -.ZN CurrentTime . -.ds Wi the window the event is to be sent to, -.ZN PointerWindow , +.BR CurrentTime . +.BR PointerWindow , or -.ZN InputFocus . +.BR InputFocus . .IP \fIw\fP 1i -Specifies the window \*(Wi. +Specifies the window the window the event is to be sent to. .SH DESCRIPTION The -.ZN XSendEvent -function identifies the destination window, -determines which clients should receive the specified events, +.B XSendEvent +function identifies the destination window, +determines which clients should receive the specified events, and ignores any active grabs. This function requires you to pass an event mask. For a discussion of the valid event mask names, @@ -127,17 +93,17 @@ see section 10.3. This function uses the w argument to identify the destination window as follows: .IP \(bu 5 If w is -.ZN PointerWindow , +.BR PointerWindow , the destination window is the window that contains the pointer. .IP \(bu 5 If w is -.ZN InputFocus -and if the focus window contains the pointer, -the destination window is the window that contains the pointer; +.B InputFocus +and if the focus window contains the pointer, +the destination window is the window that contains the pointer; otherwise, the destination window is the focus window. .LP To determine which clients should receive the specified events, -.ZN XSendEvent +.B XSendEvent uses the propagate argument as follows: .IP \(bu 5 If event_mask is the empty set, @@ -145,102 +111,103 @@ the event is sent to the client that created the destination window. If that client no longer exists, no event is sent. .IP \(bu 5 -If propagate is -.ZN False , +If propagate is +.BR False , the event is sent to every client selecting on destination any of the event types in the event_mask argument. .IP \(bu 5 -If propagate is -.ZN True +If propagate is +.B True and no clients have selected on destination any of the event types in event-mask, the destination is replaced with the closest ancestor of destination for which some client has selected a type in event-mask and for which no intervening window has that type in its -do-not-propagate-mask. +do-not-propagate-mask. If no such window exists or if the window is -an ancestor of the focus window and -.ZN InputFocus +an ancestor of the focus window and +.B InputFocus was originally specified as the destination, the event is not sent to any clients. Otherwise, the event is reported to every client selecting on the final destination any of the types specified in event_mask. .LP The event in the -.ZN XEvent +.B XEvent structure must be one of the core events or one of the events -defined by an extension (or a -.ZN BadValue -error results) so that the X server can correctly byte-swap -the contents as necessary. +defined by an extension (or a +.B BadValue +error results) so that the X server can correctly byte-swap +the contents as necessary. The contents of the event are otherwise unaltered and unchecked by the X server except to force send_event to -.ZN True +.B True in the forwarded event and to set the serial number in the event correctly; therefore these fields and the display field are ignored by -.ZN XSendEvent . +.BR XSendEvent . .LP -.ZN XSendEvent +.B XSendEvent returns zero if the conversion to wire protocol format failed and returns nonzero otherwise. -.ZN XSendEvent +.B XSendEvent can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .LP The server may retain the recent history of the pointer motion and do so to a finer granularity than is reported by -.ZN MotionNotify +.B MotionNotify events. The -.ZN XGetMotionEvents +.B XGetMotionEvents function makes this history available. .LP The -.ZN XGetMotionEvents +.B XGetMotionEvents function returns all events in the motion history buffer that fall between the specified start and stop times, inclusive, and that have coordinates that lie within the specified window (including its borders) at its present placement. -If the server does not support motion history, +If the server does not support motion history, if the start time is later than the stop time, -or if the start time is in the future, +or if the start time is in the future, no events are returned; -.ZN XGetMotionEvents +.B XGetMotionEvents returns NULL. If the stop time is in the future, it is equivalent to specifying -.ZN CurrentTime . -.ZN XGetMotionEvents +.BR CurrentTime . +.B XGetMotionEvents can generate a -.ZN BadWindow +.B BadWindow error. .SH STRUCTURES The -.ZN XTimeCoord +.B XTimeCoord structure contains: .LP -.Ds 0 +.EX typedef struct { Time time; short x, y; } XTimeCoord; -.De +.EE .LP -The time member is set to the time, in milliseconds. +The time member is set to the time, in milliseconds. The x and y members are set to the coordinates of the pointer and are reported relative to the origin of the specified window. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/lib/libX11/man/XSetArcMode.man b/lib/libX11/man/XSetArcMode.man index 18326f0dd..81afb132d 100644 --- a/lib/libX11/man/XSetArcMode.man +++ b/lib/libX11/man/XSetArcMode.man @@ -38,134 +38,102 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetArcMode __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetArcMode, XSetSubwindowMode, XSetGraphicsExposure \- GC convenience routines .SH SYNTAX .HP int XSetArcMode\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int -\fIarc_mode\fP\^); +\fIarc_mode\fP\^); .HP int XSetSubwindowMode\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int -\fIsubwindow_mode\fP\^); +\fIsubwindow_mode\fP\^); .HP int XSetGraphicsExposures\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, Bool -\fIgraphics_exposures\fP\^); +\fIgraphics_exposures\fP\^); .SH ARGUMENTS .IP \fIarc_mode\fP 1i Specifies the arc mode. You can pass -.ZN ArcChord +.B ArcChord or -.ZN ArcPieSlice . +.BR ArcPieSlice . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i Specifies the GC. .IP \fIgraphics_exposures\fP 1i Specifies a Boolean value that indicates whether you want -.ZN GraphicsExpose +.B GraphicsExpose and -.ZN NoExpose +.B NoExpose events to be reported when calling -.ZN XCopyArea +.B XCopyArea and -.ZN XCopyPlane +.B XCopyPlane with this GC. .IP \fIsubwindow_mode\fP 1i Specifies the subwindow mode. You can pass -.ZN ClipByChildren +.B ClipByChildren or -.ZN IncludeInferiors . +.BR IncludeInferiors . .SH DESCRIPTION The -.ZN XSetArcMode +.B XSetArcMode function sets the arc mode in the specified GC. .LP -.ZN XSetArcMode +.B XSetArcMode can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetSubwindowMode +.B XSetSubwindowMode function sets the subwindow mode in the specified GC. .LP -.ZN XSetSubwindowMode +.B XSetSubwindowMode can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetGraphicsExposures +.B XSetGraphicsExposures function sets the graphics-exposures flag in the specified GC. .LP -.ZN XSetGraphicsExposures +.B XSetGraphicsExposures can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XCopyArea(__libmansuffix__), diff --git a/lib/libX11/man/XSetClipOrigin.man b/lib/libX11/man/XSetClipOrigin.man index a227ebc63..207de4cc4 100644 --- a/lib/libX11/man/XSetClipOrigin.man +++ b/lib/libX11/man/XSetClipOrigin.man @@ -38,60 +38,27 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetClipOrigin __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetClipOrigin, XSetClipMask, XSetClipRectangles \- GC convenience routines .SH SYNTAX .HP int XSetClipOrigin\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int -\fIclip_x_origin\fP\^, int \fIclip_y_origin\fP\^); +\fIclip_x_origin\fP\^, int \fIclip_y_origin\fP\^); .HP int XSetClipMask\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, Pixmap -\fIpixmap\fP\^); +\fIpixmap\fP\^); .HP int XSetClipRectangles\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int \fIclip_x_origin\fP\^, int \fIclip_y_origin\fP\^, XRectangle -\fIrectangles\fP[]\^, int \fIn\fP\^, int \fIordering\fP\^); +\fIrectangles\fP[]\^, int \fIn\fP\^, int \fIordering\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -103,121 +70,122 @@ Specify the x and y coordinates of the clip-mask origin. .IP \fIgc\fP 1i Specifies the GC. .IP \fIn\fP 1i -Specifies the number of rectangles. +Specifies the number of rectangles. .IP \fIordering\fP 1i Specifies the ordering relations on the rectangles. You can pass -.ZN Unsorted , -.ZN YSorted , -.ZN YXSorted , +.BR Unsorted , +.BR YSorted , +.BR YXSorted , or -.ZN YXBanded . +.BR YXBanded . .IP \fIpixmap\fP 1i Specifies the pixmap or -.ZN None . +.BR None . .IP \fIrectangles\fP 1i Specifies an array of rectangles that define the clip-mask. .SH DESCRIPTION The -.ZN XSetClipOrigin +.B XSetClipOrigin function sets the clip origin in the specified GC. The clip-mask origin is interpreted relative to the origin of whatever destination drawable is specified in the graphics request. .LP -.ZN XSetClipOrigin +.B XSetClipOrigin can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadGC +.B BadGC errors. .LP The -.ZN XSetClipMask +.B XSetClipMask function sets the clip-mask in the specified GC to the specified pixmap. If the clip-mask is set to -.ZN None , +.BR None , the pixels are are always drawn (regardless of the clip-origin). .LP -.ZN XSetClipMask +.B XSetClipMask can generate -.ZN BadAlloc , -.ZN BadGC , -.ZN BadMatch , +.BR BadAlloc , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetClipRectangles -function changes the clip-mask in the specified GC +.B XSetClipRectangles +function changes the clip-mask in the specified GC to the specified list of rectangles and sets the clip origin. The output is clipped to remain contained within the rectangles. The clip-origin is interpreted relative to the origin of -whatever destination drawable is specified in a graphics request. -The rectangle coordinates are interpreted relative to the clip-origin. +whatever destination drawable is specified in a graphics request. +The rectangle coordinates are interpreted relative to the clip-origin. The rectangles should be nonintersecting, or the graphics results will be undefined. -Note that the list of rectangles can be empty, +Note that the list of rectangles can be empty, which effectively disables output. This is the opposite of passing -.ZN None +.B None as the clip-mask in -.ZN XCreateGC , -.ZN XChangeGC , +.BR XCreateGC , +.BR XChangeGC , and -.ZN XSetClipMask . +.BR XSetClipMask . .LP If known by the client, ordering relations on the rectangles can be -specified with the ordering argument. +specified with the ordering argument. This may provide faster operation -by the server. +by the server. If an incorrect ordering is specified, the X server may generate a -.ZN BadMatch +.B BadMatch error, but it is not required to do so. If no error is generated, the graphics results are undefined. -.ZN Unsorted +.B Unsorted means the rectangles are in arbitrary order. -.ZN YSorted +.B YSorted means that the rectangles are nondecreasing in their Y origin. -.ZN YXSorted -additionally constrains -.ZN YSorted +.B YXSorted +additionally constrains +.B YSorted order in that all rectangles with an equal Y origin are nondecreasing in their X -origin. -.ZN YXBanded -additionally constrains -.ZN YXSorted +origin. +.B YXBanded +additionally constrains +.B YXSorted by requiring that, for every possible Y scanline, all rectangles that include that scanline have an identical Y origins and Y extents. .LP -.ZN XSetClipRectangles +.B XSetClipRectangles can generate -.ZN BadAlloc , -.ZN BadGC , -.ZN BadMatch , +.BR BadAlloc , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/lib/libX11/man/XSetCloseDownMode.man b/lib/libX11/man/XSetCloseDownMode.man index 6ae6fd862..7c63f6cd4 100644 --- a/lib/libX11/man/XSetCloseDownMode.man +++ b/lib/libX11/man/XSetCloseDownMode.man @@ -38,122 +38,90 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetCloseDownMode __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetCloseDownMode, XKillClient \- control clients .SH SYNTAX .HP -int XSetCloseDownMode\^(\^Display *\fIdisplay\fP\^, int \fIclose_mode\fP\^); +int XSetCloseDownMode\^(\^Display *\fIdisplay\fP\^, int \fIclose_mode\fP\^); .HP -int XKillClient\^(\^Display *\fIdisplay\fP\^, XID \fIresource\fP\^); +int XKillClient\^(\^Display *\fIdisplay\fP\^, XID \fIresource\fP\^); .SH ARGUMENTS .IP \fIclose_mode\fP 1i Specifies the client close-down mode. -You can pass -.ZN DestroyAll , -.ZN RetainPermanent , +You can pass +.BR DestroyAll , +.BR RetainPermanent , or -.ZN RetainTemporary . +.BR RetainTemporary . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIresource\fP 1i Specifies any resource associated with the client that you want to destroy or -.ZN AllTemporary . +.BR AllTemporary . .SH DESCRIPTION The -.ZN XSetCloseDownMode +.B XSetCloseDownMode defines what will happen to the client's resources at connection close. A connection starts in -.ZN DestroyAll +.B DestroyAll mode. For information on what happens to the client's resources when the close_mode argument is -.ZN RetainPermanent +.B RetainPermanent or -.ZN RetainTemporary , +.BR RetainTemporary , see section 2.6. .LP -.ZN XSetCloseDownMode +.B XSetCloseDownMode can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XKillClient +.B XKillClient function forces a close down of the client that created the resource if a valid resource is specified. If the client has already terminated in -either -.ZN RetainPermanent -or -.ZN RetainTemporary +either +.B RetainPermanent +or +.B RetainTemporary mode, all of the client's resources are destroyed. -If -.ZN AllTemporary +If +.B AllTemporary is specified, the resources of all clients that have terminated in -.ZN RetainTemporary +.B RetainTemporary are destroyed (see section 2.5). This permits implementation of window manager facilities that aid debugging. A client can set its close-down mode to -.ZN RetainTemporary . +.BR RetainTemporary . If the client then crashes, -its windows would not be destroyed. -The programmer can then inspect the application's window tree +its windows would not be destroyed. +The programmer can then inspect the application's window tree and use the window manager to destroy the zombie windows. .LP -.ZN XKillClient +.B XKillClient can generate a -.ZN BadValue +.B BadValue error. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" \fI\*(xL\fP diff --git a/lib/libX11/man/XSetCommand.man b/lib/libX11/man/XSetCommand.man index 3b89c6644..321aee409 100644 --- a/lib/libX11/man/XSetCommand.man +++ b/lib/libX11/man/XSetCommand.man @@ -38,56 +38,23 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetCommand __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetCommand, XGetCommand \- set or read a window's WM_COMMAND property .SH SYNTAX .HP int XSetCommand\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char -**\fIargv\fP\^, int \fIargc\fP\^); +**\fIargv\fP\^, int \fIargc\fP\^); .HP Status XGetCommand\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char -***\fIargv_return\fP\^, int *\fIargc_return\fP\^); +***\fIargv_return\fP\^, int *\fIargc_return\fP\^); .SH ARGUMENTS .IP \fIargc\fP 1i Specifies the number of arguments. @@ -103,28 +70,28 @@ Specifies the connection to the X server. Specifies the window. .SH DESCRIPTION The -.ZN XSetCommand +.B XSetCommand function sets the command and arguments used to invoke the application. (Typically, argv is the argv array of your main program.) If the strings are not in the Host Portable Character Encoding, the result is implementation-dependent. .LP -.ZN XSetCommand +.B XSetCommand can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP -The -.ZN XGetCommand -function reads the WM_COMMAND property from the specified window +The +.B XGetCommand +function reads the WM_COMMAND property from the specified window and returns a string list. -If the WM_COMMAND property exists, +If the WM_COMMAND property exists, it is of type STRING and format 8. -If sufficient memory can be allocated to contain the string list, -.ZN XGetCommand +If sufficient memory can be allocated to contain the string list, +.B XGetCommand fills in the argv_return and argc_return arguments and returns a nonzero status. Otherwise, or if any other error is encountered, it returns a zero status. @@ -132,7 +99,7 @@ If the data returned by the server is in the Latin Portable Character Encoding, then the returned strings are in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. To free the memory allocated to the string list, use -.ZN XFreeStringList . +.BR XFreeStringList . .SH PROPERTIES .TP 1i \s-1WM_COMMAND\s+1 @@ -140,10 +107,10 @@ The command and arguments, null-separated, used to invoke the application. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/lib/libX11/man/XSetErrorHandler.man b/lib/libX11/man/XSetErrorHandler.man index 0e3121bfa..f04b3b491 100644 --- a/lib/libX11/man/XSetErrorHandler.man +++ b/lib/libX11/man/XSetErrorHandler.man @@ -38,65 +38,32 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetErrorHandler __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetErrorHandler, XGetErrorText, XDisplayName, XSetIOErrorHandler, XGetErrorDatabaseText \- default error handlers .SH SYNTAX .HP int (*XSetErrorHandler\^(\^int (\^*\^\fIhandler\fP\^)\^(Display *, XErrorEvent -*)\^)\^)\^(\^); +*)\^)\^)\^(\^); .HP int XGetErrorText\^(\^Display *\fIdisplay\fP\^, int \fIcode\fP\^, char -*\fIbuffer_return\fP\^, int \fIlength\fP\^); +*\fIbuffer_return\fP\^, int \fIlength\fP\^); .HP -char *XDisplayName\^(\^char *\fIstring\fP\^); +char *XDisplayName\^(\^char *\fIstring\fP\^); .HP int (*XSetIOErrorHandler\^(\^int (\^*\^\fIhandler\fP\^)(Display -*)\^)\^)\^(\^); +*)\^)\^)\^(\^); .HP int XGetErrorDatabaseText\^(\^Display *\fIdisplay\fP\^, char *\fIname\fP, char *\fImessage\fP\^, char *\fIdefault_string\fP\^, char *\fIbuffer_return\fP\^, -int \fIlength\fP\^); +int \fIlength\fP\^); .SH ARGUMENTS .IP \fIbuffer_return\fP 1i Returns the error description. @@ -120,20 +87,20 @@ Specifies the character string. Xlib generally calls the program's supplied error handler whenever an error is received. It is not called on -.ZN BadName +.B BadName errors from -.ZN OpenFont , -.ZN LookupColor , +.BR OpenFont , +.BR LookupColor , or -.ZN AllocNamedColor +.B AllocNamedColor protocol requests or on -.ZN BadFont +.B BadFont errors from a -.ZN QueryFont +.B QueryFont protocol request. These errors generally are reflected back to the program through the procedural interface. -Because this condition is not assumed to be fatal, +Because this condition is not assumed to be fatal, it is acceptable for your error handler to return; the returned value is ignored. However, the error handler should not @@ -142,7 +109,7 @@ that will generate protocol requests or that will look for input events. The previous error handler is returned. .LP The -.ZN XGetErrorText +.B XGetErrorText function copies a null-terminated string describing the specified error code into the specified buffer. The returned text is in the encoding of the current locale. @@ -151,20 +118,20 @@ because extensions to Xlib may define their own error codes and error strings. .LP The -.ZN XDisplayName -function returns the name of the display that -.ZN XOpenDisplay +.B XDisplayName +function returns the name of the display that +.B XOpenDisplay would attempt to use. If a NULL string is specified, -.ZN XDisplayName +.B XDisplayName looks in the environment for the display and returns the display name that -.ZN XOpenDisplay +.B XOpenDisplay would attempt to use. This makes it easier to report to the user precisely which display the program attempted to open when the initial connection attempt failed. .LP The -.ZN XSetIOErrorHandler +.B XSetIOErrorHandler sets the fatal I/O error handler. Xlib calls the program's supplied error handler if any sort of system call error occurs (for example, the connection to the server was lost). @@ -176,7 +143,7 @@ the client process exits. Note that the previous error handler is returned. .LP The -.ZN XGetErrorDatabaseText +.B XGetErrorDatabaseText function returns a null-terminated message (or the default message) from the error message database. @@ -190,7 +157,7 @@ The name argument should generally be the name of your application. The message argument should indicate which type of error message you want. If the name and message are not in the Host Portable Character Encoding, the result is implementation-dependent. -Xlib uses three predefined ``application names'' to report errors. +Xlib uses three predefined \*(lqapplication names\*(rq to report errors. In these names, uppercase and lowercase matter. .IP XProtoError 1i @@ -202,8 +169,8 @@ For a core protocol request, the major request protocol number is used for the message argument. For an extension request, the extension name (as given by -.ZN InitExtension ) -followed by a period (\.) and the minor request protocol number +.BR InitExtension ) +followed by a period (\.) and the minor request protocol number is used for the message argument. If no string is found in the error database, the default_string is returned to the buffer argument. diff --git a/lib/libX11/man/XSetEventQueueOwner.man b/lib/libX11/man/XSetEventQueueOwner.man index f49ac7149..cc332497e 100644 --- a/lib/libX11/man/XSetEventQueueOwner.man +++ b/lib/libX11/man/XSetEventQueueOwner.man @@ -26,7 +26,7 @@ XSetEventQueueOwner \- set event queue owner on a shared Xlib/XCB connection .HP #include <X11/Xlib-xcb.h> .HP -void XSetEventQueueOwner(Display *\fIdpy\fP, enum XEventQueueOwner \fIowner\fP); +void XSetEventQueueOwner(Display *\fIdpy\fP, enum XEventQueueOwner \fIowner\fP); .SH ARGUMENTS .IP \fIdpy\fP 1i Specifies the connection to the X server. @@ -35,19 +35,25 @@ Specifies the event queue ownership: .RS .TP \fIXlibOwnsEventQueue\fP (default) -Xlib owns the event queue. Use the Xlib event-handling functions. Do not +Xlib owns the event queue. +Use the Xlib event-handling functions. +Do not call the XCB event-handling functions. .TP \fIXCBOwnsEventQueue\fP -XCB owns the event queue. Use the XCB event-handling functions. Do not call +XCB owns the event queue. +Use the XCB event-handling functions. +Do not call the Xlib event-handling functions. .RE .SH DESCRIPTION While a client using Xlib/XCB can issue requests and handle their replies or errors with either Xlib or XCB, only one can own and handle the event queue. By default, Xlib must own the event queue, for compatibility with legacy Xlib -clients. Clients can call \fIXSetEventQueueOwner\fP immediately after -\fIXOpenDisplay\fP to let XCB own the event queue instead. Clients may not +clients. +Clients can call \fIXSetEventQueueOwner\fP immediately after +\fIXOpenDisplay\fP to let XCB own the event queue instead. +Clients may not call \fIXSetEventQueueOwner\fP at any other time, as this will potentially lose responses. .SH "SEE ALSO" diff --git a/lib/libX11/man/XSetFillStyle.man b/lib/libX11/man/XSetFillStyle.man index a4af0172d..cea178de7 100644 --- a/lib/libX11/man/XSetFillStyle.man +++ b/lib/libX11/man/XSetFillStyle.man @@ -38,111 +38,79 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetFillStyle __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetFillStyle, XSetFillRule \- GC convenience routines .SH SYNTAX .HP int XSetFillStyle\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int -\fIfill_style\fP\^); +\fIfill_style\fP\^); .HP int XSetFillRule\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int -\fIfill_rule\fP\^); +\fIfill_rule\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIfill_rule\fP 1i Specifies the fill-rule you want to set for the specified GC. -You can pass -.ZN EvenOddRule +You can pass +.B EvenOddRule or -.ZN WindingRule . +.BR WindingRule . .IP \fIfill_style\fP 1i Specifies the fill-style you want to set for the specified GC. You can pass -.ZN FillSolid , -.ZN FillTiled , -.ZN FillStippled , +.BR FillSolid , +.BR FillTiled , +.BR FillStippled , or -.ZN FillOpaqueStippled . +.BR FillOpaqueStippled . .IP \fIgc\fP 1i Specifies the GC. .SH DESCRIPTION The -.ZN XSetFillStyle +.B XSetFillStyle function sets the fill-style in the specified GC. .LP -.ZN XSetFillStyle +.B XSetFillStyle can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetFillRule +.B XSetFillRule function sets the fill-rule in the specified GC. .LP -.ZN XSetFillRule +.B XSetFillRule can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/lib/libX11/man/XSetFont.man b/lib/libX11/man/XSetFont.man index 8c303d633..5b89db470 100644 --- a/lib/libX11/man/XSetFont.man +++ b/lib/libX11/man/XSetFont.man @@ -38,52 +38,19 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetFont __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetFont \- GC convenience routines .SH SYNTAX .HP -int XSetFont\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, Font \fIfont\fP\^); +int XSetFont\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, Font \fIfont\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -93,25 +60,25 @@ Specifies the font. Specifies the GC. .SH DESCRIPTION The -.ZN XSetFont +.B XSetFont function sets the current font in the specified GC. .LP -.ZN XSetFont +.B XSetFont can generate -.ZN BadAlloc , -.ZN BadFont , +.BR BadAlloc , +.BR BadFont , and -.ZN BadGC +.B BadGC errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadFont +.B BadFont A value for a Font or GContext argument does not name a defined Font. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/lib/libX11/man/XSetFontPath.man b/lib/libX11/man/XSetFontPath.man index 382537fa2..08603930d 100644 --- a/lib/libX11/man/XSetFontPath.man +++ b/lib/libX11/man/XSetFontPath.man @@ -38,56 +38,23 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetFontPath __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetFontPath, XGetFontPath, XFreeFontPath \- set, get, or free the font search path .SH SYNTAX int XSetFontPath\^(\^Display *\fIdisplay\fP\^, char **\fIdirectories\fP\^, int -\fIndirs\fP\^); +\fIndirs\fP\^); .HP char **XGetFontPath\^(\^Display *\fIdisplay\fP\^, int *\fInpaths_return\fP\^); .HP -int XFreeFontPath\^(\^char **\fIlist\fP\^); +int XFreeFontPath\^(\^char **\fIlist\fP\^); .SH ARGUMENTS .IP \fIdirectories\fP 1i Specifies the directory path used to look for a font. @@ -103,11 +70,11 @@ Specifies the number of directories in the path. Returns the number of strings in the font path array. .SH DESCRIPTION The -.ZN XSetFontPath +.B XSetFontPath function defines the directory search path for font lookup. There is only one search path per X server, not one per client. The encoding and interpretation of the strings are implementation-dependent, -but typically they specify directories or font servers to be searched +but typically they specify directories or font servers to be searched in the order listed. An X server is permitted to cache font information internally; for example, it might cache an entire font from a file and not @@ -115,35 +82,36 @@ check on subsequent opens of that font to see if the underlying font file has changed. However, when the font path is changed, -the X server is guaranteed to flush all cached information about fonts +the X server is guaranteed to flush all cached information about fonts for which there currently are no explicit resource IDs allocated. The meaning of an error from this request is implementation-dependent. .LP -.ZN XSetFontPath +.B XSetFontPath can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XGetFontPath +.B XGetFontPath function allocates and returns an array of strings containing the search path. The contents of these strings are implementation-dependent and are not intended to be interpreted by client applications. When it is no longer needed, the data in the font path should be freed by using -.ZN XFreeFontPath . +.BR XFreeFontPath . .LP The -.ZN XFreeFontPath +.B XFreeFontPath function frees the data allocated by -.ZN XGetFontPath . +.BR XGetFontPath . .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XListFont(__libmansuffix__), diff --git a/lib/libX11/man/XSetICFocus.man b/lib/libX11/man/XSetICFocus.man index 39278880d..01f6a7684 100644 --- a/lib/libX11/man/XSetICFocus.man +++ b/lib/libX11/man/XSetICFocus.man @@ -38,71 +38,38 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetICFocus __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetICFocus, XUnsetICFocus \- set and unset input context focus .SH SYNTAX .HP -void XSetICFocus\^(\^XIC \fIic\fP\^); +void XSetICFocus\^(\^XIC \fIic\fP\^); .HP -void XUnsetICFocus\^(\^XIC \fIic\fP\^); +void XUnsetICFocus\^(\^XIC \fIic\fP\^); .SH ARGUMENTS .IP \fIic\fP 1i Specifies the input context. .SH DESCRIPTION The -.ZN XSetICFocus +.B XSetICFocus function allows a client to notify an input method that the focus window attached to the specified input context has received keyboard focus. The input method should take action to provide appropriate feedback. Complete feedback specification is a matter of user interface policy. .LP Calling -.ZN XSetICFocus +.B XSetICFocus does not affect the focus window value. .LP The -.ZN XUnsetICFocus +.B XUnsetICFocus function allows a client to notify an input method that the specified input context has lost the keyboard focus and that no more input is expected on the focus window attached to that input context. @@ -110,9 +77,9 @@ The input method should take action to provide appropriate feedback. Complete feedback specification is a matter of user interface policy. .LP Calling -.ZN XUnsetICFocus +.B XUnsetICFocus does not affect the focus window value; -the client may still receive +the client may still receive events from the input method that are directed to the focus window. .SH "SEE ALSO" XCreateIC(__libmansuffix__), diff --git a/lib/libX11/man/XSetICValues.man b/lib/libX11/man/XSetICValues.man index 490ee176f..966d47b04 100644 --- a/lib/libX11/man/XSetICValues.man +++ b/lib/libX11/man/XSetICValues.man @@ -38,70 +38,36 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetICValues __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetICValues, XGetICValues \- set and obtain XIC values .SH SYNTAX .HP -char * XSetICValues\^(\^XIC \fIic\fP, ...\^); +char * XSetICValues\^(\^XIC \fIic\fP, ...\^); .HP -char * XGetICValues\^(\^XIC \fIic\fP, ...\^); +char * XGetICValues\^(\^XIC \fIic\fP, ...\^); .SH ARGUMENTS .IP \fIic\fP 1i Specifies the input context. -.ds Al \ to set or get XIC values .IP ... 1i -Specifies the variable length argument list\*(Al. +Specifies the variable length argument list to set or get XIC values. .SH DESCRIPTION The -.ZN XSetICValues -function returns NULL if no error occurred; +.B XSetICValues +function returns NULL if no error occurred; otherwise, it returns the name of the first argument that could not be set. An argument might not be set for any of the following reasons: .IP \(bu 5 The argument is read-only (for example, -.ZN XNFilterEvents ). +.BR XNFilterEvents ). .IP \(bu 5 The argument name is not recognized. .IP \(bu 5 @@ -111,18 +77,18 @@ Each value to be set must be an appropriate datum, matching the data type imposed by the semantics of the argument. .LP The -.ZN XSetICValues +.B XSetICValues can generate -.ZN BadAtom , -.ZN BadColor , -.ZN BadCursor , -.ZN BadPixmap , +.BR BadAtom , +.BR BadColor , +.BR BadCursor , +.BR BadPixmap , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetICValues +.B XGetICValues function returns NULL if no error occurred; otherwise, it returns the name of the first argument that could not be obtained. An argument could not be obtained for any of the following reasons: @@ -137,33 +103,33 @@ That is, if the IC value is of type T, the argument must be of type T*. If T itself is a pointer type, then -.ZN XGetICValues +.B XGetICValues allocates memory to store the actual data, and the client is responsible for freeing this data by calling -.ZN XFree +.B XFree with the returned pointer. The exception to this rule is for an IC value of type -.ZN XNVaNestedList +.B XNVaNestedList (for preedit and status attributes). In this case, the argument must also be of type -.ZN XVaNestedList . +.BR XVaNestedList . Then, the rule of changing type T to T* and freeing the allocated data applies to each element of the nested list. .SH DIAGNOSTICS .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XCreateIC(__libmansuffix__), diff --git a/lib/libX11/man/XSetInputFocus.man b/lib/libX11/man/XSetInputFocus.man index 25dedddc8..b0584b807 100644 --- a/lib/libX11/man/XSetInputFocus.man +++ b/lib/libX11/man/XSetInputFocus.man @@ -38,175 +38,143 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetInputFocus __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetInputFocus, XGetInputFocus \- control input focus .SH SYNTAX .HP int XSetInputFocus\^(\^Display *\fIdisplay\fP\^, Window \fIfocus\fP\^, int -\fIrevert_to\fP\^, Time \fItime\fP\^); +\fIrevert_to\fP\^, Time \fItime\fP\^); .HP int XGetInputFocus\^(\^Display *\fIdisplay\fP\^, Window *\fIfocus_return\fP\^, -int *\fIrevert_to_return\fP\^); +int *\fIrevert_to_return\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIfocus\fP 1i Specifies the window, -.ZN PointerRoot , +.BR PointerRoot , or -.ZN None . +.BR None . .IP \fIfocus_return\fP 1i Returns the focus window, -.ZN PointerRoot , -or -.ZN None . +.BR PointerRoot , +or +.BR None . .IP \fIrevert_to\fP 1i Specifies where the input focus reverts to if the window becomes not viewable. -You can pass -.ZN RevertToParent , -.ZN RevertToPointerRoot , -or -.ZN RevertToNone . +You can pass +.BR RevertToParent , +.BR RevertToPointerRoot , +or +.BR RevertToNone . .IP \fIrevert_to_return\fP 1i Returns the current focus state -.Pn ( RevertToParent , -.ZN RevertToPointerRoot , -or -.ZN RevertToNone ). +.Pn ( RevertToParent , +.BR RevertToPointerRoot , +or +.BR RevertToNone ). .IP \fItime\fP 1i Specifies the time. You can pass either a timestamp or -.ZN CurrentTime . +.BR CurrentTime . .SH DESCRIPTION The -.ZN XSetInputFocus +.B XSetInputFocus function changes the input focus and the last-focus-change time. It has no effect if the specified time is earlier than the current last-focus-change time or is later than the current X server time. Otherwise, the last-focus-change time is set to the specified time -.Pn ( CurrentTime +.Pn ( CurrentTime is replaced by the current X server time). -.ZN XSetInputFocus +.B XSetInputFocus causes the X server to generate -.ZN FocusIn -and -.ZN FocusOut +.B FocusIn +and +.B FocusOut events. .LP Depending on the focus argument, -the following occurs: +the following occurs: .IP \(bu 5 If focus is -.ZN None , +.BR None , all keyboard events are discarded until a new focus window is set, and the revert_to argument is ignored. .IP \(bu 5 -If focus is a window, +If focus is a window, it becomes the keyboard's focus window. If a generated keyboard event would normally be reported to this window -or one of its inferiors, the event is reported as usual. +or one of its inferiors, the event is reported as usual. Otherwise, the event is reported relative to the focus window. .IP \(bu 5 If focus is -.ZN PointerRoot , -the focus window is dynamically taken to be the root window of whatever screen -the pointer is on at each keyboard event. +.BR PointerRoot , +the focus window is dynamically taken to be the root window of whatever screen +the pointer is on at each keyboard event. In this case, the revert_to argument is ignored. .LP -The specified focus window must be viewable at the time -.ZN XSetInputFocus +The specified focus window must be viewable at the time +.B XSetInputFocus is called, or a -.ZN BadMatch +.B BadMatch error results. -If the focus window later becomes not viewable, +If the focus window later becomes not viewable, the X server -evaluates the revert_to argument to determine the new focus window as follows: +evaluates the revert_to argument to determine the new focus window as follows: .IP \(bu 5 If revert_to is -.ZN RevertToParent , -the focus reverts to the parent (or the closest viewable ancestor), +.BR RevertToParent , +the focus reverts to the parent (or the closest viewable ancestor), and the new revert_to value is taken to be -.ZN RevertToNone . +.BR RevertToNone . .IP \(bu 5 If revert_to is -.ZN RevertToPointerRoot -or -.ZN RevertToNone , +.B RevertToPointerRoot +or +.BR RevertToNone , the focus reverts to -.ZN PointerRoot +.B PointerRoot or -.ZN None , +.BR None , respectively. When the focus reverts, the X server generates -.ZN FocusIn +.B FocusIn and -.ZN FocusOut +.B FocusOut events, but the last-focus-change time is not affected. .LP -.ZN XSetInputFocus +.B XSetInputFocus can generate -.ZN BadMatch , -.ZN BadValue , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetInputFocus +.B XGetInputFocus function returns the focus window and the current focus state. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XWarpPointer(__libmansuffix__) diff --git a/lib/libX11/man/XSetLineAttributes.man b/lib/libX11/man/XSetLineAttributes.man index f54c77499..6a0d4a973 100644 --- a/lib/libX11/man/XSetLineAttributes.man +++ b/lib/libX11/man/XSetLineAttributes.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetLineAttributes __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetLineAttributes, XSetDashes \- GC convenience routines @@ -85,25 +52,25 @@ XSetLineAttributes, XSetDashes \- GC convenience routines .HP int XSetLineAttributes\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned int \fIline_width\fP\^, int \fIline_style\fP\^, int \fIcap_style\fP\^, int -\fIjoin_style\fP\^); +\fIjoin_style\fP\^); .HP int XSetDashes\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int -\fIdash_offset\fP\^, char \fIdash_list\fP[]\^, int \fIn\fP\^); +\fIdash_offset\fP\^, char \fIdash_list\fP[]\^, int \fIn\fP\^); .SH ARGUMENTS .IP \fIcap_style\fP 1i Specifies the line-style and cap-style you want to set for the specified GC. You can pass -.ZN CapNotLast , -.ZN CapButt , -.ZN CapRound , +.BR CapNotLast , +.BR CapButt , +.BR CapRound , or -.ZN CapProjecting . +.BR CapProjecting . .IP \fIdash_list\fP 1i Specifies the dash-list for the dashed line-style -you want to set for the specified GC. +you want to set for the specified GC. .IP \fIdash_offset\fP 1i Specifies the phase of the pattern for the dashed line-style you want to set -for the specified GC. +for the specified GC. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i @@ -111,49 +78,49 @@ Specifies the GC. .IP \fIjoin_style\fP 1i Specifies the line join-style you want to set for the specified GC. You can pass -.ZN JoinMiter , -.ZN JoinRound , +.BR JoinMiter , +.BR JoinRound , or -.ZN JoinBevel . +.BR JoinBevel . .IP \fIline_style\fP 1i Specifies the line-style you want to set for the specified GC. You can pass -.ZN LineSolid , -.ZN LineOnOffDash , +.BR LineSolid , +.BR LineOnOffDash , or -.ZN LineDoubleDash . +.BR LineDoubleDash . .IP \fIline_width\fP 1i Specifies the line-width you want to set for the specified GC. .IP \fIn\fP 1i -Specifies the number of elements in dash_list. +Specifies the number of elements in dash_list. .SH DESCRIPTION The -.ZN XSetLineAttributes +.B XSetLineAttributes function sets the line drawing components in the specified GC. .LP -.ZN XSetLineAttributes +.B XSetLineAttributes can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetDashes +.B XSetDashes function sets the dash-offset and dash-list attributes for dashed line styles in the specified GC. There must be at least one element in the specified dash_list, or a -.ZN BadValue -error results. -The initial and alternating elements (second, fourth, and so on) +.B BadValue +error results. +The initial and alternating elements (second, fourth, and so on) of the dash_list are the even dashes, and the others are the odd dashes. Each element specifies a dash length in pixels. All of the elements must be nonzero, or a -.ZN BadValue +.B BadValue error results. Specifying an odd-length list is equivalent to specifying the same list concatenated with itself to produce an even-length list. @@ -173,25 +140,26 @@ The major axis is defined as the x axis for lines drawn at an angle of between \-45 and +45 degrees or between 135 and 225 degrees from the x axis. For all other lines, the major axis is the y axis. .LP -.ZN XSetDashes +.B XSetDashes can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/lib/libX11/man/XSetPointerMapping.man b/lib/libX11/man/XSetPointerMapping.man index 054757d29..d52ff3080 100644 --- a/lib/libX11/man/XSetPointerMapping.man +++ b/lib/libX11/man/XSetPointerMapping.man @@ -38,56 +38,23 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetPointerMapping __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetPointerMapping, XGetPointerMapping \- manipulate pointer settings .SH SYNTAX .HP int XSetPointerMapping\^(\^Display *\fIdisplay\fP\^, unsigned char -\fImap\fP\^[]\^, int \fInmap\fP\^); +\fImap\fP\^[]\^, int \fInmap\fP\^); .HP int XGetPointerMapping\^(\^Display *\fIdisplay\fP\^, unsigned char -\fImap_return\fP\^[]\^, int \fInmap\fP\^); +\fImap_return\fP\^[]\^, int \fInmap\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -99,55 +66,56 @@ Returns the mapping list. Specifies the number of items in the mapping list. .SH DESCRIPTION The -.ZN XSetPointerMapping +.B XSetPointerMapping function sets the mapping of the pointer. If it succeeds, the X server generates a -.ZN MappingNotify +.B MappingNotify event, and -.ZN XSetPointerMapping +.B XSetPointerMapping returns -.ZN MappingSuccess . +.BR MappingSuccess . Element map[i] defines the logical button number for the physical button i+1. The length of the list must be the same as -.ZN XGetPointerMapping +.B XGetPointerMapping would return, or a -.ZN BadValue +.B BadValue error results. A zero element disables a button, and elements are not restricted in value by the number of physical buttons. However, no two elements can have the same nonzero value, or a -.ZN BadValue +.B BadValue error results. If any of the buttons to be altered are logically in the down state, -.ZN XSetPointerMapping +.B XSetPointerMapping returns -.ZN MappingBusy , +.BR MappingBusy , and the mapping is not changed. .LP -.ZN XSetPointerMapping +.B XSetPointerMapping can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XGetPointerMapping +.B XGetPointerMapping function returns the current mapping of the pointer. Pointer buttons are numbered starting from one. -.ZN XGetPointerMapping +.B XGetPointerMapping returns the number of physical buttons actually on the pointer. The nominal mapping for a pointer is map[i]=i+1. The nmap argument specifies the length of the array where the pointer -mapping is returned, and only the first nmap elements are returned +mapping is returned, and only the first nmap elements are returned in map_return. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XChangeKeyboardControl(__libmansuffix__), diff --git a/lib/libX11/man/XSetScreenSaver.man b/lib/libX11/man/XSetScreenSaver.man index 8684769ba..2d047986f 100644 --- a/lib/libX11/man/XSetScreenSaver.man +++ b/lib/libX11/man/XSetScreenSaver.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetScreenSaver __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetScreenSaver, XForceScreenSaver, XActivateScreenSaver, XResetScreenSaver, XGetScreenSaver \- manipulate the screen saver @@ -85,31 +52,31 @@ XSetScreenSaver, XForceScreenSaver, XActivateScreenSaver, XResetScreenSaver, XGe .HP int XSetScreenSaver\^(\^Display *\fIdisplay\fP\^, int \fItimeout\fP\^, int \fIinterval\fP\^, int \fIprefer_blanking\fP\^, int -\fIallow_exposures\fP\^); +\fIallow_exposures\fP\^); .HP -int XForceScreenSaver\^(\^Display *\fIdisplay\fP\^, int \fImode\fP\^); +int XForceScreenSaver\^(\^Display *\fIdisplay\fP\^, int \fImode\fP\^); .HP -int XActivateScreenSaver\^(\^Display *\fIdisplay\fP\^); +int XActivateScreenSaver\^(\^Display *\fIdisplay\fP\^); .HP -int XResetScreenSaver\^(\^Display *\fIdisplay\fP\^); +int XResetScreenSaver\^(\^Display *\fIdisplay\fP\^); .HP int XGetScreenSaver\^(\^Display *\fIdisplay\fP\^, int *\fItimeout_return\fP\^, int *\fIinterval_return\fP\^, int *\fIprefer_blanking_return\fP\^, int -*\fIallow_exposures_return\fP\^); +*\fIallow_exposures_return\fP\^); .SH ARGUMENTS .IP \fIallow_exposures\fP 1i Specifies the screen save control values. You can pass -.ZN DontAllowExposures , -.ZN AllowExposures , +.BR DontAllowExposures , +.BR AllowExposures , or -.ZN DefaultExposures . +.BR DefaultExposures . .IP \fIallow_exposures_return\fP 1i Returns the current screen save control value .Pn ( DontAllowExposures , -.ZN AllowExposures , +.BR AllowExposures , or -.ZN DefaultExposures ). +.BR DefaultExposures ). .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIinterval\fP 1i @@ -119,111 +86,33 @@ Returns the interval between screen saver invocations. .IP \fImode\fP 1i Specifies the mode that is to be applied. You can pass -.ZN ScreenSaverActive +.B ScreenSaverActive or -.ZN ScreenSaverReset . +.BR ScreenSaverReset . .IP \fIprefer_blanking\fP 1i Specifies how to enable screen blanking. You can pass -.ZN DontPreferBlanking , -.ZN PreferBlanking , +.BR DontPreferBlanking , +.BR PreferBlanking , or -.ZN DefaultBlanking . +.BR DefaultBlanking . .IP \fIprefer_blanking_return\fP 1i Returns the current screen blanking preference .Pn ( DontPreferBlanking , -.ZN PreferBlanking , +.BR PreferBlanking , or -.ZN DefaultBlanking ). +.BR DefaultBlanking ). .IP \fItimeout\fP 1i Specifies the timeout, in seconds, until the screen saver turns on. .IP \fItimeout_return\fP 1i Returns the timeout, in seconds, until the screen saver turns on. .SH DESCRIPTION -Timeout and interval are specified in seconds. -A timeout of 0 disables the screen saver +Timeout and interval are specified in seconds. +A timeout of 0 disables the screen saver (but an activated screen saver is not deactivated), and a timeout of \-1 restores the default. Other negative values generate a -.ZN BadValue -error. -If the timeout value is nonzero, -.ZN XSetScreenSaver -enables the screen saver. -An interval of 0 disables the random-pattern motion. -Both values are limited to a 16-bit signed integer range by the wire protocol, -despite the C prototype. -If no input from devices (keyboard, mouse, and so on) is generated -for the specified number of timeout seconds once the screen saver is enabled, -the screen saver is activated. -.LP -For each screen, -if blanking is preferred and the hardware supports video blanking, -the screen simply goes blank. -Otherwise, if either exposures are allowed or the screen can be regenerated -without sending -.ZN Expose -events to clients, -the screen is tiled with the root window background tile randomly -re-origined each interval seconds. -Otherwise, the screens' state do not change, -and the screen saver is not activated. -The screen saver is deactivated, -and all screen states are restored at the next -keyboard or pointer input or at the next call to -.ZN XForceScreenSaver -with mode -.ZN ScreenSaverReset . -.LP -If the server-dependent screen saver method supports periodic change, -the interval argument serves as a hint about how long the change period -should be, and zero hints that no periodic change should be made. -Examples of ways to change the screen include scrambling the colormap -periodically, moving an icon image around the screen periodically, or tiling -the screen with the root window background tile, randomly re-origined -periodically. -.LP -.ZN XSetScreenSaver -can generate a -.ZN BadValue -error. -.LP -If the specified mode is -.ZN ScreenSaverActive -and the screen saver currently is deactivated, -.ZN XForceScreenSaver -activates the screen saver even if the screen saver had been disabled -with a timeout of zero. -If the specified mode is -.ZN ScreenSaverReset -and the screen saver currently is enabled, -.ZN XForceScreenSaver -deactivates the screen saver if it was activated, -and the activation timer is reset to its initial state -(as if device input had been received). -.LP -.ZN XForceScreenSaver -can generate a -.ZN BadValue +.B BadValue error. -.LP -The -.ZN XActivateScreenSaver -function activates the screen saver. -.LP -The -.ZN XResetScreenSaver -function resets the screen saver. -.LP -The -.ZN XGetScreenSaver -function gets the current screen saver values. -.SH DIAGNOSTICS -.TP 1i -.ZN BadValue -Some numeric value falls outside the range of values accepted by the request. -Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of -alternatives can generate this error. -.SH "SEE ALSO" -\fI\*(xL\fP +If the timeout value is nonzero, +.B XSetScreenSaver diff --git a/lib/libX11/man/XSetSelectionOwner.man b/lib/libX11/man/XSetSelectionOwner.man index 3a3707c7b..d1d90db15 100644 --- a/lib/libX11/man/XSetSelectionOwner.man +++ b/lib/libX11/man/XSetSelectionOwner.man @@ -38,71 +38,38 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetSelectionOwner __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetSelectionOwner, XGetSelectionOwner, XConvertSelection \- manipulate window selection .SH SYNTAX .HP int XSetSelectionOwner\^(\^Display *\fIdisplay\fP\^, Atom \fIselection\fP\^, -Window \fIowner\fP\^, Time \fItime\fP\^); +Window \fIowner\fP\^, Time \fItime\fP\^); .HP Window XGetSelectionOwner\^(\^Display *\fIdisplay\fP\^, Atom -\fIselection\fP\^); +\fIselection\fP\^); .HP int XConvertSelection\^(\^Display *\fIdisplay\fP\^, Atom \fIselection\fP\^, Atom \fItarget\fP\^, Atom \fIproperty\fP\^, Window \fIrequestor\fP\^, Time -\fItime\fP\^); +\fItime\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIowner\fP 1i Specifies the owner of the specified selection atom. You can pass a window or -.ZN None . +.BR None . .IP \fIproperty\fP 1i Specifies the property name. You also can pass -.ZN None . +.BR None . .IP \fIrequestor\fP 1i Specifies the requestor. .IP \fIselection\fP 1i @@ -112,34 +79,34 @@ Specifies the target atom. .IP \fItime\fP 1i Specifies the time. You can pass either a timestamp or -.ZN CurrentTime . +.BR CurrentTime . .SH DESCRIPTION The -.ZN XSetSelectionOwner +.B XSetSelectionOwner function changes the owner and last-change time for the specified selection and has no effect if the specified time is earlier than the current -last-change time of the specified selection +last-change time of the specified selection or is later than the current X server time. Otherwise, the last-change time is set to the specified time, with -.ZN CurrentTime +.B CurrentTime replaced by the current server time. If the owner window is specified as -.ZN None , -then the owner of the selection becomes -.ZN None +.BR None , +then the owner of the selection becomes +.B None (that is, no owner). Otherwise, the owner of the selection becomes the client executing the request. -.LP +.LP If the new owner (whether a client or -.ZN None ) +.BR None ) is not the same as the current owner of the selection and the current owner is not -.ZN None , -the current owner is sent a -.ZN SelectionClear +.BR None , +the current owner is sent a +.B SelectionClear event. If the client that is the owner of a selection is later terminated (that is, its connection is closed) @@ -147,71 +114,71 @@ or if the owner window it has specified in the request is later destroyed, the owner of the selection automatically reverts to -.ZN None , +.BR None , but the last-change time is not affected. The selection atom is uninterpreted by the X server. -.ZN XGetSelectionOwner -returns the owner window, which is reported in -.ZN SelectionRequest +.B XGetSelectionOwner +returns the owner window, which is reported in +.B SelectionRequest and -.ZN SelectionClear +.B SelectionClear events. Selections are global to the X server. .LP -.ZN XSetSelectionOwner +.B XSetSelectionOwner can generate -.ZN BadAtom +.B BadAtom and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetSelectionOwner +.B XGetSelectionOwner function returns the window ID associated with the window that currently owns the specified selection. If no selection was specified, the function returns the constant -.ZN None . +.BR None . If -.ZN None +.B None is returned, there is no owner for the selection. .LP -.ZN XGetSelectionOwner +.B XGetSelectionOwner can generate a -.ZN BadAtom +.B BadAtom error. .LP -.ZN XConvertSelection +.B XConvertSelection requests that the specified selection be converted to the specified target type: .IP \(bu 5 If the specified selection has an owner, the X server sends a -.ZN SelectionRequest +.B SelectionRequest event to that owner. .IP \(bu 5 If no owner for the specified selection exists, the X server generates a -.ZN SelectionNotify +.B SelectionNotify event to the requestor with property -.ZN None . +.BR None . .LP The arguments are passed on unchanged in either of the events. There are two predefined selection atoms: PRIMARY and SECONDARY. .LP -.ZN XConvertSelection +.B XConvertSelection can generate -.ZN BadAtom +.B BadAtom and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" \fI\*(xL\fP diff --git a/lib/libX11/man/XSetState.man b/lib/libX11/man/XSetState.man index 6fb7d724f..e8478a8f5 100644 --- a/lib/libX11/man/XSetState.man +++ b/lib/libX11/man/XSetState.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetState __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetState, XSetFunction, XSetPlaneMask, XSetForeground, XSetBackground \- GC convenience routines @@ -85,19 +52,19 @@ XSetState, XSetFunction, XSetPlaneMask, XSetForeground, XSetBackground \- GC con .HP int XSetState\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned long \fIforeground\fP\^, unsigned int \fIbackground\fP\^, int \fIfunction\fP\^, -unsigned long \fIplane_mask\fP\^); +unsigned long \fIplane_mask\fP\^); .HP int XSetFunction\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int -\fIfunction\fP\^); +\fIfunction\fP\^); .HP int XSetPlaneMask\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned long -\fIplane_mask\fP\^); +\fIplane_mask\fP\^); .HP int XSetForeground\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned long -\fIforeground\fP\^); +\fIforeground\fP\^); .HP int XSetBackground\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned long -\fIbackground\fP\^); +\fIbackground\fP\^); .SH ARGUMENTS .IP \fIbackground\fP 1i Specifies the background you want to set for the specified GC. @@ -114,73 +81,74 @@ Specifies the plane mask. .\" *** JIM: NEED MORE INFO FOR THIS. *** .SH DESCRIPTION The -.ZN XSetState +.B XSetState function sets the foreground, background, plane mask, and function components for the specified GC. .LP -.ZN XSetState +.B XSetState can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .LP -.ZN XSetFunction +.B XSetFunction sets a specified value in the specified GC. .LP -.ZN XSetFunction +.B XSetFunction can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetPlaneMask +.B XSetPlaneMask function sets the plane mask in the specified GC. .LP -.ZN XSetPlaneMask +.B XSetPlaneMask can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadGC +.B BadGC errors. .LP The -.ZN XSetForeground +.B XSetForeground function sets the foreground in the specified GC. .LP -.ZN XSetForeground +.B XSetForeground can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadGC +.B BadGC errors. .LP The -.ZN XSetBackground +.B XSetBackground function sets the background in the specified GC. .LP -.ZN XSetBackground +.B XSetBackground can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadGC +.B BadGC errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/lib/libX11/man/XSetTextProperty.man b/lib/libX11/man/XSetTextProperty.man index 1438a4202..9b2605c8e 100644 --- a/lib/libX11/man/XSetTextProperty.man +++ b/lib/libX11/man/XSetTextProperty.man @@ -38,56 +38,23 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetTextProperty __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetTextProperty, XGetTextProperty \- set and read text properties .SH SYNTAX .HP void XSetTextProperty\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -XTextProperty *\fItext_prop\fP\^, Atom \fIproperty\fP\^); +XTextProperty *\fItext_prop\fP\^, Atom \fIproperty\fP\^); .HP Status XGetTextProperty\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -XTextProperty *\fItext_prop_return\fP\^, Atom \fIproperty\fP\^); +XTextProperty *\fItext_prop_return\fP\^, Atom \fIproperty\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -95,68 +62,68 @@ Specifies the connection to the X server. Specifies the property name. .IP \fItext_prop\fP 1i Specifies the -.ZN XTextProperty +.B XTextProperty structure to be used. .IP \fItext_prop_return\fP 1i Returns the -.ZN XTextProperty +.B XTextProperty structure. .SH DESCRIPTION The -.ZN XSetTextProperty -function replaces the existing specified property for the named window -with the data, type, format, and number of items determined -by the value field, the encoding field, the format field, +.B XSetTextProperty +function replaces the existing specified property for the named window +with the data, type, format, and number of items determined +by the value field, the encoding field, the format field, and the nitems field, respectively, of the specified -.ZN XTextProperty +.B XTextProperty structure. If the property does not already exist, -.ZN XSetTextProperty +.B XSetTextProperty sets it for the specified window. .LP -.ZN XSetTextProperty +.B XSetTextProperty can generate -.ZN BadAlloc , -.ZN BadAtom , -.ZN BadValue , +.BR BadAlloc , +.BR BadAtom , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetTextProperty +.B XGetTextProperty function reads the specified property from the window and stores the data in the returned -.ZN XTextProperty +.B XTextProperty structure. It stores the data in the value field, the type of the data in the encoding field, -the format of the data in the format field, +the format of the data in the format field, and the number of items of data in the nitems field. -An extra byte containing null (which is not included in the nitems member) +An extra byte containing null (which is not included in the nitems member) is stored at the end of the value field of text_prop_return. -The particular interpretation of the property's encoding +The particular interpretation of the property's encoding and data as text is left to the calling application. If the specified property does not exist on the window, -.ZN XGetTextProperty -sets the value field to NULL, +.B XGetTextProperty +sets the value field to NULL, the encoding field to -.ZN None , -the format field to zero, +.BR None , +the format field to zero, and the nitems field to zero. .LP If it was able to read and store the data in the -.ZN XTextProperty +.B XTextProperty structure, -.ZN XGetTextProperty -returns a nonzero status; +.B XGetTextProperty +returns a nonzero status; otherwise, it returns a zero status. .LP -.ZN XGetTextProperty +.B XGetTextProperty can generate -.ZN BadAtom +.B BadAtom and -.ZN BadWindow +.B BadWindow errors. .SH PROPERTIES .TP 1i @@ -174,19 +141,20 @@ The name to be used in an icon. The name of the application. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/lib/libX11/man/XSetTile.man b/lib/libX11/man/XSetTile.man index d35c5a2af..6138622a2 100644 --- a/lib/libX11/man/XSetTile.man +++ b/lib/libX11/man/XSetTile.man @@ -38,59 +38,26 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetTile __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetTile, XSetStipple, XSetTSOrigin \- GC convenience routines .SH SYNTAX .HP int XSetTile\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, Pixmap -\fItile\fP\^); +\fItile\fP\^); .HP int XSetStipple\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, Pixmap -\fIstipple\fP\^); +\fIstipple\fP\^); .HP int XSetTSOrigin\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int -\fIts_x_origin\fP\^, int \fIts_y_origin\fP\^); +\fIts_x_origin\fP\^, int \fIts_y_origin\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -99,7 +66,7 @@ Specifies the GC. .IP \fIstipple\fP 1i Specifies the stipple you want to set for the specified GC. .IP \fItile\fP 1i -Specifies the fill tile you want to set for the specified GC. +Specifies the fill tile you want to set for the specified GC. .IP \fIts_x_origin\fP 1i .br .ns @@ -107,65 +74,65 @@ Specifies the fill tile you want to set for the specified GC. Specify the x and y coordinates of the tile and stipple origin. .SH DESCRIPTION The -.ZN XSetTile +.B XSetTile function sets the fill tile in the specified GC. The tile and GC must have the same depth, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XSetTile +.B XSetTile can generate -.ZN BadAlloc , -.ZN BadGC , -.ZN BadMatch , +.BR BadAlloc , +.BR BadGC , +.BR BadMatch , and -.ZN BadPixmap +.B BadPixmap errors. .LP The -.ZN XSetStipple +.B XSetStipple function sets the stipple in the specified GC. The stipple must have a depth of one, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XSetStipple +.B XSetStipple can generate -.ZN BadAlloc , -.ZN BadGC , -.ZN BadMatch , +.BR BadAlloc , +.BR BadGC , +.BR BadMatch , and -.ZN BadPixmap +.B BadPixmap errors. .LP The -.ZN XSetTSOrigin +.B XSetTSOrigin function sets the tile/stipple origin in the specified GC. When graphics requests call for tiling or stippling, the parent's origin will be interpreted relative to whatever destination drawable is specified in the graphics request. .LP -.ZN XSetTSOrigin +.B XSetTSOrigin can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadGC +.B BadGC errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/lib/libX11/man/XSetTransientForHint.man b/lib/libX11/man/XSetTransientForHint.man index 3255137e9..26be3f033 100644 --- a/lib/libX11/man/XSetTransientForHint.man +++ b/lib/libX11/man/XSetTransientForHint.man @@ -38,56 +38,23 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetTransientForHint __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetTransientForHint, XGetTransientForHint \- set or read a window's WM_TRANSIENT_FOR property .SH SYNTAX .HP int XSetTransientForHint\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -Window \fIprop_window\fP\^); +Window \fIprop_window\fP\^); .HP Status XGetTransientForHint\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -Window *\fIprop_window_return\fP\^); +Window *\fIprop_window_return\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -99,26 +66,26 @@ Specifies the window that the WM_TRANSIENT_FOR property is to be set to. Returns the WM_TRANSIENT_FOR property of the specified window. .SH DESCRIPTION The -.ZN XSetTransientForHint -function sets the WM_TRANSIENT_FOR property of the specified window to the +.B XSetTransientForHint +function sets the WM_TRANSIENT_FOR property of the specified window to the specified prop_window. .LP -.ZN XSetTransientForHint +.B XSetTransientForHint can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetTransientForHint +.B XGetTransientForHint function returns the WM_TRANSIENT_FOR property for the specified window. It returns a nonzero status on success; otherwise, it returns a zero status. .LP -.ZN XGetTransientForHint +.B XGetTransientForHint can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -127,10 +94,10 @@ Set by application programs to indicate to the window manager that a transient top-level window, such as a dialog box. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/lib/libX11/man/XSetWMClientMachine.man b/lib/libX11/man/XSetWMClientMachine.man index 1fe1fa391..988dd4722 100644 --- a/lib/libX11/man/XSetWMClientMachine.man +++ b/lib/libX11/man/XSetWMClientMachine.man @@ -38,80 +38,47 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetWMClientMachine __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetWMClientMachine, XGetWMClientMachine \- set or read a window's WM_CLIENT_MACHINE property .SH SYNTAX .HP void XSetWMClientMachine\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -XTextProperty *\fItext_prop\fP\^); +XTextProperty *\fItext_prop\fP\^); .HP Status XGetWMClientMachine\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -XTextProperty *\fItext_prop_return\fP\^); +XTextProperty *\fItext_prop_return\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fItext_prop\fP 1i Specifies the -.ZN XTextProperty +.B XTextProperty structure to be used. .IP \fItext_prop_return\fP 1i Returns the -.ZN XTextProperty +.B XTextProperty structure. .IP \fIw\fP 1i Specifies the window. .SH DESCRIPTION The -.ZN XSetWMClientMachine +.B XSetWMClientMachine convenience function calls -.ZN XSetTextProperty +.B XSetTextProperty to set the WM_CLIENT_MACHINE property. .LP The -.ZN XGetWMClientMachine -convenience function performs an -.ZN XGetTextProperty +.B XGetWMClientMachine +convenience function performs an +.B XGetTextProperty on the WM_CLIENT_MACHINE property. It returns a nonzero status on success; otherwise, it returns a zero status. diff --git a/lib/libX11/man/XSetWMColormapWindows.man b/lib/libX11/man/XSetWMColormapWindows.man index 66cb8a050..5b57c3d46 100644 --- a/lib/libX11/man/XSetWMColormapWindows.man +++ b/lib/libX11/man/XSetWMColormapWindows.man @@ -38,56 +38,23 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetWMColormapWindows __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetWMColormapWindows, XGetWMColormapWindows \- set or read a window's WM_COLORMAP_WINDOWS property .SH SYNTAX .HP Status XSetWMColormapWindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -Window *\fIcolormap_windows\fP\^, int \fIcount\fP\^); +Window *\fIcolormap_windows\fP\^, int \fIcount\fP\^); .HP Status XGetWMColormapWindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -Window **\fIcolormap_windows_return\fP\^, int *\fIcount_return\fP\^); +Window **\fIcolormap_windows_return\fP\^, int *\fIcount_return\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -95,56 +62,54 @@ Specifies the connection to the X server. Specifies the list of windows. .IP \fIcolormap_windows_return\fP 1i Returns the list of windows. -.ds Cn windows in the list .IP \fIcount\fP 1i -Specifies the number of \*(Cn. -.ds Cn windows in the list +Specifies the number of windows in the list. .IP \fIcount_return\fP 1i -Returns the number of \*(Cn. +Returns the number of windows in the list. .IP \fIw\fP 1i Specifies the window. .SH DESCRIPTION -The -.ZN XSetWMColormapWindows +The +.B XSetWMColormapWindows function replaces the WM_COLORMAP_WINDOWS property on the specified window with the list of windows specified by the colormap_windows argument. It the property does not already exist, -.ZN XSetWMColormapWindows +.B XSetWMColormapWindows sets the WM_COLORMAP_WINDOWS property on the specified window to the list of windows specified by the colormap_windows argument. The property is stored with a type of WINDOW and a format of 32. If it cannot intern the WM_COLORMAP_WINDOWS atom, -.ZN XSetWMColormapWindows +.B XSetWMColormapWindows returns a zero status. Otherwise, it returns a nonzero status. .LP -.ZN XSetWMColormapWindows +.B XSetWMColormapWindows can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP -The -.ZN XGetWMColormapWindows -function returns the list of window identifiers stored +The +.B XGetWMColormapWindows +function returns the list of window identifiers stored in the WM_COLORMAP_WINDOWS property on the specified window. These identifiers indicate the colormaps that the window manager may need to install for this window. -If the property exists, is of type WINDOW, is of format 32, -and the atom WM_COLORMAP_WINDOWS can be interned, -.ZN XGetWMColormapWindows -sets the windows_return argument to a list of window identifiers, -sets the count_return argument to the number of elements in the list, +If the property exists, is of type WINDOW, is of format 32, +and the atom WM_COLORMAP_WINDOWS can be interned, +.B XGetWMColormapWindows +sets the windows_return argument to a list of window identifiers, +sets the count_return argument to the number of elements in the list, and returns a nonzero status. Otherwise, it sets neither of the return arguments and returns a zero status. To release the list of window identifiers, use -.ZN XFree . +.BR XFree . .LP -.ZN XGetWMColormapWindows +.B XGetWMColormapWindows can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -153,10 +118,10 @@ The list of window IDs that may need a different colormap from that of their top-level window. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/lib/libX11/man/XSetWMIconName.man b/lib/libX11/man/XSetWMIconName.man index 98190a40b..382b3d1d5 100644 --- a/lib/libX11/man/XSetWMIconName.man +++ b/lib/libX11/man/XSetWMIconName.man @@ -38,62 +38,29 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetWMIconName __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetWMIconName, XGetWMIconName, XSetIconName, XGetIconName \- set or read a window's WM_ICON_NAME property .SH SYNTAX .HP void XSetWMIconName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -XTextProperty *\fItext_prop\fP\^); +XTextProperty *\fItext_prop\fP\^); .HP Status XGetWMIconName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -XTextProperty *\fItext_prop_return\fP\^); +XTextProperty *\fItext_prop_return\fP\^); .HP int XSetIconName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char -*\fIicon_name\fP\^); +*\fIicon_name\fP\^); .HP Status XGetIconName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char -**\fIicon_name_return\fP\^); +**\fIicon_name_return\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -105,59 +72,59 @@ Returns the window's icon name, which is a null-terminated string. .IP \fItext_prop\fP 1i Specifies the -.ZN XTextProperty +.B XTextProperty structure to be used. .IP \fItext_prop_return\fP 1i Returns the -.ZN XTextProperty +.B XTextProperty structure. .IP \fIw\fP 1i Specifies the window. .SH DESCRIPTION The -.ZN XSetWMIconName +.B XSetWMIconName convenience function calls -.ZN XSetTextProperty +.B XSetTextProperty to set the WM_ICON_NAME property. .LP -The -.ZN XGetWMIconName +The +.B XGetWMIconName convenience function calls -.ZN XGetTextProperty +.B XGetTextProperty to obtain the WM_ICON_NAME property. It returns a nonzero status on success; otherwise, it returns a zero status. .LP The -.ZN XSetIconName +.B XSetIconName function sets the name to be displayed in a window's icon. .LP -.ZN XSetIconName +.B XSetIconName can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetIconName +.B XGetIconName function returns the name to be displayed in the specified window's icon. -If it succeeds, it returns a nonzero status; otherwise, +If it succeeds, it returns a nonzero status; otherwise, if no icon name has been set for the window, it returns zero. If you never assigned a name to the window, -.ZN XGetIconName +.B XGetIconName sets icon_name_return to NULL. If the data returned by the server is in the Latin Portable Character Encoding, then the returned string is in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. When finished with it, a client must free the icon name string using -.ZN XFree . +.BR XFree . .LP -.ZN XGetIconName +.B XGetIconName can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -165,10 +132,10 @@ error. The name to be used in an icon. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/lib/libX11/man/XSetWMName.man b/lib/libX11/man/XSetWMName.man index 8f598d1bb..064fe1596 100644 --- a/lib/libX11/man/XSetWMName.man +++ b/lib/libX11/man/XSetWMName.man @@ -38,72 +38,39 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetWMName __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetWMName, XGetWMName, XStoreName, XFetchName \- set or read a window's WM_NAME property .SH SYNTAX .HP void XSetWMName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, XTextProperty -*\fItext_prop\fP\^); +*\fItext_prop\fP\^); .HP Status XGetWMName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, -XTextProperty *\fItext_prop_return\fP\^); +XTextProperty *\fItext_prop_return\fP\^); .HP int XStoreName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char -*\fIwindow_name\fP\^); +*\fIwindow_name\fP\^); .HP Status XFetchName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char -**\fIwindow_name_return\fP\^); +**\fIwindow_name_return\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fItext_prop\fP 1i Specifies the -.ZN XTextProperty +.B XTextProperty structure to be used. .IP \fItext_prop_return\fP 1i Returns the -.ZN XTextProperty +.B XTextProperty structure. .IP \fIw\fP 1i Specifies the window. @@ -114,21 +81,21 @@ which should be a null-terminated string. Returns the window name, which is a null-terminated string. .SH DESCRIPTION The -.ZN XSetWMName +.B XSetWMName convenience function calls -.ZN XSetTextProperty +.B XSetTextProperty to set the WM_NAME property. .LP The -.ZN XGetWMName +.B XGetWMName convenience function calls -.ZN XGetTextProperty +.B XGetTextProperty to obtain the WM_NAME property. It returns a nonzero status on success; otherwise, it returns a zero status. .LP The -.ZN XStoreName +.B XStoreName function assigns the name passed to window_name to the specified window. A window manager can display the window name in some prominent place, such as the title bar, to allow users to identify windows easily. @@ -138,33 +105,33 @@ if one is provided by the application. If the string is not in the Host Portable Character Encoding, the result is implementation-dependent. .LP -.ZN XStoreName +.B XStoreName can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XFetchName +.B XFetchName function returns the name of the specified window. If it succeeds, -it returns a nonzero status; +it returns a nonzero status; otherwise, no name has been set for the window, and it returns zero. If the WM_NAME property has not been set for this window, -.ZN XFetchName +.B XFetchName sets window_name_return to NULL. If the data returned by the server is in the Latin Portable Character Encoding, then the returned string is in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. When finished with it, a client must free the window name string using -.ZN XFree . +.BR XFree . .LP -.ZN XFetchName +.B XFetchName can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -172,10 +139,10 @@ error. The name of the application. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/lib/libX11/man/XSetWMProperties.man b/lib/libX11/man/XSetWMProperties.man index 9d670c5c4..0587c12ac 100644 --- a/lib/libX11/man/XSetWMProperties.man +++ b/lib/libX11/man/XSetWMProperties.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. +.\" It is provided "as is" without express or implied warranty. +.\" .\" -.\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetWMProperties __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetWMProperties, XmbSetWMProperties, Xutf8SetWMProperties \- set standard window properties @@ -87,17 +54,17 @@ XSetWMProperties, XmbSetWMProperties, Xutf8SetWMProperties \- set standard windo void XSetWMProperties\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, XTextProperty *\fIwindow_name\fP\^, XTextProperty *\fIicon_name\fP\^, char **\fIargv\fP\^, int \fIargc\fP\^, XSizeHints *\fInormal_hints\fP\^, XWMHints -*\fIwm_hints\fP\^, XClassHint *\fIclass_hints\fP\^); +*\fIwm_hints\fP\^, XClassHint *\fIclass_hints\fP\^); .HP void XmbSetWMProperties\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char *\fIwindow_name\fP\^, char *\fIicon_name\fP\^, char *\fIargv\fP\^[], int \fIargc\fP\^, XSizeHints *\fInormal_hints\fP\^, XWMHints *\fIwm_hints\fP\^, -XClassHint *\fIclass_hints\fP\^); +XClassHint *\fIclass_hints\fP\^); .HP void Xutf8SetWMProperties\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char *\fIwindow_name\fP\^, char *\fIicon_name\fP\^, char *\fIargv\fP\^[], int \fIargc\fP\^, XSizeHints *\fInormal_hints\fP\^, XWMHints *\fIwm_hints\fP\^, -XClassHint *\fIclass_hints\fP\^); +XClassHint *\fIclass_hints\fP\^); .SH ARGUMENTS .IP \fIargc\fP 1i Specifies the number of arguments. @@ -105,7 +72,7 @@ Specifies the number of arguments. Specifies the application's argument list. .IP \fIclass_hints\fP 1i Specifies the -.ZN XClassHint +.B XClassHint structure to be used. .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -121,69 +88,69 @@ Specifies the window name, which should be a null-terminated string. .IP \fIwm_hints\fP 1i Specifies the -.ZN XWMHints +.B XWMHints structure to be used. .SH DESCRIPTION -The -.ZN XSetWMProperties -convenience function provides a single programming interface -for setting those essential window properties that are used +The +.B XSetWMProperties +convenience function provides a single programming interface +for setting those essential window properties that are used for communicating with other clients (particularly window and session managers). .LP -If the window_name argument is non-NULL, -.ZN XSetWMProperties +If the window_name argument is non-NULL, +.B XSetWMProperties calls -.ZN XSetWMName , +.BR XSetWMName , which in turn, sets the WM_NAME property (see section 14.1.4). If the icon_name argument is non-NULL, -.ZN XSetWMProperties +.B XSetWMProperties calls -.ZN XSetWMIconName , +.BR XSetWMIconName , which sets the WM_ICON_NAME property (see section 14.1.5). -If the argv argument is non-NULL, -.ZN XSetWMProperties +If the argv argument is non-NULL, +.B XSetWMProperties calls -.ZN XSetCommand , +.BR XSetCommand , which sets the WM_COMMAND property (see section 14.2.1). Note that an argc of zero is allowed to indicate a zero-length command. Note also that the hostname of this machine is stored using -.ZN XSetWMClientMachine +.B XSetWMClientMachine (see section 14.2.2). .LP -If the normal_hints argument is non-NULL, -.ZN XSetWMProperties +If the normal_hints argument is non-NULL, +.B XSetWMProperties calls -.ZN XSetWMNormalHints , +.BR XSetWMNormalHints , which sets the WM_NORMAL_HINTS property (see section 14.1.7). -If the wm_hints argument is non-NULL, -.ZN XSetWMProperties +If the wm_hints argument is non-NULL, +.B XSetWMProperties calls -.ZN XSetWMHints , +.BR XSetWMHints , which sets the WM_HINTS property (see section 14.1.6). .LP -If the class_hints argument is non-NULL, -.ZN XSetWMProperties +If the class_hints argument is non-NULL, +.B XSetWMProperties calls -.ZN XSetClassHint , +.BR XSetClassHint , which sets the WM_CLASS property (see section 14.1.8). If the res_name member in the -.ZN XClassHint -structure is set to the NULL pointer and the RESOURCE_NAME environment -variable is set, +.B XClassHint +structure is set to the NULL pointer and the RESOURCE_NAME environment +variable is set, then the value of the environment variable is substituted for res_name. -If the res_name member is NULL, -the environment variable is not set, -and argv and argv[0] are set, +If the res_name member is NULL, +the environment variable is not set, +and argv and argv[0] are set, then the value of argv[0], stripped of any directory prefixes, is substituted for res_name. .LP The -.ZN XmbSetWMProperties +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties -convenience functions provide a simple programming interface -for setting those essential window properties that are used +.B Xutf8SetWMProperties +convenience functions provide a simple programming interface +for setting those essential window properties that are used for communicating with other clients (particularly window and session managers). .LP @@ -192,48 +159,48 @@ they set the WM_NAME property. If the icon_name argument is non-NULL, they set the WM_ICON_NAME property. The window_name and icon_name arguments are null-terminated strings, for -.ZN XmbSetWMProperties +.B XmbSetWMProperties in the encoding of the current locale, for -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties in UTF-8 encoding. If the arguments can be fully converted to the STRING encoding, -the properties are created with type ``STRING''; -otherwise, the arguments are converted to Compound Text, -and the properties are created with type ``COMPOUND_TEXT''. +the properties are created with type \*(lqSTRING\*(rq; +otherwise, the arguments are converted to Compound Text, +and the properties are created with type \*(lqCOMPOUND_TEXT\*(rq. .LP If the normal_hints argument is non-NULL, -.ZN XmbSetWMProperties +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties call -.ZN XSetWMNormalHints , +.BR XSetWMNormalHints , which sets the WM_NORMAL_HINTS property (see section 14.1.7). -If the wm_hints argument is non-NULL, -.ZN XmbSetWMProperties +If the wm_hints argument is non-NULL, +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties call -.ZN XSetWMHints , +.BR XSetWMHints , which sets the WM_HINTS property (see section 14.1.6). .LP If the argv argument is non-NULL, -.ZN XmbSetWMProperties +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties set the WM_COMMAND property from argv and argc. An argc of zero indicates a zero-length command. .LP -The hostname of the machine is stored using -.ZN XSetWMClientMachine +The hostname of the machine is stored using +.B XSetWMClientMachine (see section 14.2.2). .LP If the class_hints argument is non-NULL, -.ZN XmbSetWMProperties +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties set the WM_CLASS property. -If the res_name member in the -.ZN XClassHint +If the res_name member in the +.B XClassHint structure is set to the NULL pointer and the RESOURCE_NAME environment variable is set, the value of the environment variable is substituted for res_name. @@ -251,29 +218,30 @@ No encoding conversion is performed for these strings prior to storage in the properties. .LP For clients that need to process the property text in a locale, -.ZN XmbSetWMProperties +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties set the WM_LOCALE_NAME property to be the name of the current locale. The name is assumed to be in the Host Portable Character Encoding and is converted to STRING for storage in the property. .LP -.ZN XSetWMProperties , -.ZN XmbSetWMProperties +.BR XSetWMProperties , +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The function -.ZN Xutf8SetWMProperties -is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 -release. Its presence is +.B Xutf8SetWMProperties +is an extension introduced by The XFree86 Project, Inc., in their 4.0.2 +release. +Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH PROPERTIES .TP 1i \s-1WM_CLASS\s+1 @@ -289,8 +257,8 @@ application. .TP 1i \s-1WM_HINTS\s+1 Additional hints set by the client for use by the window manager. -The C type of this property is -.ZN XWMHints . +The C type of this property is +.BR XWMHints . .TP 1i \s-1WM_ICON_NAME\s+1 The name to be used in an icon. @@ -301,13 +269,13 @@ The name of the application. \s-1WM_NORMAL_HINTS\s+1 Size hints for a window in its normal state. The C type of this property is -.ZN XSizeHints . +.BR XSizeHints . .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/lib/libX11/man/XSetWMProtocols.man b/lib/libX11/man/XSetWMProtocols.man index d43510745..d684dccde 100644 --- a/lib/libX11/man/XSetWMProtocols.man +++ b/lib/libX11/man/XSetWMProtocols.man @@ -38,111 +38,76 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSetWMProtocols __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSetWMProtocols, XGetWMProtocols \- set or read a window's WM_PROTOCOLS property .SH SYNTAX .HP Status XSetWMProtocols\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Atom -*\fIprotocols\fP\^, int \fIcount\fP\^); +*\fIprotocols\fP\^, int \fIcount\fP\^); .HP Status XGetWMProtocols\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Atom -**\fIprotocols_return\fP\^, int *\fIcount_return\fP\^); +**\fIprotocols_return\fP\^, int *\fIcount_return\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. -.ds Cn protocols in the list .IP \fIcount\fP 1i -Specifies the number of \*(Cn. -.ds Cn protocols in the list +Specifies the number of protocols in the list. .IP \fIcount_return\fP 1i -Returns the number of \*(Cn. +Returns the number of protocols in the list. .IP \fIprotocols\fP 1i Specifies the list of protocols. .IP \fIprotocols_return\fP 1i Returns the list of protocols. .SH DESCRIPTION -The -.ZN XSetWMProtocols -function replaces the WM_PROTOCOLS property on the specified window +The +.B XSetWMProtocols +function replaces the WM_PROTOCOLS property on the specified window with the list of atoms specified by the protocols argument. If the property does not already exist, -.ZN XSetWMProtocols +.B XSetWMProtocols sets the WM_PROTOCOLS property on the specified window to the list of atoms specified by the protocols argument. The property is stored with a type of ATOM and a format of 32. -If it cannot intern the WM_PROTOCOLS atom, -.ZN XSetWMProtocols +If it cannot intern the WM_PROTOCOLS atom, +.B XSetWMProtocols returns a zero status. Otherwise, it returns a nonzero status. .LP -.ZN XSetWMProtocols +.B XSetWMProtocols can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP -The -.ZN XGetWMProtocols -function returns the list of atoms stored in the WM_PROTOCOLS property +The +.B XGetWMProtocols +function returns the list of atoms stored in the WM_PROTOCOLS property on the specified window. -These atoms describe window manager protocols in which the owner +These atoms describe window manager protocols in which the owner of this window is willing to participate. -If the property exists, is of type ATOM, is of format 32, -and the atom WM_PROTOCOLS can be interned, -.ZN XGetWMProtocols -sets the protocols_return argument to a list of atoms, -sets the count_return argument to the number of elements in the list, +If the property exists, is of type ATOM, is of format 32, +and the atom WM_PROTOCOLS can be interned, +.B XGetWMProtocols +sets the protocols_return argument to a list of atoms, +sets the count_return argument to the number of elements in the list, and returns a nonzero status. Otherwise, it sets neither of the return arguments and returns a zero status. To release the list of atoms, use -.ZN XFree . +.BR XFree . .LP -.ZN XGetWMProtocols +.B XGetWMProtocols can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -151,10 +116,10 @@ List of atoms that identify the communications protocols between the client and window manager in which the client is willing to participate. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/lib/libX11/man/XStoreBytes.man b/lib/libX11/man/XStoreBytes.man index c57d5b55e..e2dd461f6 100644 --- a/lib/libX11/man/XStoreBytes.man +++ b/lib/libX11/man/XStoreBytes.man @@ -38,68 +38,34 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XStoreBytes __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XStoreBytes, XStoreBuffer, XFetchBytes, XFetchBuffer, XRotateBuffers \- manipulate cut and paste buffers .SH SYNTAX .HP int XStoreBytes\^(\^Display *\fIdisplay\fP\^, char *\fIbytes\fP\^, int -\^\fInbytes\fP\^); +\^\fInbytes\fP\^); .HP int XStoreBuffer\^(\^Display *\fIdisplay\fP\^, char *\fIbytes\fP\^, int -\^\fInbytes\fP\^, int \fIbuffer\fP\^); +\^\fInbytes\fP\^, int \fIbuffer\fP\^); .HP -char *XFetchBytes\^(\^Display *\fIdisplay\fP\^, int *\fInbytes_return\fP\^); +char *XFetchBytes\^(\^Display *\fIdisplay\fP\^, int *\fInbytes_return\fP\^); .HP char *XFetchBuffer\^(\^Display *\fIdisplay\fP\^, int *\fInbytes_return\fP\^, -int \fIbuffer\fP\^); +int \fIbuffer\fP\^); .HP -int XRotateBuffers\^(\^Display *\fIdisplay\fP\^, int \fIrotate\fP\^); +int XRotateBuffers\^(\^Display *\fIdisplay\fP\^, int \fIrotate\fP\^); .SH ARGUMENTS -.ds Fn in which you want to store the bytes \ -or from which you want the stored data returned .IP \fIbuffer\fP 1i -Specifies the buffer \*(Fn. +Specifies the buffer in which you want to store the bytes +or from which you want the stored data returned. .IP \fIbytes\fP 1i Specifies the bytes, which are not necessarily ASCII or null-terminated. .IP \fIdisplay\fP 1i @@ -115,24 +81,24 @@ The data can have embedded null characters and need not be null-terminated. The cut buffer's contents can be retrieved later by any client calling -.ZN XFetchBytes . +.BR XFetchBytes . .LP -.ZN XStoreBytes +.B XStoreBytes can generate a -.ZN BadAlloc +.B BadAlloc error. .LP If an invalid buffer is specified, the call has no effect. The data can have embedded null characters and need not be null-terminated. .LP -.ZN XStoreBuffer +.B XStoreBuffer can generate a -.ZN BadAlloc +.B BadAlloc error. .LP The -.ZN XFetchBytes +.B XFetchBytes function returns the number of bytes in the nbytes_return argument, if the buffer contains data. @@ -140,51 +106,52 @@ Otherwise, the function returns NULL and sets nbytes to 0. The appropriate amount of storage is allocated and the pointer returned. The client must free this storage when finished with it by calling -.ZN XFree . +.BR XFree . .LP The -.ZN XFetchBuffer -function returns zero to the nbytes_return argument +.B XFetchBuffer +function returns zero to the nbytes_return argument if there is no data in the buffer or if an invalid buffer is specified. .LP -.ZN XFetchBuffer +.B XFetchBuffer can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XRotateBuffers +.B XRotateBuffers function rotates the cut -buffers, such that buffer 0 becomes buffer n, +buffers, such that buffer 0 becomes buffer n, buffer 1 becomes n + 1 mod 8, and so on. This cut buffer numbering is global to the display. Note that -.ZN XRotateBuffers +.B XRotateBuffers generates -.ZN BadMatch +.B BadMatch errors if any of the eight buffers have not been created. .LP -.ZN XRotateBuffers +.B XRotateBuffers can generate a -.ZN BadMatch +.B BadMatch error. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XFree(__libmansuffix__) diff --git a/lib/libX11/man/XStoreColors.man b/lib/libX11/man/XStoreColors.man index b487390b5..cd585ee8e 100644 --- a/lib/libX11/man/XStoreColors.man +++ b/lib/libX11/man/XStoreColors.man @@ -38,63 +38,29 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XStoreColors __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XStoreColors, XStoreColor, XStoreNamedColor \- set colors .SH SYNTAX .HP int XStoreColors\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, -XColor \fIcolor\fP\^[\^]\^, int \fIncolors\fP\^); +XColor \fIcolor\fP\^[\^]\^, int \fIncolors\fP\^); .HP int XStoreColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, -XColor *\fIcolor\fP\^); +XColor *\fIcolor\fP\^); .HP int XStoreNamedColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, char *\^\fIcolor\fP\^, unsigned long \fIpixel\fP\^, int \fIflags\fP\^); .SH ARGUMENTS -.ds Co pixel and RGB values or the color name string (for example, red) .IP \fIcolor\fP 1i -Specifies the \*(Co. +Specifies the pixel and RGB values or the color name string (for example, red). .IP \fIcolor\fP 1i Specifies an array of color definition structures to be stored. .IP \fIcolormap\fP 1i @@ -104,136 +70,137 @@ Specifies the connection to the X server. .IP \fIflags\fP 1i Specifies which red, green, and blue components are set. .IP \fIncolors\fP 1i -.\"Specifies the number of color definition structures. -Specifies the number of -.ZN XColor +.\"Specifies the number of color definition structures. +Specifies the number of +.B XColor structures in the color definition array. .IP \fIpixel\fP 1i -Specifies the entry in the colormap. +Specifies the entry in the colormap. .SH DESCRIPTION The -.ZN XStoreColors +.B XStoreColors function changes the colormap entries of the pixel values specified in the pixel members of the -.ZN XColor +.B XColor structures. -You specify which color components are to be changed by setting -.ZN DoRed , -.ZN DoGreen , +You specify which color components are to be changed by setting +.BR DoRed , +.BR DoGreen , and/or -.ZN DoBlue +.B DoBlue in the flags member of the -.ZN XColor +.B XColor structures. If the colormap is an installed map for its screen, the changes are visible immediately. -.ZN XStoreColors -changes the specified pixels if they are allocated writable in the colormap +.B XStoreColors +changes the specified pixels if they are allocated writable in the colormap by any client, even if one or more pixels generates an error. If a specified pixel is not a valid index into the colormap, a -.ZN BadValue +.B BadValue error results. If a specified pixel either is unallocated or is allocated read-only, a -.ZN BadAccess +.B BadAccess error results. -If more than one pixel is in error, +If more than one pixel is in error, the one that gets reported is arbitrary. .LP -.ZN XStoreColors +.B XStoreColors can generate -.ZN BadAccess , -.ZN BadColor , +.BR BadAccess , +.BR BadColor , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XStoreColor +.B XStoreColor function changes the colormap entry of the pixel value specified in the pixel member of the -.ZN XColor +.B XColor structure. You specified this value in the pixel member of the -.ZN XColor +.B XColor structure. This pixel value must be a read/write cell and a valid index into the colormap. If a specified pixel is not a valid index into the colormap, a -.ZN BadValue +.B BadValue error results. -.ZN XStoreColor +.B XStoreColor also changes the red, green, and/or blue color components. You specify which color components are to be changed by setting -.ZN DoRed , -.ZN DoGreen , +.BR DoRed , +.BR DoGreen , and/or -.ZN DoBlue +.B DoBlue in the flags member of the -.ZN XColor +.B XColor structure. -If the colormap is an installed map for its screen, +If the colormap is an installed map for its screen, the changes are visible immediately. .LP -.ZN XStoreColor +.B XStoreColor can generate -.ZN BadAccess , -.ZN BadColor , -and -.ZN BadValue +.BR BadAccess , +.BR BadColor , +and +.B BadValue errors. .LP The -.ZN XStoreNamedColor +.B XStoreNamedColor function looks up the named color with respect to the screen associated with the colormap and stores the result in the specified colormap. The pixel argument determines the entry in the colormap. -The flags argument determines which of the red, green, and blue components -are set. +The flags argument determines which of the red, green, and blue components +are set. You can set this member to the -bitwise inclusive OR of the bits -.ZN DoRed , -.ZN DoGreen , -and -.ZN DoBlue . -If the color name is not in the Host Portable Character Encoding, +bitwise inclusive OR of the bits +.BR DoRed , +.BR DoGreen , +and +.BR DoBlue . +If the color name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. If the specified pixel is not a valid index into the colormap, a -.ZN BadValue +.B BadValue error results. If the specified pixel either is unallocated or is allocated read-only, a -.ZN BadAccess +.B BadAccess error results. .LP -.ZN XStoreNamedColor +.B XStoreNamedColor can generate -.ZN BadAccess , -.ZN BadColor , -.ZN BadName , +.BR BadAccess , +.BR BadColor , +.BR BadName , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to free a color map entry that it did not already allocate. .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to store into a read-only color map entry. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadName +.B BadName A font or color of the specified name does not exist. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XAllocColor(__libmansuffix__), diff --git a/lib/libX11/man/XStringListToTextProperty.man b/lib/libX11/man/XStringListToTextProperty.man index d990525f6..fdc62a4eb 100644 --- a/lib/libX11/man/XStringListToTextProperty.man +++ b/lib/libX11/man/XStringListToTextProperty.man @@ -39,65 +39,30 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. +.\" It is provided "as is" without express or implied warranty. +.\" .\" -.\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XStringListToTextProperty __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XStringListToTextProperty, XTextPropertyToStringList, XFreeStringList, XTextProperty \- convert string lists and text property structure .SH SYNTAX .HP Status XStringListToTextProperty\^(\^char **\fIlist\fP\^, int \fIcount\fP\^, -XTextProperty *\fItext_prop_return\fP\^); +XTextProperty *\fItext_prop_return\fP\^); .HP Status XTextPropertyToStringList\^(\^XTextProperty *\fItext_prop\fP\^, char -***\fIlist_return\fP\^, int *\fIcount_return\fP\^); +***\fIlist_return\fP\^, int *\fIcount_return\fP\^); .HP -void XFreeStringList\^(\^char **\fIlist\fP\^); +void XFreeStringList\^(\^char **\fIlist\fP\^); .SH ARGUMENTS -.ds Cn strings .IP \fIcount\fP 1i -Specifies the number of \*(Cn. -.ds Cn strings +Specifies the number of strings. .IP \fIcount_return\fP 1i -Returns the number of \*(Cn. +Returns the number of strings. .IP \fIlist\fP 1i Specifies the list of strings to be freed. .IP \fIlist\fP 1i @@ -106,71 +71,71 @@ Specifies a list of null-terminated character strings. Returns a list of null-terminated character strings. .IP \fItext_prop\fP 1i Specifies the -.ZN XTextProperty +.B XTextProperty structure to be used. .IP \fItext_prop_return\fP 1i Returns the -.ZN XTextProperty +.B XTextProperty structure. .SH DESCRIPTION -The -.ZN XStringListToTextProperty -function sets the specified -.ZN XTextProperty +The +.B XStringListToTextProperty +function sets the specified +.B XTextProperty to be of type STRING (format 8) with a value representing the concatenation of the specified list of null-separated character strings. -An extra null byte (which is not included in the nitems member) +An extra null byte (which is not included in the nitems member) is stored at the end of the value field of text_prop_return. The strings are assumed (without verification) to be in the STRING encoding. -If insufficient memory is available for the new value string, -.ZN XStringListToTextProperty +If insufficient memory is available for the new value string, +.B XStringListToTextProperty does not set any fields in the -.ZN XTextProperty +.B XTextProperty structure and returns a zero status. Otherwise, it returns a nonzero status. -To free the storage for the value field, use -.ZN XFree . +To free the storage for the value field, use +.BR XFree . .LP -The -.ZN XTextPropertyToStringList -function returns a list of strings representing the null-separated elements +The +.B XTextPropertyToStringList +function returns a list of strings representing the null-separated elements of the specified -.ZN XTextProperty +.B XTextProperty structure. -The data in text_prop must be of type STRING and format 8. -Multiple elements of the property -(for example, the strings in a disjoint text selection) +The data in text_prop must be of type STRING and format 8. +Multiple elements of the property +(for example, the strings in a disjoint text selection) are separated by NULL (encoding 0). The contents of the property are not null-terminated. -If insufficient memory is available for the list and its elements, -.ZN XTextPropertyToStringList +If insufficient memory is available for the list and its elements, +.B XTextPropertyToStringList sets no return values and returns a zero status. Otherwise, it returns a nonzero status. -To free the storage for the list and its contents, use -.ZN XFreeStringList . +To free the storage for the list and its contents, use +.BR XFreeStringList . .LP -The -.ZN XFreeStringList -function releases memory allocated by -.ZN XmbTextPropertyToTextList , -.ZN Xutf8TextPropertyToTextList +The +.B XFreeStringList +function releases memory allocated by +.BR XmbTextPropertyToTextList , +.B Xutf8TextPropertyToTextList and -.ZN XTextPropertyToStringList -and the missing charset list allocated by -.ZN XCreateFontSet . +.B XTextPropertyToStringList +and the missing charset list allocated by +.BR XCreateFontSet . .SH STRUCTURES The -.ZN XTextProperty +.B XTextProperty structure contains: .LP -.Ds 0 +.EX typedef struct { unsigned char *value; /\&* property data */ Atom encoding; /\&* type of property */ int format; /\&* 8, 16, or 32 */ unsigned long nitems; /\&* number of items in value */ } XTextProperty; -.De +.EE .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), XAllocIconSize(__libmansuffix__), diff --git a/lib/libX11/man/XStringToKeysym.man b/lib/libX11/man/XStringToKeysym.man index 3a7fb7b18..14bc0d627 100644 --- a/lib/libX11/man/XStringToKeysym.man +++ b/lib/libX11/man/XStringToKeysym.man @@ -38,62 +38,29 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XStringToKeysym __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XStringToKeysym, XKeysymToString, XKeycodeToKeysym, XKeysymToKeycode, XConvertCase \- convert keysyms .SH SYNTAX .HP -KeySym XStringToKeysym\^(\^char *\fIstring\fP\^); +KeySym XStringToKeysym\^(\^char *\fIstring\fP\^); .HP -char *XKeysymToString\^(\^KeySym \fIkeysym\fP\^); +char *XKeysymToString\^(\^KeySym \fIkeysym\fP\^); .HP KeySym XKeycodeToKeysym\^(\^Display *\fIdisplay\fP\^, KeyCode \fIkeycode\fP\^, -int \fIindex\fP\^); +int \fIindex\fP\^); .HP KeyCode XKeysymToKeycode\^(\^Display *\fIdisplay\fP\^, KeySym \fIkeysym\fP\^); .HP void XConvertCase(\^KeySym \fIkeysym\fP\^, KeySym *\fIlower_return\fP\^, -KeySym *\fIupper_return\fP\^); +KeySym *\fIupper_return\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -101,9 +68,8 @@ Specifies the connection to the X server. Specifies the element of KeyCode vector. .IP \fIkeycode\fP 1i Specifies the KeyCode. -.ds Fn searched for or converted .IP \fIkeysym\fP 1i -Specifies the KeySym that is to be \*(Fn. +Specifies the KeySym that is to be searched for or converted. .IP \fIlower_return\fP 1i Returns the lowercase form of keysym, or keysym. .IP \fIstring\fP 1i @@ -116,42 +82,43 @@ Standard KeySym names are obtained from by removing the XK_ prefix from each name. KeySyms that are not part of the Xlib standard also may be obtained with this function. -The set of KeySyms that are available in this manner +The set of KeySyms that are available in this manner and the mechanisms by which Xlib obtains them is implementation-dependent. .LP If the KeySym name is not in the Host Portable Character Encoding, the result is implementation-dependent. If the specified string does not match a valid KeySym, -.ZN XStringToKeysym +.B XStringToKeysym returns -.ZN NoSymbol . +.BR NoSymbol . .LP The returned string is in a static area and must not be modified. The returned string is in the Host Portable Character Encoding. If the specified KeySym is not defined, -.ZN XKeysymToString +.B XKeysymToString returns a NULL. .LP The -.ZN XKeycodeToKeysym +.B XKeycodeToKeysym function uses internal Xlib tables and returns the KeySym defined for the specified KeyCode and the element of the KeyCode vector. If no symbol is defined, -.ZN XKeycodeToKeysym +.B XKeycodeToKeysym returns -.ZN NoSymbol . -.ZN XKeycodeToKeysym -predates the XKB extension. If you want to lookup a KeySym while +.BR NoSymbol . +.B XKeycodeToKeysym +predates the XKB extension. +If you want to lookup a KeySym while using XKB you have to use -.ZN XkbKeycodeToKeysym . +.BR XkbKeycodeToKeysym . .LP If the specified KeySym is not defined for any KeyCode, -.ZN XKeysymToKeycode +.B XKeysymToKeycode returns zero. .LP The -.ZN XConvertCase +.B XConvertCase function returns the uppercase and lowercase forms of the specified Keysym, if the KeySym is subject to case conversion; otherwise, the specified KeySym is returned to both lower_return and diff --git a/lib/libX11/man/XSupportsLocale.man b/lib/libX11/man/XSupportsLocale.man index f0e4853ed..348aa09dc 100644 --- a/lib/libX11/man/XSupportsLocale.man +++ b/lib/libX11/man/XSupportsLocale.man @@ -39,78 +39,45 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSupportsLocale __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XSupportsLocale, XSetLocaleModifiers \- determine locale support and configure locale modifiers .SH SYNTAX .HP -Bool XSupportsLocale\^(void); +Bool XSupportsLocale\^(void); .HP -char *XSetLocaleModifiers\^(\^char *\fImodifier_list\fP\^); +char *XSetLocaleModifiers\^(\^char *\fImodifier_list\fP\^); .SH ARGUMENTS .IP \fImodifier_list\fP 1i Specifies the modifiers. .SH DESCRIPTION -The -.ZN XSupportsLocale -function returns -.ZN True +The +.B XSupportsLocale +function returns +.B True if Xlib functions are capable of operating under the current locale. -If it returns -.ZN False , -Xlib locale-dependent functions for which the -.ZN XLocaleNotSupported -return status is defined will return -.ZN XLocaleNotSupported . -Other Xlib locale-dependent routines will operate in the ``C'' locale. +If it returns +.BR False , +Xlib locale-dependent functions for which the +.B XLocaleNotSupported +return status is defined will return +.BR XLocaleNotSupported . +Other Xlib locale-dependent routines will operate in the \*(lqC\*(rq locale. .LP The -.ZN XSetLocaleModifiers +.B XSetLocaleModifiers function sets the X modifiers for the current locale setting. The modifier_list argument is a null-terminated string of the form -``{@\^\fIcategory\fP\^=\^\fIvalue\fP\^}'', that is, -having zero or more concatenated ``@\^\fIcategory\fP\^=\^\fIvalue\fP\^'' -entries, where \fIcategory\fP is a category name +\*(lq{@\^\fIcategory\fP\^=\^\fIvalue\fP\^}\*(rq, that is, +having zero or more concatenated \*(lq@\^\fIcategory\fP\^=\^\fIvalue\fP\^\*(rq +entries, where \fIcategory\fP is a category name and \fIvalue\fP is the (possibly empty) setting for that category. The values are encoded in the current locale. Category names are restricted to the POSIX Portable Filename Character Set. @@ -130,7 +97,7 @@ If the function is successful, it returns a pointer to a string. The contents of the string are such that a subsequent call with that string (in the same locale) will restore the modifiers to the same settings. If modifier_list is a NULL pointer, -.ZN XSetLocaleModifiers +.B XSetLocaleModifiers also returns a pointer to such a string, and the current locale modifiers are not changed. .LP @@ -140,15 +107,16 @@ current modifiers are changed. .LP At program startup, the modifiers that are in effect are unspecified until -the first successful call to set them. Whenever the locale is changed, the +the first successful call to set them. +Whenever the locale is changed, the modifiers that are in effect become unspecified until the next successful call to set them. Clients should always call -.ZN XSetLocaleModifiers +.B XSetLocaleModifiers with a non-NULL modifier_list after setting the locale before they call any locale-dependent Xlib routine. .LP -The only standard modifier category currently defined is ``im'', +The only standard modifier category currently defined is \*(lqim\*(rq, which identifies the desired input method. The values for input method are not standardized. A single locale may use multiple input methods, diff --git a/lib/libX11/man/XSynchronize.man b/lib/libX11/man/XSynchronize.man index f99facc55..2a6129f76 100644 --- a/lib/libX11/man/XSynchronize.man +++ b/lib/libX11/man/XSynchronize.man @@ -38,79 +38,46 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XSynchronize __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME -XSynchronize, XSetAfterFunction \- enable or disable synchronization +XSynchronize, XSetAfterFunction \- enable or disable synchronization .SH SYNTAX .HP -int (*XSynchronize\^(\^Display *\fIdisplay\fP\^, Bool \fIonoff\fP\^))(); +int (*XSynchronize\^(\^Display *\fIdisplay\fP\^, Bool \fIonoff\fP\^))(); .HP int (*XSetAfterFunction\^(\^Display *\fIdisplay\fP\^, int -(\^*\^\fIprocedure\fP\^)\^()))(); +(\^*\^\fIprocedure\fP\^)\^()))(); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIprocedure\fP 1i Specifies the procedure to be called. .IP \fIonoff\fP 1i -Specifies a Boolean value that indicates whether to enable +Specifies a Boolean value that indicates whether to enable or disable synchronization. .SH DESCRIPTION The -.ZN XSynchronize -function returns +.B XSynchronize +function returns the previous after function. -If onoff is -.ZN True , -.ZN XSynchronize +If onoff is +.BR True , +.B XSynchronize turns on synchronous behavior. If onoff is -.ZN False , -.ZN XSynchronize +.BR False , +.B XSynchronize turns off synchronous behavior. .LP The specified procedure is called with only a display pointer. -.ZN XSetAfterFunction +.B XSetAfterFunction returns the previous after function. .SH "SEE ALSO" XSetErrorHandler(__libmansuffix__) diff --git a/lib/libX11/man/XTextExtents.man b/lib/libX11/man/XTextExtents.man index cd8f37a92..752fa2c5c 100644 --- a/lib/libX11/man/XTextExtents.man +++ b/lib/libX11/man/XTextExtents.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XTextExtents __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XTextExtents, XTextExtents16, XQueryTextExtents, XQueryTextExtents16 \- compute or query text extents @@ -86,12 +53,12 @@ XTextExtents, XTextExtents16, XQueryTextExtents, XQueryTextExtents16 \- compute int XTextExtents\^(\^XFontStruct *\fIfont_struct\fP\^, char *\fIstring\fP\^, int \fInchars\fP\^, int *\fIdirection_return\fP\^, int *\fIfont_ascent_return\fP, int *\fIfont_descent_return\fP\^, XCharStruct -*\fIoverall_return\fP\^); +*\fIoverall_return\fP\^); .HP int XTextExtents16\^(\^XFontStruct *\fIfont_struct\fP\^, XChar2b *\fIstring\fP\^, int \fInchars\fP\^, int *\fIdirection_return\fP\^, int *\fIfont_ascent_return\fP, int *\fIfont_descent_return\fP\^, XCharStruct -*\fIoverall_return\fP\^); +*\fIoverall_return\fP\^); .HP int XQueryTextExtents\^(\^Display *\fIdisplay\fP\^, XID \fIfont_ID\fP\^, char *\fIstring\fP\^, int \fInchars\fP\^, int *\fIdirection_return\fP\^, int @@ -101,26 +68,26 @@ int XQueryTextExtents\^(\^Display *\fIdisplay\fP\^, XID \fIfont_ID\fP\^, char int XQueryTextExtents16\^(\^Display *\fIdisplay\fP\^, XID \fIfont_ID\fP\^, XChar2b *\fIstring\fP\^, int \fInchars\fP\^, int *\fIdirection_return\fP\^, int *\fIfont_ascent_return\fP, int *\fIfont_descent_return\fP\^, XCharStruct -*\fIoverall_return\fP\^); +*\fIoverall_return\fP\^); .SH ARGUMENTS .IP \fIdirection_return\fP 1i Returns the value of the direction hint .Pn ( FontLeftToRight or -.ZN FontRightToLeft ). +.BR FontRightToLeft ). .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIfont_ID\fP 1i -Specifies either the font ID or the -.ZN GContext +Specifies either the font ID or the +.B GContext ID that contains the font. .IP \fIfont_ascent_return\fP 1i Returns the font ascent. .IP \fIfont_descent_return\fP 1i Returns the font descent. .IP \fIfont_struct\fP 1i -Specifies the -.ZN XFontStruct +Specifies the +.B XFontStruct structure. .IP \fInchars\fP 1i Specifies the number of characters in the character string. @@ -128,21 +95,21 @@ Specifies the number of characters in the character string. Specifies the character string. .IP \fIoverall_return\fP 1i Returns the overall size in the specified -.ZN XCharStruct +.B XCharStruct structure. .SH DESCRIPTION The -.ZN XTextExtents +.B XTextExtents and -.ZN XTextExtents16 -functions +.B XTextExtents16 +functions perform the size computation locally and, thereby, avoid the round-trip overhead of -.ZN XQueryTextExtents +.B XQueryTextExtents and -.ZN XQueryTextExtents16 . +.BR XQueryTextExtents16 . Both functions return an -.ZN XCharStruct +.B XCharStruct structure, whose members are set to the values as follows. .LP The ascent member is set to the maximum of the ascent metrics of all @@ -151,7 +118,7 @@ The descent member is set to the maximum of the descent metrics. The width member is set to the sum of the character-width metrics of all characters in the string. For each character in the string, -let W be the sum of the character-width metrics of all characters preceding +let W be the sum of the character-width metrics of all characters preceding it in the string. Let L be the left-side-bearing metric of the character plus W. Let R be the right-side-bearing metric of the character plus W. @@ -159,33 +126,33 @@ The lbearing member is set to the minimum L of all characters in the string. The rbearing member is set to the maximum R. .LP For fonts defined with linear indexing rather than 2-byte matrix indexing, -each -.ZN XChar2b -structure is interpreted as a 16-bit number with byte1 as the +each +.B XChar2b +structure is interpreted as a 16-bit number with byte1 as the most significant byte. If the font has no defined default character, undefined characters in the string are taken to have all zero metrics. .LP The -.ZN XQueryTextExtents +.B XQueryTextExtents and -.ZN XQueryTextExtents16 +.B XQueryTextExtents16 functions return the bounding box of the specified 8-bit and 16-bit character string in the specified font or the font contained in the specified GC. These functions query the X server and, therefore, suffer the round-trip overhead that is avoided by -.ZN XTextExtents -and -.ZN XTextExtents16 . +.B XTextExtents +and +.BR XTextExtents16 . Both functions return a -.ZN XCharStruct +.B XCharStruct structure, whose members are set to the values as follows. .LP -The ascent member is set to the maximum of the ascent metrics +The ascent member is set to the maximum of the ascent metrics of all characters in the string. The descent member is set to the maximum of the descent metrics. -The width member is set to the sum of the character-width metrics +The width member is set to the sum of the character-width metrics of all characters in the string. For each character in the string, let W be the sum of the character-width metrics of all characters preceding @@ -196,9 +163,9 @@ The lbearing member is set to the minimum L of all characters in the string. The rbearing member is set to the maximum R. .LP For fonts defined with linear indexing rather than 2-byte matrix indexing, -each -.ZN XChar2b -structure is interpreted as a 16-bit number with byte1 as the +each +.B XChar2b +structure is interpreted as a 16-bit number with byte1 as the most significant byte. If the font has no defined default character, undefined characters in the string are taken to have all zero metrics. @@ -207,20 +174,20 @@ Characters with all zero metrics are ignored. If the font has no defined default_char, the undefined characters in the string are also ignored. .LP -.ZN XQueryTextExtents +.B XQueryTextExtents and -.ZN XQueryTextExtents16 +.B XQueryTextExtents16 can generate -.ZN BadFont +.B BadFont and -.ZN BadGC +.B BadGC errors. .SH DIAGNOSTICS .TP 1i -.ZN BadFont +.B BadFont A value for a Font or GContext argument does not name a defined Font. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .SH "SEE ALSO" XLoadFont(__libmansuffix__), diff --git a/lib/libX11/man/XTextWidth.man b/lib/libX11/man/XTextWidth.man index b236de9c7..5985bcbc1 100644 --- a/lib/libX11/man/XTextWidth.man +++ b/lib/libX11/man/XTextWidth.man @@ -38,56 +38,23 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XTextWidth __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XTextWidth, XTextWidth16 \- compute text width .SH SYNTAX .HP int XTextWidth\^(\^XFontStruct *\fIfont_struct\fP\^, char *\fIstring\fP\^, -int \fIcount\fP\^); +int \fIcount\fP\^); .HP int XTextWidth16\^(\^XFontStruct *\fIfont_struct\fP\^, XChar2b -*\fIstring\fP\^, int \fIcount\fP\^); +*\fIstring\fP\^, int \fIcount\fP\^); .SH ARGUMENTS .IP \fIcount\fP 1i Specifies the character count in the specified string. @@ -97,9 +64,9 @@ Specifies the font used for the width computation. Specifies the character string. .SH DESCRIPTION The -.ZN XTextWidth +.B XTextWidth and -.ZN XTextWidth16 +.B XTextWidth16 functions return the width of the specified 8-bit or 2-byte character strings. .SH "SEE ALSO" XLoadFont(__libmansuffix__), diff --git a/lib/libX11/man/XTranslateCoordinates.man b/lib/libX11/man/XTranslateCoordinates.man index cddd18049..e9cc3b69f 100644 --- a/lib/libX11/man/XTranslateCoordinates.man +++ b/lib/libX11/man/XTranslateCoordinates.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XTranslateCoordinates __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XTranslateCoordinates \- translate window coordinates @@ -86,7 +53,7 @@ XTranslateCoordinates \- translate window coordinates Bool XTranslateCoordinates\^(\^Display *\fIdisplay\fP\^, Window \fIsrc_w\fP\^, \fIdest_w\fP\^, int \fIsrc_x\fP\^, int \fIsrc_y\fP\^, int *\fIdest_x_return\fP\^, int *\fIdest_y_return\fP\^, Window -*\fIchild_return\fP\^); +*\fIchild_return\fP\^); .SH ARGUMENTS .IP \fIchild_return\fP 1i Returns the child if the coordinates are contained in a mapped child of the @@ -109,31 +76,31 @@ Specifies the source window. Specify the x and y coordinates within the source window. .SH DESCRIPTION If -.ZN XTranslateCoordinates +.B XTranslateCoordinates returns -.ZN True , +.BR True , it takes the src_x and src_y coordinates relative -to the source window's origin and returns these coordinates to +to the source window's origin and returns these coordinates to dest_x_return and dest_y_return relative to the destination window's origin. If -.ZN XTranslateCoordinates -returns -.ZN False , +.B XTranslateCoordinates +returns +.BR False , src_w and dest_w are on different screens, and dest_x_return and dest_y_return are zero. If the coordinates are contained in a mapped child of dest_w, that child is returned to child_return. Otherwise, child_return is set to -.ZN None . +.BR None . .LP -.ZN XTranslateCoordinates +.B XTranslateCoordinates can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" \fI\*(xL\fP diff --git a/lib/libX11/man/XUnmapEvent.man b/lib/libX11/man/XUnmapEvent.man index c47bc1311..314835ec0 100644 --- a/lib/libX11/man/XUnmapEvent.man +++ b/lib/libX11/man/XUnmapEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XUnmapEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XUnmapEvent \- UnmapNotify event structure .SH STRUCTURES The structure for -.ZN UnmapNotify +.B UnmapNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* UnmapNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -96,7 +63,7 @@ typedef struct { Window window; Bool from_configure; } XUnmapEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -104,16 +71,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -122,17 +89,17 @@ dispatchers. .LP The event member is set either to the unmapped window or to its parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify +.B SubstructureNotify was selected. This is the window used by the X server to report the event. The window member is set to the window that was unmapped. The from_configure member is set to -.ZN True +.B True if the event was generated as a result of a resizing of the window's parent when the window itself had a win_gravity of -.ZN UnmapGravity . +.BR UnmapGravity . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/lib/libX11/man/XUnmapWindow.man b/lib/libX11/man/XUnmapWindow.man index 87fca8886..b0010e252 100644 --- a/lib/libX11/man/XUnmapWindow.man +++ b/lib/libX11/man/XUnmapWindow.man @@ -38,54 +38,21 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XUnmapWindow __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XUnmapWindow, XUnmapSubwindows \- unmap windows .SH SYNTAX .HP -int XUnmapWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); +int XUnmapWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .HP -int XUnmapSubwindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); +int XUnmapSubwindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -93,50 +60,50 @@ Specifies the connection to the X server. Specifies the window. .SH DESCRIPTION The -.ZN XUnmapWindow +.B XUnmapWindow function unmaps the specified window and causes the X server to generate an -.ZN UnmapNotify +.B UnmapNotify .IN "UnmapNotify Event" .IN "XUnmapWindow" event. -If the specified window is already unmapped, -.ZN XUnmapWindow +If the specified window is already unmapped, +.B XUnmapWindow has no effect. Normal exposure processing on formerly obscured windows is performed. Any child window will no longer be visible until another map call is made on the parent. In other words, the subwindows are still mapped but are not visible until the parent is mapped. -Unmapping a window will generate -.ZN Expose +Unmapping a window will generate +.B Expose events on windows that were formerly obscured by it. .LP -.ZN XUnmapWindow +.B XUnmapWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XUnmapSubwindows +.B XUnmapSubwindows function unmaps all subwindows for the specified window in bottom-to-top stacking order. It causes the X server to generate an -.ZN UnmapNotify -event on each subwindow and -.ZN Expose +.B UnmapNotify +event on each subwindow and +.B Expose events on formerly obscured windows. .IN "UnmapNotify Event" Using this function is much more efficient than unmapping multiple windows one at a time because the server needs to perform much of the work only once, for all of the windows, rather than for each window. .LP -.ZN XUnmapSubwindows +.B XUnmapSubwindows can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/lib/libX11/man/XVaCreateNestedList.man b/lib/libX11/man/XVaCreateNestedList.man index 39ed727e3..44b0b5b08 100644 --- a/lib/libX11/man/XVaCreateNestedList.man +++ b/lib/libX11/man/XVaCreateNestedList.man @@ -38,62 +38,28 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XVaCreateNestedList __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XVaCreateNestedList \- allocate a nested variable argument list .SH SYNTAX typedef void * XVaNestedList; .HP -XVaNestedList XVaCreateNestedList\^(\^int \fIdummy\fP\^, ...\^); +XVaNestedList XVaCreateNestedList\^(\^int \fIdummy\fP\^, ...\^); .SH ARGUMENTS .IP \fIdummy\fP 1i Specifies an unused argument (required by ANSI C). -.ds Al .IP ... 1i -Specifies the variable length argument list\*(Al. +Specifies the variable length argument list. .SH DESCRIPTION The -.ZN XVaCreateNestedList +.B XVaCreateNestedList function allocates memory and copies its arguments into a single list pointer, which may be used as a value for arguments requiring a list value. @@ -102,7 +68,7 @@ Data passed by reference is not copied; the caller must ensure data remains valid for the lifetime of the nested list. The list should be freed using -.ZN XFree +.B XFree when it is no longer needed. .SH "SEE ALSO" \fI\*(xL\fP diff --git a/lib/libX11/man/XVisibilityEvent.man b/lib/libX11/man/XVisibilityEvent.man index b406cde95..5773e1093 100644 --- a/lib/libX11/man/XVisibilityEvent.man +++ b/lib/libX11/man/XVisibilityEvent.man @@ -38,55 +38,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XVisibilityEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XVisibilityEvent \- VisibilityNotify event structure .SH STRUCTURES The structure for -.ZN VisibilityNotify +.B VisibilityNotify events contains: .LP -.Ds 0 +.EX typedef struct { int type; /\&* VisibilityNotify */ unsigned long serial; /\&* # of last request processed by server */ @@ -95,7 +62,7 @@ typedef struct { Window window; int state; } XVisibilityEvent; -.De +.EE .LP When you receive this event, the structure members are set as follows. @@ -103,16 +70,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -121,36 +88,36 @@ dispatchers. .LP The window member is set to the window whose visibility state changes. The state member is set to the state of the window's visibility and can be -.ZN VisibilityUnobscured , -.ZN VisibilityPartiallyObscured , +.BR VisibilityUnobscured , +.BR VisibilityPartiallyObscured , or -.ZN VisibilityFullyObscured . +.BR VisibilityFullyObscured . The X server ignores all of a window's subwindows -when determining the visibility state of the window and processes -.ZN VisibilityNotify +when determining the visibility state of the window and processes +.B VisibilityNotify events according to the following: .IP \(bu 5 When the window changes state from partially obscured, fully obscured, or not viewable to viewable and completely unobscured, the X server generates the event with the state member of the -.ZN XVisibilityEvent +.B XVisibilityEvent structure set to -.ZN VisibilityUnobscured . +.BR VisibilityUnobscured . .IP \(bu 5 -When the window changes state from viewable and completely unobscured or +When the window changes state from viewable and completely unobscured or not viewable to viewable and partially obscured, the X server generates the event with the state member of the -.ZN XVisibilityEvent +.B XVisibilityEvent structure set to -.ZN VisibilityPartiallyObscured . +.BR VisibilityPartiallyObscured . .IP \(bu 5 -When the window changes state from viewable and completely unobscured, -viewable and partially obscured, or not viewable to viewable and +When the window changes state from viewable and completely unobscured, +viewable and partially obscured, or not viewable to viewable and fully obscured, the X server generates the event with the state member of the -.ZN XVisibilityEvent +.B XVisibilityEvent structure set to -.ZN VisibilityFullyObscured . +.BR VisibilityFullyObscured . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/lib/libX11/man/XWarpPointer.man b/lib/libX11/man/XWarpPointer.man index 7b10ef2cb..e4be6063b 100644 --- a/lib/libX11/man/XWarpPointer.man +++ b/lib/libX11/man/XWarpPointer.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XWarpPointer __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XWarpPointer \- move pointer @@ -86,11 +53,11 @@ XWarpPointer \- move pointer int XWarpPointer\^(\^Display *\fIdisplay\fP\^, Window \fIsrc_w\fP\^, Window \fIdest_w\fP\^, int \fIsrc_x\fP\^, int \fIsrc_y\fP\^, unsigned int \fIsrc_width\fP\^, unsigned int \fIsrc_height\fP\^, int \fIdest_x\fP\^, int -\fIdest_y\fP\^); +\fIdest_y\fP\^); .SH ARGUMENTS .IP \fIdest_w\fP 1i Specifies the destination window or -.ZN None . +.BR None . .IP \fIdest_x\fP 1i .br .ns @@ -111,19 +78,19 @@ Specifies the connection to the X server. Specify a rectangle in the source window. .IP \fIsrc_w\fP 1i Specifies the source window or -.ZN None . +.BR None . .SH DESCRIPTION If dest_w is -.ZN None , -.ZN XWarpPointer +.BR None , +.B XWarpPointer moves the pointer by the offsets (dest_x, dest_y) relative to the current position of the pointer. If dest_w is a window, -.ZN XWarpPointer +.B XWarpPointer moves the pointer to the offsets (dest_x, dest_y) relative to the origin of dest_w. However, if src_w is a window, -the move only takes place if the window src_w contains the pointer +the move only takes place if the window src_w contains the pointer and if the specified rectangle of src_w contains the pointer. .LP The src_x and src_y coordinates are relative to the origin of src_w. @@ -132,23 +99,23 @@ it is replaced with the current height of src_w minus src_y. If src_width is zero, it is replaced with the current width of src_w minus src_x. .LP -There is seldom any reason for calling this function. +There is seldom any reason for calling this function. The pointer should normally be left to the user. If you do use this function, however, it generates events just as if the user had instantaneously moved the pointer from one position to another. Note that you cannot use -.ZN XWarpPointer +.B XWarpPointer to move the pointer outside the confine_to window of an active pointer grab. An attempt to do so will only move the pointer as far as the closest edge of the -confine_to window. +confine_to window. .LP -.ZN XWarpPointer +.B XWarpPointer can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XSetInputFocus(__libmansuffix__) diff --git a/lib/libX11/man/XcmsAllocColor.man b/lib/libX11/man/XcmsAllocColor.man index ebae27cdc..c8346e322 100644 --- a/lib/libX11/man/XcmsAllocColor.man +++ b/lib/libX11/man/XcmsAllocColor.man @@ -38,53 +38,20 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XcmsAllocColor __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XcmsAllocColor, XcmsAllocNamedColor \- allocate colors .SH SYNTAX .HP Status XcmsAllocColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, -XcmsColor *\fIcolor_in_out\fP\^, XcmsColorFormat \fIresult_format\fP\^); +XcmsColor *\fIcolor_in_out\fP\^, XcmsColorFormat \fIresult_format\fP\^); .HP Status XcmsAllocNamedColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, char *\fIcolor_string\fP\^, XcmsColor @@ -98,69 +65,69 @@ Specifies the colormap. Returns the color specification parsed from the color string or parsed from the corresponding string found in a color-name database. .IP \fIcolor_in_out\fP 1i -Specifies the color to allocate and returns the pixel and color +Specifies the color to allocate and returns the pixel and color that is actually used in the colormap. .IP \fIcolor_screen_return\fP 1i -Returns the pixel value of the color cell and color specification +Returns the pixel value of the color cell and color specification that actually is stored for that cell. -.ds St \ whose color definition structure is to be returned +.ds St \ .IP \fIcolor_string\fP 1i -Specifies the color string\*(St. +Specifies the color string whose color definition structure is to be returned. .IP \fIresult_format\fP 1i Specifies the color format for the returned color specification. .SH DESCRIPTION The -.ZN XcmsAllocColor +.B XcmsAllocColor function is similar to -.ZN XAllocColor +.B XAllocColor except the color can be specified in any format. The -.ZN XcmsAllocColor -function ultimately calls -.ZN XAllocColor +.B XcmsAllocColor +function ultimately calls +.B XAllocColor to allocate a read-only color cell (colormap entry) with the specified color. -.ZN XcmsAllocColor +.B XcmsAllocColor first converts the color specified to an RGB value and then passes this to -.ZN XAllocColor . -.ZN XcmsAllocColor +.BR XAllocColor . +.B XcmsAllocColor returns the pixel value of the color cell and the color specification actually allocated. This returned color specification is the result of converting the RGB value -returned by -.ZN XAllocColor +returned by +.B XAllocColor into the format specified with the result_format argument. -If there is no interest in a returned color specification, +If there is no interest in a returned color specification, unnecessary computation can be bypassed if result_format is set to -.ZN XcmsRGBFormat . +.BR XcmsRGBFormat . The corresponding colormap cell is read-only. -If this routine returns -.ZN XcmsFailure , +If this routine returns +.BR XcmsFailure , the color_in_out color specification is left unchanged. .LP -.ZN XcmsAllocColor +.B XcmsAllocColor can generate a -.ZN BadColor +.B BadColor errors. .LP The -.ZN XcmsAllocNamedColor +.B XcmsAllocNamedColor function is similar to -.ZN XAllocNamedColor +.B XAllocNamedColor except that the color returned can be in any format specified. This function ultimately calls -.ZN XAllocColor +.B XAllocColor to allocate a read-only color cell with the color specified by a color string. The color string is parsed into an -.ZN XcmsColor +.B XcmsColor structure (see -.ZN XcmsLookupColor ), +.BR XcmsLookupColor ), converted to an RGB value, and finally passed to -.ZN XAllocColor . -If the color name is not in the Host Portable Character Encoding, +.BR XAllocColor . +If the color name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. .LP @@ -169,23 +136,23 @@ of parsing (exact specification) and the actual color specification stored (screen specification). This screen specification is the result of converting the RGB value returned by -.ZN XAllocColor +.B XAllocColor into the format specified in result_format. If there is no interest in a returned color specification, unnecessary computation can be bypassed if result_format is set to -.ZN XcmsRGBFormat . +.BR XcmsRGBFormat . If color_screen_return and color_exact_return point to the same structure, the pixel field will be set correctly, but the color values are undefined. .LP .LP -.ZN XcmsAllocNamedColor +.B XcmsAllocNamedColor can generate a -.ZN BadColor +.B BadColor errors. .SH DIAGNOSTICS .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .SH "SEE ALSO" XcmsQueryColor(__libmansuffix__), diff --git a/lib/libX11/man/XcmsCCCOfColormap.man b/lib/libX11/man/XcmsCCCOfColormap.man index 9f0dfc10c..145e83e21 100644 --- a/lib/libX11/man/XcmsCCCOfColormap.man +++ b/lib/libX11/man/XcmsCCCOfColormap.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XcmsCCCOfColormap __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XcmsCCCOfColormap, XcmsSetCCCOfColormap \- query and modify CCC of a colormap @@ -87,7 +54,7 @@ XcmsCCC XcmsCCCOfColormap\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^); .HP XcmsCCC XcmsSetCCCOfColormap\^(\^Display *\fIdisplay\fP\^, Colormap -\fIcolormap\fP\^, XcmsCCC \fIccc\fP\^); +\fIcolormap\fP\^, XcmsCCC \fIccc\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -97,24 +64,25 @@ Specifies the CCC. Specifies the colormap. .SH DESCRIPTION The -.ZN XcmsCCCOfColormap +.B XcmsCCCOfColormap function returns the CCC associated with the specified colormap. -Once obtained, +Once obtained, the CCC attributes can be queried or modified. Unless the CCC associated with the specified colormap is changed with -.ZN XcmsSetCCCOfColormap , -this CCC is used when the specified colormap is used as an argument +.BR XcmsSetCCCOfColormap , +this CCC is used when the specified colormap is used as an argument to color functions. .LP The -.ZN XcmsSetCCCOfColormap +.B XcmsSetCCCOfColormap function changes the CCC associated with the specified colormap. It returns the CCC previously associated with the colormap. If they are not used again in the application, CCCs should be freed by calling -.ZN XcmsFreeCCC . +.BR XcmsFreeCCC . Several colormaps may share the same CCC without restriction; this -includes the CCCs generated by Xlib with each colormap. Xlib, however, +includes the CCCs generated by Xlib with each colormap. +Xlib, however, creates a new CCC with each new colormap. .SH "SEE ALSO" DisplayOfCCC(__libmansuffix__), diff --git a/lib/libX11/man/XcmsCIELabQueryMaxC.man b/lib/libX11/man/XcmsCIELabQueryMaxC.man index 69ad94de3..141498c37 100644 --- a/lib/libX11/man/XcmsCIELabQueryMaxC.man +++ b/lib/libX11/man/XcmsCIELabQueryMaxC.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XcmsCIELabQueryMax __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XcmsCIELabQueryMaxC, XcmsCIELabQueryMaxL, XcmsCIELabQueryMaxLC, XcmsCIELabQueryMinL \- obtain the CIE L*a*b* coordinates @@ -90,7 +57,7 @@ Status XcmsCIELabQueryMaxL\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue_angle\fP\^, XcmsFloat \fIchroma\fP\^, XcmsColor *\fIcolor_return\fP\^); .HP Status XcmsCIELabQueryMaxLC\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat -\fIhue_angle\fP\^, XcmsColor *\fIcolor_return\fP\^); +\fIhue_angle\fP\^, XcmsColor *\fIcolor_return\fP\^); .HP Status XcmsCIELabQueryMinL\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue_angle\fP\^, XcmsFloat \fIchroma\fP\^, XcmsColor *\fIcolor_return\fP\^); @@ -99,57 +66,52 @@ Status XcmsCIELabQueryMinL\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat Specifies the CCC. Note that the CCC's Client White Point and White Point Adjustment procedures are ignored. -.ds Ch maximum lightness (MaxL) or minimum lightness (MinL) .IP \fIchroma\fP 1i -Specifies the chroma at which to find \*(Ch. -.ds Lc maximum chroma (MaxC and MaxLC), maximum lightness (MaxL), \ -or minimum lightness (MinL) -.ds lC hue angle and lightness (MaxC), hue angle and chroma (MaxL and MinL), \ -or hue angle (MaxLC) +Specifies the chroma at which to find maximum lightness (MaxL) or minimum lightness (MinL). .IP \fIcolor_return\fP 1i -Returns the CIE L*a*b* coordinates of \*(Lc -displayable by the screen for the given \*(lC. +Returns the CIE L*a*b* coordinates of +maximum chroma (MaxC and MaxLC), maximum lightness (MaxL), +or minimum lightness (MinL) +displayable by the screen for the given hue angle and lightness (MaxC), hue angle and chroma (MaxL and MinL), or hue angle (MaxLC). The white point associated with the returned color specification is the Screen White Point. The value returned in the pixel member is undefined. -.ds Ha maximum chroma (MaxC and MaxLC), maximum lightness (MaxL), \ -or minimum lightness (MinL) .IP \fIhue_angle\fP 1i -Specifies the hue angle (in degrees) at which to find \*(Ha. -.ds Ls maximum chroma (MaxC) +Specifies the hue angle (in degrees) at which to find maximum chroma (MaxC and MaxLC), maximum lightness (MaxL), +or minimum lightness (MinL). .IP \fIL_star\fP 1i -Specifies the lightness (L*) at which to find \*(Ls. +Specifies the lightness (L*) at which to find maximum chroma (MaxC). .SH DESCRIPTION The -.ZN XcmsCIELabQueryMaxC +.B XcmsCIELabQueryMaxC function, given a hue angle and lightness, finds the point of maximum chroma displayable by the screen. It returns this point in CIE L*a*b* coordinates. .LP The -.ZN XcmsCIELabQueryMaxL +.B XcmsCIELabQueryMaxL function, given a hue angle and chroma, -finds the point in CIE L*a*b* color space of maximum +finds the point in CIE L*a*b* color space of maximum lightness (L*) displayable by the screen. It returns this point in CIE L*a*b* coordinates. -An -.ZN XcmsFailure +An +.B XcmsFailure return value usually indicates that the given chroma is beyond maximum for the given hue angle. .LP The -.ZN XcmsCIELabQueryMaxLC +.B XcmsCIELabQueryMaxLC function, given a hue angle, finds the point of maximum chroma displayable by the screen. It returns this point in CIE L*a*b* coordinates. .LP The -.ZN XcmsCIELabQueryMinL +.B XcmsCIELabQueryMinL function, given a hue angle and chroma, finds the point of minimum lightness (L*) displayable by the screen. It returns this point in CIE L*a*b* coordinates. -An -.ZN XcmsFailure +An +.B XcmsFailure return value usually indicates that the given chroma is beyond maximum for the given hue angle. .SH "SEE ALSO" diff --git a/lib/libX11/man/XcmsCIELuvQueryMaxC.man b/lib/libX11/man/XcmsCIELuvQueryMaxC.man index 14a2a2262..cd09f45ba 100644 --- a/lib/libX11/man/XcmsCIELuvQueryMaxC.man +++ b/lib/libX11/man/XcmsCIELuvQueryMaxC.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XcmsCIELuvQueryMaxC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XcmsCIELuvQueryMaxC, XcmsCIELuvQueryMaxL, XcmsCIELuvQueryMaxLC, XcmsCIELuvQueryMinL \- obtain the CIE L*u*v* coordinates @@ -90,7 +57,7 @@ Status XcmsCIELuvQueryMaxL\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue_angle\fP\^, XcmsFloat \fIchroma\fP\^, XcmsColor *\fIcolor_return\fP\^); .HP Status XcmsCIELuvQueryMaxLC\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat -\fIhue_angle\fP\^, XcmsColor *\fIcolor_return\fP\^); +\fIhue_angle\fP\^, XcmsColor *\fIcolor_return\fP\^); .HP Status XcmsCIELuvQueryMinL\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue_angle\fP\^, XcmsFloat \fIchroma\fP\^, XcmsColor *\fIcolor_return\fP\^); @@ -121,35 +88,35 @@ Specifies the hue angle (in degrees) at which to find \*(Ha. Specifies the lightness (L*) at which to find \*(Ls. .SH DESCRIPTION The -.ZN XcmsCIELuvQueryMaxC +.B XcmsCIELuvQueryMaxC function, given a hue angle and lightness, finds the point of maximum chroma displayable by the screen. It returns this point in CIE L*u*v* coordinates. .LP The -.ZN XcmsCIELuvQueryMaxL +.B XcmsCIELuvQueryMaxL function, given a hue angle and chroma, -finds the point in CIE L*u*v* color space of maximum +finds the point in CIE L*u*v* color space of maximum lightness (L*) displayable by the screen. It returns this point in CIE L*u*v* coordinates. -An -.ZN XcmsFailure +An +.B XcmsFailure return value usually indicates that the given chroma is beyond maximum for the given hue angle. .LP The -.ZN XcmsCIELuvQueryMaxLC +.B XcmsCIELuvQueryMaxLC function, given a hue angle, finds the point of maximum chroma displayable by the screen. It returns this point in CIE L*u*v* coordinates. .LP The -.ZN XcmsCIELuvQueryMinL +.B XcmsCIELuvQueryMinL function, given a hue angle and chroma, finds the point of minimum lightness (L*) displayable by the screen. It returns this point in CIE L*u*v* coordinates. -An -.ZN XcmsFailure +An +.B XcmsFailure return value usually indicates that the given chroma is beyond maximum for the given hue angle. .SH "SEE ALSO" diff --git a/lib/libX11/man/XcmsColor.man b/lib/libX11/man/XcmsColor.man index 376913d97..aba9a6946 100644 --- a/lib/libX11/man/XcmsColor.man +++ b/lib/libX11/man/XcmsColor.man @@ -37,46 +37,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .de EX .sp .nf @@ -92,7 +59,7 @@ XcmsColor, XcmsRGB, XcmsRGBi, XcmsCIEXYZ, XcmsCIEuvY, XcmsCIExyY, XcmsCIELab, XcmsCIELuv, XcmsTekHVC, XcmsPad \- Xcms color structure .SH STRUCTURES The structure for -.ZN XcmsColor +.B XcmsColor contains: .LP .EX @@ -191,7 +158,7 @@ typedef struct { .EE .SH DESCRIPTION The -.ZN XcmsColor +.B XcmsColor structure contains a union of substructures, each supporting color specification encoding for a particular color space. .SH "SEE ALSO" diff --git a/lib/libX11/man/XcmsConvertColors.man b/lib/libX11/man/XcmsConvertColors.man index 941873bb9..a8a791adb 100644 --- a/lib/libX11/man/XcmsConvertColors.man +++ b/lib/libX11/man/XcmsConvertColors.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XcmsConvertColors __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XcmsConvertColors \- convert CCC color specifications @@ -85,7 +52,7 @@ XcmsConvertColors \- convert CCC color specifications .HP Status XcmsConvertColors\^(\^XcmsCCC \fIccc\fP\^, XcmsColor \fIcolors_in_out\fP\^[\^]\^, unsigned int \fIncolors\fP\^, XcmsColorFormat -\fItarget_format\fP\^, Bool \fIcompression_flags_return\fP\^[\^]\^); +\fItarget_format\fP\^, Bool \fIcompression_flags_return\fP\^[\^]\^); .SH ARGUMENTS .IP \fIccc\fP 1i Specifies the CCC. @@ -99,26 +66,26 @@ Pixel members are ignored and remain unchanged upon return. Returns an array of Boolean values indicating compression status. If a non-NULL pointer is supplied, each element of the array is set to -.ZN True +.B True if the corresponding color was compressed and -.ZN False +.B False otherwise. Pass NULL if the compression status is not useful. .IP \fIncolors\fP 1i -Specifies the number of -.ZN XcmsColor +Specifies the number of +.B XcmsColor structures in the color-specification array. .IP \fItarget_format\fP 1i Specifies the target color specification format. .SH DESCRIPTION The -.ZN XcmsConvertColors +.B XcmsConvertColors function converts the color specifications in the specified array of -.ZN XcmsColor +.B XcmsColor structures from their current format to a single target format, using the specified CCC. When the return value is -.ZN XcmsFailure , +.BR XcmsFailure , the contents of the color specification array are left unchanged. .LP The array may contain a mixture of color specification formats @@ -126,8 +93,8 @@ The array may contain a mixture of color specification formats When the array contains both device-independent and device-dependent color specifications and the target_format argument specifies a device-dependent format (for example, -.ZN XcmsRGBiFormat , -.ZN XcmsRGBFormat ), +.BR XcmsRGBiFormat , +.BR XcmsRGBFormat ), all specifications are converted to CIE XYZ format and then to the target device-dependent format. .SH "SEE ALSO" diff --git a/lib/libX11/man/XcmsCreateCCC.man b/lib/libX11/man/XcmsCreateCCC.man index 1c260170e..dc21d115f 100644 --- a/lib/libX11/man/XcmsCreateCCC.man +++ b/lib/libX11/man/XcmsCreateCCC.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XcmsCreateCCC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XcmsCreateCCC, XcmsFreeCCC \- creating and destroying CCCs @@ -87,9 +54,9 @@ XcmsCCC XcmsCreateCCC\^(\^Display *\fIdisplay\fP\^, int \fIscreen_number\fP\^, Visual *\fIvisual\fP\^, XcmsColor *\fIclient_white_point\fP\^, XcmsCompressionProc \fIcompression_proc\fP\^, XPointer \fIcompression_client_data\fP\^, XcmsWhiteAdjustProc -\fIwhite_adjust_proc\fP\^, XPointer \fIwhite_adjust_client_data\fP\^); +\fIwhite_adjust_proc\fP\^, XPointer \fIwhite_adjust_client_data\fP\^); .LP -void XcmsFreeCCC\^(\^XcmsCCC \fIccc\fP\^); +void XcmsFreeCCC\^(\^XcmsCCC \fIccc\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -97,20 +64,20 @@ Specifies the connection to the X server. Specifies the CCC. .IP \fIclient_white_point\fP 1i Specifies the Client White Point. -If NULL is specified, +If NULL is specified, the Client White Point is to be assumed to be the same as the Screen White Point. Note that the pixel member is ignored. .IP \fIcompression_client_data\fP 1i Specifies client data for use by the gamut compression procedure or NULL. .IP \fIcompression_proc\fP 1i -Specifies the gamut compression procedure that is to be applied +Specifies the gamut compression procedure that is to be applied when a color lies outside the screen's color gamut. If NULL is specified and a function using this CCC must convert a color specification to a device-dependent format and encounters a color -that lies outside the screen's color gamut, +that lies outside the screen's color gamut, that function will return -.ZN XcmsFailure . +.BR XcmsFailure . .IP \fIscreen_number\fP 1i Specifies the appropriate screen number on the host server. .IP \fIvisual\fP 1i @@ -123,11 +90,11 @@ when the Client White Point differs from the Screen White Point. NULL indicates that no white point adjustment is desired. .SH DESCRIPTION The -.ZN XcmsCreateCCC +.B XcmsCreateCCC function creates a CCC for the specified display, screen, and visual. .LP The -.ZN XcmsFreeCCC +.B XcmsFreeCCC function frees the memory used for the specified CCC. Note that default CCCs and those currently associated with colormaps are ignored. diff --git a/lib/libX11/man/XcmsDefaultCCC.man b/lib/libX11/man/XcmsDefaultCCC.man index 21bf6cfcc..3ca593188 100644 --- a/lib/libX11/man/XcmsDefaultCCC.man +++ b/lib/libX11/man/XcmsDefaultCCC.man @@ -38,53 +38,20 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XcmsDefaultCCC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XcmsDefaultCCC \- obtain the default CCC for a screen .SH SYNTAX .HP XcmsCCC XcmsDefaultCCC\^(\^Display *\fIdisplay\fP\^, int -\fIscreen_number\fP\^); +\fIscreen_number\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -92,7 +59,7 @@ Specifies the connection to the X server. Specifies the appropriate screen number on the host server. .SH DESCRIPTION The -.ZN XcmsDefaultCCC +.B XcmsDefaultCCC function returns the default CCC for the specified screen. Its visual is the default visual of the screen. Its initial gamut compression and white point diff --git a/lib/libX11/man/XcmsQueryBlack.man b/lib/libX11/man/XcmsQueryBlack.man index 4c65f9008..de0a4cc53 100644 --- a/lib/libX11/man/XcmsQueryBlack.man +++ b/lib/libX11/man/XcmsQueryBlack.man @@ -38,74 +38,39 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XcmsQueryBlack __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XcmsQueryBlack, XcmsQueryBlue, XcmsQueryGreen, XcmsQueryRed, XcmsQueryWhite \- obtain black, blue, green, red, and white CCC color specifications .SH SYNTAX .HP Status XcmsQueryBlack\^(\^XcmsCCC \fIccc\fP\^, XcmsColorFormat -\fItarget_format\fP\^, XcmsColor *\fIcolor_return\fP\^); +\fItarget_format\fP\^, XcmsColor *\fIcolor_return\fP\^); .HP Status XcmsQueryBlue\^(\^XcmsCCC \fIccc\fP\^, XcmsColorFormat -\fItarget_format\fP\^, XcmsColor *\fIcolor_return\fP\^); +\fItarget_format\fP\^, XcmsColor *\fIcolor_return\fP\^); .HP Status XcmsQueryGreen\^(\^XcmsCCC \fIccc\fP\^, XcmsColorFormat -\fItarget_format\fP\^, XcmsColor *\fIcolor_return\fP\^); +\fItarget_format\fP\^, XcmsColor *\fIcolor_return\fP\^); .HP Status XcmsQueryRed\^(\^XcmsCCC \fIccc\fP\^, XcmsColorFormat -\fItarget_format\fP\^, XcmsColor *\fIcolor_return\fP\^); +\fItarget_format\fP\^, XcmsColor *\fIcolor_return\fP\^); .HP Status XcmsQueryWhite\^(\^XcmsCCC \fIccc\fP\^, XcmsColorFormat -\fItarget_format\fP\^, XcmsColor *\fIcolor_return\fP\^); +\fItarget_format\fP\^, XcmsColor *\fIcolor_return\fP\^); .SH ARGUMENTS .IP \fIccc\fP 1i Specifies the CCC. Note that the CCC's Client White Point and White Point Adjustment procedures are ignored. -.ds Cs .IP \fIcolor_return\fP 1i -Returns the color specification in the specified target format -for \*(Cs. +Returns the color specification in the specified target format. The white point associated with the returned color specification is the Screen White Point. The value returned in the pixel member is undefined. @@ -113,27 +78,27 @@ The value returned in the pixel member is undefined. Specifies the target color specification format. .SH DESCRIPTION The -.ZN XcmsQueryBlack +.B XcmsQueryBlack function returns the color specification in the specified target format for zero-intensity red, green, and blue. .LP The -.ZN XcmsQueryBlue +.B XcmsQueryBlue function returns the color specification in the specified target format for full-intensity blue while red and green are zero. .LP The -.ZN XcmsQueryGreen +.B XcmsQueryGreen function returns the color specification in the specified target format for full-intensity green while red and blue are zero. .LP The -.ZN XcmsQueryRed +.B XcmsQueryRed function returns the color specification in the specified target format for full-intensity red while green and blue are zero. .LP The -.ZN XcmsQueryWhite +.B XcmsQueryWhite function returns the color specification in the specified target format for full-intensity red, green, and blue. .SH "SEE ALSO" diff --git a/lib/libX11/man/XcmsQueryColor.man b/lib/libX11/man/XcmsQueryColor.man index cc4742aed..6a1099fcb 100644 --- a/lib/libX11/man/XcmsQueryColor.man +++ b/lib/libX11/man/XcmsQueryColor.man @@ -38,62 +38,29 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XcmsQueryColor __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XcmsQueryColor, XcmsQueryColors, XcmsLookupColor \- obtain color values .SH SYNTAX .HP Status XcmsQueryColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, -XcmsColor *\fIcolor_in_out\fP\^, XcmsColorFormat \fIresult_format\fP\^); +XcmsColor *\fIcolor_in_out\fP\^, XcmsColorFormat \fIresult_format\fP\^); .HP Status XcmsQueryColors\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, XcmsColor \fIcolors_in_out\fP\^[\^]\^, unsigned int -\fIncolors\fP\^, XcmsColorFormat \fIresult_format\fP\^); +\fIncolors\fP\^, XcmsColorFormat \fIresult_format\fP\^); .HP Status XcmsLookupColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, char *\fIcolor_string\fP\^, XcmsColor *\fIcolor_exact_return\fP\^, XcmsColor *\fIcolor_screen_return\fP\^, -XcmsColorFormat \fIresult_format\fP\^); +XcmsColorFormat \fIresult_format\fP\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -105,97 +72,97 @@ or parsed from the corresponding string found in a color-name database. .IP \fIcolor_in_out\fP 1i Specifies the pixel member that indicates the color cell to query. The color specification stored for the color cell is returned in this -.ZN XcmsColor +.B XcmsColor structure. .IP \fIcolor_screen_return\fP 1i Returns the color that can be reproduced on the screen. -.ds St .IP \fIcolor_string\fP 1i -Specifies the color string\*(St. +Specifies the color string. .IP \fIresult_format\fP 1i Specifies the color format for the returned color specifications (color_screen_return and color_exact_return arguments). If the format is -.ZN XcmsUndefinedFormat +.B XcmsUndefinedFormat and the color string contains a numerical color specification, the specification is returned in the format used in that numerical color specification. If the format is -.ZN XcmsUndefinedFormat +.B XcmsUndefinedFormat and the color string contains a color name, -the specification is returned in the format used +the specification is returned in the format used to store the color in the database. .IP \fIncolors\fP 1i -Specifies the number of -.ZN XcmsColor +Specifies the number of +.B XcmsColor structures in the color-specification array. .SH DESCRIPTION The -.ZN XcmsQueryColor +.B XcmsQueryColor function obtains the RGB value for the pixel value in the pixel member of the specified -.ZN XcmsColor +.B XcmsColor structure and then converts the value to the target format as specified by the result_format argument. If the pixel is not a valid index in the specified colormap, a -.ZN BadValue +.B BadValue error results. The -.ZN XcmsQueryColors +.B XcmsQueryColors function obtains the RGB values for pixel values in the pixel members of -.ZN XcmsColor +.B XcmsColor structures and then converts the values to the target format as specified by the result_format argument. If a pixel is not a valid index into the specified colormap, a -.ZN BadValue +.B BadValue error results. If more than one pixel is in error, the one that gets reported is arbitrary. .LP -.ZN XcmsQueryColor +.B XcmsQueryColor and -.ZN XcmsQueryColors +.B XcmsQueryColors can generate -.ZN BadColor +.B BadColor and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XcmsLookupColor +.B XcmsLookupColor function looks up the string name of a color with respect to the screen associated with the specified colormap. It returns both the exact color values and -the closest values provided by the screen +the closest values provided by the screen with respect to the visual type of the specified colormap. The values are returned in the format specified by result_format. -If the color name is not in the Host Portable Character Encoding, +If the color name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. -.ZN XcmsLookupColor +.B XcmsLookupColor returns -.ZN XcmsSuccess +.B XcmsSuccess or -.ZN XcmsSuccessWithCompression +.B XcmsSuccessWithCompression if the name is resolved; otherwise, it returns -.ZN XcmsFailure . +.BR XcmsFailure . If -.ZN XcmsSuccessWithCompression -is returned, the color specification returned in +.B XcmsSuccessWithCompression +is returned, the color specification returned in color_screen_return is the result of gamut compression. .SH DIAGNOSTICS .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XcmsAllocColor(__libmansuffix__), diff --git a/lib/libX11/man/XcmsSetWhitePoint.man b/lib/libX11/man/XcmsSetWhitePoint.man index c44b7dee1..1258ed00b 100644 --- a/lib/libX11/man/XcmsSetWhitePoint.man +++ b/lib/libX11/man/XcmsSetWhitePoint.man @@ -38,81 +38,46 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XcmsSetWhitePoint __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XcmsSetWhitePoint, XcmsSetWhiteAdjustProc \- modifying CCC attributes .SH SYNTAX .HP -Status XcmsSetWhitePoint\^(\^XcmsCCC \fIccc\fP\^, XcmsColor *\fIcolor\fP\^); +Status XcmsSetWhitePoint\^(\^XcmsCCC \fIccc\fP\^, XcmsColor *\fIcolor\fP\^); .HP XcmsWhiteAdjustProc XcmsSetWhiteAdjustProc\^(\^XcmsCCC \fIccc\fP\^, -XcmsWhiteAdjustProc \fIwhite_adjust_proc\fP\^, XPointer \fIclient_data\fP\^); +XcmsWhiteAdjustProc \fIwhite_adjust_proc\fP\^, XPointer \fIclient_data\fP\^); .SH ARGUMENTS .IP \fIccc\fP 1i Specifies the CCC. -.ds Cd the white point adjustment procedure .IP \fIclient_data\fP 1i -Specifies client data for \*(Cd or NULL. -.ds Co new Client White Point +Specifies client data for the white point adjustment procedure or NULL. .IP \fIcolor\fP 1i -Specifies the \*(Co. +Specifies the new Client White Point. .IP \fIwhite_adjust_proc\fP 1i Specifies the white point adjustment procedure. .SH DESCRIPTION The -.ZN XcmsSetWhitePoint +.B XcmsSetWhitePoint function changes the Client White Point in the specified CCC. -Note that the pixel member is ignored +Note that the pixel member is ignored and that the color specification is left unchanged upon return. The format for the new white point must be -.ZN XcmsCIEXYZFormat , -.ZN XcmsCIEuvYFormat , -.ZN XcmsCIExyYFormat , +.BR XcmsCIEXYZFormat , +.BR XcmsCIEuvYFormat , +.BR XcmsCIExyYFormat , or -.ZN XcmsUndefinedFormat . +.BR XcmsUndefinedFormat . If the color argument is NULL, this function sets the format component of the Client White Point specification to -.ZN XcmsUndefinedFormat , +.BR XcmsUndefinedFormat , indicating that the Client White Point is assumed to be the same as the Screen White Point. .LP @@ -122,8 +87,8 @@ otherwise, it returns zero. .LP The -.ZN XcmsSetWhiteAdjustProc -function first sets the white point adjustment procedure and client data +.B XcmsSetWhiteAdjustProc +function first sets the white point adjustment procedure and client data in the specified CCC with the newly specified procedure and client data and then returns the old procedure. .SH "SEE ALSO" diff --git a/lib/libX11/man/XcmsStoreColor.man b/lib/libX11/man/XcmsStoreColor.man index 58282886e..39cbaca05 100644 --- a/lib/libX11/man/XcmsStoreColor.man +++ b/lib/libX11/man/XcmsStoreColor.man @@ -38,68 +38,35 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XcmsStoreColor __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XcmsStoreColor, XcmsStoreColors \- set colors .SH SYNTAX .HP Status XcmsStoreColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, -XcmsColor *\fIcolor\fP\^); +XcmsColor *\fIcolor\fP\^); .HP Status XcmsStoreColors\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, XcmsColor \fIcolors\fP\^[\^]\^, int \fIncolors\fP\^, Bool -\fIcompression_flags_return\fP\^[\^]\^); +\fIcompression_flags_return\fP\^[\^]\^); .SH ARGUMENTS .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIcolor\fP 1i Specifies the color cell and the color to store. Values specified in this -.ZN XcmsColor +.B XcmsColor structure remain unchanged on return. .IP \fIcolors\fP 1i Specifies the color specification array of -.ZN XcmsColor +.B XcmsColor structures, each specifying a color cell and the color to store in that cell. Values specified in the array remain unchanged upon return. @@ -109,134 +76,135 @@ Specifies the colormap. Returns an array of Boolean values indicating compression status. If a non-NULL pointer is supplied, each element of the array is set to -.ZN True +.B True if the corresponding color was compressed and -.ZN False +.B False otherwise. Pass NULL if the compression status is not useful. .IP \fIncolors\fP 1i -Specifies the number of -.ZN XcmsColor +Specifies the number of +.B XcmsColor structures in the color-specification array. .SH DESCRIPTION The -.ZN XcmsStoreColor +.B XcmsStoreColor function converts the color specified in the -.ZN XcmsColor +.B XcmsColor structure into RGB values. It then uses this RGB specification in an -.ZN XColor -structure, whose three flags -.Pn ( DoRed , -.ZN DoGreen , +.B XColor +structure, whose three flags +.Pn ( DoRed , +.BR DoGreen , and -.ZN DoBlue ) +.BR DoBlue ) are set, in a call to -.ZN XStoreColor +.B XStoreColor to change the color cell specified by the pixel member of the -.ZN XcmsColor +.B XcmsColor structure. This pixel value must be a valid index for the specified colormap, and the color cell specified by the pixel value must be a read/write cell. If the pixel value is not a valid index, a -.ZN BadValue +.B BadValue error results. If the color cell is unallocated or is allocated read-only, a -.ZN BadAccess +.B BadAccess error results. -If the colormap is an installed map for its screen, +If the colormap is an installed map for its screen, the changes are visible immediately. .LP -Note that -.ZN XStoreColor +Note that +.B XStoreColor has no return value; therefore, an -.ZN XcmsSuccess -return value from this function indicates that the conversion +.B XcmsSuccess +return value from this function indicates that the conversion to RGB succeeded and the call to -.ZN XStoreColor +.B XStoreColor was made. To obtain the actual color stored, use -.ZN XcmsQueryColor . +.BR XcmsQueryColor . Because of the screen's hardware limitations or gamut compression, the color stored in the colormap may not be identical to the color specified. .LP -.ZN XcmsStoreColor +.B XcmsStoreColor can generate -.ZN BadAccess , -.ZN BadColor , +.BR BadAccess , +.BR BadColor , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XcmsStoreColors +.B XcmsStoreColors function converts the colors specified in the array of -.ZN XcmsColor +.B XcmsColor structures into RGB values and then uses these RGB specifications in -.ZN XColor -structures, whose three flags -.Pn ( DoRed , -.ZN DoGreen , +.B XColor +structures, whose three flags +.Pn ( DoRed , +.BR DoGreen , and -.ZN DoBlue ) +.BR DoBlue ) are set, in a call to -.ZN XStoreColors +.B XStoreColors to change the color cells specified by the pixel member of the corresponding -.ZN XcmsColor +.B XcmsColor structure. Each pixel value must be a valid index for the specified colormap, and the color cell specified by each pixel value must be a read/write cell. If a pixel value is not a valid index, a -.ZN BadValue +.B BadValue error results. If a color cell is unallocated or is allocated read-only, a -.ZN BadAccess +.B BadAccess error results. If more than one pixel is in error, the one that gets reported is arbitrary. -If the colormap is an installed map for its screen, +If the colormap is an installed map for its screen, the changes are visible immediately. .LP -Note that -.ZN XStoreColors +Note that +.B XStoreColors has no return value; therefore, an -.ZN XcmsSuccess -return value from this function indicates that conversions +.B XcmsSuccess +return value from this function indicates that conversions to RGB succeeded and the call to -.ZN XStoreColors +.B XStoreColors was made. To obtain the actual colors stored, use -.ZN XcmsQueryColors . +.BR XcmsQueryColors . Because of the screen's hardware limitations or gamut compression, the colors stored in the colormap may not be identical to the colors specified. .LP .LP -.ZN XcmsStoreColors +.B XcmsStoreColors can generate -.ZN BadAccess , -.ZN BadColor , +.BR BadAccess , +.BR BadColor , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to free a color map entry that it did not already allocate. .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to store into a read-only color map entry. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .SH "SEE ALSO" XcmsAllocColor(__libmansuffix__), diff --git a/lib/libX11/man/XcmsTekHVCQueryMaxC.man b/lib/libX11/man/XcmsTekHVCQueryMaxC.man index 5d682ccb2..f6bce1ea0 100644 --- a/lib/libX11/man/XcmsTekHVCQueryMaxC.man +++ b/lib/libX11/man/XcmsTekHVCQueryMaxC.man @@ -38,105 +38,70 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XcmsTekHVCQueryMaxC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XcmsTekHVCQueryMaxC, XcmsTekHVCQueryMaxV, XcmsTekHVCQueryMaxVC, XcmsTekHVCQueryMaxVSamples, XcmsTekHVCQueryMinV \- obtain the TekHVC coordinates .SH SYNTAX .HP Status XcmsTekHVCQueryMaxC\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue\fP\^, -XcmsFloat \fIvalue\fP\^, XcmsColor *\fIcolor_return\fP\^); +XcmsFloat \fIvalue\fP\^, XcmsColor *\fIcolor_return\fP\^); .HP Status XcmsTekHVCQueryMaxV\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue\fP\^, -XcmsFloat \fIchroma\fP\^, XcmsColor *\fIcolor_return\fP\^); +XcmsFloat \fIchroma\fP\^, XcmsColor *\fIcolor_return\fP\^); .HP Status XcmsTekHVCQueryMaxVC\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue\fP\^, -XcmsColor *\fIcolor_return\fP\^); +XcmsColor *\fIcolor_return\fP\^); .HP Status XcmsTekHVCQueryMaxVSamples\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue\fP\^, XcmsColor \fIcolors_return[]\fP\^, unsigned int -\fInsamples\fP\^); +\fInsamples\fP\^); .HP Status XcmsTekHVCQueryMinV\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue\fP\^, -XcmsFloat \fIchroma\fP\^, XcmsColor *\fIcolor_return\fP\^); +XcmsFloat \fIchroma\fP\^, XcmsColor *\fIcolor_return\fP\^); .SH ARGUMENTS .IP \fIccc\fP 1i Specifies the CCC. Note that the CCC's Client White Point and White Point Adjustment procedures are ignored. -.ds Ch maximum Value (MaxV) .IP \fIchroma\fP 1i -Specifies the chroma at which to find \*(Ch. +Specifies the chroma at which to find maximum Value (MaxV). .IP \fIcolors_return\fP 1i Returns nsamples of color specifications in XcmsTekHVC such that the Chroma is the maximum attainable for the Value and Hue. The white point associated with the returned color specification is the Screen White Point. The value returned in the pixel member is undefined. -.ds Lc maximum Chroma along with the actual Hue and Value (MaxC), \ -maximum Value along with the Hue and Chroma (MaxV), \ -color specification in XcmsTekHVC for the maximum Chroma, \ -the Value at which that maximum Chroma is reached and actual Hue (MaxVC) \ -or minimum Value and the actual Hue and Chroma (MinL) -.ds lC maximum Chroma (MaxC and MaxVC), maximum Value (MaxV), or \ -minimum Value (MinL) +.ds Lc +.ds lC .IP \fIcolor_return\fP 1i -Returns the \*(Lc at which the \*(lC was found. +Returns the maximum Chroma along with the actual Hue and Value (MaxC), +maximum Value along with the Hue and Chroma (MaxV), +color specification in XcmsTekHVC for the maximum Chroma, +the Value at which that maximum Chroma is reached and actual Hue (MaxVC) +or minimum Value and the actual Hue and Chroma (MinL) +at which the maximum Chroma (MaxC and MaxVC), maximum Value (MaxV), or +minimum Value (MinL) was found. The white point associated with the returned color specification is the Screen White Point. The value returned in the pixel member is undefined. -.ds Hu in which to find the maximum Chroma (MaxC and MaxVC), \ -maximum Value (MaxV), the maximum Chroma/Value samples (MaxVSamples), \ -or the minimum Value (MinL) .IP \fIhue\fP 1i -Specifies the Hue \*(Hu. +Specifies the Hue in which to find the maximum Chroma (MaxC and MaxVC), +maximum Value (MaxV), the maximum Chroma/Value samples (MaxVSamples), +or the minimum Value (MinL). .IP \fInsamples\fP 1i Specifies the number of samples. -.ds Va maximum Chroma (MaxC) or minimum Value (MinL) .IP \fIvalue\fP 1i -Specifies the Value in which to find the \*(Va. +Specifies the Value in which to find the maximum Chroma (MaxC) or minimum Value (MinL). .SH DESCRIPTION The -.ZN XcmsTekHVCQueryMaxC +.B XcmsTekHVCQueryMaxC function, given a Hue and Value, determines the maximum Chroma in TekHVC color space displayable by the screen. @@ -144,7 +109,7 @@ It returns the maximum Chroma along with the actual Hue and Value at which the maximum Chroma was found. .LP The -.ZN XcmsTekHVCQueryMaxV +.B XcmsTekHVCQueryMaxV function, given a Hue and Chroma, determines the maximum Value in TekHVC color space displayable by the screen. @@ -152,7 +117,7 @@ It returns the maximum Value and the actual Hue and Chroma at which the maximum Value was found. .LP The -.ZN XcmsTekHVCQueryMaxVC +.B XcmsTekHVCQueryMaxVC function, given a Hue, determines the maximum Chroma in TekHVC color space displayable by the screen and the Value at which that maximum Chroma is reached. @@ -161,7 +126,7 @@ the Value at which that maximum Chroma is reached, and the actual Hue for which the maximum Chroma was found. .LP The -.ZN XcmsTekHVCQueryMaxVSamples +.B XcmsTekHVCQueryMaxVSamples returns nsamples of maximum Value, the Chroma at which that maximum Value is reached, and the actual Hue for which the maximum Chroma was found. These sample points may then be used to plot the maximum Value/Chroma @@ -169,7 +134,7 @@ boundary of the screen's color gamut for the specified Hue in TekHVC color space. .LP The -.ZN XcmsTekHVCQueryMinV +.B XcmsTekHVCQueryMinV function, given a Hue and Chroma, determines the minimum Value in TekHVC color space displayable by the screen. It returns the minimum Value and the actual Hue and Chroma at which diff --git a/lib/libX11/man/XmbDrawImageString.man b/lib/libX11/man/XmbDrawImageString.man index 6599f5002..406645fdf 100644 --- a/lib/libX11/man/XmbDrawImageString.man +++ b/lib/libX11/man/XmbDrawImageString.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. +.\" It is provided "as is" without express or implied warranty. +.\" .\" -.\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XmbDrawImageString __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XmbDrawImageString, XwcDrawImageString, Xutf8DrawImageString \- draw image text using a single font set @@ -86,18 +53,18 @@ XmbDrawImageString, XwcDrawImageString, Xutf8DrawImageString \- draw image text .HP void XmbDrawImageString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, XFontSet \fIfont_set\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, char -*\fIstring\fP\^, int \fInum_bytes\fP\^); +*\fIstring\fP\^, int \fInum_bytes\fP\^); .HP void XwcDrawImageString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, XFontSet \fIfont_set\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, -wchar_t *\fIstring\fP\^, int \fInum_wchars\fP\^); +wchar_t *\fIstring\fP\^, int \fInum_wchars\fP\^); .HP void Xutf8DrawImageString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, XFontSet \fIfont_set\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, char -*\fIstring\fP\^, int \fInum_bytes\fP\^); +*\fIstring\fP\^, int \fInum_bytes\fP\^); .SH ARGUMENTS .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIfont_set\fP 1i @@ -110,41 +77,41 @@ Specifies the number of bytes in the string argument. Specifies the number of characters in the string argument. .IP \fIstring\fP 1i Specifies the character string. -.ds Xy .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates. .SH DESCRIPTION The -.ZN XmbDrawImageString , -.ZN XwcDrawImageString +.BR XmbDrawImageString , +.B XwcDrawImageString and -.ZN Xutf8DrawImageString +.B Xutf8DrawImageString functions fill a destination rectangle with the background pixel defined in the GC and then paint the text with the foreground pixel. The filled rectangle is the rectangle returned to overall_logical_return by -.ZN XmbTextExtents , -.ZN XwcTextExtents -or -.ZN Xutf8TextExtents -for the same text and -.ZN XFontSet . +.BR XmbTextExtents , +.B XwcTextExtents +or +.B Xutf8TextExtents +for the same text and +.BR XFontSet . .LP -When the -.ZN XFontSet -has missing charsets, each unavailable character is drawn -with the default string returned by -.ZN XCreateFontSet . +When the +.B XFontSet +has missing charsets, each unavailable character is drawn +with the default string returned by +.BR XCreateFontSet . The behavior for an invalid codepoint is undefined. .LP The function -.ZN Xutf8TextExtents -is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 -release. Its presence is +.B Xutf8TextExtents +is an extension introduced by The XFree86 Project, Inc., in their 4.0.2 +release. +Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XDrawImageString(__libmansuffix__), XDrawString(__libmansuffix__), diff --git a/lib/libX11/man/XmbDrawString.man b/lib/libX11/man/XmbDrawString.man index 1c608d619..da48940dc 100644 --- a/lib/libX11/man/XmbDrawString.man +++ b/lib/libX11/man/XmbDrawString.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. +.\" It is provided "as is" without express or implied warranty. +.\" .\" -.\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XmbDrawString __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XmbDrawString, XwcDrawString, Xutf8DrawString \- draw text using a single font set @@ -86,18 +53,18 @@ XmbDrawString, XwcDrawString, Xutf8DrawString \- draw text using a single font s .HP void XmbDrawString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, XFontSet \fIfont_set\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, char -*\fIstring\fP\^, int \fInum_bytes\fP\^); +*\fIstring\fP\^, int \fInum_bytes\fP\^); .HP void XwcDrawString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, XFontSet \fIfont_set\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, wchar_t -*\fIstring\fP\^, int \fInum_wchars\fP\^); +*\fIstring\fP\^, int \fInum_wchars\fP\^); .HP void Xutf8DrawString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, XFontSet \fIfont_set\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, char *\fIstring\fP\^, int \fInum_bytes\fP\^); .SH ARGUMENTS .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIfont_set\fP 1i @@ -110,32 +77,32 @@ Specifies the number of bytes in the string argument. Specifies the number of characters in the string argument. .IP \fIstring\fP 1i Specifies the character string. -.ds Xy .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates. .SH DESCRIPTION The -.ZN XmbDrawString , -.ZN XwcDrawString +.BR XmbDrawString , +.B XwcDrawString and -.ZN Xutf8DrawString +.B Xutf8DrawString functions draw the specified text with the foreground pixel. -When the -.ZN XFontSet -has missing charsets, each unavailable character is drawn -with the default string returned by -.ZN XCreateFontSet . +When the +.B XFontSet +has missing charsets, each unavailable character is drawn +with the default string returned by +.BR XCreateFontSet . The behavior for an invalid codepoint is undefined. .LP The function -.ZN Xutf8DrawString -is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 -release. Its presence is +.B Xutf8DrawString +is an extension introduced by The XFree86 Project, Inc., in their 4.0.2 +release. +Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XDrawImageString(__libmansuffix__), XDrawString(__libmansuffix__), diff --git a/lib/libX11/man/XmbDrawText.man b/lib/libX11/man/XmbDrawText.man index 81bd284a2..8cfca06ce 100644 --- a/lib/libX11/man/XmbDrawText.man +++ b/lib/libX11/man/XmbDrawText.man @@ -39,64 +39,31 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. +.\" It is provided "as is" without express or implied warranty. +.\" .\" -.\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XmbDrawText __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME -XmbDrawText, XwcDrawText, Xutf8DrawText \- draw text using multiple font sets +XmbDrawText, XwcDrawText, Xutf8DrawText \- draw text using multiple font sets .SH SYNTAX .HP void XmbDrawText\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, XmbTextItem *\fIitems\fP\^, int -\fInitems\fP\^); +\fInitems\fP\^); .HP void XwcDrawText\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, XwcTextItem *\fIitems\fP\^, int -\fInitems\fP\^); +\fInitems\fP\^); .HP void Xutf8DrawText\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, XmbTextItem *\fIitems\fP\^, int \fInitems\fP\^); .SH ARGUMENTS .IP \fId\fP 1i -Specifies the drawable. +Specifies the drawable. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i @@ -105,81 +72,81 @@ Specifies the GC. Specifies an array of text items. .IP \fInitems\fP 1i Specifies the number of text items in the array. -.ds Xy .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates. .SH DESCRIPTION The -.ZN XmbDrawText , -.ZN XwcDrawText -and -.ZN Xutf8DrawText +.BR XmbDrawText , +.B XwcDrawText +and +.B Xutf8DrawText functions allow complex spacing and font set shifts between text strings. Each text item is processed in turn, with the origin of a text element advanced in the primary draw direction by the escapement of the previous text item. A text item delta specifies an additional escapement of the text item drawing origin in the primary draw direction. -A font_set member other than -.ZN None +A font_set member other than +.B None in an item causes the font set to be used for this and subsequent text items in the text_items list. Leading text items with a font_set member set to -.ZN None +.B None will not be drawn. .LP -.ZN XmbDrawText , -.ZN XwcDrawText +.BR XmbDrawText , +.B XwcDrawText and -.ZN Xutf8DrawText +.B Xutf8DrawText do not perform any context-dependent rendering between text segments. Clients may compute the drawing metrics by passing each text segment to -.ZN XmbTextExtents , -.ZN XwcTextExtents , -.ZN Xutf8TextExtents +.BR XmbTextExtents , +.BR XwcTextExtents , +.B Xutf8TextExtents or -.ZN XmbTextPerCharExtents , -.ZN XwcTextPerCharExtents . -.ZN Xutf8TextPerCharExtents . -When the -.ZN XFontSet -has missing charsets, each unavailable character is drawn -with the default string returned by -.ZN XCreateFontSet . +.BR XmbTextPerCharExtents , +.BR XwcTextPerCharExtents . +.BR Xutf8TextPerCharExtents . +When the +.B XFontSet +has missing charsets, each unavailable character is drawn +with the default string returned by +.BR XCreateFontSet . The behavior for an invalid codepoint is undefined. .LP The function -.ZN Xutf8DrawText -is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 -release. Its presence is +.B Xutf8DrawText +is an extension introduced by The XFree86 Project, Inc., in their 4.0.2 +release. +Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH STRUCTURES The -.ZN XmbTextItem +.B XmbTextItem structure contains: -.Ds 0 +.EX typedef struct { char *chars; /\&* pointer to string */ int nchars; /\&* number of bytes */ int delta; /\&* pixel delta between strings */ XFontSet font_set; /\&* fonts, None means don't change */ } XmbTextItem; -.De +.EE The -.ZN XwcTextItem +.B XwcTextItem structure contains: -.Ds 0 +.EX typedef struct { wchar_t *chars; /\&* pointer to wide char string */ int nchars; /\&* number of wide characters */ int delta; /\&* pixel delta between strings */ XFontSet font_set; /\&* fonts, None means don't change */ } XwcTextItem; -.De +.EE .SH "SEE ALSO" XDrawImageString(__libmansuffix__), XDrawString(__libmansuffix__), diff --git a/lib/libX11/man/XmbLookupString.man b/lib/libX11/man/XmbLookupString.man index c03a58291..2215a244c 100644 --- a/lib/libX11/man/XmbLookupString.man +++ b/lib/libX11/man/XmbLookupString.man @@ -40,46 +40,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. +.\" It is provided "as is" without express or implied warranty. +.\" .\" -.\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XmbLookupString __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME @@ -88,15 +55,15 @@ XmbLookupString, XwcLookupString, Xutf8LookupString \- obtain composed input fro .HP int XmbLookupString\^(\^XIC \fIic\fP\^, XKeyPressedEvent *\fIevent\fP, char *\fIbuffer_return\fP\^, int \fIbytes_buffer\fP\^, KeySym -*\fIkeysym_return\fP\^, Status *\fIstatus_return\fP\^); +*\fIkeysym_return\fP\^, Status *\fIstatus_return\fP\^); .HP int XwcLookupString\^(\^XIC \fIic\fP\^, XKeyPressedEvent *\fIevent\fP\^, wchar_t *\fIbuffer_return\fP\^, int \fIwchars_buffer\fP\^, KeySym -*\fIkeysym_return\fP\^, Status *\fIstatus_return\fP\^); +*\fIkeysym_return\fP\^, Status *\fIstatus_return\fP\^); .HP int Xutf8LookupString\^(\^XIC \fIic\fP\^, XKeyPressedEvent *\fIevent\fP, char *\fIbuffer_return\fP\^, int \fIbytes_buffer\fP\^, KeySym -*\fIkeysym_return\fP\^, Status *\fIstatus_return\fP\^); +*\fIkeysym_return\fP\^, Status *\fIstatus_return\fP\^); .SH ARGUMENTS .IP \fIbuffer_return\fP 1i Returns a multibyte string or wide character string (if any) @@ -106,9 +73,8 @@ from the input method. .ns .IP \fIwchars_buffer\fP 1i Specifies space available in the return buffer. -.ds Ev key event to be used .IP \fIevent\fP 1i -Specifies the \*(Ev. +Specifies the key event to be used. .IP \fIic\fP 1i Specifies the input context. .IP \fIkeysym_return\fP 1i @@ -117,10 +83,10 @@ Returns the KeySym computed from the event if this argument is not NULL. Returns a value indicating what kind of data is returned. .SH DESCRIPTION The -.ZN XmbLookupString , -.ZN XwcLookupString +.BR XmbLookupString , +.B XwcLookupString and -.ZN Xutf8LookupString +.B Xutf8LookupString functions return the string from the input method specified in the buffer_return argument. If no string is returned, @@ -132,70 +98,70 @@ argument indicates that a KeySym was returned. If both a string and a KeySym are returned, the KeySym value does not necessarily correspond to the string returned. .LP -.ZN XmbLookupString +.B XmbLookupString and -.ZN Xutf8LookupString +.B Xutf8LookupString return the length of the string in bytes, and -.ZN XwcLookupString +.B XwcLookupString returns the length of the string in characters. Both -.ZN XmbLookupString +.B XmbLookupString and -.ZN XwcLookupString +.B XwcLookupString return text in the encoding of the locale bound to the input method of the specified input context, and -.ZN Xutf8LookupString +.B Xutf8LookupString returns text in UTF-8 encoding. .LP Each string returned by -.ZN XmbLookupString +.B XmbLookupString and -.ZN XwcLookupString +.B XwcLookupString begins in the initial state of the encoding of the locale (if the encoding of the locale is state-dependent). .LP Note: To ensure proper input processing, -it is essential that the client pass only -.ZN KeyPress +it is essential that the client pass only +.B KeyPress events to -.ZN XmbLookupString , -.ZN XwcLookupString +.BR XmbLookupString , +.B XwcLookupString and -.ZN Xutf8LookupString . -Their behavior when a client passes a -.ZN KeyRelease +.BR Xutf8LookupString . +Their behavior when a client passes a +.B KeyRelease event is undefined. .LP Clients should check the status_return argument before using the other returned values. -These three functions each return a value to status_return +These three functions each return a value to status_return that indicates what has been returned in the other arguments. The possible values returned are: .TS -lw(1.5i) lw(4.3i). +lw(1.3i) lw(4.3i). T{ -.ZN XBufferOverflow +.B XBufferOverflow T} T{ The input string to be returned is too large for the supplied buffer_return. The required size (for -.ZN XmbLookupString , -.ZN Xutf8LookupString +.BR XmbLookupString , +.B Xutf8LookupString in bytes; for -.ZN XwcLookupString +.B XwcLookupString in characters) is returned as the value of the function, and the contents of buffer_return and keysym_return are not modified. The client should recall the function with the same event and a buffer of adequate size to obtain the string. T} T{ -.ZN XLookupNone +.B XLookupNone T} T{ No consistent input has been composed so far. -The contents of buffer_return and keysym_return are not modified, +The contents of buffer_return and keysym_return are not modified, and the function returns zero. T} T{ -.ZN XLookupChars +.B XLookupChars T} T{ Some input characters have been composed. They are placed in the buffer_return argument, using the encoding @@ -204,7 +170,7 @@ and the string length is returned as the value of the function. The content of the keysym_return argument is not modified. T} T{ -.ZN XLookupKeySym +.B XLookupKeySym T} T{ A KeySym has been returned instead of a string and is returned in keysym_return. @@ -212,36 +178,37 @@ The content of the buffer_return argument is not modified, and the function returns zero. T} T{ -.ZN XLookupBoth +.B XLookupBoth T} T{ Both a KeySym and a string are returned; -.ZN XLookupChars +.B XLookupChars and -.ZN XLookupKeySym +.B XLookupKeySym occur simultaneously. T} .TE .LP It does not make any difference if the input context passed as an argument to -.ZN XmbLookupString , -.ZN XwcLookupString +.BR XmbLookupString , +.B XwcLookupString and -.ZN Xutf8LookupString +.B Xutf8LookupString is the one currently in possession of the focus or not. Input may have been composed within an input context before it lost the focus, and that input may be returned on subsequent calls to -.ZN XmbLookupString , -.ZN XwcLookupString +.BR XmbLookupString , +.B XwcLookupString or -.ZN Xutf8LookupString +.B Xutf8LookupString even though it does not have any more keyboard focus. .LP The function -.ZN Xutf8LookupString -is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 -release. Its presence is +.B Xutf8LookupString +is an extension introduced by The XFree86 Project, Inc., in their 4.0.2 +release. +Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XLookupKeysym(__libmansuffix__), Compose(__filemansuffix__) diff --git a/lib/libX11/man/XmbResetIC.man b/lib/libX11/man/XmbResetIC.man index f265ee2fe..30d1c33f4 100644 --- a/lib/libX11/man/XmbResetIC.man +++ b/lib/libX11/man/XmbResetIC.man @@ -39,108 +39,76 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. +.\" It is provided "as is" without express or implied warranty. +.\" .\" -.\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XmbResetIC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XmbResetIC, XwcResetIC, Xutf8ResetIC \- reset the state of an input context .SH SYNTAX .HP -char *XmbResetIC\^(\^XIC \fIic\fP\^); +char *XmbResetIC\^(\^XIC \fIic\fP\^); .HP -wchar_t *XwcResetIC\^(\^XIC \fIic\fP\^); +wchar_t *XwcResetIC\^(\^XIC \fIic\fP\^); .HP -char *Xutf8ResetIC\^(\^XIC \fIic\fP\^); +char *Xutf8ResetIC\^(\^XIC \fIic\fP\^); .SH ARGUMENTS .IP \fIic\fP 1i Specifies the input context. .SH DESCRIPTION When -.ZN XNResetState +.B XNResetState is set to -.ZN XIMInitialState , -.ZN XmbResetIC , -.ZN XwcResetIC +.BR XIMInitialState , +.BR XmbResetIC , +.B XwcResetIC and -.ZN Xutf8ResetIC +.B Xutf8ResetIC reset an input context to its initial state; when -.ZN XNResetState +.B XNResetState is set to -.ZN XIMPreserveState , +.BR XIMPreserveState , the current input context state is preserved. In both cases, any input pending on that context is deleted. The input method is required to clear the preedit area, if any, and update the status accordingly. -Calling -.ZN XmbResetIC , -.ZN XwcResetIC +Calling +.BR XmbResetIC , +.B XwcResetIC or -.ZN Xutf8ResetIC +.B Xutf8ResetIC does not change the focus. .LP The return value of -.ZN XmbResetIC +.B XmbResetIC is its current preedit string as a multibyte string. The return value of -.ZN XwcResetIC +.B XwcResetIC is its current preedit string as a wide character string. The return value of -.ZN Xutf8ResetIC +.B Xutf8ResetIC is its current preedit string as an UTF-8 string. If there is any preedit text drawn or visible to the user, then these procedures must return a non-NULL string. -If there is no visible preedit text, -then it is input method implementation-dependent +If there is no visible preedit text, +then it is input method implementation-dependent whether these procedures return a non-NULL string or NULL. .LP The client should free the returned string by calling -.ZN XFree . +.BR XFree . .LP The function -.ZN Xutf8ResetIC -is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 -release. Its presence is +.B Xutf8ResetIC +is an extension introduced by The XFree86 Project, Inc., in their 4.0.2 +release. +Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XCreateIC(__libmansuffix__), XOpenIM(__libmansuffix__), diff --git a/lib/libX11/man/XmbTextEscapement.man b/lib/libX11/man/XmbTextEscapement.man index 35da94c1b..5391f68b4 100644 --- a/lib/libX11/man/XmbTextEscapement.man +++ b/lib/libX11/man/XmbTextEscapement.man @@ -39,59 +39,26 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. +.\" It is provided "as is" without express or implied warranty. +.\" .\" -.\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XmbTextEscapement __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XmbTextEscapement, XwcTextEscapement, Xutf8TextEscapement \- obtain the escapement of text .SH SYNTAX .HP int XmbTextEscapement\^(\^XFontSet \fIfont_set\fP\^, char *\fIstring\fP\^, int -\fInum_bytes\fP\^); +\fInum_bytes\fP\^); .HP int XwcTextEscapement\^(\^XFontSet \fIfont_set\fP\^, wchar_t *\fIstring\fP\^, -int \fInum_wchars\fP\^); +int \fInum_wchars\fP\^); .HP -int Xutf8TextEscapement\^(\^XFontSet \fIfont_set\fP\^, char *\fIstring\fP\^, -int \fInum_bytes\fP\^); +int Xutf8TextEscapement\^(\^XFontSet \fIfont_set\fP\^, char *\fIstring\fP\^, +int \fInum_bytes\fP\^); .SH ARGUMENTS .IP \fIfont_set\fP 1i Specifies the font set. @@ -103,10 +70,10 @@ Specifies the number of characters in the string argument. Specifies the character string. .SH DESCRIPTION The -.ZN XmbTextEscapement , -.ZN XwcTextEscapement +.BR XmbTextEscapement , +.B XwcTextEscapement and -.ZN Xutf8TextEscapement +.B Xutf8TextEscapement functions return the escapement in pixels of the specified string as a value, using the fonts loaded for the specified font set. The escapement is the distance in pixels in the primary draw @@ -118,11 +85,12 @@ Regardless of the character rendering order, the escapement is always positive. .LP The function -.ZN Xutf8TextEscapement -is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 -release. Its presence is +.B Xutf8TextEscapement +is an extension introduced by The XFree86 Project, Inc., in their 4.0.2 +release. +Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XmbTextExtents(__libmansuffix__), XmbTextPerCharExtents(__libmansuffix__) diff --git a/lib/libX11/man/XmbTextExtents.man b/lib/libX11/man/XmbTextExtents.man index 8ede8fc09..01ae8e581 100644 --- a/lib/libX11/man/XmbTextExtents.man +++ b/lib/libX11/man/XmbTextExtents.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. +.\" It is provided "as is" without express or implied warranty. +.\" .\" -.\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XmbTextExtents __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XmbTextExtents, XwcTextExtents, Xutf8TextExtents \- compute text extents @@ -86,11 +53,11 @@ XmbTextExtents, XwcTextExtents, Xutf8TextExtents \- compute text extents .HP int XmbTextExtents\^(\^XFontSet \fIfont_set\fP\^, char *\fIstring\fP\^, int \fInum_bytes\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle -*\fIoverall_logical_return\fP\^); +*\fIoverall_logical_return\fP\^); .HP int XwcTextExtents\^(\^XFontSet \fIfont_set\fP\^, wchar_t *\fIstring\fP\^, int \fInum_wchars\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle -*\fIoverall_logical_return\fP\^); +*\fIoverall_logical_return\fP\^); .HP int Xutf8TextExtents\^(\^XFontSet \fIfont_set\fP\^, char *\fIstring\fP\^, int \fInum_bytes\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle @@ -102,28 +69,27 @@ Specifies the font set. Specifies the number of bytes in the string argument. .IP \fInum_wchars\fP 1i Specifies the number of characters in the string argument. -.ds Ov dimensions .IP \fIoverall_ink_return\fP 1i -Returns the overall ink \*(Ov. +Returns the overall ink dimensions. .IP \fIoverall_logical_return\fP 1i -Returns the overall logical \*(Ov. +Returns the overall logical dimensions. .IP \fIstring\fP 1i Specifies the character string. .SH DESCRIPTION The -.ZN XmbTextExtents , -.ZN XwcTextExtents +.BR XmbTextExtents , +.B XwcTextExtents and -.ZN Xutf8TextExtents +.B Xutf8TextExtents functions set the components of the specified overall_ink_return and overall_logical_return arguments to the overall bounding box of the string's image and a logical bounding box for spacing purposes, respectively. -They return the value returned by -.ZN XmbTextEscapement , -.ZN XwcTextEscapement +They return the value returned by +.BR XmbTextEscapement , +.B XwcTextEscapement or -.ZN Xutf8TextEscapement . +.BR Xutf8TextEscapement . These metrics are relative to the drawing origin of the string, using the fonts loaded for the specified font set. .LP @@ -144,21 +110,22 @@ to other graphical features for the string. Other graphical features, for example, a border surrounding the text, should not intersect this rectangle. .LP -When the -.ZN XFontSet +When the +.B XFontSet has missing charsets, -metrics for each unavailable character are taken -from the default string returned by -.ZN XCreateFontSet +metrics for each unavailable character are taken +from the default string returned by +.B XCreateFontSet so that the metrics represent the text as it will actually be drawn. The behavior for an invalid codepoint is undefined. .LP The function -.ZN Xutf8TextExtents -is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 -release. Its presence is +.B Xutf8TextExtents +is an extension introduced by The XFree86 Project, Inc., in their 4.0.2 +release. +Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XmbTextEscapement(__libmansuffix__), XmbTextPerCharExtents(__libmansuffix__) diff --git a/lib/libX11/man/XmbTextListToTextProperty.man b/lib/libX11/man/XmbTextListToTextProperty.man index b937761ee..e97636597 100644 --- a/lib/libX11/man/XmbTextListToTextProperty.man +++ b/lib/libX11/man/XmbTextListToTextProperty.man @@ -40,46 +40,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. +.\" It is provided "as is" without express or implied warranty. .\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XmbTextListToTextProperty __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME @@ -88,27 +55,27 @@ XmbTextListToTextProperty, XwcTextListToTextProperty, Xutf8TextListToTextPropert .HP int XmbTextListToTextProperty\^(\^Display *\fIdisplay\fP\^, char **\fIlist\fP\^, int \fIcount\fP\^, XICCEncodingStyle \fIstyle\fP\^, -XTextProperty *\fItext_prop_return\fP\^); +XTextProperty *\fItext_prop_return\fP\^); .HP int XwcTextListToTextProperty\^(\^Display *\fIdisplay\fP\^, wchar_t **\fIlist\fP\^, int \fIcount\fP\^, XICCEncodingStyle \fIstyle\fP\^, -XTextProperty *\fItext_prop_return\fP\^); +XTextProperty *\fItext_prop_return\fP\^); .HP int Xutf8TextListToTextProperty\^(\^Display *\fIdisplay\fP\^, char **\fIlist\fP\^, int \fIcount\fP\^, XICCEncodingStyle \fIstyle\fP\^, -XTextProperty *\fItext_prop_return\fP\^); +XTextProperty *\fItext_prop_return\fP\^); .HP int XmbTextPropertyToTextList\^(\^Display *\fIdisplay\fP\^, XTextProperty -*\fItext_prop\fP\^, char ***\fIlist_return\fP\^, int *\fIcount_return\fP\^); +*\fItext_prop\fP\^, char ***\fIlist_return\fP\^, int *\fIcount_return\fP\^); .HP int XwcTextPropertyToTextList\^(\^Display *\fIdisplay\fP\^, XTextProperty *\fItext_prop\fP\^, wchar_t ***\fIlist_return\fP\^, int -*\fIcount_return\fP\^); +*\fIcount_return\fP\^); .HP int Xutf8TextPropertyToTextList\^(\^Display *\fIdisplay\fP\^, XTextProperty -*\fItext_prop\fP\^, char ***\fIlist_return\fP\^, int *\fIcount_return\fP\^); +*\fItext_prop\fP\^, char ***\fIlist_return\fP\^, int *\fIcount_return\fP\^); .HP -void XwcFreeStringList\^(\^wchar_t **\fIlist\fP\^); +void XwcFreeStringList\^(\^wchar_t **\fIlist\fP\^); .HP char *XDefaultString\^(void) .SH ARGUMENTS @@ -122,109 +89,111 @@ Specifies the number of strings specified. Specifies the manner in which the property is encoded. .IP \fItext_prop_return\fP 1i Returns the -.ZN XTextProperty +.B XTextProperty structure. .IP \fItext_prop\fP 1i Specifies the -.ZN XTextProperty +.B XTextProperty structure to be used. .IP \fIlist_return\fP 1i Returns a list of null-terminated character strings. -.ds Cn strings .IP \fIcount_return\fP 1i -Returns the number of \*(Cn. +Returns the number of strings. .IP \fIlist\fP 1i Specifies the list of strings to be freed. .SH DESCRIPTION The -.ZN XmbTextListToTextProperty , -.ZN XwcTextListToTextProperty +.BR XmbTextListToTextProperty , +.B XwcTextListToTextProperty and -.ZN Xutf8TextListToTextProperty -functions set the specified -.ZN XTextProperty +.B Xutf8TextListToTextProperty +functions set the specified +.B XTextProperty value to a set of null-separated elements representing the concatenation -of the specified list of null-terminated text strings. The input text +of the specified list of null-terminated text strings. +The input text strings must be given in the current locale encoding (for -.ZN XmbTextListToTextProperty +.B XmbTextListToTextProperty and -.ZN XwcTextListToTextProperty ), +.BR XwcTextListToTextProperty ), or in UTF-8 encoding (for -.ZN Xutf8TextListToTextProperty ). +.BR Xutf8TextListToTextProperty ). .LP The functions set the encoding field of text_prop_return to an -.ZN Atom -for the specified display +.B Atom +for the specified display naming the encoding determined by the specified style and convert the specified text list to this encoding for storage in the text_prop_return value field. -If the style -.ZN XStringStyle -or -.ZN XCompoundTextStyle +If the style +.B XStringStyle +or +.B XCompoundTextStyle is specified, -this encoding is ``STRING'' or ``COMPOUND_TEXT'', respectively. +this encoding is \*(lqSTRING\*(rq or \*(lqCOMPOUND_TEXT\*(rq, respectively. If the style -.ZN XUTF8StringStyle +.B XUTF8StringStyle is specified, -this encoding is ``UTF8_STRING''. -(This is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 -release. Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING .) -If the style -.ZN XTextStyle +this encoding is \*(lqUTF8_STRING\*(rq. +(This is an extension introduced by The XFree86 Project, Inc., in their 4.0.2 +release. +Its presence is indicated by the macro +.BR X_HAVE_UTF8_STRING .) +If the style +.B XTextStyle is specified, this encoding is the encoding of the current locale. -If the style -.ZN XStdICCTextStyle +If the style +.B XStdICCTextStyle is specified, -this encoding is ``STRING'' if the text is fully convertible to STRING, -else ``COMPOUND_TEXT''. -A final terminating null byte is stored at the end of the value field +this encoding is \*(lqSTRING\*(rq if the text is fully convertible to STRING, +else \*(lqCOMPOUND_TEXT\*(rq. +A final terminating null byte is stored at the end of the value field of text_prop_return but is not included in the nitems member. .LP If insufficient memory is available for the new value string, -the functions return -.ZN XNoMemory . +the functions return +.BR XNoMemory . If the current locale is not supported, -the functions return -.ZN XLocaleNotSupported . +the functions return +.BR XLocaleNotSupported . In both of these error cases, the functions do not set text_prop_return. .LP To determine if the functions are guaranteed not to return -.ZN XLocaleNotSupported , +.BR XLocaleNotSupported , use -.ZN XSupportsLocale . +.BR XSupportsLocale . .LP If the supplied text is not fully convertible to the specified encoding, the functions return the number of unconvertible characters. Each unconvertible character is converted to an implementation-defined and encoding-specific default string. -Otherwise, the functions return -.ZN Success . -Note that full convertibility to all styles except -.ZN XStringStyle +Otherwise, the functions return +.BR Success . +Note that full convertibility to all styles except +.B XStringStyle is guaranteed. .LP To free the storage for the value field, use -.ZN XFree . +.BR XFree . .LP -The -.ZN XmbTextPropertyToTextList , -.ZN XwcTextPropertyToTextList -and -.ZN Xutf8TextPropertyToTextList +The +.BR XmbTextPropertyToTextList , +.B XwcTextPropertyToTextList +and +.B Xutf8TextPropertyToTextList functions return a list of text strings representing the null-separated elements of the specified -.ZN XTextProperty -structure. The returned strings are encoded using the current locale encoding +.B XTextProperty +structure. +The returned strings are encoded using the current locale encoding (for -.ZN XmbTextPropertyToTextList +.B XmbTextPropertyToTextList and -.ZN XwcTextPropertyToTextList ) +.BR XwcTextPropertyToTextList ) or in UTF-8 (for -.ZN Xutf8TextPropertyToTextList ). +.BR Xutf8TextPropertyToTextList ). The data in text_prop must be format 8. .LP Multiple elements of the property (for example, the strings in a disjoint @@ -233,36 +202,36 @@ The contents of the property are not required to be null-terminated; any terminating null should not be included in text_prop.nitems. .LP If insufficient memory is available for the list and its elements, -.ZN XmbTextPropertyToTextList , -.ZN XwcTextPropertyToTextList +.BR XmbTextPropertyToTextList , +.B XwcTextPropertyToTextList and -.ZN Xutf8TextPropertyToTextList -return -.ZN XNoMemory . +.B Xutf8TextPropertyToTextList +return +.BR XNoMemory . If the current locale is not supported, the functions return -.ZN XLocaleNotSupported . -Otherwise, if the encoding field of text_prop is not convertible +.BR XLocaleNotSupported . +Otherwise, if the encoding field of text_prop is not convertible to the encoding of the current locale, the functions return -.ZN XConverterNotFound . +.BR XConverterNotFound . For supported locales, existence of a converter from COMPOUND_TEXT, STRING, UTF8_STRING or the encoding of the current locale is guaranteed if -.ZN XSupportsLocale -returns -.ZN True +.B XSupportsLocale +returns +.B True for the current locale (but the actual text may contain unconvertible characters). Conversion of other encodings is implementation-dependent. In all of these error cases, the functions do not set any return values. .LP -Otherwise, -.ZN XmbTextPropertyToTextList , -.ZN XwcTextPropertyToTextList +Otherwise, +.BR XmbTextPropertyToTextList , +.B XwcTextPropertyToTextList and -.ZN Xutf8TextPropertyToTextList +.B Xutf8TextPropertyToTextList return the list of null-terminated text strings to list_return and the number of text strings to count_return. .LP @@ -271,54 +240,54 @@ encoding of the current locale, the functions return the number of unconvertible characters. Each unconvertible character is converted to a string in the current locale that is specific to the current locale. -To obtain the value of this string, +To obtain the value of this string, use -.ZN XDefaultString . +.BR XDefaultString . Otherwise, -.ZN XmbTextPropertyToTextList , -.ZN XwcTextPropertyToTextList +.BR XmbTextPropertyToTextList , +.B XwcTextPropertyToTextList and -.ZN Xutf8TextPropertyToTextList -return -.ZN Success . +.B Xutf8TextPropertyToTextList +return +.BR Success . .LP To free the storage for the list and its contents returned by -.ZN XmbTextPropertyToTextList +.B XmbTextPropertyToTextList or -.ZN Xutf8TextPropertyToTextList , +.BR Xutf8TextPropertyToTextList , use -.ZN XFreeStringList . +.BR XFreeStringList . To free the storage for the list and its contents returned by -.ZN XwcTextPropertyToTextList , +.BR XwcTextPropertyToTextList , use -.ZN XwcFreeStringList . +.BR XwcFreeStringList . .LP The -.ZN XwcFreeStringList +.B XwcFreeStringList function frees memory allocated by -.ZN XwcTextPropertyToTextList . +.BR XwcTextPropertyToTextList . .LP The -.ZN XDefaultString +.B XDefaultString function returns the default string used by Xlib for text conversion -(for example, in -.ZN XmbTextPropertyToTextList ). -The default string is the string in the current locale that is output +(for example, in +.BR XmbTextPropertyToTextList ). +The default string is the string in the current locale that is output when an unconvertible character is found during text conversion. If the string returned by -.ZN XDefaultString +.B XDefaultString is the empty string ("\^"), no character is output in the converted text. -.ZN XDefaultString +.B XDefaultString does not return NULL. .LP -The string returned by -.ZN XDefaultString +The string returned by +.B XDefaultString is independent of the default string for text drawing; -see -.ZN XCreateFontSet +see +.B XCreateFontSet to obtain the default string for an -.ZN XFontSet . +.BR XFontSet . .LP The behavior when an invalid codepoint is supplied to any Xlib function is undefined. @@ -329,29 +298,30 @@ It may be freed after the current locale is changed. Until freed, it will not be modified by Xlib. .LP The functions -.ZN Xutf8TextListToTextProperty +.B Xutf8TextListToTextProperty and -.ZN Xutf8TextPropertyToTextList -are extensions introduced by The XFree86 Project, Inc. in their 4.0.2 -release. Their presence is +.B Xutf8TextPropertyToTextList +are extensions introduced by The XFree86 Project, Inc., in their 4.0.2 +release. +Their presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH STRUCTURES The -.ZN XTextProperty +.B XTextProperty structure contains: .LP -.Ds 0 +.EX typedef struct { unsigned char *value; /\&* property data */ Atom encoding; /\&* type of property */ int format; /\&* 8, 16, or 32 */ unsigned long nitems; /\&* number of items in value */ } XTextProperty; -.De +.EE .LP The -.ZN XICCEncodingStyle +.B XICCEncodingStyle structure contains: .LP .TS @@ -359,26 +329,26 @@ lw(.5i) lw(2i) lw(2.5i). T{ \&#define T} T{ -.ZN XNoMemory +.B XNoMemory T} T{ \-1 T} T{ \&#define T} T{ -.ZN XLocaleNotSupported +.B XLocaleNotSupported T} T{ \-2 T} T{ \&#define T} T{ -.ZN XConverterNotFound +.B XConverterNotFound T} T{ \-3 T} .TE -.Ds 0 +.EX typedef enum { XStringStyle, /\&* STRING */ XCompoundTextStyle, /\&* COMPOUND_TEXT */ @@ -386,7 +356,7 @@ typedef enum { XStdICCTextStyle, /\&* STRING, else COMPOUND_TEXT */ XUTF8StringStyle /\&* UTF8_STRING */ } XICCEncodingStyle; -.De +.EE .SH "SEE ALSO" XSetTextProperty(__libmansuffix__), XStringListToTextProperty(__libmansuffix__) diff --git a/lib/libX11/man/XmbTextPerCharExtents.man b/lib/libX11/man/XmbTextPerCharExtents.man index eceaf6aed..eaa771c1a 100644 --- a/lib/libX11/man/XmbTextPerCharExtents.man +++ b/lib/libX11/man/XmbTextPerCharExtents.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. +.\" It is provided "as is" without express or implied warranty. +.\" .\" -.\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XmbTextPerCharExtents __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XmbTextPerCharExtents, XwcTextPerCharExtents, Xutf8TextPerCharExtents \- obtain per-character information for a text string @@ -88,13 +55,13 @@ Status XmbTextPerCharExtents\^(\^XFontSet \fIfont_set\fP\^, char *\fIstring\fP\^, int \fInum_bytes\fP\^, XRectangle *\fIink_array_return\fP\^, XRectangle *\fIlogical_array_return\fP\^, int \fIarray_size\fP\^, int *\fInum_chars_return\fP\^, XRectangle *\fIoverall_ink_return\fP\^, XRectangle -*\fIoverall_logical_return\fP\^); +*\fIoverall_logical_return\fP\^); .HP Status XwcTextPerCharExtents\^(\^XFontSet \fIfont_set\fP\^, wchar_t *\fIstring\fP\^, int \fInum_wchars\fP\^, XRectangle *\fIink_array_return\fP\^, XRectangle *\fIlogical_array_return\fP, int \fIarray_size\fP\^, int *\fInum_chars_return\fP\^, XRectangle -*\fIoverall_ink_return\fP\^, XRectangle *\fIoverall_logical_return\fP\^); +*\fIoverall_ink_return\fP\^, XRectangle *\fIoverall_logical_return\fP\^); .HP Status Xutf8TextPerCharExtents\^(\^XFontSet \fIfont_set\fP\^, char *\fIstring\fP\^, int \fInum_bytes\fP\^, XRectangle *\fIink_array_return\fP\^, @@ -117,52 +84,51 @@ Specifies the number of bytes in the string argument. Returns the number of characters in the string argument. .IP \fInum_wchars\fP 1i Specifies the number of characters in the string argument. -.ds Ov extents of the entire string .IP \fIoverall_ink_return\fP 1i -Returns the overall ink \*(Ov. +Returns the overall ink extents of the entire string. .IP \fIoverall_logical_return\fP 1i -Returns the overall logical \*(Ov. +Returns the overall logical extents of the entire string. .IP \fIstring\fP 1i Specifies the character string. .SH DESCRIPTION The -.ZN XmbTextPerCharExtents , -.ZN XwcTextPerCharExtents +.BR XmbTextPerCharExtents , +.B XwcTextPerCharExtents and -.ZN Xutf8TextPerCharExtents +.B Xutf8TextPerCharExtents functions return the text dimensions of each character of the specified text, using the fonts loaded for the specified font set. Each successive element of ink_array_return and logical_array_return is set to the successive character's drawn metrics, -relative to the drawing origin of the string and one +relative to the drawing origin of the string and one rectangle for each character in the supplied text string. The number of elements of ink_array_return and logical_array_return that have been set is returned to num_chars_return. .LP -Each element of ink_array_return is set to the bounding box +Each element of ink_array_return is set to the bounding box of the corresponding character's drawn foreground color. -Each element of logical_array_return is set to the bounding box +Each element of logical_array_return is set to the bounding box that provides minimum spacing to other graphical features for the corresponding character. Other graphical features should not intersect any of the logical_array_return rectangles. .LP -Note that an -.ZN XRectangle +Note that an +.B XRectangle represents the effective drawing dimensions of the character, regardless of the number of font glyphs that are used to draw the character or the direction in which the character is drawn. If multiple characters map to a single character glyph, -the dimensions of all the -.ZN XRectangles +the dimensions of all the +.B XRectangles of those characters are the same. .LP -When the -.ZN XFontSet +When the +.B XFontSet has missing charsets, metrics for each unavailable -character are taken from the default string returned by -.ZN XCreateFontSet +character are taken from the default string returned by +.B XCreateFontSet so that the metrics represent the text as it will actually be drawn. The behavior for an invalid codepoint is undefined. .LP @@ -172,23 +138,24 @@ and num_chars_return is set to the number of rectangles required. Otherwise, the functions return a nonzero value. .LP If the overall_ink_return or overall_logical_return argument is non-NULL, -.ZN XmbTextPerCharExtents , -.ZN XwcTextPerCharExtents -and -.ZN Xutf8TextPerCharExtents +.BR XmbTextPerCharExtents , +.B XwcTextPerCharExtents +and +.B Xutf8TextPerCharExtents return the maximum extent of the string's metrics to overall_ink_return -or overall_logical_return, as returned by -.ZN XmbTextExtents , -.ZN XwcTextExtents -or -.ZN Xutf8TextExtents . +or overall_logical_return, as returned by +.BR XmbTextExtents , +.B XwcTextExtents +or +.BR Xutf8TextExtents . .LP The function -.ZN Xutf8TextPerCharExtents -is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 -release. Its presence is +.B Xutf8TextPerCharExtents +is an extension introduced by The XFree86 Project, Inc., in their 4.0.2 +release. +Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XmbTextEscapement(__libmansuffix__), XmbTextExtents(__libmansuffix__) diff --git a/lib/libX11/man/XrmEnumerateDatabase.man b/lib/libX11/man/XrmEnumerateDatabase.man index 03c0f30e2..da803ccbc 100644 --- a/lib/libX11/man/XrmEnumerateDatabase.man +++ b/lib/libX11/man/XrmEnumerateDatabase.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XrmEnumerateDatabase __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME @@ -91,14 +58,14 @@ lw(.5i) lw(2i) lw(2.5i). T{ \&#define T} T{ -.ZN XrmEnumAllLevels +.B XrmEnumAllLevels T} T{ 0 T} T{ \&#define T} T{ -.ZN XrmEnumOneLevel +.B XrmEnumOneLevel T} T{ 1 T} @@ -106,7 +73,7 @@ T} .HP Bool XrmEnumerateDatabase\^(\^XrmDatabase \fIdatabase\fP\^, XrmNameList \fIname_prefix\fP\^, XrmClassList \fIclass_prefix\fP\^, int \fImode\fP\^, Bool -(\^*\fIproc\fP\^)\^(\^)\^, XPointer \fIarg\fP\^); +(\^*\fIproc\fP\^)\^(\^)\^, XPointer \fIarg\fP\^); .SH ARGUMENTS .IP \fIdatabase\fP 1i Specifies the resource database. @@ -122,30 +89,31 @@ Specifies the procedure that is to be called for each matching entry. Specifies the user-supplied argument that will be passed to the procedure. .SH DESCRIPTION The -.ZN XrmEnumerateDatabase +.B XrmEnumerateDatabase function calls the specified procedure for each resource in the database that would match some completion of the given name/class resource prefix. The order in which resources are found is implementation-dependent. If mode is -.ZN XrmEnumOneLevel , +.BR XrmEnumOneLevel , a resource must match the given name/class prefix with -just a single name and class appended. If mode is -.ZN XrmEnumAllLevels , +just a single name and class appended. +If mode is +.BR XrmEnumAllLevels , the resource must match the given name/class prefix with one or more names and classes appended. If the procedure returns -.ZN True , +.BR True , the enumeration terminates and the function returns -.ZN True . +.BR True . If the procedure always returns -.ZN False , +.BR False , all matching resources are enumerated and the function returns -.ZN False . +.BR False . .LP The procedure is called with the following arguments: .LP .\" Start marker code here -.Ds 0 +.EX (*\fIproc\fP\^)(\^\fIdatabase\fP, \fIbindings\fP, \fIquarks\fP, \fItype\fP, \fIvalue\fP, \fIarg\fP\^) XrmDatabase *\fIdatabase\fP\^; XrmBindingList \fIbindings\fP\^; @@ -153,11 +121,11 @@ The procedure is called with the following arguments: XrmRepresentation *\fItype\fP\^; XrmValue *\fIvalue\fP\^; XPointer \fIarg\fP\^; -.De +.EE .\" End marker code here .LP The bindings and quarks lists are terminated by -.ZN NULLQUARK . +.BR NULLQUARK . Note that pointers to the database and type are passed, but these values should not be modified. .LP diff --git a/lib/libX11/man/XrmGetFileDatabase.man b/lib/libX11/man/XrmGetFileDatabase.man index a0c101979..5cbad8995 100644 --- a/lib/libX11/man/XrmGetFileDatabase.man +++ b/lib/libX11/man/XrmGetFileDatabase.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .de EX .sp .nf @@ -95,21 +62,21 @@ XrmGetFileDatabase, XrmPutFileDatabase, XrmGetStringDatabase, XrmLocaleOfDatabas .HP #include <X11/Xresource.h> .HP -XrmDatabase XrmGetFileDatabase\^(\^char *\fIfilename\fP\^); +XrmDatabase XrmGetFileDatabase\^(\^char *\fIfilename\fP\^); .HP void XrmPutFileDatabase\^(\^XrmDatabase \fIdatabase\fP\^, char -*\fIstored_db\fP\^); +*\fIstored_db\fP\^); .HP XrmDatabase XrmGetStringDatabase\^(\^char *\fIdata\fP\^); .HP -char *XrmLocaleOfDatabase\^(\^XrmDatabase \fIdatabase\fP\^); +char *XrmLocaleOfDatabase\^(\^XrmDatabase \fIdatabase\fP\^); .HP -XrmDatabase XrmGetDatabase\^(\^Display *\fIdisplay\fP\^); +XrmDatabase XrmGetDatabase\^(\^Display *\fIdisplay\fP\^); .HP void XrmSetDatabase\^(\^Display *\fIdisplay\fP\^, XrmDatabase -\fIdatabase\fP\^); +\fIdatabase\fP\^); .HP -void XrmDestroyDatabase\^(\^XrmDatabase \fIdatabase\fP\^); +void XrmDestroyDatabase\^(\^XrmDatabase \fIdatabase\fP\^); .SH ARGUMENTS .IP \fIfilename\fP 1i Specifies the resource database file name. @@ -125,21 +92,21 @@ Specifies the resource database. Specifies the connection to the X server. .SH DESCRIPTION The -.ZN XrmGetFileDatabase +.B XrmGetFileDatabase function opens the specified file, creates a new resource database, and loads it with the specifications read in from the specified file. The specified file should contain a sequence of entries in valid ResourceLine format (see section 15.1); the database that results from reading a file with incorrect syntax is implementation-dependent. -The file is parsed in the current locale, +The file is parsed in the current locale, and the database is created in the current locale. If it cannot open the specified file, -.ZN XrmGetFileDatabase +.B XrmGetFileDatabase returns NULL. .LP The -.ZN XrmPutFileDatabase +.B XrmPutFileDatabase function stores a copy of the specified database in the specified file. Text is written to the file as a sequence of entries in valid ResourceLine format (see section 15.1). @@ -148,29 +115,29 @@ Entries containing resource names that are not in the Host Portable Character Encoding or containing values that are not in the encoding of the database locale, are written in an implementation-dependent manner. The order in which entries are written is implementation-dependent. -Entries with representation types other than ``String'' are ignored. +Entries with representation types other than \*(lqString\*(rq are ignored. .LP The -.ZN XrmGetStringDatabase +.B XrmGetStringDatabase function creates a new database and stores the resources specified in the specified null-terminated string. -.ZN XrmGetStringDatabase +.B XrmGetStringDatabase is similar to -.ZN XrmGetFileDatabase +.B XrmGetFileDatabase except that it reads the information out of a string instead of out of a file. The string should contain a sequence of entries in valid ResourceLine format (see section 15.1) terminated by a null character; the database that results from using a string with incorrect syntax is implementation-dependent. -The string is parsed in the current locale, +The string is parsed in the current locale, and the database is created in the current locale. .LP If database is NULL, -.ZN XrmDestroyDatabase +.B XrmDestroyDatabase returns immediately. .LP The -.ZN XrmLocaleOfDatabase +.B XrmLocaleOfDatabase function returns the name of the locale bound to the specified database, as a null-terminated string. The returned locale name string is owned by Xlib and should not be @@ -180,12 +147,12 @@ Until the string is freed, it will not be modified by Xlib. .LP The -.ZN XrmGetDatabase +.B XrmGetDatabase function returns the database associated with the specified display. It returns NULL if a database has not yet been set. .LP The -.ZN XrmSetDatabase +.B XrmSetDatabase function associates the specified resource database (or NULL) with the specified display. The database previously associated with the display (if any) is not destroyed. @@ -220,41 +187,42 @@ Quotes ("\&.\&.\&.") are used around literal characters. .LP IncludeFile lines are interpreted by replacing the line with the contents of the specified file. -The word ``include'' must be in lowercase. +The word \*(lqinclude\*(rq must be in lowercase. The file name is interpreted relative to the directory of the file in which the line occurs (for example, if the file name contains no directory or contains a relative directory specification). .LP If a ResourceName contains a contiguous sequence of two or more Binding -characters, the sequence will be replaced with single ``\&.'' character -if the sequence contains only ``\&.'' characters; -otherwise, the sequence will be replaced with a single ``*'' character. +characters, the sequence will be replaced with single \*(lq\&.\*(rq character +if the sequence contains only \*(lq\&.\*(rq characters; +otherwise, the sequence will be replaced with a single \*(lq*\*(rq character. .LP A resource database never contains more than one entry for a given -ResourceName. If a resource file contains multiple lines with the +ResourceName. +If a resource file contains multiple lines with the same ResourceName, the last line in the file is used. .LP Any white space characters before or after the name or colon in a ResourceSpec are ignored. To allow a Value to begin with white space, -the two-character sequence ``\^\\\^\fIspace\fP'' (backslash followed by space) +the two-character sequence \*(lq\^\\\^\fIspace\fP\*(rq (backslash followed by space) is recognized and replaced by a space character, -and the two-character sequence ``\^\\\^\fItab\fP'' +and the two-character sequence \*(lq\^\\\^\fItab\fP\*(rq (backslash followed by horizontal tab) is recognized and replaced by a horizontal tab character. To allow a Value to contain embedded newline characters, -the two-character sequence ``\^\\\^n'' is recognized and replaced by a +the two-character sequence \*(lq\^\\\^n\*(rq is recognized and replaced by a newline character. To allow a Value to be broken across multiple lines in a text file, -the two-character sequence ``\^\\\^\fInewline\fP'' +the two-character sequence \*(lq\^\\\^\fInewline\fP\*(rq (backslash followed by newline) is recognized and removed from the value. To allow a Value to contain arbitrary character codes, -the four-character sequence ``\^\\\^\fInnn\fP'', -where each \fIn\fP is a digit character in the range of ``0''\^\-``7'', +the four-character sequence \*(lq\^\\\^\fInnn\fP\*(rq, +where each \fIn\fP is a digit character in the range of \*(lq0\*(rq\^\-\*(lq7\*(rq, is recognized and replaced with a single byte that contains the octal value specified by the sequence. -Finally, the two-character sequence ``\^\\\\'' is recognized +Finally, the two-character sequence \*(lq\^\\\\\*(rq is recognized and replaced with a single backslash. .SH "SEE ALSO" XrmGetResource(__libmansuffix__), diff --git a/lib/libX11/man/XrmGetResource.man b/lib/libX11/man/XrmGetResource.man index ef2cf9ada..41021ef15 100644 --- a/lib/libX11/man/XrmGetResource.man +++ b/lib/libX11/man/XrmGetResource.man @@ -39,46 +39,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" e .TH XrmGetResource __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME @@ -89,21 +56,21 @@ XrmGetResource, XrmQGetResource, XrmQGetSearchList, XrmQGetSearchResource \- ret .HP Bool XrmGetResource\^(\^XrmDatabase \fIdatabase\fP\^, char *\fIstr_name\fP\^, char *\fIstr_class\fP\^, char **\fIstr_type_return\fP\^, XrmValue -*\fIvalue_return\fP\^); +*\fIvalue_return\fP\^); .HP Bool XrmQGetResource\^(\^XrmDatabase \fIdatabase\fP\^, XrmNameList \fIquark_name\fP\^, XrmClassList \fIquark_class\fP\^, XrmRepresentation -*\fIquark_type_return\fP\^, XrmValue *\fIvalue_return\fP\^); +*\fIquark_type_return\fP\^, XrmValue *\fIvalue_return\fP\^); .HP typedef XrmHashTable *XrmSearchList; .sp Bool XrmQGetSearchList\^(\^XrmDatabase \fIdatabase\fP\^, XrmNameList \fInames\fP\^, XrmClassList \fIclasses\fP\^, XrmSearchList -\fIlist_return\fP\^, int \fIlist_length\fP\^); +\fIlist_return\fP\^, int \fIlist_length\fP\^); .HP Bool XrmQGetSearchResource\^(\^XrmSearchList \fIlist\fP\^, XrmName -\fIname\fP\^, XrmClass \fIclass\fP\^, XrmRepresentation *\fItype_return\fP\^, -XrmValue *\fIvalue_return\fP\^); +\fIname\fP\^, XrmClass \fIclass\fP\^, XrmRepresentation *\fItype_return\fP\^, +XrmValue *\fIvalue_return\fP\^); .SH ARGUMENTS .IP \fIclass\fP 1i Specifies the resource class. @@ -113,7 +80,7 @@ Specifies a list of resource classes. Specifies the database that is to be used. .IP \fIlist\fP 1i Specifies the search list returned by -.ZN XrmQGetSearchList . +.BR XrmQGetSearchList . .IP \fIlist_length\fP 1i Specifies the number of entries (not the byte size) allocated for list_return. .IP \fIlist_return\fP 1i @@ -139,88 +106,88 @@ Returns data representation type. .IP \fIvalue_return\fP 1i Returns the value in the database. .SH DESCRIPTION -The -.ZN XrmGetResource -and -.ZN XrmQGetResource +The +.B XrmGetResource +and +.B XrmQGetResource functions retrieve a resource from the specified database. Both take a fully qualified name/class pair, a destination resource representation, and the address of a value -(size/address pair). +(size/address pair). The value and returned type point into database memory; therefore, you must not modify the data. .LP The database only frees or overwrites entries on -.ZN XrmPutResource , -.ZN XrmQPutResource , -or -.ZN XrmMergeDatabases . +.BR XrmPutResource , +.BR XrmQPutResource , +or +.BR XrmMergeDatabases . A client that is not storing new values into the database or -is not merging the database should be safe using the address passed +is not merging the database should be safe using the address passed back at any time until it exits. If a resource was found, both -.ZN XrmGetResource +.B XrmGetResource and -.ZN XrmQGetResource -return -.ZN True ; -otherwise, they return -.ZN False . +.B XrmQGetResource +return +.BR True ; +otherwise, they return +.BR False . .LP The -.ZN XrmQGetSearchList +.B XrmQGetSearchList function takes a list of names and classes and returns a list of database levels where a match might occur. The returned list is in best-to-worst order and -uses the same algorithm as -.ZN XrmGetResource +uses the same algorithm as +.B XrmGetResource for determining precedence. If list_return was large enough for the search list, -.ZN XrmQGetSearchList -returns -.ZN True ; +.B XrmQGetSearchList +returns +.BR True ; otherwise, it returns -.ZN False . +.BR False . .LP The size of the search list that the caller must allocate is -dependent upon the number of levels and wildcards in the resource specifiers +dependent upon the number of levels and wildcards in the resource specifiers that are stored in the database. The worst case length is %3 sup n%, where \fIn\fP is the number of name or class components in names or classes. .LP -When using -.ZN XrmQGetSearchList +When using +.B XrmQGetSearchList followed by multiple probes for resources with a common name and class prefix, -only the common prefix should be specified in the name and class list to -.ZN XrmQGetSearchList . +only the common prefix should be specified in the name and class list to +.BR XrmQGetSearchList . .LP The -.ZN XrmQGetSearchResource -function searches the specified database levels for the resource +.B XrmQGetSearchResource +function searches the specified database levels for the resource that is fully identified by the specified name and class. The search stops with the first match. -.ZN XrmQGetSearchResource -returns -.ZN True +.B XrmQGetSearchResource +returns +.B True if the resource was found; otherwise, it returns -.ZN False . +.BR False . .LP -A call to -.ZN XrmQGetSearchList -with a name and class list containing all but the last component -of a resource name followed by a call to -.ZN XrmQGetSearchResource -with the last component name and class returns the same database entry as -.ZN XrmGetResource -and -.ZN XrmQGetResource +A call to +.B XrmQGetSearchList +with a name and class list containing all but the last component +of a resource name followed by a call to +.B XrmQGetSearchResource +with the last component name and class returns the same database entry as +.B XrmGetResource +and +.B XrmQGetResource with the fully qualified name and class. .SH "MATCHING RULES" The algorithm for determining which resource database entry matches a given query is the heart of the resource manager. All queries must fully specify the name and class of the desired resource -(use of the characters ``*'' and ``?'' are not permitted). +(use of the characters \*(lq*\*(rq and \*(lq?\*(rq are not permitted). The library supports up to 100 components in a full name or class. Resources are stored in the database with only partially specified names and classes, using pattern matching constructs. @@ -230,7 +197,7 @@ A period (.) is a tight binding and is used to separate immediately adjacent components. A question mark (?) is used to match any single component name or class. A database entry cannot end in a loose binding; -the final component (which cannot be the character ``?'') must be specified. +the final component (which cannot be the character \*(lq?\*(rq) must be specified. The lookup algorithm searches the database for the entry that most closely matches (is most specific for) the full name and class being queried. When more than one database entry matches the full name and class, @@ -246,14 +213,14 @@ until a rule selects a single entry over all others. The rules, in order of precedence, are: .IP 1. 5 An entry that contains a matching component (whether name, class, -or the character ``?'') +or the character \*(lq?\*(rq) takes precedence over entries that elide the level (that is, entries that match the level in a loose binding). .IP 2. 5 An entry with a matching name takes precedence over both -entries with a matching class and entries that match using the character ``?''. +entries with a matching class and entries that match using the character \*(lq?\*(rq. An entry with a matching class takes precedence over -entries that match using the character ``?''. +entries that match using the character \*(lq?\*(rq. .IP 3. 5 An entry preceded by a tight binding takes precedence over entries preceded by a loose binding. diff --git a/lib/libX11/man/XrmInitialize.man b/lib/libX11/man/XrmInitialize.man index 3b3ddd78b..683ae650a 100644 --- a/lib/libX11/man/XrmInitialize.man +++ b/lib/libX11/man/XrmInitialize.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XrmInitialize __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XrmInitialize, XrmParseCommand, XrmValue, XrmOptionKind, XrmOptionDescRec \- initialize the Resource Manager, Resource Manager structures, and parse the command line @@ -89,7 +56,7 @@ void XrmInitialize\^(void\^); .HP void XrmParseCommand\^(\^XrmDatabase *\fIdatabase\fP\^, XrmOptionDescList \fItable\fP\^, int \fItable_count\fP\^, char *\fIname\fP\^, int -*\fIargc_in_out\fP\^, char **\fIargv_in_out\fP\^); +*\fIargc_in_out\fP\^, char **\fIargv_in_out\fP\^); .SH ARGUMENTS .IP \fIargc_in_out\fP 1i Specifies the number of arguments and returns the number of remaining arguments. @@ -106,17 +73,17 @@ Specifies the table of command line arguments to be parsed. Specifies the number of entries in the table. .SH DESCRIPTION The -.ZN XrmInitialize +.B XrmInitialize function initialize the resource manager. It must be called before any other Xrm functions are used. .LP The -.ZN XrmParseCommand +.B XrmParseCommand function parses an (argc, argv) pair according to the specified option table, -loads recognized options into the specified database with type ``String,'' +loads recognized options into the specified database with type \*(lqString,\*(rq and modifies the (argc, argv) pair to remove all recognized options. If database contains NULL, -.ZN XrmParseCommand +.B XrmParseCommand creates a new database and returns a pointer to it. Otherwise, entries are added to the database specified. If a database is created, it is created in the current locale. @@ -126,15 +93,15 @@ Recognized options in the table are removed from argv, and entries are added to the specified resource database in the order they occur in argv. The table entries contain information on the option string, -the option name, the style of option, -and a value to provide if the option kind is -.ZN XrmoptionNoArg . +the option name, the style of option, +and a value to provide if the option kind is +.BR XrmoptionNoArg . The option names are compared byte-for-byte to arguments in argv, independent of any locale. The resource values given in the table are stored in the resource database without modification. All resource database entries are created -using a ``String'' representation type. +using a \*(lqString\*(rq representation type. The argc argument specifies the number of arguments in argv and is set on return to the remaining number of arguments that were not parsed. The name argument should be the name of your application @@ -153,20 +120,20 @@ Host Portable Character Encoding, the result is implementation-dependent. .SH STRUCTURES The -.ZN XrmValue , -.ZN XrmOptionKind , +.BR XrmValue , +.BR XrmOptionKind , and -.ZN XrmOptionDescRec +.B XrmOptionDescRec structures contain: .LP -.Ds 0 +.EX typedef struct { unsigned int size; XPointer addr; } XrmValue, *XrmValuePtr; -.De +.EE .LP -.Ds 0 +.EX typedef enum { XrmoptionNoArg, /\&* Value is specified in XrmOptionDescRec.value */ XrmoptionIsArg, /\&* Value is the option string itself */ @@ -178,17 +145,17 @@ typedef enum { XrmoptionSkipNArgs /\&* Ignore this option and the next \ \ \ XrmOptionDescRec.value arguments in argv */ } XrmOptionKind; -.De +.EE .LP -.Ds 0 +.EX typedef struct { char *option; /\&* Option specification string in argv */ char *specifier; /\&* Binding and resource name (sans application name) */ XrmOptionKind argKind; /\&* Which style of option it is */ - XPointer value; /\&* Value to provide if XrmoptionNoArg or + XPointer value; /\&* Value to provide if XrmoptionNoArg or \ \ \ XrmoptionSkipNArgs */ } XrmOptionDescRec, *XrmOptionDescList; -.De +.EE .SH "SEE ALSO" XrmGetResource(__libmansuffix__), XrmMergeDatabases(__libmansuffix__), diff --git a/lib/libX11/man/XrmMergeDatabases.man b/lib/libX11/man/XrmMergeDatabases.man index 41b27bb63..2a6ada2f0 100644 --- a/lib/libX11/man/XrmMergeDatabases.man +++ b/lib/libX11/man/XrmMergeDatabases.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XrmMergeDatabases __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XrmMergeDatabases, XrmCombineDatabase, XrmCombineFileDatabase \- merge resource databases @@ -86,18 +53,18 @@ XrmMergeDatabases, XrmCombineDatabase, XrmCombineFileDatabase \- merge resource #include <X11/Xresource.h> .HP void XrmMergeDatabases(\^XrmDatabase \fIsource_db\fP, XrmDatabase -*\fItarget_db\fP\^); +*\fItarget_db\fP\^); .HP void XrmCombineDatabase(\^XrmDatabase \fIsource_db\fP, XrmDatabase -*\fItarget_db\fP, Bool \fIoverride\fP\^); +*\fItarget_db\fP, Bool \fIoverride\fP\^); .HP Status XrmCombineFileDatabase(\^char *\fIfilename\fP, XrmDatabase -*\fItarget_db\fP\^, Bool \fIoverride\fP); +*\fItarget_db\fP\^, Bool \fIoverride\fP); .SH ARGUMENTS .IP \fIsource_db\fP 1i Specifies the resource database that is to be merged into the target database. .IP \fItarget_db\fP 1i -Specifies the resource database into which the source +Specifies the resource database into which the source database is to be merged. .IP \fIfilename\fP 1i Specifies the resource database file name. @@ -105,22 +72,22 @@ Specifies the resource database file name. Specifies whether source entries override target ones. .SH DESCRIPTION Calling the -.ZN XrmMergeDatabases +.B XrmMergeDatabases function is equivalent to calling the -.ZN XrmCombineDatabase +.B XrmCombineDatabase function with an override argument of -.ZN True . +.BR True . .LP The -.ZN XrmCombineDatabase +.B XrmCombineDatabase function merges the contents of one database into another. If the same specifier is used for an entry in both databases, the entry in the source_db will replace the entry in the target_db if override is -.ZN True ; +.BR True ; otherwise, the entry in source_db is discarded. If target_db contains NULL, -.ZN XrmCombineDatabase +.B XrmCombineDatabase simply stores source_db in it. Otherwise, source_db is destroyed by the merge, but the database pointed to by target_db is not destroyed. @@ -129,20 +96,20 @@ regardless of the locales of the databases. The locale of the target database is not modified. .LP The -.ZN XrmCombineFileDatabase +.B XrmCombineFileDatabase function merges the contents of a resource file into a database. If the same specifier is used for an entry in both the file and the database, the entry in the file will replace the entry in the database if override is -.ZN True ; +.BR True ; otherwise, the entry in the file is discarded. The file is parsed in the current locale. If the file cannot be read, a zero status is returned; otherwise, a nonzero status is returned. If target_db contains NULL, -.ZN XrmCombineFileDatabase +.B XrmCombineFileDatabase creates and returns a new database to it. Otherwise, the database pointed to by target_db is not destroyed by the merge. The database entries are merged without changing values or types, diff --git a/lib/libX11/man/XrmPutResource.man b/lib/libX11/man/XrmPutResource.man index fd644630d..86258f58a 100644 --- a/lib/libX11/man/XrmPutResource.man +++ b/lib/libX11/man/XrmPutResource.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XrmPutResource __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XrmPutResource, XrmQPutResource, XrmPutStringResource, XrmQPutStringResource, XrmPutLineResource \- store database resources @@ -86,20 +53,20 @@ XrmPutResource, XrmQPutResource, XrmPutStringResource, XrmQPutStringResource, Xr #include <X11/Xresource.h> .HP void XrmPutResource\^(\^XrmDatabase *\fIdatabase\fP\^, char -*\fIspecifier\fP\^, char *\fItype\fP\^, XrmValue *\fIvalue\fP\^); +*\fIspecifier\fP\^, char *\fItype\fP\^, XrmValue *\fIvalue\fP\^); .HP void XrmQPutResource\^(\^XrmDatabase *\fIdatabase\fP\^, XrmBindingList \fIbindings\fP\^, XrmQuarkList \fIquarks\fP\^, XrmRepresentation \fItype\fP\^, -XrmValue *\fIvalue\fP\^); +XrmValue *\fIvalue\fP\^); .HP void XrmPutStringResource\^(\^XrmDatabase *\fIdatabase\fP\^, char -*\fIspecifier\fP\^, char *\fIvalue\fP\^); +*\fIspecifier\fP\^, char *\fIvalue\fP\^); .HP void XrmQPutStringResource\^(\^XrmDatabase *\fIdatabase\fP\^, XrmBindingList -\fIbindings\fP\^, XrmQuarkList \fIquarks\fP\^, char *\fIvalue\fP\^); +\fIbindings\fP\^, XrmQuarkList \fIquarks\fP\^, char *\fIvalue\fP\^); .HP void XrmPutLineResource\^(\^XrmDatabase *\fIdatabase\fP\^, char -*\fIline\fP\^); +*\fIline\fP\^); .SH ARGUMENTS .IP \fIbindings\fP 1i Specifies a list of bindings. @@ -117,23 +84,23 @@ Specifies the type of the resource. Specifies the value of the resource, which is specified as a string. .SH DESCRIPTION If database contains NULL, -.ZN XrmPutResource +.B XrmPutResource creates a new database and returns a pointer to it. -.ZN XrmPutResource +.B XrmPutResource is a convenience function that calls -.ZN XrmStringToBindingQuarkList +.B XrmStringToBindingQuarkList followed by: .LP -.Ds +.EX XrmQPutResource(database, bindings, quarks, XrmStringToQuark(type), value) -.De +.EE .LP If the specifier and type are not in the Host Portable Character Encoding, the result is implementation-dependent. The value is stored in the database without modification. .LP If database contains NULL, -.ZN XrmQPutResource +.B XrmQPutResource creates a new database and returns a pointer to it. If a resource entry with the identical bindings and quarks already exists in the database, the previous type and value are replaced by the new @@ -141,38 +108,38 @@ specified type and value. The value is stored in the database without modification. .LP If database contains NULL, -.ZN XrmPutStringResource +.B XrmPutStringResource creates a new database and returns a pointer to it. -.ZN XrmPutStringResource +.B XrmPutStringResource adds a resource with the specified value to the specified database. -.ZN XrmPutStringResource +.B XrmPutStringResource is a convenience function that first calls -.ZN XrmStringToBindingQuarkList +.B XrmStringToBindingQuarkList on the specifier and then calls -.ZN XrmQPutResource , -using a ``String'' representation type. +.BR XrmQPutResource , +using a \*(lqString\*(rq representation type. If the specifier is not in the Host Portable Character Encoding, the result is implementation-dependent. The value is stored in the database without modification. .LP If database contains NULL, -.ZN XrmQPutStringResource +.B XrmQPutStringResource creates a new database and returns a pointer to it. -.ZN XrmQPutStringResource +.B XrmQPutStringResource is a convenience routine that constructs an -.ZN XrmValue +.B XrmValue for the value string (by calling -.ZN strlen +.B strlen to compute the size) and then calls -.ZN XrmQPutResource , -using a ``String'' representation type. +.BR XrmQPutResource , +using a \*(lqString\*(rq representation type. The value is stored in the database without modification. .LP If database contains NULL, -.ZN XrmPutLineResource +.B XrmPutLineResource creates a new database and returns a pointer to it. -.ZN XrmPutLineResource +.B XrmPutLineResource adds a single resource entry to the specified database. The line should be in valid ResourceLine format (see section 15.1) terminated by a newline or null character; @@ -180,7 +147,7 @@ the database that results from using a string with incorrect syntax is implementation-dependent. The string is parsed in the locale of the database. If the -.ZN ResourceName +.B ResourceName is not in the Host Portable Character Encoding, the result is implementation-dependent. Note that comment lines are not stored. diff --git a/lib/libX11/man/XrmUniqueQuark.man b/lib/libX11/man/XrmUniqueQuark.man index 93755f71b..544ffced6 100644 --- a/lib/libX11/man/XrmUniqueQuark.man +++ b/lib/libX11/man/XrmUniqueQuark.man @@ -38,46 +38,13 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 .TH XrmUniqueQuark __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XrmUniqueQuark, XrmStringToQuark, XrmPermStringToQuark, XrmQuarkToString, XrmStringToQuarkList, XrmStringToBindingQuarkList \- manipulate resource quarks @@ -85,7 +52,7 @@ XrmUniqueQuark, XrmStringToQuark, XrmPermStringToQuark, XrmQuarkToString, XrmStr .HP #include <X11/Xresource.h> .HP -XrmQuark XrmUniqueQuark\^(void); +XrmQuark XrmUniqueQuark\^(void); .LP \&#define XrmStringToName(string) XrmStringToQuark(string) .br @@ -93,9 +60,9 @@ XrmQuark XrmUniqueQuark\^(void); .br \&#define XrmStringToRepresentation(string) XrmStringToQuark(string) .HP -int XrmQuark XrmStringToQuark\^(\^char *\fIstring\fP\^); +int XrmQuark XrmStringToQuark\^(\^char *\fIstring\fP\^); .HP -XrmQuark XrmPermStringToQuark\^(\^char *\fIstring\fP\^); +XrmQuark XrmPermStringToQuark\^(\^char *\fIstring\fP\^); .LP \&#define XrmStringToName(string) XrmStringToQuark(string) .br @@ -103,9 +70,9 @@ XrmQuark XrmPermStringToQuark\^(\^char *\fIstring\fP\^); .br \&#define XrmStringToRepresentation(string) XrmStringToQuark(string) .HP -XrmQuark XrmStringToQuark\^(\^char *\fIstring\fP\^); +XrmQuark XrmStringToQuark\^(\^char *\fIstring\fP\^); .HP -XrmQuark XrmPermStringToQuark\^(\^char *\fIstring\fP\^); +XrmQuark XrmPermStringToQuark\^(\^char *\fIstring\fP\^); .LP \&#define XrmNameToString(name) XrmQuarkToString(name) .br @@ -113,7 +80,7 @@ XrmQuark XrmPermStringToQuark\^(\^char *\fIstring\fP\^); .br \&#define XrmRepresentationToString(type) XrmQuarkToString(type) .HP -char *XrmQuarkToString\^(\^XrmQuark \fIquark\fP\^); +char *XrmQuarkToString\^(\^XrmQuark \fIquark\fP\^); .LP \&#define XrmStringToNameList(str, name) XrmStringToQuarkList((str), (name)) .br @@ -121,10 +88,10 @@ char *XrmQuarkToString\^(\^XrmQuark \fIquark\fP\^); .sp .HP void XrmStringToQuarkList\^(\^char *\fIstring\fP\^, XrmQuarkList -\fIquarks_return\fP\^); +\fIquarks_return\fP\^); .HP XrmStringToBindingQuarkList\^(\^char *\fIstring\fP\^, XrmBindingList -\fIbindings_return\fP\^, XrmQuarkList \fIquarks_return\fP\^); +\fIbindings_return\fP\^, XrmQuarkList \fIquarks_return\fP\^); .SH ARGUMENTS .IP \fIbindings_return\fP 1i Returns the binding list. @@ -132,12 +99,11 @@ Returns the binding list. Specifies the quark for which the equivalent string is desired. .IP \fIquarks_return\fP 1i Returns the list of quarks. -.ds Ql \ or quark list .IP \fIstring\fP 1i -Specifies the string for which a quark\*(Ql is to be allocated. +Specifies the string for which a quark or quark list is to be allocated. .SH DESCRIPTION The -.ZN XrmUniqueQuark +.B XrmUniqueQuark function allocates a quark that is guaranteed not to represent any string that is known to the resource manager. .LP @@ -145,18 +111,18 @@ These functions can be used to convert from string to quark representation. If the string is not in the Host Portable Character Encoding, the conversion is implementation-dependent. The string argument to -.ZN XrmStringToQuark +.B XrmStringToQuark need not be permanently allocated storage. -.ZN XrmPermStringToQuark +.B XrmPermStringToQuark is just like -.ZN XrmStringToQuark , +.BR XrmStringToQuark , except that Xlib is permitted to assume the string argument is permanently allocated, and, hence, that it can be used as the value to be returned by -.ZN XrmQuarkToString . +.BR XrmQuarkToString . .LP For any given quark, if -.ZN XrmStringToQuark +.B XrmStringToQuark returns a non-NULL value, all future calls will return the same value (identical address). .LP @@ -165,10 +131,10 @@ The string pointed to by the return value must not be modified or freed. The returned string is byte-for-byte equal to the original string passed to one of the string-to-quark routines. If no string exists for that quark, -.ZN XrmQuarkToString +.B XrmQuarkToString returns NULL. For any given quark, if -.ZN XrmQuarkToString +.B XrmQuarkToString returns a non-NULL value, all future calls will return the same value (identical address). .LP @@ -176,34 +142,34 @@ These functions can be used to convert from string to quark representation. If the string is not in the Host Portable Character Encoding, the conversion is implementation-dependent. The string argument to -.ZN XrmStringToQuark +.B XrmStringToQuark need not be permanently allocated storage. -.ZN XrmPermStringToQuark +.B XrmPermStringToQuark is just like -.ZN XrmStringToQuark , +.BR XrmStringToQuark , except that Xlib is permitted to assume the string argument is permanently allocated, and, hence, that it can be used as the value to be returned by -.ZN XrmQuarkToString . +.BR XrmQuarkToString . .LP For any given quark, if -.ZN XrmStringToQuark +.B XrmStringToQuark returns a non-NULL value, all future calls will return the same value (identical address). .LP The -.ZN XrmStringToQuarkList +.B XrmStringToQuarkList function converts the null-terminated string (generally a fully qualified name) to a list of quarks. -The caller must allocate sufficient space for the quarks list before calling -.ZN XrmStringToQuarkList . -Note that the string must be in the valid ResourceName format +The caller must allocate sufficient space for the quarks list before calling +.BR XrmStringToQuarkList . +Note that the string must be in the valid ResourceName format (see section 15.1). If the string is not in the Host Portable Character Encoding, the conversion is implementation-dependent. .LP A binding list is a list of type -.ZN XrmBindingList +.B XrmBindingList and indicates if components of name or class lists are bound tightly or loosely (that is, if wildcarding of intermediate components is specified). .LP @@ -211,27 +177,27 @@ and indicates if components of name or class lists are bound tightly or loosely typedef enum {XrmBindTightly, XrmBindLoosely} XrmBinding, *XrmBindingList; .EE .LP -.ZN XrmBindTightly +.B XrmBindTightly indicates that a period separates the components, and -.ZN XrmBindLoosely +.B XrmBindLoosely indicates that an asterisk separates the components. .LP The -.ZN XrmStringToBindingQuarkList +.B XrmStringToBindingQuarkList function converts the specified string to a binding list and a quark list. The caller must allocate sufficient space for the quarks list and the -binding list before calling -.ZN XrmStringToBindingQuarkList . +binding list before calling +.BR XrmStringToBindingQuarkList . If the string is not in the Host Portable Character Encoding the conversion is implementation-dependent. Component names in the list are separated by a period or an asterisk character. If the string does not start with period or asterisk, a period is assumed. -For example, ``*a.b*c'' becomes: +For example, \*(lq*a.b*c\*(rq becomes: .LP .TS -l l l. +L l l l. quarks a b c bindings loose tight loose .TE diff --git a/lib/libX11/man/xkb/XkbFreeIndicatorMaps.man b/lib/libX11/man/xkb/XkbFreeIndicatorMaps.man index f7137578e..bff887fce 100644 --- a/lib/libX11/man/xkb/XkbFreeIndicatorMaps.man +++ b/lib/libX11/man/xkb/XkbFreeIndicatorMaps.man @@ -46,3 +46,9 @@ frees the memory associated with the .I indicators member of .I xkb. + +If xkb is NULL, no operation is performed. + +.SH "SEE ALSO" +.BR XkbAllocIndicatorMaps (__libmansuffix__) + diff --git a/lib/libX11/man/xkb/XkbFreeKeyboard.man b/lib/libX11/man/xkb/XkbFreeKeyboard.man index afa928e4d..6d90307f8 100644 --- a/lib/libX11/man/xkb/XkbFreeKeyboard.man +++ b/lib/libX11/man/xkb/XkbFreeKeyboard.man @@ -60,3 +60,13 @@ and then frees the .I xkb structure itself. +If kbd is NULL, no operation is performed. + +.SH "SEE ALSO" +.BR XkbFreeClientMap (__libmansuffix__), +.BR XkbFreeServerMap (__libmansuffix__), +.BR XkbFreeCompatMap (__libmansuffix__), +.BR XkbFreeIndicatorMaps (__libmansuffix__), +.BR XkbFreeNames (__libmansuffix__), +.BR XkbFreeGeometry (__libmansuffix__), +.BR XkbFreeControls (__libmansuffix__) diff --git a/lib/libX11/src/OpenDis.c b/lib/libX11/src/OpenDis.c index 82723578e..717de3390 100644 --- a/lib/libX11/src/OpenDis.c +++ b/lib/libX11/src/OpenDis.c @@ -201,6 +201,7 @@ XOpenDisplay ( X_DPY_SET_LAST_REQUEST_READ(dpy, 0); dpy->default_screen = iscreen; /* Value returned by ConnectDisplay */ dpy->last_req = (char *)&_dummy_request; + dpy->req_seq_syncing = False; /* Initialize the display lock */ if (InitDisplayLock(dpy) != 0) { diff --git a/lib/libX11/src/XlibInt.c b/lib/libX11/src/XlibInt.c index 4e45e62b2..e4fb4e5f2 100644 --- a/lib/libX11/src/XlibInt.c +++ b/lib/libX11/src/XlibInt.c @@ -218,10 +218,12 @@ void _XSeqSyncFunction( xGetInputFocusReply rep; _X_UNUSED register xReq *req; - if ((X_DPY_GET_REQUEST(dpy) - X_DPY_GET_LAST_REQUEST_READ(dpy)) >= (65535 - BUFSIZE/SIZEOF(xReq))) { + if ((X_DPY_GET_REQUEST(dpy) - X_DPY_GET_LAST_REQUEST_READ(dpy)) >= (65535 - BUFSIZE/SIZEOF(xReq)) && !dpy->req_seq_syncing) { + dpy->req_seq_syncing = True; GetEmptyReq(GetInputFocus, req); (void) _XReply (dpy, (xReply *)&rep, 0, xTrue); sync_while_locked(dpy); + dpy->req_seq_syncing = False; } else if (sync_hazard(dpy)) _XSetPrivSyncFunction(dpy); } diff --git a/lib/libX11/src/util/Makefile.am b/lib/libX11/src/util/Makefile.am index ba2dd3709..02c53ac71 100644 --- a/lib/libX11/src/util/Makefile.am +++ b/lib/libX11/src/util/Makefile.am @@ -8,10 +8,11 @@ AM_CFLAGS = \ AM_CPPFLAGS = \ -I$(top_srcdir)/include +LINK = $(CCLD) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@ CC = @CC_FOR_BUILD@ CPPFLAGS = @CPPFLAGS_FOR_BUILD@ CFLAGS = @CFLAGS_FOR_BUILD@ -LDFLAGS = @LDFLAGS_FOR_BUILD@ -all-static +LDFLAGS = @LDFLAGS_FOR_BUILD@ LIBS = EXEEXT = @EXEEXT_FOR_BUILD@ diff --git a/lib/libX11/src/util/Makefile.in b/lib/libX11/src/util/Makefile.in index 3bc718d9c..acaf970fb 100644 --- a/lib/libX11/src/util/Makefile.in +++ b/lib/libX11/src/util/Makefile.in @@ -101,9 +101,6 @@ am__v_CC_ = $(am__v_CC_@AM_DEFAULT_V@) am__v_CC_0 = @echo " CC " $@; am__v_CC_1 = CCLD = $(CC) -LINK = $(LIBTOOL) $(AM_V_lt) --tag=CC $(AM_LIBTOOLFLAGS) \ - $(LIBTOOLFLAGS) --mode=link $(CCLD) $(AM_CFLAGS) $(CFLAGS) \ - $(AM_LDFLAGS) $(LDFLAGS) -o $@ AM_V_CCLD = $(am__v_CCLD_@AM_V@) am__v_CCLD_ = $(am__v_CCLD_@AM_DEFAULT_V@) am__v_CCLD_0 = @echo " CCLD " $@; @@ -172,7 +169,7 @@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ KEYSYMDEFS = @KEYSYMDEFS@ LAUNCHD = @LAUNCHD@ LD = @LD@ -LDFLAGS = @LDFLAGS_FOR_BUILD@ -all-static +LDFLAGS = @LDFLAGS_FOR_BUILD@ LDFLAGS_FOR_BUILD = @LDFLAGS_FOR_BUILD@ LIBOBJS = @LIBOBJS@ LIBS = @@ -306,6 +303,7 @@ AM_CFLAGS = \ AM_CPPFLAGS = \ -I$(top_srcdir)/include +LINK = $(CCLD) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@ EXTRA_DIST = mkks.sh # Check source code with tools like lint & sparse diff --git a/lib/libX11/src/xkb/XKBAlloc.c b/lib/libX11/src/xkb/XKBAlloc.c index f1d96c19a..4bd746870 100644 --- a/lib/libX11/src/xkb/XKBAlloc.c +++ b/lib/libX11/src/xkb/XKBAlloc.c @@ -32,7 +32,7 @@ THE USE OR PERFORMANCE OF THIS SOFTWARE. #include <stdio.h> #include "Xlibint.h" #include "XKBlibint.h" -#include <X11/extensions/XKBgeom.h> +#include "X11/extensions/XKBgeom.h" #include <X11/extensions/XKBproto.h> #include "XKBlibint.h" diff --git a/lib/libX11/src/xkb/XKBGAlloc.c b/lib/libX11/src/xkb/XKBGAlloc.c index 6326c8d48..6b464d41c 100644 --- a/lib/libX11/src/xkb/XKBGAlloc.c +++ b/lib/libX11/src/xkb/XKBGAlloc.c @@ -32,7 +32,7 @@ THE USE OR PERFORMANCE OF THIS SOFTWARE. #include <stdio.h> #include "Xlibint.h" #include "XKBlibint.h" -#include <X11/extensions/XKBgeom.h> +#include "X11/extensions/XKBgeom.h" #include <X11/extensions/XKBproto.h> /***====================================================================***/ diff --git a/lib/libX11/src/xkb/XKBGeom.c b/lib/libX11/src/xkb/XKBGeom.c index 66dca9ee0..be7537b96 100644 --- a/lib/libX11/src/xkb/XKBGeom.c +++ b/lib/libX11/src/xkb/XKBGeom.c @@ -33,7 +33,7 @@ THE USE OR PERFORMANCE OF THIS SOFTWARE. #define NEED_MAP_READERS #include "Xlibint.h" -#include <X11/extensions/XKBgeom.h> +#include "X11/extensions/XKBgeom.h" #include <X11/extensions/XKBproto.h> #include "XKBlibint.h" diff --git a/lib/libX11/src/xkb/XKBSetGeom.c b/lib/libX11/src/xkb/XKBSetGeom.c index 7ac37ca61..3a24fbdfd 100644 --- a/lib/libX11/src/xkb/XKBSetGeom.c +++ b/lib/libX11/src/xkb/XKBSetGeom.c @@ -33,7 +33,7 @@ THE USE OR PERFORMANCE OF THIS SOFTWARE. #include "Xlibint.h" #include "XKBlibint.h" -#include <X11/extensions/XKBgeom.h> +#include "X11/extensions/XKBgeom.h" #include <X11/extensions/XKBproto.h> #ifndef MINSHORT |