Blame man/DMXQueryVersion.man

Packit ec660a
.\" Copyright 2004 Red Hat Inc., Durham, North Carolina.
Packit ec660a
.\" All Rights Reserved.
Packit ec660a
.\"
Packit ec660a
.\" Permission is hereby granted, free of charge, to any person obtaining
Packit ec660a
.\" a copy of this software and associated documentation files (the
Packit ec660a
.\" "Software"), to deal in the Software without restriction, including
Packit ec660a
.\" without limitation on the rights to use, copy, modify, merge,
Packit ec660a
.\" publish, distribute, sublicense, and/or sell copies of the Software,
Packit ec660a
.\" and to permit persons to whom the Software is furnished to do so,
Packit ec660a
.\" subject to the following conditions:
Packit ec660a
.\"
Packit ec660a
.\" he above copyright notice and this permission notice (including the
Packit ec660a
.\" next paragraph) shall be included in all copies or substantial
Packit ec660a
.\" portions of the Software.
Packit ec660a
.\"
Packit ec660a
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Packit ec660a
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Packit ec660a
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Packit ec660a
.\" NON-INFRINGEMENT.  IN NO EVENT SHALL RED HAT AND/OR THEIR SUPPLIERS
Packit ec660a
.\" BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
Packit ec660a
.\" ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
Packit ec660a
.\" CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
Packit ec660a
.\" SOFTWARE.
Packit ec660a
.TH DMXQueryVersion __libmansuffix__ __vendorversion__
Packit ec660a
.SH NAME
Packit ec660a
DMXQueryVersion \- determine DMX extension version
Packit ec660a
.SH SYNOPSIS
Packit ec660a
.B #include <X11/extensions/dmxext.h>
Packit ec660a
.sp
Packit ec660a
.nf
Packit ec660a
.BI "Bool DMXQueryVersion(Display " *dpy ,
Packit ec660a
.BI "                     int " *major_version ,
Packit ec660a
.BI "                     int " *minor_version ,
Packit ec660a
.BI "                     int " *patch_version );
Packit ec660a
.fi
Packit ec660a
.SH DESCRIPTION
Packit ec660a
.B DMXQueryVersion()
Packit ec660a
returns version information about the DMX protocol extension.
Packit ec660a
.PP
Packit ec660a
Any incompatible changes to the protocol will be indicated by
Packit ec660a
a change in
Packit ec660a
.IR major_version .
Packit ec660a
Small, upward-compatible changes will be indicated by a change in
Packit ec660a
.IR minor_version .
Packit ec660a
In general,
Packit ec660a
.I patch_version
Packit ec660a
is for informational purposes and will encode the date of the last
Packit ec660a
protocol revision (e.g., 20040604).
Packit ec660a
.SH "RETURN VALUE"
Packit ec660a
If the DMX protocol extension is available,
Packit ec660a
.IR major_version ,
Packit ec660a
.IR minor_version ,
Packit ec660a
and
Packit ec660a
.I patch_version
Packit ec660a
will be set, and
Packit ec660a
.B True
Packit ec660a
will be returned.  Otherwise,
Packit ec660a
.B False
Packit ec660a
will be returned.
Packit ec660a
.SH NOTES
Packit ec660a
At the time of this writing, the DMX protocol is at version 2.2.
Packit ec660a
.PP
Packit ec660a
Version 2.2 was the final development version, and code supporting this
Packit ec660a
version was submitted to upstream X server repositories in the summer of
Packit ec660a
2004.
Packit ec660a
.PP
Packit ec660a
Version 1.5 was the last of the 1.x series, which was used for
Packit ec660a
development before screen and input addition and removal were supported.
Packit ec660a
Version 2.0 and 2.1 were development versions that partially supported
Packit ec660a
screen and input addition and removal.
Packit ec660a
.PP
Packit ec660a
Since we do not expect development versions to be widely used, we
Packit ec660a
recommend that any software that uses the DMX protocol extension to
Packit ec660a
support only versions 2.2 and above (although they should detect earlier
Packit ec660a
versions and either reduce functionality or fail gracefully).
Packit ec660a
.SH "SEE ALSO"
Packit ec660a
.BR DMXQueryExtension "(__libmansuffix__), "
Packit ec660a
.BR DMX "(__libmansuffix__), " Xdmx (1)