1 files changed, 93 insertions, 0 deletions
diff --git a/libX11/man/xkb/XkbGetIndicatorState.man b/libX11/man/xkb/XkbGetIndicatorState.man
new file mode 100644
index 000000000..cd40d1553
--- /dev/null
+++ b/libX11/man/xkb/XkbGetIndicatorState.man
@@ -0,0 +1,93 @@
+.\" Copyright (c) 1999 - Sun Microsystems, Inc.
+.\" All rights reserved.
+.\" 
+.\" Permission is hereby granted, free of charge, to any person obtaining a
+.\" copy of this software and associated documentation files (the
+.\" "Software"), to deal in the Software without restriction, including
+.\" without limitation the rights to use, copy, modify, merge, publish,
+.\" distribute, and/or sell copies of the Software, and to permit persons
+.\" to whom the Software is furnished to do so, provided that the above
+.\" 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
+.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR 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.
+.\" 
+.\" 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.
+.\"
+.TH XkbGetIndicatorState __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
+.SH NAME
+XkbGetIndicatorState \- Obtains the current state of the keyboard indicators
+.SH SYNOPSIS
+.B Status XkbGetIndicatorState
+(
+.I display,
+.I device_spec,
+.I state_return
+)
+.br
+      Display *\fIdisplay\fP\^;
+.br
+      unsigned int \fIdevice_spec\fP\^;
+.br
+      unsigned int \fIstate_return\fP\^;
+.if n .ti +5n
+.if t .ti +.5i
+.SH ARGUMENTS
+.TP
+.I \- display
+connection to the X server
+.TP
+.I \- device_spec
+device ID, or XkbUseCoreKbd
+.TP
+.I \- state_return
+backfilled with a mask of the indicator state
+.SH DESCRIPTION
+.LP
+Xkb allows applications to obtain information about indicators using two 
+different methods. The first method, which is similar to the core X 
+implementation, uses a mask to specify the indicators. The second method, which 
+is more suitable for applications concerned with interoperability, uses 
+indicator names. The correspondence between the indicator name and the bit 
+position in masks is as follows: one of the parameters returned from
+.I XkbGetNamedIndicators 
+is an index that is the bit position to use in any function call that requires a 
+mask of indicator bits, as well as the indicator's index into the 
+XkbIndicatorRec array of indicator maps.
+
+.I XkbGetIndicatorState 
+queries the 
+.I display 
+for the state of the indicators on the device specified by the 
+.I device_spec. 
+For each indicator that is "turned on" on the device, the associated bit is set 
+in 
+.I state_return. 
+If a compatible version of the Xkb extension is not available in the server, .I 
+XkbGetIndicatorState 
+returns a BadMatch error. Otherwise, it sends the request to the X server, 
+places the state of the indicators into 
+.I state_return, 
+and returns Success. Thus the value reported by 
+.I XkbGetIndicatorState 
+is identical to the value reported by the core protocol.
+.SH DIAGNOSTICS
+.TP 15
+.B BadMatch
+A compatible version of Xkb was not available in the server or an argument has 
+correct type and range, but is otherwise invalid
+.SH "SEE ALSO"
+.BR XkbGetNamedIndicators (__libmansuffix__)
+