SecBSD/xenocara
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

sync with OpenBSD -current

Browse source
This commit is contained in:
purplerain 2024-07-12 14:44:09 +02:00
parent 2d1e52c274
commit b5b25afdb8
Signed by: purplerain
GPG key ID: F42C07F07E2E35B7
657 changed files with 21464 additions and 54675 deletions
Download patch file Download diff file Expand all files Collapse all files

2
lib/libX11/man/Compose.man
View file

@ -1,4 +1,4 @@
.\" Copyright 2009 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 2009, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),

1
lib/libX11/man/Makefile.in
View file

@ -257,6 +257,7 @@ STRICT_CFLAGS = @STRICT_CFLAGS@
STRIP = @STRIP@
STYLESHEET_SRCDIR = @STYLESHEET_SRCDIR@
TRADITIONALCPPFLAGS = @TRADITIONALCPPFLAGS@
USE_THREAD_LIBS = @USE_THREAD_LIBS@
VERSION = @VERSION@
WCHAR32 = @WCHAR32@
X11_CFLAGS = @X11_CFLAGS@

2
lib/libX11/man/XAddHost.man
View file

@ -29,7 +29,7 @@
.\"
.\" X Window System is a trademark of The Open Group.
.\"
.\" Copyright 2004 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 2004, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),

2
lib/libX11/man/XGetVisualInfo.man
View file

