diff options
Diffstat (limited to 'libX11/man/xkb/XkbOpenDisplay.man')
-rw-r--r-- | libX11/man/xkb/XkbOpenDisplay.man | 300 |
1 files changed, 150 insertions, 150 deletions
diff --git a/libX11/man/xkb/XkbOpenDisplay.man b/libX11/man/xkb/XkbOpenDisplay.man index 2e8d74f31..78b6520d3 100644 --- a/libX11/man/xkb/XkbOpenDisplay.man +++ b/libX11/man/xkb/XkbOpenDisplay.man @@ -1,150 +1,150 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
-.\"
-.\" Permission is hereby granted, free of charge, to any person obtaining a
-.\" copy of this software and associated documentation files (the "Software"),
-.\" to deal in the Software without restriction, including without limitation
-.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
-.\" and/or sell copies of the Software, and to permit persons to whom the
-.\" Software is furnished to do so, subject to the following conditions:
-.\"
-.\" The above copyright notice and this permission notice (including the next
-.\" paragraph) shall be included in all copies or substantial portions of the
-.\" Software.
-.\"
-.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
-.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-.\" DEALINGS IN THE SOFTWARE.
-.\"
-.TH XkbOpenDisplay __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
-.SH NAME
-XkbOpenDisplay \- Checks for a compatible version of the Xkb extension in both
-the library and the server, and initializes the extension for use.
-.SH SYNOPSIS
-.HP
-.B Display XkbOpenDisplay
-.BI "(\^char *" "display_name" "\^,"
-.BI "int *" "event_rtrn" "\^,"
-.BI "int *" "error_rtrn" "\^,"
-.BI "int *" "major_in_out" "\^,"
-.BI "int *" "minor_in_out" "\^,"
-.BI "int *" "reason_rtrn" "\^);"
-.if n .ti +5n
-.if t .ti +.5i
-.SH ARGUMENTS
-.TP
-.I display_name
-hardware display name, which determines the display and communications domain to
-be used
-.TP
-.I event_rtrn
-backfilled with the extension base event code
-.TP
-.I error_rtrn
-backfilled with the extension base error code
-.TP
-.I major_in_out
-compile time lib major version in, server major version out
-.TP
-.I minor_in_out
-compile time lib min version in, server minor version out
-.TP
-.I reason_rtrn
-backfilled with a status code
-.SH DESCRIPTION
-.LP
-As a convenience, you can use the function
-.I XkbOpenDisplay
-to perform these three
-tasks at once: open a connection to an X server, check for a compatible version
-of the Xkb extension in both the library and the server, and initialize the
-extension for use.
-
-.I XkbOpenDisplay
-is a convenience function that opens an X display connection and
-initializes the X keyboard extension. In all cases, upon return
-.I reason_rtrn
-contains a status value indicating success or the type of failure. If
-.I major_in_out
-and
-.I minor_in_out
-are not NULL,
-.I XkbOpenDisplay
-first calls
-.I XkbLibraryVersion
-to determine whether the client library is compatible, passing
-it the values pointed to by
-.I major_in_out and
-.I minor_in_out. If the library is
-incompatible,
-.I XkbOpenDisplay backfills
-.I major_in_out
-and
-.I minor_in_out
-with the
-major and minor extension versions of the library being used and returns NULL.
-If the library is compatible,
-.I XkbOpenDisplay
-next calls
-.I XOpenDisplay
-with the
-.I display_name.
-If this fails, the function returns NULL. If successful,
-.I XkbOpenDisplay
-calls
-.I XkbQueryExtension
-and backfills the major and minor Xkb
-server extension version numbers in
-.I major_in_out and
-.I minor_in_out. If the server
-extension version is not compatible with the library extension version or if the
-server extension is not present,
-.I XkbOpenDisplay
-closes the display and returns
-NULL. When successful, the function returns the display connection.
-
-The possible values for reason_rtrn are:
-
-.IP \(bu 5
-XkbOD_BadLibraryVersion indicates XkbLibraryVersion returned False.
-.IP \(bu 5
-XkbOD_ConnectionRefused indicates the display could not be opened.
-.IP \(bu 5
-XkbOD_BadServerVersion indicates the library and the server have incompatible
-extension versions.
-.IP \(bu 5
-XkbOD_NonXkbServer indicates the extension is not present in the X server.
-.IP \(bu 5
-XkbOD_Success indicates that the function succeeded.
-.SH "RETURN VALUES"
-.TP 15
-NULL
-The
-.I XkbOpenDisplay
-function returns NULL if the library is incompatible.
-.sp
-.in 20
-The
-.I XkbOpenDisplay
-function returns NULL if the call to
-.I XOpenDisplay
-with the
-.I display_name
-fails.
-.sp
-.in 20
-The
-.I XkbOpenDisplay
-function returns NULL and closes the display if the server extension version is not
-compatible with the library extension version or if the server extension is not present.
-.SH DIAGNOSTICS
-.TP 15
-.SM BadAccess
-The Xkb extension has not been properly initialized
-.SH "SEE ALSO"
-.BR XkbLibraryVersion (__libmansuffix__),
-.BR XkbQueryExtension (__libmansuffix__),
-.BR XOpenDisplay (__libmansuffix__)
+.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" +.\" Permission is hereby granted, free of charge, to any person obtaining a +.\" copy of this software and associated documentation files (the "Software"), +.\" to deal in the Software without restriction, including without limitation +.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, +.\" and/or sell copies of the Software, and to permit persons to whom the +.\" Software is furnished to do so, subject to the following conditions: +.\" +.\" The above copyright notice and this permission notice (including the next +.\" paragraph) shall be included in all copies or substantial portions of the +.\" Software. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +.\" DEALINGS IN THE SOFTWARE. +.\" +.TH XkbOpenDisplay __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbOpenDisplay \- Checks for a compatible version of the Xkb extension in both +the library and the server, and initializes the extension for use. +.SH SYNOPSIS +.HP +.B Display XkbOpenDisplay +.BI "(\^char *" "display_name" "\^," +.BI "int *" "event_rtrn" "\^," +.BI "int *" "error_rtrn" "\^," +.BI "int *" "major_in_out" "\^," +.BI "int *" "minor_in_out" "\^," +.BI "int *" "reason_rtrn" "\^);" +.if n .ti +5n +.if t .ti +.5i +.SH ARGUMENTS +.TP +.I display_name +hardware display name, which determines the display and communications domain to +be used +.TP +.I event_rtrn +backfilled with the extension base event code +.TP +.I error_rtrn +backfilled with the extension base error code +.TP +.I major_in_out +compile time lib major version in, server major version out +.TP +.I minor_in_out +compile time lib min version in, server minor version out +.TP +.I reason_rtrn +backfilled with a status code +.SH DESCRIPTION +.LP +As a convenience, you can use the function +.I XkbOpenDisplay +to perform these three +tasks at once: open a connection to an X server, check for a compatible version +of the Xkb extension in both the library and the server, and initialize the +extension for use. + +.I XkbOpenDisplay +is a convenience function that opens an X display connection and +initializes the X keyboard extension. In all cases, upon return +.I reason_rtrn +contains a status value indicating success or the type of failure. If +.I major_in_out +and +.I minor_in_out +are not NULL, +.I XkbOpenDisplay +first calls +.I XkbLibraryVersion +to determine whether the client library is compatible, passing +it the values pointed to by +.I major_in_out and +.I minor_in_out. If the library is +incompatible, +.I XkbOpenDisplay backfills +.I major_in_out +and +.I minor_in_out +with the +major and minor extension versions of the library being used and returns NULL. +If the library is compatible, +.I XkbOpenDisplay +next calls +.I XOpenDisplay +with the +.I display_name. +If this fails, the function returns NULL. If successful, +.I XkbOpenDisplay +calls +.I XkbQueryExtension +and backfills the major and minor Xkb +server extension version numbers in +.I major_in_out and +.I minor_in_out. If the server +extension version is not compatible with the library extension version or if the +server extension is not present, +.I XkbOpenDisplay +closes the display and returns +NULL. When successful, the function returns the display connection. + +The possible values for reason_rtrn are: + +.IP \(bu 5 +XkbOD_BadLibraryVersion indicates XkbLibraryVersion returned False. +.IP \(bu 5 +XkbOD_ConnectionRefused indicates the display could not be opened. +.IP \(bu 5 +XkbOD_BadServerVersion indicates the library and the server have incompatible +extension versions. +.IP \(bu 5 +XkbOD_NonXkbServer indicates the extension is not present in the X server. +.IP \(bu 5 +XkbOD_Success indicates that the function succeeded. +.SH "RETURN VALUES" +.TP 15 +NULL +The +.I XkbOpenDisplay +function returns NULL if the library is incompatible. +.sp +.in 20 +The +.I XkbOpenDisplay +function returns NULL if the call to +.I XOpenDisplay +with the +.I display_name +fails. +.sp +.in 20 +The +.I XkbOpenDisplay +function returns NULL and closes the display if the server extension version is not +compatible with the library extension version or if the server extension is not present. +.SH DIAGNOSTICS +.TP 15 +.SM BadAccess +The Xkb extension has not been properly initialized +.SH "SEE ALSO" +.BR XkbLibraryVersion (__libmansuffix__), +.BR XkbQueryExtension (__libmansuffix__), +.BR XOpenDisplay (__libmansuffix__) |