@ -115,7 +115,7 @@ structure contains:
.LP
/\&* Visual information mask bits */
.TS
lw(.5i) lw(2.5i) lw(.8i).
lw(10) lw(2.5i) lw(.8i).
T{
\&#define
T} T{

8
lib/libX11/man/XInitThreads.man
View file

@ -52,6 +52,8 @@ XInitThreads, XLockDisplay, XUnlockDisplay \- multi-threading support
.HP
Status XInitThreads\^(void);
.HP
Status XFreeThreads\^(void);
.HP
void XLockDisplay\^(\^Display *\fIdisplay\fP\^);
.HP
void XUnlockDisplay\^(\^Display *\fIdisplay\fP\^);
@ -76,7 +78,11 @@ 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.
It is recommended that single-threaded programs not call this function.
.LP
The
.B XFreeThreads
function frees the memory allocated by
.BR XInitThreads .
.LP
The
.B XLockDisplay

3
lib/libX11/man/XOpenIM.man
View file

@ -139,7 +139,8 @@ returns NULL if no input method could be opened.
.LP
The
.B XCloseIM
function closes the specified input method.
function closes the specified input method and frees the memory pointed
to by the im argument.
.LP
The
.B XSetIMValues

78
lib/libX11/man/XSetScreenSaver.man
View file

@ -116,3 +116,81 @@ Other negative values generate a
error.
If the timeout value is nonzero,
.B 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
.B Expose
events to clients,
the screen is tiled with the root window background tile randomly
re-origined each interval seconds.
Otherwise, the screens' states 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
.B XForceScreenSaver
with mode
.BR 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
.B XSetScreenSaver
can generate a
.B BadValue
error.
.LP
If the specified mode is
.B ScreenSaverActive
and the screen saver currently is deactivated,
.B XForceScreenSaver
activates the screen saver even if the screen saver had been disabled
with a timeout of zero.
If the specified mode is
.B ScreenSaverReset
and the screen saver currently is enabled,
.B 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
.B XForceScreenSaver
can generate a
.B BadValue
error.
.LP
The
.B XActivateScreenSaver
function activates the screen saver.
.LP
The
.B XResetScreenSaver
function resets the screen saver.
.LP
The
.B XGetScreenSaver
function gets the current screen saver values.
.SH DIAGNOSTICS
.TP 1i
.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
alternatives can generate this error.
.SH "SEE ALSO"
\fI\*(xL\fP

18
lib/libX11/man/xkb/Makefile.am
View file

@ -20,7 +20,6 @@ libman_PRE = \
XkbAllocCompatMap.man \
XkbAllocControls.man \
XkbAllocDeviceInfo.man \
XkbAllocDeviceLedInfo.man \
XkbAllocGeomColors.man \
XkbAllocGeomDoodads.man \
XkbAllocGeomKeyAliases.man \
@ -46,7 +45,6 @@ libman_PRE = \
XkbChangeControls.man \
XkbChangeDeviceInfo.man \
XkbChangeEnabledControls.man \
XkbChangeIndicators.man \
XkbChangeMap.man \
XkbChangeNames.man \
XkbChangeTypesOfKey.man \
@ -84,10 +82,8 @@ libman_PRE = \
XkbFreeKeyboard.man \
XkbFreeNames.man \
XkbFreeServerMap.man \
XkbGetAccessXTimeout.man \
XkbGetAutoRepeatRate.man \
XkbGetAutoResetControls.man \
XkbGetBounceKeysDelay.man \
XkbGetCompatMap.man \
XkbGetControls.man \
XkbGetControlsChanges.man \
@ -97,7 +93,6 @@ libman_PRE = \
XkbGetDeviceInfoChanges.man \
XkbGetDeviceLedInfo.man \
XkbGetGeometry.man \
XkbGetIndicatorChanges.man \
XkbGetIndicatorMap.man \
XkbGetIndicatorState.man \
XkbGetKeyActions.man \
@ -110,14 +105,11 @@ libman_PRE = \
XkbGetKeyboard.man \
XkbGetKeyboardByName.man \
XkbGetMap.man \
XkbGetNameChanges.man \
XkbGetNamedDeviceIndicator.man \
XkbGetNamedGeometry.man \
XkbGetNamedIndicator.man \
XkbGetNames.man \
XkbGetSlowKeysDelay.man \
XkbGetState.man \
XkbGetStickyKeysOptions.man \
XkbGetUpdatedMap.man \
XkbGetVirtualMods.man \
XkbGetXlibControls.man \
@ -130,14 +122,13 @@ libman_PRE = \
XkbKeyGroupWidth.man \
XkbKeyGroupsWidth.man \
XkbKeyHasActions.man \
XkbKeyKeyType.man \
XkbKeyKeyTypeIndex.man \
XkbKeyNumActions.man \
XkbKeyNumGroups.man \
XkbKeyNumSyms.man \
XkbKeySymEntry.man \
XkbKeySymsOffset.man \
XkbKeySymsPtr.man \
XkbKeyType.man \
XkbKeyTypeIndex.man \
XkbKeyTypesForCoreSymbols.man \
XkbKeycodeToKeysym.man \
XkbKeysymToModifiers.man \
@ -152,7 +143,6 @@ libman_PRE = \
XkbModActionVMods.man \
XkbNoteControlsChanges.man \
XkbNoteDeviceChanges.man \
XkbNoteIndicatorChanges.man \
XkbNoteNameChanges.man \
XkbOpenDisplay.man \
XkbOutOfRangeGroupInfo.man \
@ -165,7 +155,7 @@ libman_PRE = \
XkbResizeKeyActions.man \
XkbResizeKeySyms.man \
XkbResizeKeyType.man \
XkbSAActionSetCtrls.man \
XkbActionSetCtrls.man \
XkbSAGroup.man \
XkbSAPtrDfltValue.man \
XkbSARedirectSetVMods.man \
@ -178,10 +168,8 @@ libman_PRE = \
XkbSASetScreen.man \
XkbSelectEventDetails.man \
XkbSelectEvents.man \
XkbSetAccessXTimeout.man \
XkbSetAutoRepeatRate.man \
XkbSetAutoResetControls.man \
XkbSetBounceKeysDelay.man \
XkbSetCompatMap.man \
XkbSetControls.man \
XkbSetDebuggingFlags.man \

19
lib/libX11/man/xkb/Makefile.in
View file

@ -217,6 +217,7 @@ STRICT_CFLAGS = @STRICT_CFLAGS@
STRIP = @STRIP@
STYLESHEET_SRCDIR = @STYLESHEET_SRCDIR@
TRADITIONALCPPFLAGS = @TRADITIONALCPPFLAGS@
USE_THREAD_LIBS = @USE_THREAD_LIBS@
VERSION = @VERSION@
WCHAR32 = @WCHAR32@
X11_CFLAGS = @X11_CFLAGS@
@ -317,7 +318,6 @@ libman_PRE = \
XkbAllocCompatMap.man \
XkbAllocControls.man \
XkbAllocDeviceInfo.man \
XkbAllocDeviceLedInfo.man \
XkbAllocGeomColors.man \
XkbAllocGeomDoodads.man \
XkbAllocGeomKeyAliases.man \
@ -343,7 +343,6 @@ libman_PRE = \
XkbChangeControls.man \
XkbChangeDeviceInfo.man \
XkbChangeEnabledControls.man \
XkbChangeIndicators.man \
XkbChangeMap.man \
XkbChangeNames.man \
XkbChangeTypesOfKey.man \
@ -381,10 +380,8 @@ libman_PRE = \
XkbFreeKeyboard.man \
XkbFreeNames.man \
XkbFreeServerMap.man \
XkbGetAccessXTimeout.man \
XkbGetAutoRepeatRate.man \
XkbGetAutoResetControls.man \
XkbGetBounceKeysDelay.man \
XkbGetCompatMap.man \
XkbGetControls.man \
XkbGetControlsChanges.man \
@ -394,7 +391,6 @@ libman_PRE = \
XkbGetDeviceInfoChanges.man \
XkbGetDeviceLedInfo.man \
XkbGetGeometry.man \
XkbGetIndicatorChanges.man \
XkbGetIndicatorMap.man \
XkbGetIndicatorState.man \
XkbGetKeyActions.man \
@ -407,14 +403,11 @@ libman_PRE = \
XkbGetKeyboard.man \
XkbGetKeyboardByName.man \
XkbGetMap.man \
XkbGetNameChanges.man \
XkbGetNamedDeviceIndicator.man \
XkbGetNamedGeometry.man \
XkbGetNamedIndicator.man \
XkbGetNames.man \
XkbGetSlowKeysDelay.man \
XkbGetState.man \
XkbGetStickyKeysOptions.man \
XkbGetUpdatedMap.man \
XkbGetVirtualMods.man \
XkbGetXlibControls.man \
@ -427,14 +420,13 @@ libman_PRE = \
XkbKeyGroupWidth.man \
XkbKeyGroupsWidth.man \
XkbKeyHasActions.man \
XkbKeyKeyType.man \
XkbKeyKeyTypeIndex.man \
XkbKeyNumActions.man \
XkbKeyNumGroups.man \
XkbKeyNumSyms.man \
XkbKeySymEntry.man \
XkbKeySymsOffset.man \
XkbKeySymsPtr.man \
XkbKeyType.man \
XkbKeyTypeIndex.man \
XkbKeyTypesForCoreSymbols.man \
XkbKeycodeToKeysym.man \
XkbKeysymToModifiers.man \
@ -449,7 +441,6 @@ libman_PRE = \
XkbModActionVMods.man \
XkbNoteControlsChanges.man \
XkbNoteDeviceChanges.man \
XkbNoteIndicatorChanges.man \
XkbNoteNameChanges.man \
XkbOpenDisplay.man \
XkbOutOfRangeGroupInfo.man \
@ -462,7 +453,7 @@ libman_PRE = \
XkbResizeKeyActions.man \
XkbResizeKeySyms.man \
XkbResizeKeyType.man \
XkbSAActionSetCtrls.man \
XkbActionSetCtrls.man \
XkbSAGroup.man \
XkbSAPtrDfltValue.man \
XkbSARedirectSetVMods.man \
@ -475,10 +466,8 @@ libman_PRE = \
XkbSASetScreen.man \
XkbSelectEventDetails.man \
XkbSelectEvents.man \
XkbSetAccessXTimeout.man \
XkbSetAutoRepeatRate.man \
XkbSetAutoResetControls.man \
XkbSetBounceKeysDelay.man \
XkbSetCompatMap.man \
XkbSetControls.man \
XkbSetDebuggingFlags.man \

4
lib/libX11/man/xkb/XkbActionCtrls.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,7 +31,7 @@ XkbActionCtrls \- Returns the ctrls fields of act converted to an unsigned int
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- act
.I act
action from which to extract controls
.SH DESCRIPTION
.LP

14
lib/libX11/man/xkb/XkbSAActionSetCtrls.man → lib/libX11/man/xkb/XkbActionSetCtrls.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -20,9 +20,9 @@
.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
.\" DEALINGS IN THE SOFTWARE.
.\"
.TH XkbSAActionSetCtrls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.TH XkbActionSetCtrls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
XkbSAActionSetCtrls \- Sets the
XkbActionSetCtrls \- Sets the
.I ctrls0
through
.I ctrls3
@ -32,17 +32,17 @@ from
.I ctrls
.SH SYNOPSIS
.HP
.B void XkbSAActionSetCtrls
.B void XkbActionSetCtrls
.BI "(\^XkbCtrlsAction " "act" "\^,"
.BI "unsigned int " "ctrls" "\^);"
.if n .ti +5n
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- act
.I act
action in which to set ctrls0-ctrls3
.TP
.I \- ctrls
.I ctrls
value to set in ctrls0-ctrls3
.SH DESCRIPTION
.LP
@ -121,7 +121,7 @@ fields represent the boolean controls in the
.I enabled_ctrls
field of the controls structure. Xkb macros, to convert between the two formats.
.I XkbSAActionSetCtrls
.I XkbActionSetCtrls
sets the
.I ctrls0
through

8
lib/libX11/man/xkb/XkbAddDeviceLedInfo.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ XkbAddDeviceLedInfo \- Initialize an XkbDeviceLedInfoRec structure
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- device_info
.I device_info
structure in which to add LED info
.TP
.I \- led_class
.I led_class
input extension class for LED device of interest
.TP
.I \- led_id
.I led_id
input extension ID for LED device of interest
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbAddGeomColor.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ description
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry to be updated
.TP
.I \- spec
.I spec
color to be added
.TP
.I \- pixel
.I pixel
color to be added
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbAddGeomDoodad.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ top-level geometry
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry to which the doodad is added
.TP
.I \- section
.I section
section, if any, to which the doodad is added
.TP
.I \- name
.I name
name of the new doodad
.SH DESCRIPTION
.LP

4
lib/libX11/man/xkb/XkbAddGeomKey.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -30,7 +30,7 @@ XkbAddGeomKey \- Add one key at the end of an existing row of keys
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- row
.I row
row to be updated
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbAddGeomKeyAlias.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ description
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry to be updated
.TP
.I \- alias
.I alias
alias to be added
.TP
.I \- real
.I real
real name to be bound to the new alias
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAddGeomOutline.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbAddGeomOutline \- Add one outline to an existing shape
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- shape
.I shape
shape to be updated
.TP
.I \- sz_points
.I sz_points
number of points to be reserved
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbAddGeomOverlay.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,13 +32,13 @@ XkbAddGeomOverlay \- Add one overlay to a section
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- section
.I section
section to which an overlay will be added
.TP
.I \- name
.I name
name of the overlay
.TP
.I \- sz_rows
.I sz_rows
number of rows to reserve in the overlay
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbAddGeomOverlayKey.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ XkbAddGeomOverlayKey \- Add a key to an existing overlay row
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- overlay
.I overlay
overlay to be updated
.TP
.I \- row
.I row
row in overlay to be updated
.TP
.I \- under
.I under
primary name of the key to be considered
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbAddGeomOverlayRow.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,13 +32,13 @@ XkbAddGeomOverlayRow \- Add a row to an existing overlay
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- overlay
.I overlay
overlay to be updated
.TP
.I \- row_under
.I row_under
row to be overlaid in the section overlay overlays
.TP
.I \- sz_keys
.I sz_keys
number of keys to reserve in the row
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbAddGeomProperty.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ description
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry to be updated
.TP
.I \- name
.I name
name of the new property
.TP
.I \- value
.I value
value for the new property
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAddGeomRow.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbAddGeomRow \- Add a row to a section
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- section
.I section
section to be updated
.TP
.I \- sz_keys
.I sz_keys
number of keys to be reserved
.SH DESCRIPTION
.LP

12
lib/libX11/man/xkb/XkbAddGeomSection.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,19 +34,19 @@ XkbAddGeomSection \- Add one section to an existing keyboard geometry
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry to be updated
.TP
.I \- name
.I name
name of the new section
.TP
.I \- sz_rows
.I sz_rows
number of rows to reserve in the section
.TP
.I \- sz_doodads
.I sz_doodads
number of doodads to reserve in the section
.TP
.I \- sz_overlays
.I sz_overlays
number of overlays to reserve in the section
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbAddGeomShape.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,13 +32,13 @@ XkbAddGeomShape \- Add a shape to a keyboard geometry
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry to be updated
.TP
.I \- name
.I name
name of the new shape
.TP
.I \- sz_outlines
.I sz_outlines
number of outlines to be reserved
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbAddSymInterpret.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,16 +34,16 @@ interpretations in an XkbCompatRec
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description to be updated
.TP
.I \- si
.I si
symbol interpretation to be added
.TP
.I \- updateMap
.I updateMap
True=>apply compatibility map to keys
.TP
.I \- changes
.I changes
changes are put here
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbAllocClientMap.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,13 +34,13 @@ record
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description in which to allocate client map
.TP
.I \- which
.I which
mask selecting map components to allocate
.TP
.I \- type_count
.I type_count
value of num_types field in map to be allocated
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbAllocCompatMap.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ XkbAllocCompatMap \- Allocate a new compatibility map if you do not already have
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description in which to allocate compat map
.TP
.I \- which
.I which
mask of compatibility map components to allocate
.TP
.I \- num_si
.I num_si
number of symbol interpretations to allocate
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocControls.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,10 +32,10 @@ XkbAllocControls \- Allocates an XkbControlsRec structure in the XkbDescRec
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
Xkb description in which to allocate ctrls rec
.TP
.I \- which
.I which
mask of components of ctrls to allocate
.SH DESCRIPTION
.LP

16
lib/libX11/man/xkb/XkbAllocDeviceInfo.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ XkbAllocDeviceInfo \- Obtain an XkbDeviceInfoRec structure
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- device_spec
.I device_spec
device ID with which structure will be used
.TP
.I \- n_buttons
.I n_buttons
number of button actions to allocate space for
.TP
.I \- sz_leds
.I sz_leds
number of LED feedbacks to allocate space for
.SH DESCRIPTION
.LP
@ -58,10 +58,8 @@ is nonzero,
.I sz_leds
XkbDeviceLedInfoRec structures are also allocated and linked into the XkbDeviceInfoRec structure. If
you request XkbDeviceLedInfoRec structures be allocated using this request, you must initialize them
explicitly.
To obtain an XkbDeviceLedInfoRec structure, use
.I XkbAllocDeviceLedInfo.
explicitly, by using
.BR XkbAddDeviceLedInfo (__libmansuffix__).
.SH STRUCTURES
.LP
Information about X Input Extension devices is transferred between a client program and the Xkb
@ -97,4 +95,4 @@ extension in an XkbDeviceInfoRec structure:
} XkbDeviceLedInfoRec, *XkbDeviceLedInfoPtr;
.fi
.SH "SEE ALSO"
.BR XkbAllocDeviceLedInfo (__libmansuffix__)
.BR XkbAddDeviceLedInfo (__libmansuffix__)

113
lib/libX11/man/xkb/XkbAllocDeviceLedInfo.man
View file

@ -1,113 +0,0 @@
'\" t
.\" 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 XkbAllocDeviceLedInfo __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
XkbAllocDeviceLedInfo \- Obtain an XkbDeviceLedInfoRec structure
.SH SYNOPSIS
.HP
.B Status XkbAllocDeviceLedInfo
.BI "(\^XkbDeviceInfoPtr " "device_info" "\^,"
.BI "int " "num_needed" "\^);"
.if n .ti +5n
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- device_info
structure in which to allocate LED space
.TP
.I \- num_needed
number of indicators to allocate space for
.SH DESCRIPTION
.LP
.I XkbAllocDeviceLedInfo
allocates space for an XkbDeviceLedInfoRec and places it in
.I device_info.
If
.I num_needed
is nonzero,
.I num_needed
XkbIndicatorMapRec structures are also allocated and linked into the XkbDeviceLedInfoRec structure. If you request XkbIndicatorMapRec structures be allocated using this request, you must initialize them explicitly. All other fields are initialized to zero.
To initialize an XkbDeviceLedInfoRec structure, use
.I XkbAddDeviceLedInfo.
.SH STRUCTURES
.LP
Information about X Input Extension devices is transferred between a client program and the Xkb
extension in an XkbDeviceInfoRec structure:
.nf
typedef struct {
char * name; /\&* name for device */
Atom type; /\&* name for class of devices */
unsigned short device_spec; /\&* device of interest */
Bool has_own_state; /\&* True=>this device has its own state */
unsigned short supported; /\&* bits indicating supported capabilities */
unsigned short unsupported; /\&* bits indicating unsupported capabilities */
unsigned short num_btns; /\&* number of entries in btn_acts */
XkbAction * btn_acts; /\&* button actions */
unsigned short sz_leds; /\&* total number of entries in LEDs vector */
unsigned short num_leds; /\&* number of valid entries in LEDs vector */
unsigned short dflt_kbd_fb; /\&* input extension ID of default (core kbd) indicator */
unsigned short dflt_led_fb; /\&* input extension ID of default indicator feedback */
XkbDeviceLedInfoPtr leds; /\&* LED descriptions */
} XkbDeviceInfoRec, *XkbDeviceInfoPtr;
typedef struct {
unsigned short led_class; /\&* class for this LED device*/
unsigned short led_id; /\&* ID for this LED device */
unsigned int phys_indicators; /\&* bits for which LEDs physically present */
unsigned int maps_present; /\&* bits for which LEDs have maps in maps */
unsigned int names_present; /\&* bits for which LEDs are in names */
unsigned int state; /\&* 1 bit => corresponding LED is on */
Atom names[XkbNumIndicators]; /\&* names for LEDs */
XkbIndicatorMapRec maps; /\&* indicator maps for each LED */
} XkbDeviceLedInfoRec, *XkbDeviceLedInfoPtr;
.fi
Each indicator has its own set of attributes that specify whether clients can explicitly set its state and whether it tracks the keyboard state. The attributes of each indicator are held in the maps array, which is an array of XkbIndicatorRec structures:
.nf
typedef struct {
unsigned char flags; /\&* how the indicator can be changed */
unsigned char which_groups; /\&* match criteria for groups */
unsigned char groups; /\&* which keyboard groups the indicator watches */
unsigned char which_mods; /\&* match criteria for modifiers */
XkbModsRec mods; /\&* which modifiers the indicator watches */
unsigned int ctrls; /\&* which controls the indicator watches */
} XkbIndicatorMapRec, *XkbIndicatorMapPtr;
.fi
This indicator map specifies for each indicator:
.IP \(bu 5
The conditions under which the keyboard modifier state affects the indicator
.IP \(bu 5
The conditions under which the keyboard group state affects the indicator
.IP \(bu 5
The conditions under which the state of the boolean controls affects the indicator
.IP \(bu 5
The effect (if any) of attempts to explicitly change the state of the indicator using the functions XkbSetControls or XChangeKeyboardControl
.SH "SEE ALSO"
.BR XkbAddDeviceLedInfo (__libmansuffix__),
.BR XkbSetControls (__libmansuffix__)

6
lib/libX11/man/xkb/XkbAllocGeomColors.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbAllocGeomColors \- Allocate geometry colors
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry for which colors should be allocated
.TP
.I \- num_needed
.I num_needed
number of new colors required
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocGeomDoodads.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,10 +32,10 @@ XkbAllocGeomDoodads \- Allocate doodads that are global to a keyboard geometry
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry for which doodads should be allocated
.TP
.I \- num_needed
.I num_needed
number of new doodads required
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocGeomKeyAliases.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbAllocGeomKeyAliases \- Allocate geometry key aliases
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry for which key aliases should be allocated
.TP
.I \- num_needed
.I num_needed
number of new key aliases required
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocGeomKeys.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbAllocGeomKeys \- Allocate space for an arbitrary number of keys to a row
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- row
.I row
row to which keys should be allocated
.TP
.I \- num_needed
.I num_needed
number of new keys required
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocGeomOutlines.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,10 +32,10 @@ shape
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- shape
.I shape
shape for which outlines should be allocated
.TP
.I \- num_needed
.I num_needed
number of new outlines required
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocGeomOverlayKeys.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,10 +32,10 @@ XkbAllocGeomOverlayKeys \- Allocate keys in an overlay row
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- row
.I row
section for which rows should be allocated
.TP
.I \- num_needed
.I num_needed
number of new rows required
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocGeomOverlayRows.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbAllocGeomOverlayRows \- Allocate rows in a overlay
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- overlay
.I overlay
section for which rows should be allocated
.TP
.I \- num_needed
.I num_needed
number of new rows required
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocGeomOverlays.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbAllocGeomOverlays \- Allocate overlays in a section
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- section
.I section
section for which overlays should be allocated
.TP
.I \- num_needed
.I num_needed
number of new overlays required
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocGeomPoints.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbAllocGeomPoints \- Allocate points in an outline
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- outline
.I outline
outline for which points should be allocated
.TP
.I \- num_needed
.I num_needed
number of new points required
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbAllocGeomProps.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,11 +31,11 @@ XkbAllocGeomProps \- Allocate geometry properties
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
_summary_
.I geom
geometry for which properties should be allocated
.TP
.I \- num_needed
_summary_
.I num_needed
number of new properties required
.SH DESCRIPTION
.LP
Xkb provides a number of functions to allocate and free subcomponents of a

6
lib/libX11/man/xkb/XkbAllocGeomRows.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbAllocGeomRows \- Allocate rows in a section
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- section
.I section
section for which rows should be allocated
.TP
.I \- num_needed
.I num_needed
number of new rows required
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocGeomSectionDoodads.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,10 +32,10 @@ XkbAllocGeomSectionDoodads \- Allocate doodads that are specific to a section
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- section
.I section
section for which doodads should be allocated
.TP
.I \- num_needed
.I num_needed
number of new doodads required
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocGeomSections.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbAllocGeomSections \- Allocate geometry sections
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry for which sections should be allocated
.TP
.I \- num_needed
.I num_needed
number of new sections required
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocGeomShapes.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbAllocGeomShapes \- Allocate space for an arbitrary number of geometry shapes
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry for which shapes should be allocated
.TP
.I \- num_needed
.I num_needed
number of new shapes required
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbAllocGeometry.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,10 +32,10 @@ XkbAllocGeometry \- Allocate an entire geometry
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description for which geometry is to be allocated
.TP
.I \- sizes
.I sizes
initial sizes for all geometry components
.SH DESCRIPTION
.LP

4
lib/libX11/man/xkb/XkbAllocIndicatorMaps.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,7 +32,7 @@ member of the keyboard description record
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description structure
.SH DESCRIPTION
.LP

2
lib/libX11/man/xkb/XkbAllocKeyboard.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),

10
lib/libX11/man/xkb/XkbAllocNames.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,16 +34,16 @@ XkbAllocNames \- Allocate symbolic names structures
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description for which names are to be allocated
.TP
.I \- which
.I which
mask of names to be allocated
.TP
.I \- num_rg
.I num_rg
total number of radio group names needed
.TP
.I \- num_key_aliases
.I num_key_aliases
total number of key aliases needed
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbAllocServerMap.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ XkbAllocServerMap \- Allocate and initialize an empty server map description rec
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description in which to allocate server map
.TP
.I \- which
.I which
mask selecting map components to allocate
.TP
.I \- count_acts
.I count_acts
value of num_acts field in map to be allocated
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbApplyCompatMapToKey.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,13 +34,13 @@ key to get its semantics updated
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description to be updated
.TP
.I \- key
.I key
key to be updated
.TP
.I \- changes
.I changes
notes changes to the Xkb keyboard description
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbBell.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,16 +34,16 @@ XkbBell \- Rings the bell on the default keyboard
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- display
.I display
connection to the X server
.TP
.I \- window
.I window
event window, or None
.TP
.I \- percent
.I percent
relative volume, which can range from -100 to 100 inclusive
.TP
.I \- name
.I name
a bell name, or NULL
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbBellEvent.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -35,16 +35,16 @@ without ringing the bell
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- display
.I display
connection to the X server
.TP
.I \- window
.I window
the event window, or None
.TP
.I \- percent,
.I percent
relative volume, which can range from -100 to 100 inclusive
.TP
.I \- name
.I name
a bell name, or NULL
.SH DESCRIPTION
.LP

3
lib/libX11/man/xkb/XkbChangeControls.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -312,7 +312,6 @@ typedef struct _XkbControlsChanges {
XkbChangeControls(__libmansuffix__),
XkbChangeDeviceInfo(__libmansuffix__),
XkbChangeEnabledControls(__libmansuffix__),
XkbChangeIndicators(__libmansuffix__),
XkbChangeMap(__libmansuffix__),
XkbChangeNames(__libmansuffix__),
XkbChangeTypesOfKey(__libmansuffix__)

8
lib/libX11/man/xkb/XkbChangeDeviceInfo.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,13 +34,13 @@ XkbDeviceChangesRec
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- dpy
.I dpy
connection to X server
.TP
.I \- device_info
.I device_info
local copy of device state and configuration
.TP
.I \- changes
.I changes
note specifying changes in device_info
.SH DESCRIPTION
.LP

12
lib/libX11/man/xkb/XkbChangeEnabledControls.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,16 +34,16 @@ XkbChangeEnabledControls \- Manipulates the EnabledControls control
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- dpy
.I dpy
connection to X server
.TP
.I \- device_spec
keyboard device to modify
.I device_spec
keyboard device to modify
.TP
.I \- mask
.I mask
1 bit -> controls to enable / disable
.TP
.I \- values
.I values
1 bit => enable, 0 bit => disable
.SH DESCRIPTION
.LP

156
lib/libX11/man/xkb/XkbChangeIndicators.man
View file

@ -1,156 +0,0 @@
.\" 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 XkbChangeIndicators __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
XkbChangeIndicators \- Changes indicator maps or state without passing the
entire keyboard description
.SH SYNOPSIS
.HP
.B Bool XkbChangeIndicators
.BI "(\^Display *" "dpy" "\^,"
.BI "XkbDescPtr " "xkb" "\^,"
.BI "XkbIndicatorChangesPtr " "changes" "\^,"
.BI "unsigned int " "state" "\^);"
.if n .ti +5n
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- dpy
connection to the X server
.TP
.I \- xkb
keyboard description from which names are to be taken.
.TP
.I \- changes
indicators to be updated on the server
.TP
.I \- state
new state of indicators listed in changes->state_changes
.SH DESCRIPTION
.LP
The XkbIndicatorChangesRec identifies small modifications to the indicator map.
Use it with the function
.I XkbChangeIndicators
to reduce the amount of traffic sent to the server (see STRUCTURES).
The
.I state_changes
field is a mask that specifies the indicators that have changed state, and
.I map_changes
is a mask that specifies the indicators whose maps have changed.
.I XkbChangeIndicators
copies any maps specified by
.I changes
from the keyboard description,
.I xkb,
to the server specified by
.I dpy.
If any bits are set in the
.I state_changes
field of
.I changes, XkbChangeIndicators
also sets the state of those indicators to the values specified in the
.I state
mask. A 1 bit in
.I state
turns the corresponding indicator on, a 0 bit turns it off.
In addition, it can also generate XkbIndicatorStateNotify and
XkbIndicatorMapNotify events.
Whenever an indicator changes state, the server sends XkbIndicatorStateNotify events
to all interested clients. Similarly, whenever an indicator's map changes, the
server sends XkbIndicatorMapNotify events to all interested clients.
To receive XkbIndicatorStateNotify events, use
.I XkbSelectEvents
with both the
.I bits_to_change
and
.I values_for_bits
parameters containing XkbIndicatorStateNotifyMask. To receive XkbIndicatorMapNotify
events, use
.I XkbSelectEvents
with XkbIndicatorMapNotifyMask.
To receive events for only specific indicators, use
.I XkbSelectEventDetails.
Set the
.I event_type
parameter to XkbIndicatorStateNotify or XkbIndicatorMapNotify, and set both the
.I bits_to_change
and
.I values_for_bits
detail parameters to a mask where each bit specifies one indicator, turning on those
bits that specify the indicators for which you want to receive events.
.I xkb_type
is either XkbIndicatorStateNotify or XkbIndicatorMapNotify, depending on whether the
event is a kbIndicatorStateNotify event or kbIndicatorMapNotify event.
The
.I changed
parameter is a mask that is the bitwise inclusive OR of the indicators that have
changed. If the event is of type XkbIndicatorMapNotify,
.I changed
reports the maps that changed. If the event is of type XkbIndicatorStateNotify,
.I changed
reports the indicators that have changed state.
.I state
is a mask that specifies the current state of all indicators, whether they have
changed or not, for both XkbIndicatorStateNotify and IndicatorMapNotify events.
.SH STRUCTURES
.LP
.nf
typedef struct _XkbIndicatorChanges {
unsigned int state_changes;
unsigned int map_changes;
}XkbIndicatorChangesRec,*XkbIndicatorChangesPtr;
.fi
Both types of indicator events use the same structure:
.nf
typedef struct _XkbIndicatorNotify {
int type; /\&* Xkb extension base event code */
unsigned long serial; /\&* X server serial number for event */
Bool send_event; /\&* True => synthetically generated */
Display * display; /\&* server connection where event generated */
Time time; /\&* server time when event generated */
int xkb_type; /\&* specifies state or map notify */
int device; /\&* Xkb device ID, will not be XkbUseCoreKbd*/
unsigned int changed; /\&* mask of indicators with new state or map */
unsigned int state; /\&* current state of all indicators */
} XkbIndicatorNotifyEvent;
.fi
.SH DIAGNOSTICS
.TP 15
.B BadAtom
A name is neither a valid Atom or None
.TP 15
.B BadImplementation
Invalid reply from server
.SH "SEE ALSO"
.BR XkbIndicatorMapNotify (__libmansuffix__),
.BR XkbIndicatorStateNotify (__libmansuffix__)

8
lib/libX11/man/xkb/XkbChangeMap.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -35,13 +35,13 @@ keyboard description
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- dpy
.I dpy
connection to X server
.TP
.I \- xkb
.I xkb
description from which new values are taken
.TP
.I \- changes
.I changes
identifies component parts to update
.SH DESCRIPTION
.LP

12
lib/libX11/man/xkb/XkbChangeNames.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -22,24 +22,24 @@
.\"
.TH XkbChangeNames __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
XkbChangeNames \- _summary-line_
XkbChangeNames \- Change symbolic names in the server
.SH SYNOPSIS
.HP
.B Bool XkbChangeNames
.BI "(\^Display *" "dpy" "\^,"
.BI "unsigned int " "which" "\^,"
.BI "XkbDescPtr " "Xkb" "\^);"
.BI "XkbDescPtr " "xkb" "\^);"
.if n .ti +5n
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- dpy
.I dpy
connection to the X server
.TP
.I \- which
.I which
mask of names or map components to be updated
.TP
.I \- Xkb
.I xkb
keyboard description to be updated
.SH DESCRIPTION
.LP

14
lib/libX11/man/xkb/XkbChangeTypesOfKey.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -36,22 +36,22 @@ XkbChangeTypesOfKey \- Change the number of groups and the types bound to a key
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description to be changed
.TP
.I \- key
.I key
keycode for key of interest
.TP
.I \- n_groups
.I n_groups
new number of groups for key
.TP
.I \- groups
.I groups
mask indicating groups to change
.TP
.I \- new_types_in
.I new_types_in
indices for new groups specified in groups
.TP
.I \- p_changes
.I p_changes
notes changes made to xkb
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbComputeRowBounds.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,13 +32,13 @@ XkbComputeRowBounds \- Update the bounding box of a row
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry that contains the section
.TP
.I \- section
.I section
section that contains the row
.TP
.I \- row
.I row
row to be examined and updated
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbComputeSectionBounds.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbComputeSectionBounds \- Update the bounding box of a section
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry that contains the section
.TP
.I \- section
.I section
section to be examined and updated
.SH DESCRIPTION
.LP

4
lib/libX11/man/xkb/XkbComputeShapeBounds.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -30,7 +30,7 @@ XkbComputeShapeBounds \- Updates the bounding box of a shape
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- shape
.I shape
shape to be examined
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbComputeShapeTop.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbComputeShapeTop \- Determines the bounding box of the top surface of a shape
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- shape
.I shape
shape to be examined
.TP
.I \- bounds_rtrn
.I bounds_rtrn
backfilled with the bounding box for the shape
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbCopyKeyType.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -31,10 +31,10 @@ XkbCopyKeyType \- Copy one XkbKeyTypeRec structures
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- from
.I from
pointer to XkbKeyTypeRec to be copied
.TP
.I \- into
.I into
pointer to XkbKeyTypeRec to be changed
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbCopyKeyTypes.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,13 +32,13 @@ XkbCopyKeyTypes \- Copy more than one XkbKeyTypeRec structure
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- from
.I from
pointer to array of XkbKeyTypeRecs to copy
.TP
.I \- into
.I into
pointer to array of XkbKeyTypeRecs to change
.TP
.I \- num_types
.I num_types
number of types to copy
.SH DESCRIPTION
.LP

16
lib/libX11/man/xkb/XkbDeviceBell.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -37,25 +37,25 @@ XkbDeviceBell \- Rings the bell on an X input extension device or the default ke
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- display
.I display
connection to the X server
.TP
.I \- window
.I window
window for which the bell is generated, or None
.TP
.I \- device_spec
.I device_spec
device ID, or XkbUseCoreKbd
.TP
.I \- bell_class
.I bell_class
X input extension bell class of the bell to be rung
.TP
.I \- bell_id
.I bell_id
X input extension bell ID of the bell to be rung
.TP
.I \- percent
.I percent
bell volume, from -100 to 100 inclusive
.TP
.I \- name
.I name
a name for the bell, or NULL
.SH DESCRIPTION
.LP

16
lib/libX11/man/xkb/XkbDeviceBellEvent.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -38,25 +38,25 @@ for the keyboard, without ringing the corresponding bell
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- display
.I display
connection to the X server
.TP
.I \- window
.I window
event window, or None
.TP
.I \- device_spec
.I device_spec
device ID, or XkbUseCoreKbd
.TP
.I \- bell_class
.I bell_class
input extension bell class for the event
.TP
.I \- bell_id
.I bell_id
input extension bell ID for the event
.TP
.I \- percent
.I percent
volume for the bell, which can range from -100 to 100 inclusive
.TP
.I \- name
.I name
a bell name, or NULL
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbFindOverlayForKey.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ key that is part of an overlay
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry that contains the section
.TP
.I \- section
.I section
section to be searched for matching keys
.TP
.I \- under
.I under
primary name of the key to be considered
.SH DESCRIPTION
.LP

6
lib/libX11/man/xkb/XkbForceBell.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,10 +33,10 @@ bell on the default keyboard
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- display
.I display
connection to the X server
.TP
.I \- percent
.I percent
volume for the bell, which can range from -100 to 100 inclusive
.SH DESCRIPTION
.LP

14
lib/libX11/man/xkb/XkbForceDeviceBell.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -37,22 +37,22 @@ settings for audible bells
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- display
.I display
connection to the X server
.TP
.I \- window
.I window
event window, or None
.TP
.I \- device_spec
.I device_spec
device ID, or XkbUseCoreKbd
.TP
.I \- bell_class
.I bell_class
input extension class of the bell to be rung
.TP
.I \- bell_id
.I bell_id
input extension ID of the bell to be rung
.TP
.I \- percent
.I percent
relative volume, which can range from -100 to 100 inclusive
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbFreeClientMap.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,13 +34,13 @@ structure
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description containing client map to free
.TP
.I \- which
.I which
mask identifying components of map to free
.TP
.I \- free_all
.I free_all
True => free all client components and map itself
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbFreeCompatMap.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ XkbFreeCompatMap \- Free an entire compatibility map or selected portions of one
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
Xkb description in which to free compatibility map
.TP
.I \- which
.I which
mask of compatibility map components to free
.TP
.I \- free_map
.I free_map
True => free XkbCompatMap structure itself
.SH DESCRIPTION
.LP

4
lib/libX11/man/xkb/XkbFreeComponentList.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,7 +32,7 @@ XkbFreeComponentList \- Free the structure returned by
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- list
.I list
pointer to XkbComponentListRec to free
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbFreeControls.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ XkbFreeControls \- Frees memory used by the ctrls member of an XkbDescRec struct
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
Xkb description in which to free controls components
.TP
.I \- which
.I which
mask of components of ctrls to free
.TP
.I \- free_all
.I free_all
True => free everything + ctrls itself
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbFreeDeviceInfo.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ XkbFreeDeviceInfo \- Free an XkbDeviceInfoRec structure
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- device_info
.I device_info
pointer to XkbDeviceInfoRec in which to free items
.TP
.I \- which
.I which
mask of components of device_info to free
.TP
.I \- free_all
.I free_all
True => free everything, including device_info
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbFreeGeomColors.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,16 +33,16 @@ XkbFreeGeomColors \- Free geometry colors
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry in which colors should be freed
.TP
.I \- first
.I first
first color to be freed
.TP
.I \- count
.I count
number of colors to be freed
.TP
.I \- free_all
.I free_all
True => all colors are freed
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbFreeGeomDoodads.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,13 +32,13 @@ XkbFreeGeomDoodads \- Free geometry doodads
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- doodads
.I doodads
doodads to be freed
.TP
.I \- count
.I count
number of doodads to be freed
.TP
.I \- free_all
.I free_all
True => all doodads are freed
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbFreeGeomKeyAliases.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,16 +33,16 @@ XkbFreeGeomKeyAliases \- Free geometry key aliases
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry in which key aliases should be freed
.TP
.I \- first
.I first
first key alias to be freed
.TP
.I \- count
.I count
number of key aliases to be freed
.TP
.I \- free_all
.I free_all
True => all key aliases are freed
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbFreeGeomKeys.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,16 +33,16 @@ XkbFreeGeomKeys \- Free geometry keys
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- row
.I row
row in which keys should be freed
.TP
.I \- first
.I first
first key to be freed
.TP
.I \- count
.I count
number of keys to be freed
.TP
.I \- free_all
.I free_all
True => all keys are freed
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbFreeGeomOutlines.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,16 +33,16 @@ XkbFreeGeomOutlines \- Free geometry outlines
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- shape
.I shape
shape in which outlines should be freed
.TP
.I \- first
.I first
first outline to be freed
.TP
.I \- count
.I count
number of outlines to be freed
.TP
.I \- free_all
.I free_all
True => all outlines are freed
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbFreeGeomOverlayKeys.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,16 +33,16 @@ XkbFreeGeomOverlayKeys \- Free keys in an overlay row
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- row
.I row
row in which keys should be freed
.TP
.I \- first
.I first
first key to be freed
.TP
.I \- count
.I count
number of keys to be freed
.TP
.I \- free_all
.I free_all
True => all keys are freed
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbFreeGeomOverlayRows.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,16 +33,16 @@ XkbFreeGeomOverlayRows \- Free rows in an overlay
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- overlay
.I overlay
section in which rows should be freed
.TP
.I \- first
.I first
first row to be freed
.TP
.I \- count
.I count
number of rows to be freed
.TP
.I \- free_all
.I free_all
True => all rows are freed
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbFreeGeomOverlays.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,16 +33,16 @@ XkbFreeGeomOverlays \- Free rows in a section
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- section
.I section
section in which overlays should be freed
.TP
.I \- first
.I first
first overlay to be freed
.TP
.I \- count
.I count
number of overlays to be freed
.TP
.I \- free_all
.I free_all
True => all overlays are freed
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbFreeGeomPoints.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,16 +33,16 @@ XkbFreeGeomPoints \- Free points in a outline
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- outline
.I outline
outline in which points should be freed
.TP
.I \- first
.I first
first point to be freed
.TP
.I \- count
.I count
number of points to be freed
.TP
.I \- free_all
.I free_all
True => all points are freed
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbFreeGeomProperties.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,16 +33,16 @@ XkbFreeGeomProperties \- Free geometry properties
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry in which properties should be freed
.TP
.I \- first
.I first
first property to be freed
.TP
.I \- count
.I count
number of properties to be freed
.TP
.I \- free_all
.I free_all
True => all properties are freed
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbFreeGeomRows.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,16 +33,16 @@ XkbFreeGeomRows \- Free rows in a section
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- section
.I section
section in which rows should be freed
.TP
.I \- first
.I first
first row to be freed
.TP
.I \- count
.I count
number of rows to be freed
.TP
.I \- free_all
.I free_all
True => all rows are freed
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbFreeGeomSections.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,16 +33,16 @@ XkbFreeGeomSections \- Free geometry sections
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry in which sections should be freed
.TP
.I \- first
.I first
first section to be freed
.TP
.I \- count
.I count
number of sections to be freed
.TP
.I \- free_all
.I free_all
True => all sections are freed
.SH DESCRIPTION
.LP

10
lib/libX11/man/xkb/XkbFreeGeomShapes.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,16 +33,16 @@ XkbFreeGeomShapes \- Free geometry shapes
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry in which shapes should be freed
.TP
.I \- first
.I first
first shape to be freed
.TP
.I \- count
.I count
number of shapes to be freed
.TP
.I \- free_all
.I free_all
True => all shapes are freed
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbFreeGeometry.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,13 +32,13 @@ XkbFreeGeometry \- Free an entire geometry
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- geom
.I geom
geometry to be freed
.TP
.I \- which
.I which
mask of geometry components to be freed
.TP
.I \- free_all
.I free_all
True => the entire geometry is freed
.SH DESCRIPTION
.LP

4
lib/libX11/man/xkb/XkbFreeIndicatorMaps.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,7 +32,7 @@ member of an XkbDescRec structure
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description structure
.SH DESCRIPTION
.LP

2
lib/libX11/man/xkb/XkbFreeKeyboard.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),

8
lib/libX11/man/xkb/XkbFreeNames.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ XkbFreeNames \- Free symbolic names structures
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description for which names are to be freed
.TP
.I \- which
.I which
mask of names components to be freed
.TP
.I \- free_map
.I free_map
True => XkbNamesRec structure itself should be freed
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbFreeServerMap.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,13 +34,13 @@ structure
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- xkb
.I xkb
keyboard description containing server map to free
.TP
.I \- which
.I which
mask identifying components of map to free
.TP
.I \- free_all
.I free_all
True => free all server map components and server itself
.SH DESCRIPTION
.LP

140
lib/libX11/man/xkb/XkbGetAccessXTimeout.man
View file

@ -1,140 +0,0 @@
.\" 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 XkbGetAccessXTimeout __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
XkbGetAccessXTimeout \- Queries the current AccessXTimeout options for a
keyboard device
.SH SYNOPSIS
.HP
.B Bool XkbGetAccessXTimeout
.BI "(\^Display *" "display" "\^,"
.BI "unsigned int " "device_spec" "\^,"
.BI "unsigned short *" "timeout_rtrn" "\^,"
.BI "unsigned int *" "ctrls_mask_rtrn" "\^,"
.BI "unsigned int *" "ctrls_values_rtrn" "\^,"
.BI "unsigned short *" "options_mask_rtrn" "\^,"
.BI "unsigned short *" "options_values_rtrn" "\^);"
.if n .ti +5n
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- display
unsigned short
.TP
.I \- device_spec
device to query, or XkbUseCoreKbd
.TP
.I \- timeout_rtrn
delay until AccessXTimeout, seconds
.TP
.I \- ctrls_mask_rtrn
backfilled with controls to modify
.TP
.I \- ctrls_values_rtrn
backfilled with on/off status for controls
.TP
.I \- options_mask_rtrn
backfilled with ax_options to modify
.TP
.I \- options_values_rtrn
backfilled with values for ax_options
.SH DESCRIPTION
.LP
In environments where computers are shared, features such as SlowKeys present a
problem: if
SlowKeys is on, the keyboard can appear to be unresponsive because keys are not
accepted
until they are held for a certain period of time. To help solve this problem,
Xkb provides
an AccessXTimeout control to automatically change the enabled/disabled state of
any boolean
controls and to change the value of the AccessXKeys and AccessXFeedback control
attributes
if the keyboard is idle for a specified period of time.
When a timeout as specified by AccessXTimeout occurs and a control is
consequently modified,
Xkb generates an XkbControlsNotify event.
.I XkbGetAccessXTimeout
sends a request to the X server to obtain the current values for the
AccessXTimeout attributes, waits for a reply, and backfills the values into the
appropriate arguments. The parameters
.I options_mask_rtrn
and
.I options_values_rtrn
are backfilled with the options to modify and the values for
.I ax_options,
which is a field in the XkbControlsRec structure.
.I XkbGetAccessXTimeout
returns True if successful; if a compatible version of the Xkb extension is not
available in the server,
.I XkbGetAccessXTimeout
returns False.
.SH "RETURN VALUES"
.TP 15
True
The
.I XkbGetAccessXTimeout
returns True when it successfully sends a request to the X server to obtain the
current values for the AccessXTimeout attributes, waits for a reply, and
backfills the values into the appropriate arguments.
.TP 15
False
The
.I XkbGetAccessXTimeout
function returns False if a compatible version of the Xkb extension is not
available in the
server.
.SH STRUCTURES
.LP
.nf
The XkbControlsRec structure is defined as follows:
\&#define XkbMaxLegalKeyCode 255
\&#define XkbPerKeyBitArraySize ((XkbMaxLegalKeyCode+1)/8)
typedef struct {
unsigned char mk_dflt_btn; /\&* default button for keyboard driven mouse */
unsigned char num_groups; /\&* number of keyboard groups */
unsigned char groups_wrap; /\&* how to wrap out-of-bounds groups */
XkbModsRec internal; /\&* defines server internal modifiers */
XkbModsRec ignore_lock; /\&* modifiers to ignore when checking for grab */
unsigned int enabled_ctrls; /\&* 1 bit => corresponding boolean control enabled */
unsigned short repeat_delay; /\&* ms delay until first repeat */
unsigned short repeat_interval; /\&* ms delay between repeats */
unsigned short slow_keys_delay; /\&* ms minimum time key must be down to be ok */
unsigned short debounce_delay; /\&* ms delay before key reactivated */
unsigned short mk_delay; /\&* ms delay to second mouse motion event */
unsigned short mk_interval; /\&* ms delay between repeat mouse events */
unsigned short mk_time_to_max; /\&* # intervals until constant mouse move */
unsigned short mk_max_speed; /\&* multiplier for maximum mouse speed */
short mk_curve; /\&* determines mouse move curve type */
unsigned short ax_options; /\&* 1 bit => Access X option enabled */
unsigned short ax_timeout; /\&* seconds until Access X disabled */
unsigned short axt_opts_mask; /\&* 1 bit => options to reset on Access X timeout */
unsigned short axt_opts_values; /\&* 1 bit => turn option on, 0=> off */
unsigned int axt_ctrls_mask; /\&* which bits in enabled_ctrls to modify */
unsigned int axt_ctrls_values; /\&* values for new bits in enabled_ctrls */
unsigned char per_key_repeat[XkbPerKeyBitArraySize]; /\&* per key auto repeat */
} XkbControlsRec, *XkbControlsPtr;
.fi

10
lib/libX11/man/xkb/XkbGetAutoRepeatRate.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,16 +34,16 @@ for a keyboard device
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- display
.I display
connection to X server
.TP
.I \- device_spec
.I device_spec
desired device ID, or XkbUseCoreKbd
.TP
.I \- timeout_rtrn
.I timeout_rtrn
backfilled with initial repeat delay, ms
.TP
.I \- interval_rtrn
.I interval_rtrn
backfilled with subsequent repeat delay, ms
.SH DESCRIPTION
.LP

12
lib/libX11/man/xkb/XkbGetAutoResetControls.man
View file

@ -1,4 +1,4 @@
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -32,13 +32,13 @@ XkbGetAutoResetControls \- Gets the current values of the auto-reset controls
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- dpy
connection to X server
.I dpy
connection to X server
.TP
.I \- auto_ctrls
specifies which bits in auto_values are relevant
.I auto_ctrls
specifies which bits in auto_values are relevant
.TP
.I \- auto_values
.I auto_values
1 bit => corresponding control has auto-reset on
.SH DESCRIPTION
.LP

211
lib/libX11/man/xkb/XkbGetBounceKeysDelay.man
View file

@ -1,211 +0,0 @@
'\" t
.\" 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 XkbGetBounceKeysDelay __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
XkbGetBounceKeysDelay \- Queries the current BounceKeys delay for a keyboard
device.
.SH SYNOPSIS
.HP
.B Bool XkbGetBounceKeysDelay
.BI "(\^Display *" "display" "\^,"
.BI "unsigned int " "device_spec" "\^,"
.BI "unsigned int *" "delay_rtrn" "\^);"
.if n .ti +5n
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- display
connection to X server
.TP
.I \- device_spec
device ID, or XkbUseCoreKbd
.TP
.I \- delay_rtrn
backfilled with bounce keys delay, ms
.SH DESCRIPTION
.LP
The server can generate XkbAccessXNotify events for some of the global keyboard
controls.
The detail field describes what AccessX event just occurred and can be any of
the values in
Table 1.
.TS
c s
l l
l lw(4i).
Table 1 AccessXNotify Events
_
detail Reason
_
XkbAXN_SKPress T{
A key was pressed when SlowKeys was enabled.
T}
XkbAXN_SKAccept T{
A key was accepted (held longer than the SlowKeys delay).
T}
XkbAXN_SKRelease T{
An accepted SlowKeys key was released.
T}
XkbAXN_SKReject T{
A key was rejected (released before the SlowKeys delay expired).
T}
XkbAXN_BKAccept T{
A key was accepted by BounceKeys.
T}
XkbAXN_BKReject T{
A key was rejected (pressed before the BounceKeys delay expired).
T}
XkbAXN_AXKWarning T{
AccessXKeys is about to turn on/off StickyKeys or BounceKeys.
T}
.TE
The
.I keycode
field reports the keycode of the key for which the event occurred. If the action
is related to
.I SlowKeys,
the
.I slowKeysDelay
field contains the current SlowKeys acceptance delay. If the action is related
to BounceKeys,
the
.I debounceDelay
field contains the current BounceKeys debounce delay.
Selecting for AccessX Events
To receive XkbAccessXNotify events under all possible conditions, use
.I XkbSelectEvents
and pass XkbAccesXNotifyMask in both
.I bits_to_change
and
.I values_for_bits.
To receive XkbStateNotify events only under certain conditions, use
.I XkbSelectEventDetails
using XkbAccessXNotify as the
.I event_type
and specifying the desired state changes in
.I bits_to_change
and
.I values_for_bits
using mask bits from Table 2.
.TS
c s s
l l l
l l lw(3i).
Table 2 AccessXNotify Event Details
_
XkbAccessXNotify Event Details Value Circumstances
_
XkbAXN_SKPressMask (1<<0) T{
Slow key press notification wanted
T}
XkbAXN_SKAcceptMask (1<<1) T{
Slow key accept notification wanted
T}
XkbAXN_SKRejectMask (1<<2) T{
Slow key reject notification wanted
T}
XkbAXN_SKReleaseMask (1<<3) T{
Slow key release notification wanted
T}
XkbAXN_BKAcceptMask (1<<4) T{
Bounce key accept notification wanted
T}
XkbAXN_BKRejectMask (1<<5) T{
Bounce key reject notification wanted
T}
XkbAXN_AXKWarningMask (1<<6) T{
AccessX warning notification wanted
T}
XkbAllAccessXEventsMask (0x7f) T{
All AccessX features notifications wanted
T}
.TE
Some users may accidentally "bounce" on a key when they release it. They press
it once, then accidentally press it again after they release it. The BounceKeys
control temporarily disables a key after it has been pressed, effectively
"debouncing" the keyboard. The period of time the key is disabled after it is
released is known as the
.I BounceKeys delay.
BounceKeys is a boolean control.
When the BounceKeys control is active, the server reports acceptance or
rejection of any key to interested clients by sending an appropriate
AccessXNotify event (see STRUCTURES).
.I XkbGetBounceKeysDelay
requests the attributes of the BounceKeys control from the server, waits for a
reply, and backfills
.I delay_rtrn
with the BounceKeys delay attribute.
.I XkbGetBounceKeysDelay
returns True if successful; if a compatible version of the Xkb extension is not
available in the server
.I XkbGetSlowKeysDelay
returns False.
.SH "RETURN VALUES"
.TP 15
True
The
.I XkbGetBounceKeysDelay
function returns True when it successfully requests the attributes of the
BounceKeys control from the server, waits for a
reply, and backfills
.I delay_rtrn
with the BounceKeys delay attribute.
.TP 15
False
The
.I XkbGetBounceKeysDelay
function returns False if a compatible version of the Xkb extension is not
available in the server.
.SH STRUCTURES
.LP
The structure for the XkbAccessXNotify event type is as follows:
.nf
typedef struct {
int type; /\&* Xkb extension base event code */
unsigned long serial; /\&* X server serial number for event */
Bool send_event; /\&* True => synthetically generated */
Display * display; /\&* server connection where event generated */
Time time; /\&* server time when event generated */
int xkb_type; /\&* XkbAccessXNotify */
int device; /\&* Xkb device ID, will not be XkbUseCoreKbd */
int detail; /\&* XkbAXN_* */
KeyCode keycode; /\&* key of event */
int slowKeysDelay; /\&* current SlowKeys delay */
int debounceDelay; /\&* current debounce delay */
} XkbAccessXNotifyEvent;
.fi
.SH "SEE ALSO"
.BR XkbGetSlowKeysDelay (__libmansuffix__)

8
lib/libX11/man/xkb/XkbGetCompatMap.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,13 +34,13 @@ components from the server
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- display
.I display
connection to server
.TP
.I \- which
.I which
mask of compatibility map components to fetch
.TP
.I \- xkb
.I xkb
keyboard description where results placed
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbGetControls.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -33,13 +33,13 @@ XkbGetControls \- Finds the current state of Xkb server controls
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- display
.I display
connection to X server
.TP
.I \- which
.I which
mask of controls requested
.TP
.I \- xkb
.I xkb
keyboard description for controls information
.SH DESCRIPTION
.LP

8
lib/libX11/man/xkb/XkbGetControlsChanges.man
View file

@ -1,5 +1,5 @@
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 1999, Oracle and/or its affiliates.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
@ -34,13 +34,13 @@ XkbGetControlsChanges
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- dpy
.I dpy
connection to X server
.TP
.I \- xkb
.I xkb
xkb->ctrls will be updated
.TP
.I \- changes
.I changes
indicates which parts of xkb->ctrls to update
.SH DESCRIPTION
.LP

Some files were not shown because too many files have changed in this diff Show more