From 8848085323124d64dfa0f80e0b274ac3e1ceec05 Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Sun, 13 Jul 2025 09:47:54 -0700 Subject: [PATCH] man pages: remove whitespace at end of lines in xkb man pages Clears 6571 complaints from `mandoc -T lint` of the form: mandoc: man/xkb/XkbActionCtrls.3:107:4: STYLE: whitespace at end of input line Signed-off-by: Alan Coopersmith Part-of: --- man/xkb/XkbActionCtrls.man | 64 ++-- man/xkb/XkbActionSetCtrls.man | 76 ++--- man/xkb/XkbAddDeviceLedInfo.man | 60 ++-- man/xkb/XkbAddGeomColor.man | 66 ++-- man/xkb/XkbAddGeomDoodad.man | 92 +++--- man/xkb/XkbAddGeomKey.man | 44 +-- man/xkb/XkbAddGeomKeyAlias.man | 50 +-- man/xkb/XkbAddGeomOutline.man | 46 +-- man/xkb/XkbAddGeomOverlay.man | 52 ++-- man/xkb/XkbAddGeomOverlayKey.man | 46 +-- man/xkb/XkbAddGeomOverlayRow.man | 48 +-- man/xkb/XkbAddGeomProperty.man | 50 +-- man/xkb/XkbAddGeomRow.man | 34 +-- man/xkb/XkbAddGeomSection.man | 66 ++-- man/xkb/XkbAddGeomShape.man | 46 +-- man/xkb/XkbAddSymInterpret.man | 34 +-- man/xkb/XkbAllocClientMap.man | 142 ++++----- man/xkb/XkbAllocCompatMap.man | 34 +-- man/xkb/XkbAllocControls.man | 82 ++--- man/xkb/XkbAllocDeviceInfo.man | 36 +-- man/xkb/XkbAllocGeomColors.man | 40 +-- man/xkb/XkbAllocGeomDoodads.man | 36 +-- man/xkb/XkbAllocGeomKeyAliases.man | 40 +-- man/xkb/XkbAllocGeomKeys.man | 38 +-- man/xkb/XkbAllocGeomOutlines.man | 40 +-- man/xkb/XkbAllocGeomOverlayKeys.man | 26 +- man/xkb/XkbAllocGeomOverlayRows.man | 38 +-- man/xkb/XkbAllocGeomOverlays.man | 26 +- man/xkb/XkbAllocGeomPoints.man | 36 +-- man/xkb/XkbAllocGeomProps.man | 42 +-- man/xkb/XkbAllocGeomRows.man | 36 +-- man/xkb/XkbAllocGeomSectionDoodads.man | 38 +-- man/xkb/XkbAllocGeomSections.man | 38 +-- man/xkb/XkbAllocGeomShapes.man | 38 +-- man/xkb/XkbAllocGeometry.man | 56 ++-- man/xkb/XkbAllocIndicatorMaps.man | 36 +-- man/xkb/XkbAllocKeyboard.man | 26 +- man/xkb/XkbAllocNames.man | 38 +-- man/xkb/XkbAllocServerMap.man | 66 ++-- man/xkb/XkbApplyCompatMapToKey.man | 294 +++++++++--------- man/xkb/XkbBell.man | 290 +++++++++--------- man/xkb/XkbBellEvent.man | 288 +++++++++--------- man/xkb/XkbChangeControls.man | 108 +++---- man/xkb/XkbChangeDeviceInfo.man | 26 +- man/xkb/XkbChangeEnabledControls.man | 74 ++--- man/xkb/XkbChangeMap.man | 64 ++-- man/xkb/XkbChangeNames.man | 74 ++--- man/xkb/XkbChangeTypesOfKey.man | 138 ++++----- man/xkb/XkbComputeRowBounds.man | 10 +- man/xkb/XkbComputeSectionBounds.man | 16 +- man/xkb/XkbComputeShapeBounds.man | 30 +- man/xkb/XkbComputeShapeTop.man | 40 +-- man/xkb/XkbCopyKeyType.man | 68 ++--- man/xkb/XkbCopyKeyTypes.man | 82 ++--- man/xkb/XkbDeviceBell.man | 196 ++++++------ man/xkb/XkbDeviceBellEvent.man | 254 ++++++++-------- man/xkb/XkbFindOverlayForKey.man | 8 +- man/xkb/XkbForceBell.man | 286 +++++++++--------- man/xkb/XkbForceDeviceBell.man | 222 +++++++------- man/xkb/XkbFreeClientMap.man | 136 ++++----- man/xkb/XkbFreeCompatMap.man | 66 ++-- man/xkb/XkbFreeComponentList.man | 8 +- man/xkb/XkbFreeControls.man | 64 ++-- man/xkb/XkbFreeDeviceInfo.man | 110 +++---- man/xkb/XkbFreeGeomColors.man | 46 +-- man/xkb/XkbFreeGeomDoodads.man | 42 +-- man/xkb/XkbFreeGeomKeyAliases.man | 54 ++-- man/xkb/XkbFreeGeomKeys.man | 20 +- man/xkb/XkbFreeGeomOutlines.man | 18 +- man/xkb/XkbFreeGeomOverlayKeys.man | 50 +-- man/xkb/XkbFreeGeomOverlayRows.man | 48 +-- man/xkb/XkbFreeGeomOverlays.man | 50 +-- man/xkb/XkbFreeGeomPoints.man | 50 +-- man/xkb/XkbFreeGeomProperties.man | 50 +-- man/xkb/XkbFreeGeomRows.man | 50 +-- man/xkb/XkbFreeGeomSections.man | 50 +-- man/xkb/XkbFreeGeomShapes.man | 48 +-- man/xkb/XkbFreeGeometry.man | 54 ++-- man/xkb/XkbFreeIndicatorMaps.man | 22 +- man/xkb/XkbFreeKeyboard.man | 32 +- man/xkb/XkbFreeNames.man | 24 +- man/xkb/XkbFreeServerMap.man | 106 +++---- man/xkb/XkbGetAutoRepeatRate.man | 48 +-- man/xkb/XkbGetAutoResetControls.man | 68 ++--- man/xkb/XkbGetCompatMap.man | 82 ++--- man/xkb/XkbGetControls.man | 112 +++---- man/xkb/XkbGetControlsChanges.man | 182 +++++------ man/xkb/XkbGetDeviceButtonActions.man | 80 ++--- man/xkb/XkbGetDeviceInfo.man | 226 +++++++------- man/xkb/XkbGetDeviceInfoChanges.man | 28 +- man/xkb/XkbGetDeviceLedInfo.man | 162 +++++----- man/xkb/XkbGetGeometry.man | 20 +- man/xkb/XkbGetIndicatorMap.man | 44 +-- man/xkb/XkbGetIndicatorState.man | 44 +-- man/xkb/XkbGetKeyActions.man | 60 ++-- man/xkb/XkbGetKeyBehaviors.man | 54 ++-- man/xkb/XkbGetKeyExplicitComponents.man | 94 +++--- man/xkb/XkbGetKeyModifierMap.man | 62 ++-- man/xkb/XkbGetKeySyms.man | 70 ++--- man/xkb/XkbGetKeyTypes.man | 34 +-- man/xkb/XkbGetKeyVirtualModMap.man | 72 ++--- man/xkb/XkbGetKeyboard.man | 26 +- man/xkb/XkbGetKeyboardByName.man | 370 +++++++++++------------ man/xkb/XkbGetMap.man | 178 +++++------ man/xkb/XkbGetNamedGeometry.man | 72 ++--- man/xkb/XkbGetNamedIndicator.man | 62 ++-- man/xkb/XkbGetNames.man | 64 ++-- man/xkb/XkbGetState.man | 20 +- man/xkb/XkbGetUpdatedMap.man | 94 +++--- man/xkb/XkbGetVirtualMods.man | 180 +++++------ man/xkb/XkbGetXlibControls.man | 8 +- man/xkb/XkbIgnoreExtension.man | 60 ++-- man/xkb/XkbKeyAction.man | 110 +++---- man/xkb/XkbKeyActionEntry.man | 110 +++---- man/xkb/XkbKeyActionsPtr.man | 118 ++++---- man/xkb/XkbKeyGroupInfo.man | 110 +++---- man/xkb/XkbKeyGroupWidth.man | 36 +-- man/xkb/XkbKeyGroupsWidth.man | 32 +- man/xkb/XkbKeyHasActions.man | 102 +++---- man/xkb/XkbKeyKeyType.man | 16 +- man/xkb/XkbKeyKeyTypeIndex.man | 16 +- man/xkb/XkbKeyNumActions.man | 88 +++--- man/xkb/XkbKeyNumGroups.man | 160 +++++----- man/xkb/XkbKeyNumSyms.man | 32 +- man/xkb/XkbKeySymEntry.man | 48 +-- man/xkb/XkbKeySymsPtr.man | 34 +-- man/xkb/XkbKeyTypesForCoreSymbols.man | 150 ++++----- man/xkb/XkbKeycodeToKeysym.man | 30 +- man/xkb/XkbKeysymToModifiers.man | 22 +- man/xkb/XkbLatchGroup.man | 20 +- man/xkb/XkbLatchModifiers.man | 56 ++-- man/xkb/XkbLibraryVersion.man | 68 ++--- man/xkb/XkbListComponents.man | 124 ++++---- man/xkb/XkbLockGroup.man | 18 +- man/xkb/XkbLockModifiers.man | 54 ++-- man/xkb/XkbLookupKeyBinding.man | 42 +-- man/xkb/XkbLookupKeySym.man | 30 +- man/xkb/XkbModActionVMods.man | 20 +- man/xkb/XkbNoteControlsChanges.man | 162 +++++----- man/xkb/XkbNoteDeviceChanges.man | 56 ++-- man/xkb/XkbNoteNameChanges.man | 24 +- man/xkb/XkbOpenDisplay.man | 122 ++++---- man/xkb/XkbOutOfRangeGroupInfo.man | 94 +++--- man/xkb/XkbOutOfRangeGroupNumber.man | 92 +++--- man/xkb/XkbPtrActionX.man | 46 +-- man/xkb/XkbPtrActionY.man | 46 +-- man/xkb/XkbQueryExtension.man | 100 +++--- man/xkb/XkbRefreshKeyboardMapping.man | 32 +- man/xkb/XkbResizeDeviceButtonActions.man | 36 +-- man/xkb/XkbResizeKeyActions.man | 78 ++--- man/xkb/XkbResizeKeySyms.man | 78 ++--- man/xkb/XkbResizeKeyType.man | 120 ++++---- man/xkb/XkbSAGroup.man | 16 +- man/xkb/XkbSAPtrDfltValue.man | 64 ++-- man/xkb/XkbSARedirectSetVMods.man | 78 ++--- man/xkb/XkbSARedirectSetVModsMask.man | 98 +++--- man/xkb/XkbSARedirectVMods.man | 96 +++--- man/xkb/XkbSARedirectVModsMask.man | 96 +++--- man/xkb/XkbSAScreen.man | 56 ++-- man/xkb/XkbSASetGroup.man | 14 +- man/xkb/XkbSASetPtrDfltValue.man | 52 ++-- man/xkb/XkbSASetScreen.man | 40 +-- man/xkb/XkbSelectEventDetails.man | 138 ++++----- man/xkb/XkbSetAutoRepeatRate.man | 66 ++-- man/xkb/XkbSetAutoResetControls.man | 68 ++--- man/xkb/XkbSetCompatMap.man | 136 ++++----- man/xkb/XkbSetControls.man | 120 ++++---- man/xkb/XkbSetDebuggingFlags.man | 140 ++++----- man/xkb/XkbSetDeviceButtonActions.man | 48 +-- man/xkb/XkbSetDeviceInfo.man | 168 +++++----- man/xkb/XkbSetIgnoreLockMods.man | 164 +++++----- man/xkb/XkbSetIndicatorMap.man | 118 ++++---- man/xkb/XkbSetMap.man | 172 +++++------ man/xkb/XkbSetModActionVMods.man | 26 +- man/xkb/XkbSetNamedIndicator.man | 50 +-- man/xkb/XkbSetNames.man | 100 +++--- man/xkb/XkbSetPtrActionX.man | 46 +-- man/xkb/XkbSetPtrActionY.man | 46 +-- man/xkb/XkbSetServerInternalMods.man | 174 +++++------ man/xkb/XkbSetXlibControls.man | 30 +- man/xkb/XkbTranslateKeyCode.man | 28 +- man/xkb/XkbTranslateKeySym.man | 38 +-- man/xkb/XkbUpdateMapFromCore.man | 90 +++--- man/xkb/XkbVirtualModsToReal.man | 122 ++++---- 184 files changed, 6887 insertions(+), 6887 deletions(-) diff --git a/man/xkb/XkbActionCtrls.man b/man/xkb/XkbActionCtrls.man index b747103d..e1df439e 100644 --- a/man/xkb/XkbActionCtrls.man +++ b/man/xkb/XkbActionCtrls.man @@ -35,11 +35,11 @@ XkbActionCtrls \- Returns the ctrls fields of act converted to an unsigned int action from which to extract controls .SH DESCRIPTION .LP -Actions associated with the XkbCtrlsAction structure change the state of the +Actions associated with the XkbCtrlsAction structure change the state of the boolean controls. -The -.I type +The +.I type field can have any one of the values shown in Table 1. .TS @@ -51,28 +51,28 @@ _ Type Effect _ XkbSA_SetControls T{ -A key press enables any boolean controls specified in the ctrls fields that were -not already enabled at +A key press enables any boolean controls specified in the ctrls fields that were +not already enabled at the time of the key press. A key release disables any controls enabled by the key press. This action can cause XkbControlsNotify events. T} XkbSA_LockControls T{ -If the XkbSA_LockNoLock bit is not set in the flags field, a key press enables -any controls specified in +If the XkbSA_LockNoLock bit is not set in the flags field, a key press enables +any controls specified in the ctrls fields that were not already enabled at the time of the key press. .br -If the XkbSA_LockNoUnlock bit is not set in the flags field, a key release -disables any controls -specified in the ctrls fields that were not already disabled at the time of the +If the XkbSA_LockNoUnlock bit is not set in the flags field, a key release +disables any controls +specified in the ctrls fields that were not already disabled at the time of the key press. .br This action can cause XkbControlsNotify events. T} .TE -The -.I flags +The +.I flags field is composed of the bitwise inclusive OR of the masks shown in Table 2. .TS @@ -84,37 +84,37 @@ _ Flag Meaning _ XkbSA_LockNoLock T{ -If set, and the action type is XkbSA_LockControls, the server only disables +If set, and the action type is XkbSA_LockControls, the server only disables controls. T} XkbSA_LockNoUnlock T{ -If set, and the action type is XkbSA_LockControls, the server only enables +If set, and the action type is XkbSA_LockControls, the server only enables controls. T} .TE -The XkbSA_SetControls action implements a key that enables a boolean control -when pressed and disables it -when released. The XkbSA_LockControls action is used to implement a key that -toggles the state of a -boolean control each time it is pressed and released. The XkbSA_LockNoLock and -XkbSA_LockNoUnlock flags -allow modifying the toggling behavior to only unlock or only lock the boolean +The XkbSA_SetControls action implements a key that enables a boolean control +when pressed and disables it +when released. The XkbSA_LockControls action is used to implement a key that +toggles the state of a +boolean control each time it is pressed and released. The XkbSA_LockNoLock and +XkbSA_LockNoUnlock flags +allow modifying the toggling behavior to only unlock or only lock the boolean control. -The -.I ctrls0, ctrls1, ctrls2, -and -.I ctrls3 -fields represent the boolean controls in the -.I enabled_ctrls +The +.I ctrls0, ctrls1, ctrls2, +and +.I ctrls3 +fields represent the boolean controls in the +.I enabled_ctrls field of the controls structure. Xkb macros, to convert between the two formats. -.I XkbActionCtrls -returns the -.I ctrls -fields of -.I act +.I XkbActionCtrls +returns the +.I ctrls +fields of +.I act converted to an unsigned int. .SH STRUCTURES .LP diff --git a/man/xkb/XkbActionSetCtrls.man b/man/xkb/XkbActionSetCtrls.man index 67b20231..caca8a8c 100644 --- a/man/xkb/XkbActionSetCtrls.man +++ b/man/xkb/XkbActionSetCtrls.man @@ -23,12 +23,12 @@ .TH XkbActionSetCtrls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME XkbActionSetCtrls \- Sets the -.I ctrls0 -through +.I ctrls0 +through .I ctrls3 -fields of +fields of .I act -from +from .I ctrls .SH SYNOPSIS .HP @@ -46,11 +46,11 @@ action in which to set ctrls0-ctrls3 value to set in ctrls0-ctrls3 .SH DESCRIPTION .LP -Actions associated with the XkbCtrlsAction structure change the state of the +Actions associated with the XkbCtrlsAction structure change the state of the boolean controls. -The -.I type +The +.I type field can have any one of the values shown in Table 1. .TS @@ -62,28 +62,28 @@ _ Type Effect _ XkbSA_SetControls T{ -A key press enables any boolean controls specified in the ctrls fields that were -not already enabled at +A key press enables any boolean controls specified in the ctrls fields that were +not already enabled at the time of the key press. A key release disables any controls enabled by the key press. This action can cause XkbControlsNotify events. T} XkbSA_LockControls T{ -If the XkbSA_LockNoLock bit is not set in the flags field, a key press enables -any controls specified in +If the XkbSA_LockNoLock bit is not set in the flags field, a key press enables +any controls specified in the ctrls fields that were not already enabled at the time of the key press. .br -If the XkbSA_LockNoUnlock bit is not set in the flags field, a key release -disables any controls -specified in the ctrls fields that were not already disabled at the time of the +If the XkbSA_LockNoUnlock bit is not set in the flags field, a key release +disables any controls +specified in the ctrls fields that were not already disabled at the time of the key press. .br This action can cause XkbControlsNotify events. T} .TE -The -.I flags +The +.I flags field is composed of the bitwise inclusive OR of the masks shown in Table 2. .TS @@ -95,40 +95,40 @@ _ Flag Meaning _ XkbSA_LockNoLock T{ -If set, and the action type is XkbSA_LockControls, the server only disables +If set, and the action type is XkbSA_LockControls, the server only disables controls. T} XkbSA_LockNoUnlock T{ -If set, and the action type is XkbSA_LockControls, the server only enables +If set, and the action type is XkbSA_LockControls, the server only enables controls. T} .TE -The XkbSA_SetControls action implements a key that enables a boolean control -when pressed and disables it -when released. The XkbSA_LockControls action is used to implement a key that -toggles the state of a -boolean control each time it is pressed and released. The XkbSA_LockNoLock and -XkbSA_LockNoUnlock flags -allow modifying the toggling behavior to only unlock or only lock the boolean +The XkbSA_SetControls action implements a key that enables a boolean control +when pressed and disables it +when released. The XkbSA_LockControls action is used to implement a key that +toggles the state of a +boolean control each time it is pressed and released. The XkbSA_LockNoLock and +XkbSA_LockNoUnlock flags +allow modifying the toggling behavior to only unlock or only lock the boolean control. -The -.I ctrls0, ctrls1, ctrls2, -and -.I ctrls3 -fields represent the boolean controls in the -.I enabled_ctrls +The +.I ctrls0, ctrls1, ctrls2, +and +.I ctrls3 +fields represent the boolean controls in the +.I enabled_ctrls field of the controls structure. Xkb macros, to convert between the two formats. .I XkbActionSetCtrls -sets the -.I ctrls0 -through -.I ctrls3 -fields of -.I act -from +sets the +.I ctrls0 +through +.I ctrls3 +fields of +.I act +from .I ctrls. .SH STRUCTURES .LP diff --git a/man/xkb/XkbAddDeviceLedInfo.man b/man/xkb/XkbAddDeviceLedInfo.man index 426e8581..953e962e 100644 --- a/man/xkb/XkbAddDeviceLedInfo.man +++ b/man/xkb/XkbAddDeviceLedInfo.man @@ -43,44 +43,44 @@ input extension class for LED device of interest input extension ID for LED device of interest .SH DESCRIPTION .LP -.I XkbAddDeviceLedInfo -first checks to see whether an entry matching -.I led_class -and -.I led_id -already exists in the -.I device_info->leds -array. If it finds a matching entry, it returns a pointer to that entry. Otherwise, it checks to be sure +.I XkbAddDeviceLedInfo +first checks to see whether an entry matching +.I led_class +and +.I led_id +already exists in the +.I device_info->leds +array. If it finds a matching entry, it returns a pointer to that entry. Otherwise, it checks to be sure there is at least one empty entry in -.I device_info->leds +.I device_info->leds and extends it if there is not enough room. It then increments -.I device_info->num_leds -and fills in the next available entry in -.I device_info->leds -with -.I led_class -and +.I device_info->num_leds +and fills in the next available entry in +.I device_info->leds +with +.I led_class +and .I led_id. -If successful, -.I XkbAddDeviceLedInfo -returns a pointer to the XkbDeviceLedInfoRec structure that was initialized. If unable to allocate -sufficient storage, or if -.I device_info -points to an invalid XkbDeviceInfoRec structure, or if -.I led_class -or -.I led_id -are inappropriate, -.I XkbAddDeviceLedInfo +If successful, +.I XkbAddDeviceLedInfo +returns a pointer to the XkbDeviceLedInfoRec structure that was initialized. If unable to allocate +sufficient storage, or if +.I device_info +points to an invalid XkbDeviceInfoRec structure, or if +.I led_class +or +.I led_id +are inappropriate, +.I XkbAddDeviceLedInfo returns NULL. -To allocate additional space for button actions in an XkbDeviceInfoRec structure, use +To allocate additional space for button actions in an XkbDeviceInfoRec structure, use .I XkbResizeDeviceButtonActions. .SH STRUCTURES .LP -Information about X Input Extension devices is transferred between a client program and the Xkb +Information about X Input Extension devices is transferred between a client program and the Xkb extension in an XkbDeviceInfoRec structure: .nf @@ -99,7 +99,7 @@ extension in an XkbDeviceInfoRec structure: 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*/ @@ -112,6 +112,6 @@ extension in an XkbDeviceInfoRec structure: XkbIndicatorMapRec maps; /\&* indicator maps for each LED */ } XkbDeviceLedInfoRec, *XkbDeviceLedInfoPtr; -.fi +.fi .SH "SEE ALSO" .BR XkbResizeDeviceButtonActions (__libmansuffix__) diff --git a/man/xkb/XkbAddGeomColor.man b/man/xkb/XkbAddGeomColor.man index d8f667a3..c17a8128 100644 --- a/man/xkb/XkbAddGeomColor.man +++ b/man/xkb/XkbAddGeomColor.man @@ -21,7 +21,7 @@ .\" .TH XkbAddGeomColor __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbAddGeomColor \- Add one color name to an existing keyboard geometry +XkbAddGeomColor \- Add one color name to an existing keyboard geometry description .SH SYNOPSIS .HP @@ -43,43 +43,43 @@ color to be added color to be added .SH DESCRIPTION .LP -Xkb provides functions to add a single new element to the top-level keyboard -geometry. In each case the -.I num_ * -fields of the corresponding structure is incremented by 1. These functions do -not change -.I sz_* -unless there is no more room in the array. Some of these functions fill in the -values of the element's structure from the arguments. For other functions, you +Xkb provides functions to add a single new element to the top-level keyboard +geometry. In each case the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do +not change +.I sz_* +unless there is no more room in the array. Some of these functions fill in the +values of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's elements. -The top-level geometry description includes a list of -.I geometry properties. -A geometry property associates an arbitrary string with an equally arbitrary -name. Programs that display images of keyboards can use geometry properties as -hints, but they are not interpreted by Xkb. No other geometry structures refer +The top-level geometry description includes a list of +.I geometry properties. +A geometry property associates an arbitrary string with an equally arbitrary +name. Programs that display images of keyboards can use geometry properties as +hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. -.I XkbAddGeomColor -adds the specified color -.I name -and -.I pixel -to the specified geometry -.I geom. -The top-level geometry description includes a list of up to MaxColors (32) -.I color names. -A color -.I name +.I XkbAddGeomColor +adds the specified color +.I name +and +.I pixel +to the specified geometry +.I geom. +The top-level geometry description includes a list of up to MaxColors (32) +.I color names. +A color +.I name is a string whose interpretation is not specified by Xkb and neither is the -.I pixel -value's interpretation. All other geometry data structures refer to colors using +.I pixel +value's interpretation. All other geometry data structures refer to colors using their indices in this global list or pointers to colors in this list. -.I XkbAddGeomColor -returns NULL if any of the parameters is empty or if it was not able to allocate -space for the color. To allocate space for an arbitrary number of colors to a -geometry, use the -.I XkbAllocGeomColors +.I XkbAddGeomColor +returns NULL if any of the parameters is empty or if it was not able to allocate +space for the color. To allocate space for an arbitrary number of colors to a +geometry, use the +.I XkbAllocGeomColors function. .SH STRUCTURES .LP @@ -89,7 +89,7 @@ function. unsigned int pixel; /\&* color */ char * spec; /\&* color name */ } XkbColorRec,*XkbColorPtr; - + .fi .SH "SEE ALSO" .BR XkbAllocGeomColors (__libmansuffix__) diff --git a/man/xkb/XkbAddGeomDoodad.man b/man/xkb/XkbAddGeomDoodad.man index a90483aa..69b514c7 100644 --- a/man/xkb/XkbAddGeomDoodad.man +++ b/man/xkb/XkbAddGeomDoodad.man @@ -21,7 +21,7 @@ .\" .TH XkbAddGeomDoodad __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbAddGeomDoodad \- Add one doodad to a section of a keyboard geometry or to the +XkbAddGeomDoodad \- Add one doodad to a section of a keyboard geometry or to the top-level geometry .SH SYNOPSIS .HP @@ -40,56 +40,56 @@ geometry to which the doodad is added section, if any, to which the doodad is added .TP .I name -name of the new doodad +name of the new doodad .SH DESCRIPTION .LP -Xkb provides functions to add a single new element to the top-level keyboard -geometry. In each case the -.I num_ * -fields of the corresponding structure is incremented by 1. These functions do -not change -.I sz_* -unless there is no more room in the array. Some of these functions fill in the -values of the element's structure from the arguments. For other functions, you +Xkb provides functions to add a single new element to the top-level keyboard +geometry. In each case the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do +not change +.I sz_* +unless there is no more room in the array. Some of these functions fill in the +values of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's elements. -The top-level geometry description includes a list of -.I geometry properties. -A geometry property associates an arbitrary string with an equally arbitrary -name. Programs that display images of keyboards can use geometry properties as -hints, but they are not interpreted by Xkb. No other geometry structures refer +The top-level geometry description includes a list of +.I geometry properties. +A geometry property associates an arbitrary string with an equally arbitrary +name. Programs that display images of keyboards can use geometry properties as +hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. -A -.I doodad -describes some visible aspect of the keyboard that is not a key and is not a -section. -.I XkbAddGeomDoodad -adds a doodad with name specified by -.I name -to the geometry -.I geom -if -.I section -is NULL or to the section of the geometry specified by -.I section -if -.I section -is not NULL. -.I XkbAddGeomDoodad -returns NULL if any of the parameters is empty or if it was not able to allocate -space for the doodad. If there is already a doodad with the name -.I name -in the doodad array for the geometry (if -.I section -is NULL) or the section (if -.I section -is non-NULL), a pointer to that doodad is returned. To allocate space for an -arbitrary number of doodads to a section, use the -.I XkbAllocGeomSectionDoodads -function. To allocate space for an arbitrary number of doodads to a keyboard -geometry, use the -.I XkbAllocGeomDoodads +A +.I doodad +describes some visible aspect of the keyboard that is not a key and is not a +section. +.I XkbAddGeomDoodad +adds a doodad with name specified by +.I name +to the geometry +.I geom +if +.I section +is NULL or to the section of the geometry specified by +.I section +if +.I section +is not NULL. +.I XkbAddGeomDoodad +returns NULL if any of the parameters is empty or if it was not able to allocate +space for the doodad. If there is already a doodad with the name +.I name +in the doodad array for the geometry (if +.I section +is NULL) or the section (if +.I section +is non-NULL), a pointer to that doodad is returned. To allocate space for an +arbitrary number of doodads to a section, use the +.I XkbAllocGeomSectionDoodads +function. To allocate space for an arbitrary number of doodads to a keyboard +geometry, use the +.I XkbAllocGeomDoodads function. .SH STRUCTURES .LP @@ -102,7 +102,7 @@ function. XkbIndicatorDoodadRec indicator; XkbLogoDoodadRec logo; } XkbDoodadRec, *XkbDoodadPtr; - + .fi .SH "SEE ALSO" .BR XkbAllocGeomDoodads (__libmansuffix__), diff --git a/man/xkb/XkbAddGeomKey.man b/man/xkb/XkbAddGeomKey.man index 8c6e6066..d556d67c 100644 --- a/man/xkb/XkbAddGeomKey.man +++ b/man/xkb/XkbAddGeomKey.man @@ -34,31 +34,31 @@ XkbAddGeomKey \- Add one key at the end of an existing row of keys row to be updated .SH DESCRIPTION .LP -Xkb provides functions to add a single new element to the top-level keyboard geometry. In each case -the -.I num_ * -fields of the corresponding structure is incremented by 1. These functions do not change -.I sz_* -unless there is no more room in the array. Some of these functions fill in the values of the -element's structure from the arguments. For other functions, you must explicitly write code to fill +Xkb provides functions to add a single new element to the top-level keyboard geometry. In each case +the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do not change +.I sz_* +unless there is no more room in the array. Some of these functions fill in the values of the +element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's elements. -The top-level geometry description includes a list of -.I geometry properties. -A geometry property associates an arbitrary string with an equally arbitrary name. Programs that -display images of keyboards can use geometry properties as hints, but they are not interpreted by +The top-level geometry description includes a list of +.I geometry properties. +A geometry property associates an arbitrary string with an equally arbitrary name. Programs that +display images of keyboards can use geometry properties as hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. -Keys are grouped into rows. -.I XkbAddGeomKey -adds one key to the end of the specified -.I row. -The key is allocated and zeroed. -.I XkbAddGeomKey -returns NULL if -.I row -is empty or if it was not able to allocate space for the key. To allocate space for an arbitrary -number of keys to a row, use +Keys are grouped into rows. +.I XkbAddGeomKey +adds one key to the end of the specified +.I row. +The key is allocated and zeroed. +.I XkbAddGeomKey +returns NULL if +.I row +is empty or if it was not able to allocate space for the key. To allocate space for an arbitrary +number of keys to a row, use .I XkbAllocGeomKeys. .SH STRUCTURES .LP @@ -70,7 +70,7 @@ number of keys to a row, use unsigned char shape_ndx; /\&* index of shape for key */ unsigned char color_ndx; /\&* index of color for key body */ } XkbKeyRec, *XkbKeyPtr; - + .fi .SH "SEE ALSO" .BR XkbAllocGeomKeys (__libmansuffix__) diff --git a/man/xkb/XkbAddGeomKeyAlias.man b/man/xkb/XkbAddGeomKeyAlias.man index 521694f1..04ee6a97 100644 --- a/man/xkb/XkbAddGeomKeyAlias.man +++ b/man/xkb/XkbAddGeomKeyAlias.man @@ -21,7 +21,7 @@ .\" .TH XkbAddGeomKeyAlias __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbAddGeomKeyAlias \- Add one key alias to an existing keyboard geometry +XkbAddGeomKeyAlias \- Add one key alias to an existing keyboard geometry description .SH SYNOPSIS .HP @@ -43,34 +43,34 @@ alias to be added real name to be bound to the new alias .SH DESCRIPTION .LP -Xkb provides functions to add a single new element to the top-level keyboard -geometry. In each case the -.I num_ * -fields of the corresponding structure is incremented by 1. These functions do -not change -.I sz_* -unless there is no more room in the array. Some of these functions fill in the -values of the element's structure from the arguments. For other functions, you +Xkb provides functions to add a single new element to the top-level keyboard +geometry. In each case the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do +not change +.I sz_* +unless there is no more room in the array. Some of these functions fill in the +values of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's elements. -The top-level geometry description includes a list of -.I geometry properties. -A geometry property associates an arbitrary string with an equally arbitrary -name. Programs that display images of keyboards can use geometry properties as -hints, but they are not interpreted by Xkb. No other geometry structures refer +The top-level geometry description includes a list of +.I geometry properties. +A geometry property associates an arbitrary string with an equally arbitrary +name. Programs that display images of keyboards can use geometry properties as +hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. -.I XkbAddGeomKeyAlias -adds one key alias with the value -.I alias -to the geometry -.I geom, -and associates it with the key whose real name is -.I real. XkbAddGeomKeyAlias -returns NULL if any of the parameters is empty or if it was not able to allocate -space for the alias. To allocate space for an arbitrary number of aliases, use -the -.I XkbAllocGeomKeyAliases +.I XkbAddGeomKeyAlias +adds one key alias with the value +.I alias +to the geometry +.I geom, +and associates it with the key whose real name is +.I real. XkbAddGeomKeyAlias +returns NULL if any of the parameters is empty or if it was not able to allocate +space for the alias. To allocate space for an arbitrary number of aliases, use +the +.I XkbAllocGeomKeyAliases function. .SH STRUCTURES .LP diff --git a/man/xkb/XkbAddGeomOutline.man b/man/xkb/XkbAddGeomOutline.man index 6c58983c..b6f0e58b 100644 --- a/man/xkb/XkbAddGeomOutline.man +++ b/man/xkb/XkbAddGeomOutline.man @@ -38,32 +38,32 @@ shape to be updated number of points to be reserved .SH DESCRIPTION .LP -Xkb provides functions to add a single new element to the top-level keyboard -geometry. In each case the -.I num_ * -fields of the corresponding structure is incremented by 1. These functions do -not change -.I sz_* -unless there is no more room in the array. Some of these functions fill in the -values of the element's structure from the arguments. For other functions, you +Xkb provides functions to add a single new element to the top-level keyboard +geometry. In each case the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do +not change +.I sz_* +unless there is no more room in the array. Some of these functions fill in the +values of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's elements. -The top-level geometry description includes a list of -.I geometry properties. -A geometry property associates an arbitrary string with an equally arbitrary -name. Programs that display images of keyboards can use geometry properties as -hints, but they are not interpreted by Xkb. No other geometry structures refer +The top-level geometry description includes a list of +.I geometry properties. +A geometry property associates an arbitrary string with an equally arbitrary +name. Programs that display images of keyboards can use geometry properties as +hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. -An outline consists of an arbitrary number of points. -.I XkbAddGeomOutline -adds an outline to the specified -.I shape -by reserving -.I sz_points -points for it. The new outline is allocated and zeroed. -.I XkbAddGeomOutline -returns NULL if any of the parameters is empty or if it was not able to allocate +An outline consists of an arbitrary number of points. +.I XkbAddGeomOutline +adds an outline to the specified +.I shape +by reserving +.I sz_points +points for it. The new outline is allocated and zeroed. +.I XkbAddGeomOutline +returns NULL if any of the parameters is empty or if it was not able to allocate space. To allocate space for an arbitrary number of outlines to a shape, use .I XkbAllocGeomOutlines. .SH STRUCTURES @@ -76,7 +76,7 @@ space. To allocate space for an arbitrary number of outlines to a shape, use unsigned short corner_radius; /\&* draw corners as circles with this radius */ XkbPointPtr points; /\&* array of points defining the outline */ } XkbOutlineRec, *XkbOutlinePtr; - + .fi .SH "SEE ALSO" .BR XkbAllocGeomOutlines (__libmansuffix__) diff --git a/man/xkb/XkbAddGeomOverlay.man b/man/xkb/XkbAddGeomOverlay.man index 444b2e65..bebaaab3 100644 --- a/man/xkb/XkbAddGeomOverlay.man +++ b/man/xkb/XkbAddGeomOverlay.man @@ -42,36 +42,36 @@ name of the overlay number of rows to reserve in the overlay .SH DESCRIPTION .LP -Xkb provides functions to add a single new element to the top-level keyboard -geometry. In each case the -.I num_ * -fields of the corresponding structure is incremented by 1. These functions do -not change -.I sz_* -unless there is no more room in the array. Some of these functions fill in the -values of the element's structure from the arguments. For other functions, you +Xkb provides functions to add a single new element to the top-level keyboard +geometry. In each case the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do +not change +.I sz_* +unless there is no more room in the array. Some of these functions fill in the +values of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's elements. -The top-level geometry description includes a list of -.I geometry properties. -A geometry property associates an arbitrary string with an equally arbitrary -name. Programs that display images of keyboards can use geometry properties as -hints, but they are not interpreted by Xkb. No other geometry structures refer +The top-level geometry description includes a list of +.I geometry properties. +A geometry property associates an arbitrary string with an equally arbitrary +name. Programs that display images of keyboards can use geometry properties as +hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. -.I XkbAddGeomOverlay -adds an overlay with the specified name to the specified -.I section. -The new overlay is created with space allocated for -.I sz_rows -rows. If an overlay with name -.I name +.I XkbAddGeomOverlay +adds an overlay with the specified name to the specified +.I section. +The new overlay is created with space allocated for +.I sz_rows +rows. If an overlay with name +.I name already exists in the section, a pointer to the existing overlay is returned. -.I XkbAddGeomOverlay -returns NULL if any of the parameters is empty or if it was not able to allocate -space for the overlay. To allocate space for an arbitrary number of overlays to -a section, use the -.I XkbAllocGeomOverlay +.I XkbAddGeomOverlay +returns NULL if any of the parameters is empty or if it was not able to allocate +space for the overlay. To allocate space for an arbitrary number of overlays to +a section, use the +.I XkbAllocGeomOverlay function. .SH STRUCTURES .LP @@ -85,7 +85,7 @@ function. XkbOverlayRowPtr rows; /\&* array of rows in the overlay */ XkbBoundsPtr bounds; /\&* bounding box for the overlay */ } XkbOverlayRec,*XkbOverlayPtr; - + .fi .SH "SEE ALSO" .BR XkbAllocGeomOverlay (__libmansuffix__) diff --git a/man/xkb/XkbAddGeomOverlayKey.man b/man/xkb/XkbAddGeomOverlayKey.man index c64e70f8..1d9e82e7 100644 --- a/man/xkb/XkbAddGeomOverlayKey.man +++ b/man/xkb/XkbAddGeomOverlayKey.man @@ -40,35 +40,35 @@ overlay to be updated row in overlay to be updated .TP .I under -primary name of the key to be considered +primary name of the key to be considered .SH DESCRIPTION .LP -Xkb provides functions to add a single new element to the top-level keyboard -geometry. In each case the -.I num_ * -fields of the corresponding structure is incremented by 1. These functions do -not change -.I sz_* -unless there is no more room in the array. Some of these functions fill in the -values of the element's structure from the arguments. For other functions, you +Xkb provides functions to add a single new element to the top-level keyboard +geometry. In each case the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do +not change +.I sz_* +unless there is no more room in the array. Some of these functions fill in the +values of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's elements. -The top-level geometry description includes a list of -.I geometry properties. -A geometry property associates an arbitrary string with an equally arbitrary -name. Programs that display images of keyboards can use geometry properties as -hints, but they are not interpreted by Xkb. No other geometry structures refer +The top-level geometry description includes a list of +.I geometry properties. +A geometry property associates an arbitrary string with an equally arbitrary +name. Programs that display images of keyboards can use geometry properties as +hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. -.I XkbAddGeomOverlayKey -adds one key to the -.I row -in the -.I overlay. -If there is no key named -.I under -in the row of the underlying section, -.I XkbAddGeomOverlayKey +.I XkbAddGeomOverlayKey +adds one key to the +.I row +in the +.I overlay. +If there is no key named +.I under +in the row of the underlying section, +.I XkbAddGeomOverlayKey returns NULL. .SH STRUCTURES .LP diff --git a/man/xkb/XkbAddGeomOverlayRow.man b/man/xkb/XkbAddGeomOverlayRow.man index 95b0d421..0226432a 100644 --- a/man/xkb/XkbAddGeomOverlayRow.man +++ b/man/xkb/XkbAddGeomOverlayRow.man @@ -42,35 +42,35 @@ row to be overlaid in the section overlay overlays number of keys to reserve in the row .SH DESCRIPTION .LP -Xkb provides functions to add a single new element to the top-level keyboard -geometry. In each case the -.I num_ * -fields of the corresponding structure is incremented by 1. These functions do -not change -.I sz_* -unless there is no more room in the array. Some of these functions fill in the -values of the element's structure from the arguments. For other functions, you +Xkb provides functions to add a single new element to the top-level keyboard +geometry. In each case the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do +not change +.I sz_* +unless there is no more room in the array. Some of these functions fill in the +values of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's elements. -The top-level geometry description includes a list of -.I geometry properties. -A geometry property associates an arbitrary string with an equally arbitrary -name. Programs that display images of keyboards can use geometry properties as -hints, but they are not interpreted by Xkb. No other geometry structures refer +The top-level geometry description includes a list of +.I geometry properties. +A geometry property associates an arbitrary string with an equally arbitrary +name. Programs that display images of keyboards can use geometry properties as +hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. -.I XkbAddGeomOverlayRow -adds one row to the -.I overlay. -The new row contains space for -.I sz_keys -keys. If -. I row_under +.I XkbAddGeomOverlayRow +adds one row to the +.I overlay. +The new row contains space for +.I sz_keys +keys. If +. I row_under specifies a row that doesn't exist on the underlying section, -.I XkbAddGeomOverlayRow -returns NULL and doesn't change the overlay. -.I XkbAddGeomOverlayRow -returns NULL if any of the parameters is empty or if it was not able to allocate +.I XkbAddGeomOverlayRow +returns NULL and doesn't change the overlay. +.I XkbAddGeomOverlayRow +returns NULL if any of the parameters is empty or if it was not able to allocate space for the overlay. .SH STRUCTURES .LP diff --git a/man/xkb/XkbAddGeomProperty.man b/man/xkb/XkbAddGeomProperty.man index 9b40ab10..bf812313 100644 --- a/man/xkb/XkbAddGeomProperty.man +++ b/man/xkb/XkbAddGeomProperty.man @@ -21,7 +21,7 @@ .\" .TH XkbAddGeomProperty __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbAddGeomProperty \- Add one property to an existing keyboard geometry +XkbAddGeomProperty \- Add one property to an existing keyboard geometry description .SH SYNOPSIS .HP @@ -43,34 +43,34 @@ name of the new property value for the new property .SH DESCRIPTION .LP -Xkb provides functions to add a single new element to the top-level keyboard -geometry. In each case the -.I num_ * -fields of the corresponding structure is incremented by 1. These functions do -not change -.I sz_* -unless there is no more room in the array. Some of these functions fill in the -values of the element's structure from the arguments. For other functions, you +Xkb provides functions to add a single new element to the top-level keyboard +geometry. In each case the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do +not change +.I sz_* +unless there is no more room in the array. Some of these functions fill in the +values of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's elements. -The top-level geometry description includes a list of -.I geometry properties. -A geometry property associates an arbitrary string with an equally arbitrary -name. Programs that display images of keyboards can use geometry properties as -hints, but they are not interpreted by Xkb. No other geometry structures refer +The top-level geometry description includes a list of +.I geometry properties. +A geometry property associates an arbitrary string with an equally arbitrary +name. Programs that display images of keyboards can use geometry properties as +hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. -.I XkbAddGeomProperty -adds one property with the specified -.I name -and -.I value -to the keyboard geometry specified by -.I geom. XkbAddGeomProperty -returns NULL if any of the parameters is empty or if it was not able to allocate -space for the property. To allocate space for an arbitrary number of properties, -use the -.I XkbAllocGeomProps +.I XkbAddGeomProperty +adds one property with the specified +.I name +and +.I value +to the keyboard geometry specified by +.I geom. XkbAddGeomProperty +returns NULL if any of the parameters is empty or if it was not able to allocate +space for the property. To allocate space for an arbitrary number of properties, +use the +.I XkbAllocGeomProps function. .SH STRUCTURES .LP diff --git a/man/xkb/XkbAddGeomRow.man b/man/xkb/XkbAddGeomRow.man index 0646d3e0..e093ba32 100644 --- a/man/xkb/XkbAddGeomRow.man +++ b/man/xkb/XkbAddGeomRow.man @@ -32,32 +32,32 @@ XkbAddGeomRow \- Add a row to a section .SH ARGUMENTS .TP .I section -section to be updated +section to be updated .TP .I sz_keys number of keys to be reserved .SH DESCRIPTION .LP -Xkb provides functions to add a single new element to the top-level keyboard geometry. In each case the -.I num_ * -fields of the corresponding structure is incremented by 1. These functions do not change -.I sz_* +Xkb provides functions to add a single new element to the top-level keyboard geometry. In each case the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do not change +.I sz_* unless there is no more room in the array. Some of these functions fill in the values of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's elements. -The top-level geometry description includes a list of -.I geometry properties. +The top-level geometry description includes a list of +.I geometry properties. A geometry property associates an arbitrary string with an equally arbitrary name. Programs that display images of keyboards can use geometry properties as hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. -One of the components of a keyboard geometry section is one or more rows of keys. -.I XkbAddGeomRow -adds one row to the specified -.I section. +One of the components of a keyboard geometry section is one or more rows of keys. +.I XkbAddGeomRow +adds one row to the specified +.I section. The newly created row contains space for the number of keys specified in -.I sz_keys. -They are allocated and zeroed, but otherwise uninitialized. -.I XkbAddGeomRow -returns NULL if any of the parameters is empty or if it was not able to allocate space for the row. To allocate space for an arbitrary number of rows to a section, use the -.I XkbAllocGeomRows +.I sz_keys. +They are allocated and zeroed, but otherwise uninitialized. +.I XkbAddGeomRow +returns NULL if any of the parameters is empty or if it was not able to allocate space for the row. To allocate space for an arbitrary number of rows to a section, use the +.I XkbAllocGeomRows function. .SH STRUCTURES .LP @@ -70,7 +70,7 @@ typedef struct _XkbRow { int vertical; XkbKeyPtr keys; XkbBoundsRec bounds; -} XkbRowRec, *XkbRowPtr; +} XkbRowRec, *XkbRowPtr; .fi .SH "SEE ALSO" .BR XkbAllocGeomRows (__libmansuffix__) diff --git a/man/xkb/XkbAddGeomSection.man b/man/xkb/XkbAddGeomSection.man index f5da1cce..8d9532d7 100644 --- a/man/xkb/XkbAddGeomSection.man +++ b/man/xkb/XkbAddGeomSection.man @@ -50,41 +50,41 @@ number of doodads to reserve in the section number of overlays to reserve in the section .SH DESCRIPTION .LP -Xkb provides functions to add a single new element to the top-level keyboard -geometry. In each case the -.I num_ * -fields of the corresponding structure is incremented by 1. These functions do -not change -.I sz_* -unless there is no more room in the array. Some of these functions fill in the -values of the element's structure from the arguments. For other functions, you +Xkb provides functions to add a single new element to the top-level keyboard +geometry. In each case the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do +not change +.I sz_* +unless there is no more room in the array. Some of these functions fill in the +values of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's elements. -The top-level geometry description includes a list of -.I geometry properties. -A geometry property associates an arbitrary string with an equally arbitrary -name. Programs that display images of keyboards can use geometry properties as -hints, but they are not interpreted by Xkb. No other geometry structures refer +The top-level geometry description includes a list of +.I geometry properties. +A geometry property associates an arbitrary string with an equally arbitrary +name. Programs that display images of keyboards can use geometry properties as +hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. -A keyboard geometry contains an arbitrary number of sections. -.I XkbAddGeomSection -adds one section to an existing keyboard geometry -.I geom. -The new section contains space for the number of rows, doodads, and overlays -specified by -.I sz_rows, sz_doodads, -and -.I sz_overlays. -The new section is allocated and zeroed and given the name specified by -.I name. -If a section with name -.I name +A keyboard geometry contains an arbitrary number of sections. +.I XkbAddGeomSection +adds one section to an existing keyboard geometry +.I geom. +The new section contains space for the number of rows, doodads, and overlays +specified by +.I sz_rows, sz_doodads, +and +.I sz_overlays. +The new section is allocated and zeroed and given the name specified by +.I name. +If a section with name +.I name already exists in the geometry, a pointer to the existing section is returned. -.I XkbAddGeomSection -returns NULL if any of the parameters is empty or if it was not able to allocate -space for the section. To allocate space for an arbitrary number of sections to -a geometry, use +.I XkbAddGeomSection +returns NULL if any of the parameters is empty or if it was not able to allocate +space for the section. To allocate space for an arbitrary number of sections to +a geometry, use .I XkbAllocGeomSections. .SH STRUCTURES .LP @@ -111,9 +111,9 @@ typedef struct _XkbSection { } XkbSectionRec, *XkbSectionPtr; .fi -.I top -and -.I left +.I top +and +.I left are the origin of the section, relative to the origin of the keyboard, in mm/10. angle is in 1/10 degrees. .SH "SEE ALSO" .BR XkbAllocGeomSections (__libmansuffix__) diff --git a/man/xkb/XkbAddGeomShape.man b/man/xkb/XkbAddGeomShape.man index 2f883495..401c6551 100644 --- a/man/xkb/XkbAddGeomShape.man +++ b/man/xkb/XkbAddGeomShape.man @@ -42,33 +42,33 @@ name of the new shape number of outlines to be reserved .SH DESCRIPTION .LP -Xkb provides functions to add a single new element to the top-level keyboard geometry. In each case the -.I num_ * -fields of the corresponding structure is incremented by 1. These functions do not change -.I sz_* -unless there is no more room in the array. Some of these functions fill in the values of the element's structure from the +Xkb provides functions to add a single new element to the top-level keyboard geometry. In each case the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do not change +.I sz_* +unless there is no more room in the array. Some of these functions fill in the values of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's elements. -The top-level geometry description includes a list of -.I geometry properties. -A geometry property associates an arbitrary string with an equally arbitrary name. Programs that display images of -keyboards can use geometry properties as hints, but they are not interpreted by Xkb. No other geometry structures refer to +The top-level geometry description includes a list of +.I geometry properties. +A geometry property associates an arbitrary string with an equally arbitrary name. Programs that display images of +keyboards can use geometry properties as hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. A geometry contains an arbitrary number of shapes, each of which is made up of an arbitrary number of outlines. -.I XkbAddGeomShape -adds a shape to a geometry -.I geom -by allocating space for -.I sz_outlines -outlines for it and giving it the name specified by -.I name. -If a shape with name -.I name -already exists in the geometry, a pointer to the existing shape is returned. -.I XkbAddGeomShape -returns NULL if any of the parameters is empty or if it was not able to allocate space. To allocate space for an arbitrary -number of geometry shapes, use +.I XkbAddGeomShape +adds a shape to a geometry +.I geom +by allocating space for +.I sz_outlines +outlines for it and giving it the name specified by +.I name. +If a shape with name +.I name +already exists in the geometry, a pointer to the existing shape is returned. +.I XkbAddGeomShape +returns NULL if any of the parameters is empty or if it was not able to allocate space. To allocate space for an arbitrary +number of geometry shapes, use .I XkbAllocGeomShapes. .SH STRUCTURES .LP @@ -83,7 +83,7 @@ number of geometry shapes, use XkbOutlinePtr primary; /\&* pointer into the array to the primary outline */ XkbBoundsRec bounds; /\&* bounding box for the shape; encompasses all outlines */ } XkbShapeRec, *XkbShapePtr; - + .fi .SH "SEE ALSO" .BR XkbAllocGeomShapes (__libmansuffix__) diff --git a/man/xkb/XkbAddSymInterpret.man b/man/xkb/XkbAddSymInterpret.man index 5ca629d9..2568af41 100644 --- a/man/xkb/XkbAddSymInterpret.man +++ b/man/xkb/XkbAddSymInterpret.man @@ -21,7 +21,7 @@ .\" .TH XkbAddSymInterpret __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbAddSymInterpret \- Add a symbol interpretation to the list of symbol +XkbAddSymInterpret \- Add a symbol interpretation to the list of symbol interpretations in an XkbCompatRec .SH SYNOPSIS .HP @@ -35,7 +35,7 @@ interpretations in an XkbCompatRec .SH ARGUMENTS .TP .I xkb -keyboard description to be updated +keyboard description to be updated .TP .I si symbol interpretation to be added @@ -44,22 +44,22 @@ symbol interpretation to be added True=>apply compatibility map to keys .TP .I changes -changes are put here +changes are put here .SH DESCRIPTION .LP -.I XkbAddSymInterpret -adds -.I si -to the list of symbol interpretations in -.I xkb. -If -.I updateMap -is True, it (re)applies the compatibility map to all of the keys on the -keyboard. If -.I changes +.I XkbAddSymInterpret +adds +.I si +to the list of symbol interpretations in +.I xkb. +If +.I updateMap +is True, it (re)applies the compatibility map to all of the keys on the +keyboard. If +.I changes is non-NULL, it reports the parts of the keyboard that were affected (unless -.I updateMap -is True, not much changes). -.I XkbAddSymInterpret -returns a pointer to the actual new symbol interpretation in the list or NULL if +.I updateMap +is True, not much changes). +.I XkbAddSymInterpret +returns a pointer to the actual new symbol interpretation in the list or NULL if it failed. diff --git a/man/xkb/XkbAllocClientMap.man b/man/xkb/XkbAllocClientMap.man index 668f8a80..df203a5f 100644 --- a/man/xkb/XkbAllocClientMap.man +++ b/man/xkb/XkbAllocClientMap.man @@ -22,7 +22,7 @@ .\" .TH XkbAllocClientMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbAllocClientMap \- Allocate and initialize an empty client map description +XkbAllocClientMap \- Allocate and initialize an empty client map description record .SH SYNOPSIS .HP @@ -41,44 +41,44 @@ keyboard description in which to allocate client map mask selecting map components to allocate .TP .I type_count -value of num_types field in map to be allocated +value of num_types field in map to be allocated .SH DESCRIPTION .LP -Calling -.I XkbGetMap -should be sufficient for most applications to get client and server maps. As a -result, most applications do not need to directly allocate client and server +Calling +.I XkbGetMap +should be sufficient for most applications to get client and server maps. As a +result, most applications do not need to directly allocate client and server maps. -If you change the number of key types or construct map components without -loading the necessary components from the X server, do not allocate any map -components directly using -.I malloc -or -.I Xmalloc. -Instead, use the Xkb allocators, -.I XkbAllocClientMap, -and +If you change the number of key types or construct map components without +loading the necessary components from the X server, do not allocate any map +components directly using +.I malloc +or +.I Xmalloc. +Instead, use the Xkb allocators, +.I XkbAllocClientMap, +and .I XkbAllocServerMap. -Similarly, use the Xkb destructors, -.I XkbFreeClientMap, -and -.I XkbFreeServerMap -instead of -.I free -or +Similarly, use the Xkb destructors, +.I XkbFreeClientMap, +and +.I XkbFreeServerMap +instead of +.I free +or .I Xfree. -.I XkbAllocClientMap -allocates and initializes an empty client map in the -.I map -field of the keyboard description specified by -.I xkb. -The -.I which -parameter specifies the particular components of the client map structure to -allocate and is a mask composed by a bitwise inclusive OR of one or more of the +.I XkbAllocClientMap +allocates and initializes an empty client map in the +.I map +field of the keyboard description specified by +.I xkb. +The +.I which +parameter specifies the particular components of the client map structure to +allocate and is a mask composed by a bitwise inclusive OR of one or more of the masks shown in Table 1. .bp .TS @@ -90,60 +90,60 @@ _ Mask Effect _ XkbKeyTypesMask T{ -The type_count field specifies the number of entries to preallocate for the -types field of the client map. If the type_count field is less than +The type_count field specifies the number of entries to preallocate for the +types field of the client map. If the type_count field is less than XkbNumRequiredTypes returns BadValue. T} .sp XkbKeySymsMask T{ -The min_key_code and max_key_code fields of the xkb parameter are used to -allocate the syms and key_sym_map fields of the client map. The fields are -allocated to contain the maximum number of entries necessary for max_key_code - +The min_key_code and max_key_code fields of the xkb parameter are used to +allocate the syms and key_sym_map fields of the client map. The fields are +allocated to contain the maximum number of entries necessary for max_key_code - min_key_code + 1 keys. T} .sp XkbModifierMapMask T{ -The min_key_code and max_key_code fields of the xkb parameter are used to -allocate the modmap field of the client map. The field is allocated to contain -the maximum number of entries necessary for max_key_code - min_key_code + 1 +The min_key_code and max_key_code fields of the xkb parameter are used to +allocate the modmap field of the client map. The field is allocated to contain +the maximum number of entries necessary for max_key_code - min_key_code + 1 keys. T} .TE -NOTE: The -.I min_key_code -and -.I max_key_code -fields of the -.I xkb -parameter must be legal values if the XkbKeySymsMask or XkbModifierMapMask masks -are set in the -.I which -parameter. If they are not valid, -.I XkbAllocClientMap -returns BadValue. +NOTE: The +.I min_key_code +and +.I max_key_code +fields of the +.I xkb +parameter must be legal values if the XkbKeySymsMask or XkbModifierMapMask masks +are set in the +.I which +parameter. If they are not valid, +.I XkbAllocClientMap +returns BadValue. -If the client map of the keyboard description is not NULL, and any fields are -already allocated in the client map, -.I XkbAllocClientMap -does not overwrite the existing values; it simply ignores that part of the -request. The only exception is the -.I types -array. If -.I type_count -is greater than the current -.I num_types -field of the client map, -.I XkbAllocClientMap -resizes the -.I types -array and resets the -.I num_types +If the client map of the keyboard description is not NULL, and any fields are +already allocated in the client map, +.I XkbAllocClientMap +does not overwrite the existing values; it simply ignores that part of the +request. The only exception is the +.I types +array. If +.I type_count +is greater than the current +.I num_types +field of the client map, +.I XkbAllocClientMap +resizes the +.I types +array and resets the +.I num_types field accordingly. -If -.I XkbAllocClientMap -is successful, it returns Success. Otherwise, it can return either BadMatch, +If +.I XkbAllocClientMap +is successful, it returns Success. Otherwise, it can return either BadMatch, BadAlloc, or BadValue errors. .SH DIAGNOSTICS .TP 15 @@ -151,7 +151,7 @@ BadAlloc, or BadValue errors. Unable to allocate storage .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid .TP 15 .B BadValue diff --git a/man/xkb/XkbAllocCompatMap.man b/man/xkb/XkbAllocCompatMap.man index d0a184bd..a419db5c 100644 --- a/man/xkb/XkbAllocCompatMap.man +++ b/man/xkb/XkbAllocCompatMap.man @@ -43,14 +43,14 @@ mask of compatibility map components to allocate number of symbol interpretations to allocate .SH DESCRIPTION .LP -.I xkb -specifies the keyboard description for which compatibility maps are to be allocated. The compatibility map is the -.I compat +.I xkb +specifies the keyboard description for which compatibility maps are to be allocated. The compatibility map is the +.I compat field in this structure. -.I which -specifies the compatibility map components to be allocated (see XkbGetCompatMap). -.I which +.I which +specifies the compatibility map components to be allocated (see XkbGetCompatMap). +.I which is an inclusive OR of the bits shown in Table 1. .TS @@ -65,13 +65,13 @@ XkbGroupCompatMask (1<<1) Group maps XkbAllCompatMask (0x3) All compatibility map components .TE -.I num_si +.I num_si specifies the total number of entries to allocate in the symbol interpretation vector .I (xkb.compat.sym_interpret). -.I XkbAllocCompatMap -returns Success if successful, BadMatch if -.I xkb +.I XkbAllocCompatMap +returns Success if successful, BadMatch if +.I xkb is NULL, or BadAlloc if errors are encountered when attempting to allocate storage. .SH STRUCTURES .LP @@ -85,7 +85,7 @@ is NULL, or BadAlloc if errors are encountered when attempting to allocate stora unsigned char virtual_mod; /\&* 1 modifier to add to key virtual mod map */ XkbAnyAction act; /\&* action to bind to symbol position on key */ } XkbSymInterpretRec,*XkbSymInterpretPtr; - + .fi .SH DIAGNOSTICS .TP 15 @@ -98,11 +98,11 @@ A compatible version of Xkb was not available in the server or an argument has c .BR XkbGetCompatMap (__libmansuffix__) .SH NOTES .LP -Note that symbol interpretations in a compatibility map (the -.I sym_interpret +Note that symbol interpretations in a compatibility map (the +.I sym_interpret vector of XkbSymInterpretRec structures) are also allocated using this same function. To ensure that there is sufficient space in the symbol interpretation vector for entries to be added, use -.I XkbAllocCompatMap -specifying -.I which -as XkbSymInterpretMask and the number of free symbol interpretations needed in +.I XkbAllocCompatMap +specifying +.I which +as XkbSymInterpretMask and the number of free symbol interpretations needed in .I num_si. diff --git a/man/xkb/XkbAllocControls.man b/man/xkb/XkbAllocControls.man index b5d4bc2b..4f91252a 100644 --- a/man/xkb/XkbAllocControls.man +++ b/man/xkb/XkbAllocControls.man @@ -39,57 +39,57 @@ Xkb description in which to allocate ctrls rec mask of components of ctrls to allocate .SH DESCRIPTION .LP -The need to allocate an XkbControlsRec structure seldom arises; Xkb creates one -when an application calls -.I XkbGetControls -or a related function. For those situations where there is not an XkbControlsRec -structure allocated in the XkbDescRec, allocate one by calling +The need to allocate an XkbControlsRec structure seldom arises; Xkb creates one +when an application calls +.I XkbGetControls +or a related function. For those situations where there is not an XkbControlsRec +structure allocated in the XkbDescRec, allocate one by calling .I XkbAllocControls. -.I XkbAllocControls -allocates the -.I ctrls -field of the -.I xkb -parameter, initializes all fields to zero, and returns Success. If the -.I ctrls -field is not NULL, -.I XkbAllocControls -simply returns Success. If -.I xkb -is NULL, -.I XkbAllocControls -reports a BadMatch error. If the -.I ctrls +.I XkbAllocControls +allocates the +.I ctrls +field of the +.I xkb +parameter, initializes all fields to zero, and returns Success. If the +.I ctrls +field is not NULL, +.I XkbAllocControls +simply returns Success. If +.I xkb +is NULL, +.I XkbAllocControls +reports a BadMatch error. If the +.I ctrls field could not be allocated, it reports a BadAlloc error. -The -.I which -mask specifies the individual fields of the -.I ctrls -structure to be allocated and can contain any of the valid masks defined in -Table 1. +The +.I which +mask specifies the individual fields of the +.I ctrls +structure to be allocated and can contain any of the valid masks defined in +Table 1. (SHOULD THIS COMMENT BE LEFT IN????) -Because none of the currently existing controls have any structures associated +Because none of the currently existing controls have any structures associated with them, which is currently of little practical value in this call. -Table 1 shows the actual values for the individual mask bits used to select -controls for -modification and to enable and disable the control. Note that the same mask bit -is used to -specify general modifications to the parameters used to configure the control -(which), and to -enable and disable the control (enabled_ctrls). The anomalies in the table (no -"ok" in column) -are for controls that have no configurable attributes; and for controls that are -not boolean +Table 1 shows the actual values for the individual mask bits used to select +controls for +modification and to enable and disable the control. Note that the same mask bit +is used to +specify general modifications to the parameters used to configure the control +(which), and to +enable and disable the control (enabled_ctrls). The anomalies in the table (no +"ok" in column) +are for controls that have no configurable attributes; and for controls that are +not boolean controls and therefore cannot be enabled or disabled. .TS c s s s l l l l l l l l -l l l l. +l l l l. Table 1 Controls Mask Bits _ Mask Bit which or enabled Value @@ -113,9 +113,9 @@ XkbInternalModsMask ok (1L<<28) XkbIgnoreLockModsMask ok (1L<<29) XkbPerKeyRepeatMask ok (1L<<30) XkbControlsEnabledMask ok (1L<<31) -XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | +XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | XkbAccessXFeedbackMask) -XkbAllBooleanCtrlsMask ok (0x00001FFF) +XkbAllBooleanCtrlsMask ok (0x00001FFF) XkbAllControlsMask ok (0xF8001FFF) .TE .nh @@ -132,7 +132,7 @@ the ctrls field is not NULL Unable to allocate storage .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +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 XkbGetControls (__libmansuffix__) diff --git a/man/xkb/XkbAllocDeviceInfo.man b/man/xkb/XkbAllocDeviceInfo.man index 00e540f0..2339c63a 100644 --- a/man/xkb/XkbAllocDeviceInfo.man +++ b/man/xkb/XkbAllocDeviceInfo.man @@ -43,26 +43,26 @@ number of button actions to allocate space for number of LED feedbacks to allocate space for .SH DESCRIPTION .LP -.I XkbAllocDeviceInfo -allocates space for an XkbDeviceInfoRec structure and initializes that structure's -.I device_spec -field with the device ID specified by -.I device_spec. -If -.I n_buttons -is nonzero, -.I n_buttons -XkbActions are linked into the XkbDeviceInfoRec structure and initialized to zero. If -.I sz_leds -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 +.I XkbAllocDeviceInfo +allocates space for an XkbDeviceInfoRec structure and initializes that structure's +.I device_spec +field with the device ID specified by +.I device_spec. +If +.I n_buttons +is nonzero, +.I n_buttons +XkbActions are linked into the XkbDeviceInfoRec structure and initialized to zero. If +.I sz_leds +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, by using .BR XkbAddDeviceLedInfo (__libmansuffix__). .SH STRUCTURES .LP -Information about X Input Extension devices is transferred between a client program and the Xkb +Information about X Input Extension devices is transferred between a client program and the Xkb extension in an XkbDeviceInfoRec structure: .nf @@ -81,7 +81,7 @@ extension in an XkbDeviceInfoRec structure: 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*/ @@ -93,6 +93,6 @@ extension in an XkbDeviceInfoRec structure: Atom names[XkbNumIndicators]; /\&* names for LEDs */ XkbIndicatorMapRec maps; /\&* indicator maps for each LED */ } XkbDeviceLedInfoRec, *XkbDeviceLedInfoPtr; -.fi +.fi .SH "SEE ALSO" .BR XkbAddDeviceLedInfo (__libmansuffix__) diff --git a/man/xkb/XkbAllocGeomColors.man b/man/xkb/XkbAllocGeomColors.man index e48c1ba7..a7b2e3c0 100644 --- a/man/xkb/XkbAllocGeomColors.man +++ b/man/xkb/XkbAllocGeomColors.man @@ -38,28 +38,28 @@ geometry for which colors should be allocated number of new colors required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomColors -allocates space for -.I num_needed -colors and adds them to the specified geometry -.I geom. -A color name is a string whose interpretation is not specified by Xkb. All other -geometry data structures refer to colors using their indices in this global list +.I XkbAllocGeomColors +allocates space for +.I num_needed +colors and adds them to the specified geometry +.I geom. +A color name is a string whose interpretation is not specified by Xkb. All other +geometry data structures refer to colors using their indices in this global list or pointers to colors in this list. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomDoodads.man b/man/xkb/XkbAllocGeomDoodads.man index 874ee562..69162f2b 100644 --- a/man/xkb/XkbAllocGeomDoodads.man +++ b/man/xkb/XkbAllocGeomDoodads.man @@ -39,26 +39,26 @@ geometry for which doodads should be allocated number of new doodads required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomDoodads -allocates -.I num_needed -doodads and adds them to the specified geometry -.I geom. +.I XkbAllocGeomDoodads +allocates +.I num_needed +doodads and adds them to the specified geometry +.I geom. No initialization of the doodads is done. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomKeyAliases.man b/man/xkb/XkbAllocGeomKeyAliases.man index 55dab7fb..1996df85 100644 --- a/man/xkb/XkbAllocGeomKeyAliases.man +++ b/man/xkb/XkbAllocGeomKeyAliases.man @@ -38,30 +38,30 @@ geometry for which key aliases should be allocated number of new key aliases required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomKeyAliases -allocates space for -.I num_needed -key aliases and adds them to the specified geometry -.I geom. -A key alias is a pair of strings that associates an alternate name for a key +.I XkbAllocGeomKeyAliases +allocates space for +.I num_needed +key aliases and adds them to the specified geometry +.I geom. +A key alias is a pair of strings that associates an alternate name for a key with the real name for that key. -To free geometry key aliases, use +To free geometry key aliases, use .I XkbFreeGeomKeyAliases. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomKeys.man b/man/xkb/XkbAllocGeomKeys.man index ad8375bf..6c8bb0c3 100644 --- a/man/xkb/XkbAllocGeomKeys.man +++ b/man/xkb/XkbAllocGeomKeys.man @@ -35,29 +35,29 @@ XkbAllocGeomKeys \- Allocate space for an arbitrary number of keys to a row row to which keys should be allocated .TP .I num_needed -number of new keys required +number of new keys required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomKeys -allocates -.I num_needed -keys and adds them to the -.I row. +.I XkbAllocGeomKeys +allocates +.I num_needed +keys and adds them to the +.I row. No initialization of the keys is done. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomOutlines.man b/man/xkb/XkbAllocGeomOutlines.man index 7cfc051e..08185459 100644 --- a/man/xkb/XkbAllocGeomOutlines.man +++ b/man/xkb/XkbAllocGeomOutlines.man @@ -21,7 +21,7 @@ .\" .TH XkbAllocGeomOutlines __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbAllocGeomOutlines \- Allocate space for an arbitrary number of outlines to a +XkbAllocGeomOutlines \- Allocate space for an arbitrary number of outlines to a shape .SH SYNOPSIS .HP @@ -39,29 +39,29 @@ shape for which outlines should be allocated number of new outlines required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomOutlines -allocates space for -.I num_needed -outlines in the specified -.I shape. +.I XkbAllocGeomOutlines +allocates space for +.I num_needed +outlines in the specified +.I shape. The outlines are not initialized. -To free geometry outlines, use +To free geometry outlines, use .I XkbFreeGeomOutlines. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomOverlayKeys.man b/man/xkb/XkbAllocGeomOverlayKeys.man index 58d16ee3..9da65965 100644 --- a/man/xkb/XkbAllocGeomOverlayKeys.man +++ b/man/xkb/XkbAllocGeomOverlayKeys.man @@ -39,21 +39,21 @@ section for which rows should be allocated number of new rows required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify keyboard geometries. Note that these functions merely allocate space for the new element(s), and it is up to you to fill in the values explicitly in your code. These allocation functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* +Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify keyboard geometries. Note that these functions merely allocate space for the new element(s), and it is up to you to fill in the values explicitly in your code. These allocation functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomOverlayKeys -allocates -.I num_needed -keys and adds them to the -.I row. +.I XkbAllocGeomOverlayKeys +allocates +.I num_needed +keys and adds them to the +.I row. No initialization of the keys is done. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomOverlayRows.man b/man/xkb/XkbAllocGeomOverlayRows.man index 9101e242..c0ccbac5 100644 --- a/man/xkb/XkbAllocGeomOverlayRows.man +++ b/man/xkb/XkbAllocGeomOverlayRows.man @@ -38,29 +38,29 @@ section for which rows should be allocated number of new rows required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomOverlayRows -allocates -.I num_needed -rows and adds them to the -.I overlay. +.I XkbAllocGeomOverlayRows +allocates +.I num_needed +rows and adds them to the +.I overlay. No initialization of the rows is done. -To free rows in an overlay, use +To free rows in an overlay, use .I XkbFreeGeomOverlayRows. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomOverlays.man b/man/xkb/XkbAllocGeomOverlays.man index 2c7a9afb..2ab4a8e1 100644 --- a/man/xkb/XkbAllocGeomOverlays.man +++ b/man/xkb/XkbAllocGeomOverlays.man @@ -38,21 +38,21 @@ section for which overlays should be allocated number of new overlays required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify keyboard geometries. Note that these functions merely allocate space for the new element(s), and it is up to you to fill in the values explicitly in your code. These allocation functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* +Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify keyboard geometries. Note that these functions merely allocate space for the new element(s), and it is up to you to fill in the values explicitly in your code. These allocation functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomOverlays -allocates -.I num_needed -overlays and adds them to the -.I section. +.I XkbAllocGeomOverlays +allocates +.I num_needed +overlays and adds them to the +.I section. No initialization of the overlays is done. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomPoints.man b/man/xkb/XkbAllocGeomPoints.man index 70975a14..6b60b6ae 100644 --- a/man/xkb/XkbAllocGeomPoints.man +++ b/man/xkb/XkbAllocGeomPoints.man @@ -38,26 +38,26 @@ outline for which points should be allocated number of new points required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomPoints -allocates space for -.I num_needed -points in the specified -.I outline. +.I XkbAllocGeomPoints +allocates space for +.I num_needed +points in the specified +.I outline. The points are not initialized. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomProps.man b/man/xkb/XkbAllocGeomProps.man index 4db666c5..096b6ab4 100644 --- a/man/xkb/XkbAllocGeomProps.man +++ b/man/xkb/XkbAllocGeomProps.man @@ -38,29 +38,29 @@ geometry for which properties should be allocated number of new properties required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomProps -allocates space for -.I num_needed -properties and adds them to the specified geometry -.I geom. -No initialization of the properties is done. A geometry property associates an -arbitrary string with an equally arbitrary name. Geometry properties can be used -to provide hints to programs that display images of keyboards, but they are not +.I XkbAllocGeomProps +allocates space for +.I num_needed +properties and adds them to the specified geometry +.I geom. +No initialization of the properties is done. A geometry property associates an +arbitrary string with an equally arbitrary name. Geometry properties can be used +to provide hints to programs that display images of keyboards, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomRows.man b/man/xkb/XkbAllocGeomRows.man index bdeec804..0953804b 100644 --- a/man/xkb/XkbAllocGeomRows.man +++ b/man/xkb/XkbAllocGeomRows.man @@ -38,26 +38,26 @@ section for which rows should be allocated number of new rows required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomRows -allocates -.I num_needed -rows and adds them to the -.I section. +.I XkbAllocGeomRows +allocates +.I num_needed +rows and adds them to the +.I section. No initialization of the rows is done. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomSectionDoodads.man b/man/xkb/XkbAllocGeomSectionDoodads.man index 669c68ae..83c85988 100644 --- a/man/xkb/XkbAllocGeomSectionDoodads.man +++ b/man/xkb/XkbAllocGeomSectionDoodads.man @@ -39,29 +39,29 @@ section for which doodads should be allocated number of new doodads required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomSectionDoodads -allocates -.I num_needed -doodads and adds them to the specified -.I section. +.I XkbAllocGeomSectionDoodads +allocates +.I num_needed +doodads and adds them to the specified +.I section. No initialization of the doodads is done. -To free geometry doodads, use +To free geometry doodads, use .I XkbFreeGeomDoodads. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomSections.man b/man/xkb/XkbAllocGeomSections.man index 767c1123..be10171c 100644 --- a/man/xkb/XkbAllocGeomSections.man +++ b/man/xkb/XkbAllocGeomSections.man @@ -38,29 +38,29 @@ geometry for which sections should be allocated number of new sections required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomSections -allocates -.I num_needed -sections and adds them to the geometry -.I geom. +.I XkbAllocGeomSections +allocates +.I num_needed +sections and adds them to the geometry +.I geom. No initialization of the sections is done. -To free geometry sections, use +To free geometry sections, use .I XkbFreeGeomSections. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeomShapes.man b/man/xkb/XkbAllocGeomShapes.man index 6d658025..8fafc940 100644 --- a/man/xkb/XkbAllocGeomShapes.man +++ b/man/xkb/XkbAllocGeomShapes.man @@ -38,29 +38,29 @@ geometry for which shapes should be allocated number of new shapes required .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeomShapes -allocates space for -.I num_needed -shapes in the specified geometry -.I geom. +.I XkbAllocGeomShapes +allocates space for +.I num_needed +shapes in the specified geometry +.I geom. The shapes are not initialized. -To free geometry shapes, use +To free geometry shapes, use .I XkbFreeGeomShapes. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocGeometry.man b/man/xkb/XkbAllocGeometry.man index 998f854d..09e8bc09 100644 --- a/man/xkb/XkbAllocGeometry.man +++ b/man/xkb/XkbAllocGeometry.man @@ -39,37 +39,37 @@ keyboard description for which geometry is to be allocated initial sizes for all geometry components .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -.I XkbAllocGeometry -allocates a keyboard geometry and adds it to the keyboard description specified -by -.I xkb. -The keyboard description should be obtained via the -.I XkbGetKeyboard -or -.I XkbAllocKeyboard -functions. The -.I sizes -parameter specifies the number of elements to be reserved for the subcomponents -of the keyboard geometry and can be zero or more. These subcomponents include -the -.I properties, colors, shapes, sections, and doodads. +.I XkbAllocGeometry +allocates a keyboard geometry and adds it to the keyboard description specified +by +.I xkb. +The keyboard description should be obtained via the +.I XkbGetKeyboard +or +.I XkbAllocKeyboard +functions. The +.I sizes +parameter specifies the number of elements to be reserved for the subcomponents +of the keyboard geometry and can be zero or more. These subcomponents include +the +.I properties, colors, shapes, sections, and doodads. -To free an entire geometry, use +To free an entire geometry, use .I XkbFreeGeometry. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbAllocIndicatorMaps.man b/man/xkb/XkbAllocIndicatorMaps.man index cf2a6e83..2f3c52f1 100644 --- a/man/xkb/XkbAllocIndicatorMaps.man +++ b/man/xkb/XkbAllocIndicatorMaps.man @@ -21,9 +21,9 @@ .\" .TH XkbAllocIndicatorMaps __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbAllocIndicatorMaps \- Allocates, directly, the -.I indicators -member of the keyboard description record +XkbAllocIndicatorMaps \- Allocates, directly, the +.I indicators +member of the keyboard description record .SH SYNOPSIS .HP .B Status XkbAllocIndicatorMaps @@ -36,29 +36,29 @@ member of the keyboard description record keyboard description structure .SH DESCRIPTION .LP -The -.I xkb -parameter must point to a valid keyboard description. If it doesn't, -.I XkbAllocIndicatorMaps -returns a BadMatch error. Otherwise, -.I XkbAllocIndicatorMaps -allocates and initializes the -.I indicators -member of the keyboard description record and returns Success. If -.I XkbAllocIndicatorMaps +The +.I xkb +parameter must point to a valid keyboard description. If it doesn't, +.I XkbAllocIndicatorMaps +returns a BadMatch error. Otherwise, +.I XkbAllocIndicatorMaps +allocates and initializes the +.I indicators +member of the keyboard description record and returns Success. If +.I XkbAllocIndicatorMaps was unable to allocate the indicators record, it reports a BadAlloc error. .SH RETURN VALUES" .TP 15 Success -The -.I XkbAllocIndicatorMaps -function returns Success if it is successful in allocating and initializing the -.I indicators +The +.I XkbAllocIndicatorMaps +function returns Success if it is successful in allocating and initializing the +.I indicators member of the keyboard description record. .SH DIAGNOSTICS .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid .TP 15 .B BadAlloc diff --git a/man/xkb/XkbAllocKeyboard.man b/man/xkb/XkbAllocKeyboard.man index eb94e285..692b81d3 100644 --- a/man/xkb/XkbAllocKeyboard.man +++ b/man/xkb/XkbAllocKeyboard.man @@ -31,21 +31,21 @@ XkbAllocKeyboard \- Creates a keyboard description from scratch .SH DESCRIPTION .LP Applications seldom need to directly allocate a keyboard description; calling -.I XkbGetKeyboard -usually suffices. In the event you need to create a keyboard description from -scratch, however, use -.I XkbAllocKeyboard -rather than directly calling +.I XkbGetKeyboard +usually suffices. In the event you need to create a keyboard description from +scratch, however, use +.I XkbAllocKeyboard +rather than directly calling .I malloc. -If -.I XkbAllocKeyboard -fails to allocate the keyboard description, it returns NULL. -Otherwise, it returns a pointer to an empty keyboard description structure. The -.I device_spec -field will have been initialized to XkbUseCoreKbd. You may then -either fill in the structure components or use Xkb functions to obtain values -for the structure components from a keyboard device. +If +.I XkbAllocKeyboard +fails to allocate the keyboard description, it returns NULL. +Otherwise, it returns a pointer to an empty keyboard description structure. The +.I device_spec +field will have been initialized to XkbUseCoreKbd. You may then +either fill in the structure components or use Xkb functions to obtain values +for the structure components from a keyboard device. .SH "SEE ALSO" .BR malloc (3F), .BR XkbUseCoreKbd (__libmansuffix__), diff --git a/man/xkb/XkbAllocNames.man b/man/xkb/XkbAllocNames.man index 2814f6e1..ba8e1e1a 100644 --- a/man/xkb/XkbAllocNames.man +++ b/man/xkb/XkbAllocNames.man @@ -47,20 +47,20 @@ total number of radio group names needed total number of key aliases needed .SH DESCRIPTION .LP -Most applications do not need to directly allocate symbolic names structures. Do -not allocate a names structure directly using -.I malloc -or -.I Xmalloc -if your application changes the number of key aliases or radio groups or -constructs a symbolic names structure without loading the necessary components -from the X server. Instead use +Most applications do not need to directly allocate symbolic names structures. Do +not allocate a names structure directly using +.I malloc +or +.I Xmalloc +if your application changes the number of key aliases or radio groups or +constructs a symbolic names structure without loading the necessary components +from the X server. Instead use .I XkbAllocNames. -.I XkbAllocNames -can return BadAlloc, BadMatch, and BadValue errors. The -.I which -parameter is the bitwise inclusive OR of the valid names mask bits defined in +.I XkbAllocNames +can return BadAlloc, BadMatch, and BadValue errors. The +.I which +parameter is the bitwise inclusive OR of the valid names mask bits defined in Table 1. .TS @@ -94,12 +94,12 @@ XkbComponentNamesMask (0x3f) Xkb->names keycodes, XkbAllNamesMask (0x3fff) Xkb->names all name components .TE -Do not free symbolic names structures directly using -.I free -or -.I XFree. -Use -.I XkbFreeNames +Do not free symbolic names structures directly using +.I free +or +.I XFree. +Use +.I XkbFreeNames instead. .SH DIAGNOSTICS .TP 15 @@ -107,7 +107,7 @@ instead. Unable to allocate storage .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid .TP 15 .B BadValue diff --git a/man/xkb/XkbAllocServerMap.man b/man/xkb/XkbAllocServerMap.man index b1bc12e2..d787cd89 100644 --- a/man/xkb/XkbAllocServerMap.man +++ b/man/xkb/XkbAllocServerMap.man @@ -43,14 +43,14 @@ mask selecting map components to allocate value of num_acts field in map to be allocated .SH DESCRIPTION .LP -.I XkbAllocServerMap -allocates and initializes an empty server map in the -.I server -field of the keyboard description specified by -.I xkb. -The -.I which -parameter specifies the particular components of the server map structure to allocate, as specified in Table 1. +.I XkbAllocServerMap +allocates and initializes an empty server map in the +.I server +field of the keyboard description specified by +.I xkb. +The +.I which +parameter specifies the particular components of the server map structure to allocate, as specified in Table 1. .TS c s @@ -79,24 +79,24 @@ T} .TE -If the server map of the keyboard description is not NULL and any fields are already allocated in the server map, -.I XkbAllocServerMap -does not overwrite the existing values. The only exception is with the -.I acts -array. If the -.I count_acts -parameter is greater than the current -.I num_acts -field of the server map, -.I XkbAllocServerMap -resizes the -.I acts -array and resets the -.I num_acts +If the server map of the keyboard description is not NULL and any fields are already allocated in the server map, +.I XkbAllocServerMap +does not overwrite the existing values. The only exception is with the +.I acts +array. If the +.I count_acts +parameter is greater than the current +.I num_acts +field of the server map, +.I XkbAllocServerMap +resizes the +.I acts +array and resets the +.I num_acts field accordingly. -If -.I XkbAllocServerMap +If +.I XkbAllocServerMap is successful, it returns Success. Otherwise, it can return either BadMatch or BadAlloc errors. .SH DIAGNOSTICS .TP 15 @@ -110,12 +110,12 @@ A compatible version of Xkb was not available in the server or an argument has c An argument is out of range .SH NOTES .LP -The -.I min_key_code -and -.I max_key_code -fields of the -.I xkb -parameter must be legal values. If they are not valid, -.I XkbAllocServerMap -returns BadValue. +The +.I min_key_code +and +.I max_key_code +fields of the +.I xkb +parameter must be legal values. If they are not valid, +.I XkbAllocServerMap +returns BadValue. diff --git a/man/xkb/XkbApplyCompatMapToKey.man b/man/xkb/XkbApplyCompatMapToKey.man index 640d5e1e..18a28022 100644 --- a/man/xkb/XkbApplyCompatMapToKey.man +++ b/man/xkb/XkbApplyCompatMapToKey.man @@ -22,7 +22,7 @@ .\" .TH XkbApplyCompatMapToKey __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbApplyCompatMapToKey \- Apply the new compatibility mapping to an individual +XkbApplyCompatMapToKey \- Apply the new compatibility mapping to an individual key to get its semantics updated .SH SYNOPSIS .HP @@ -44,38 +44,38 @@ key to be updated notes changes to the Xkb keyboard description .SH DESCRIPTION .LP -.I XkbApplyCompatMapToKey -essentially performs the operation described in Core Keyboard Mapping to Xkb -Keyboard Mapping Transformation to a specific key. This updates the behavior, +.I XkbApplyCompatMapToKey +essentially performs the operation described in Core Keyboard Mapping to Xkb +Keyboard Mapping Transformation to a specific key. This updates the behavior, actions, repeat status, and virtual modifier bindings of the key. .B Core Keyboard Mapping to Xkb Keyboard Mapping Transformation -When a core protocol keyboard mapping request is received by the server, the -server's core keyboard map is updated, and then the Xkb map maintained by the -server is updated. Because a client may have explicitly configured some of the -Xkb keyboard mapping in the server, this automatic regeneration of the Xkb -keyboard mapping from the core protocol keyboard mapping should not modify any -components of the Xkb keyboard mapping that were explicitly set by a client. The -client must set explicit override controls to prevent this from happening (see -Explicit Components-Avoiding Automatic Remapping by the Server). The core-to-Xkb +When a core protocol keyboard mapping request is received by the server, the +server's core keyboard map is updated, and then the Xkb map maintained by the +server is updated. Because a client may have explicitly configured some of the +Xkb keyboard mapping in the server, this automatic regeneration of the Xkb +keyboard mapping from the core protocol keyboard mapping should not modify any +components of the Xkb keyboard mapping that were explicitly set by a client. The +client must set explicit override controls to prevent this from happening (see +Explicit Components-Avoiding Automatic Remapping by the Server). The core-to-Xkb mapping is done as follows: .B Explicit Components-Avoiding Automatic Remapping by the Server -Whenever a client remaps the keyboard using core protocol requests, Xkb examines -the map to determine likely default values for the components that cannot be +Whenever a client remaps the keyboard using core protocol requests, Xkb examines +the map to determine likely default values for the components that cannot be specified using the core protocol. -This automatic remapping might replace definitions explicitly requested by an -application, so the Xkb keyboard description defines an explicit components mask -for each key. Any aspects of the automatic remapping listed in the explicit -components mask for a key are not changed by the automatic keyboard mapping. +This automatic remapping might replace definitions explicitly requested by an +application, so the Xkb keyboard description defines an explicit components mask +for each key. Any aspects of the automatic remapping listed in the explicit +components mask for a key are not changed by the automatic keyboard mapping. -The explicit components masks are held in the -.I explicit -field of the server map, which is an array indexed by keycode. Each entry in -this array is a mask that is a bitwise inclusive OR of the values shown in Table +The explicit components masks are held in the +.I explicit +field of the server map, which is an array indexed by keycode. Each entry in +this array is a mask that is a bitwise inclusive OR of the values shown in Table 1. .TS @@ -99,127 +99,127 @@ ExplicitKeyType4 (1<<3) T{ Automatic determination of the key type associated with Group4. T} ExplicitInterpret (1<<4) T{ -Application of any of the fields of a symbol interpretation to the key in +Application of any of the fields of a symbol interpretation to the key in question. T} ExplicitAutoRepeat (1<<5) T{ -Automatic determination of auto-repeat status for the key, as specified in a +Automatic determination of auto-repeat status for the key, as specified in a symbol interpretation. T} ExplicitBehavior (1<<6) T{ -Automatic assignment of the XkbKB_Lock behavior to the key, if the +Automatic assignment of the XkbKB_Lock behavior to the key, if the XkbSI_LockingKey flag is set in a symbol interpretation. T} ExplicitVModMap (1<<7) T{ -Automatic determination of the virtual modifier map for the key based on the +Automatic determination of the virtual modifier map for the key based on the actions assigned to the key and the symbol interpretations that match the key. T} .TE .TP 4 1. -Map the symbols from the keys in the core keyboard map to groups and symbols on -keys in the Xkb keyboard map. The core keyboard mapping is of fixed width, so -each key in the core mapping has the same number of symbols associated with it. -The Xkb mapping allows a different number of symbols to be associated with each -key; those symbols may be divided into a different number of groups (1-4) for -each key. For each key, this process therefore involves partitioning the fixed -number of symbols from the core mapping into a set of variable-length groups -with a variable number of symbols in each group. For example, if the core -protocol map is of width five, the partition for one key might result in one -group with two symbols and another with three symbols. A different key might -result in two groups with two symbols plus a third group with one symbol. The +Map the symbols from the keys in the core keyboard map to groups and symbols on +keys in the Xkb keyboard map. The core keyboard mapping is of fixed width, so +each key in the core mapping has the same number of symbols associated with it. +The Xkb mapping allows a different number of symbols to be associated with each +key; those symbols may be divided into a different number of groups (1-4) for +each key. For each key, this process therefore involves partitioning the fixed +number of symbols from the core mapping into a set of variable-length groups +with a variable number of symbols in each group. For example, if the core +protocol map is of width five, the partition for one key might result in one +group with two symbols and another with three symbols. A different key might +result in two groups with two symbols plus a third group with one symbol. The core protocol map requires at least two symbols in each of the first two groups. .TP 4 1a. -For each changed key, determine the number of groups represented in the new core -keyboard map. This results in a tentative group count for each key in the Xkb +For each changed key, determine the number of groups represented in the new core +keyboard map. This results in a tentative group count for each key in the Xkb map. .TP 4 1b. -For each changed key, determine the number of symbols in each of the groups -found in step 1a. There is one explicit override control associated with each of -the four possible groups for each Xkb key, ExplicitKeyType1 through -ExplicitKeyType4. If no explicit override control is set for a group, the number -of symbols used for that group from the core map is two. If the explicit -override control is set for a group on the key, the number of symbols used for -that Xkb group from the core map is the width of the Xkb group with one -exception: because of the core protocol requirement for at least two symbols in -each of groups one and two, the number of symbols used for groups one and two is +For each changed key, determine the number of symbols in each of the groups +found in step 1a. There is one explicit override control associated with each of +the four possible groups for each Xkb key, ExplicitKeyType1 through +ExplicitKeyType4. If no explicit override control is set for a group, the number +of symbols used for that group from the core map is two. If the explicit +override control is set for a group on the key, the number of symbols used for +that Xkb group from the core map is the width of the Xkb group with one +exception: because of the core protocol requirement for at least two symbols in +each of groups one and two, the number of symbols used for groups one and two is the maximum of 2 or the width of the Xkb group. .TP 4 1c. -For each changed key, assign the symbols in the core map to the appropriate -group on the key. If the total number of symbols required by the Xkb map for a -particular key needs more symbols than the core protocol map contains, the -additional symbols are taken to be NoSymbol keysyms appended to the end of the -core set. If the core map contains more symbols than are needed by the Xkb map, -trailing symbols in the core map are discarded. In the absence of an explicit -override for group one or two, symbols are assigned in order by group; the first -symbols in the core map are assigned to group one, in order, followed by group -two, and so on. For example, if the core map contained eight symbols per key, -and a particular Xkb map contained 2 symbols for G1 and G2 and three for G3, the +For each changed key, assign the symbols in the core map to the appropriate +group on the key. If the total number of symbols required by the Xkb map for a +particular key needs more symbols than the core protocol map contains, the +additional symbols are taken to be NoSymbol keysyms appended to the end of the +core set. If the core map contains more symbols than are needed by the Xkb map, +trailing symbols in the core map are discarded. In the absence of an explicit +override for group one or two, symbols are assigned in order by group; the first +symbols in the core map are assigned to group one, in order, followed by group +two, and so on. For example, if the core map contained eight symbols per key, +and a particular Xkb map contained 2 symbols for G1 and G2 and three for G3, the symbols would be assigned as (G is group, L is shift level): .nf G1L1 G1L2 G2L1 G2L2 G3L1 G3L2 G3L3 - -.fi -If an explicit override control is set for group one or two, the symbols are -taken from the core set in a somewhat different order. The first four symbols -from the core set are assigned to G1L1, G1L2, G2L1, G2L2, respectively. If group -one requires more symbols, they are taken next, and then any additional symbols -needed by group two. Group three and four symbols are taken in complete sequence -after group two. For example, a key with four groups and three symbols in each + +.fi +If an explicit override control is set for group one or two, the symbols are +taken from the core set in a somewhat different order. The first four symbols +from the core set are assigned to G1L1, G1L2, G2L1, G2L2, respectively. If group +one requires more symbols, they are taken next, and then any additional symbols +needed by group two. Group three and four symbols are taken in complete sequence +after group two. For example, a key with four groups and three symbols in each group would take symbols from the core set in the following order: .nf G1L1 G1L2 G2L1 G2L2 G1L3 G2L3 G3L1 G3L2 G3L3 G4L1 G4L2 G4L3 - -.fi -As previously noted, the core protocol map requires at lease two symbols in -groups one and two. Because of this, if an explicit override control for an Xkb -key is set and group one and / or group two is of width one, it is not possible -to generate the symbols taken from the core protocol set and assigned to + +.fi +As previously noted, the core protocol map requires at lease two symbols in +groups one and two. Because of this, if an explicit override control for an Xkb +key is set and group one and / or group two is of width one, it is not possible +to generate the symbols taken from the core protocol set and assigned to position G1L2 and / or G2L2. .TP 4 1d. -For each group on each changed key, assign a key type appropriate for the +For each group on each changed key, assign a key type appropriate for the symbols in the group. .TP 4 1e. For each changed key, remove any empty or redundant groups. -At this point, the groups and their associated symbols have been assigned to the +At this point, the groups and their associated symbols have been assigned to the corresponding key definitions in the Xkb map. .TP 4 2. -Apply symbol interpretations to modify key operation. This phase is completely -skipped if the ExplicitInterpret override control bit is set in the explicit -controls mask for the Xkb key (see Explicit Components-Avoiding Automatic +Apply symbol interpretations to modify key operation. This phase is completely +skipped if the ExplicitInterpret override control bit is set in the explicit +controls mask for the Xkb key (see Explicit Components-Avoiding Automatic Remapping by the Server). .TP 4 2a. -For each symbol on each changed key, attempt to match the symbol and modifiers -from the Xkb map to a symbol interpretation describing how to generate the +For each symbol on each changed key, attempt to match the symbol and modifiers +from the Xkb map to a symbol interpretation describing how to generate the symbol. .TP 4 2b. -When a match is found in step 2a, apply the symbol interpretation to change the -semantics associated with the symbol in the Xkb key map. If no match is found, +When a match is found in step 2a, apply the symbol interpretation to change the +semantics associated with the symbol in the Xkb key map. If no match is found, apply a default interpretation. .LP -The symbol interpretations used in step 2 are configurable and may be specified -using XkbSymInterpretRec structures referenced by the sym_interpret field of an +The symbol interpretations used in step 2 are configurable and may be specified +using XkbSymInterpretRec structures referenced by the sym_interpret field of an XkbCompatMapRec. .B Symbol Interpretations - the XkbSymInterpretRec Structure -Symbol interpretations are used to guide the X server when it modifies the Xkb -keymap in step 2. An initial set of symbol interpretations is loaded by the +Symbol interpretations are used to guide the X server when it modifies the Xkb +keymap in step 2. An initial set of symbol interpretations is loaded by the server when it starts. A client may add new ones using XkbSetCompatMap. -Symbol interpretations result in key semantics being set. When a symbol -interpretation is applied, the following components of server key event +Symbol interpretations result in key semantics being set. When a symbol +interpretation is applied, the following components of server key event processing may be modified for the particular key involved: .nf @@ -227,11 +227,11 @@ processing may be modified for the particular key involved: Auto repeat Key behavior (may be set to XkbKB_Lock) Key action - -.fi + +.fi The XkbSymInterpretRec structure specifies a symbol interpretation: .nf - + typedef struct { KeySym sym; /\&* keysym of interest or NULL */ unsigned char flags; /\&* XkbSI_AutoRepeat, XkbSI_LockingKey */ @@ -240,26 +240,26 @@ typedef struct { unsigned char virtual_mod; /\&* 1 modifier to add to key virtual mod map */ XkbAnyAction act; /\&* action to bind to symbol position on key */ } XkbSymInterpretRec,*XkbSymInterpretPtr; - -.fi -If sym is not NULL, it limits the symbol interpretation to keys on which that -particular keysym is selected by the modifiers matching the criteria specified -by -.I mods -and -.I match. -If -.I sym -is NULL, the interpretation may be applied to any symbol selected on a key when -the modifiers match the criteria specified by -.I mods -and + +.fi +If sym is not NULL, it limits the symbol interpretation to keys on which that +particular keysym is selected by the modifiers matching the criteria specified +by +.I mods +and +.I match. +If +.I sym +is NULL, the interpretation may be applied to any symbol selected on a key when +the modifiers match the criteria specified by +.I mods +and .I match. -.I match -must be one of the values shown in Table 2 and specifies how the real modifiers -specified in -.I mods +.I match +must be one of the values shown in Table 2 and specifies how the real modifiers +specified in +.I mods are to be interpreted. .TS @@ -287,26 +287,26 @@ All of the bits that are on in mods must be set, and no other bits may be set. T} .TE -In addition to the above bits, -.I match -may contain the XkbSI_LevelOneOnly bit, in which case the modifier match -criteria specified by -.I mods -and -.I match -applies only if -.I sym -is in level one of its group; otherwise, -.I mods -and -.I match +In addition to the above bits, +.I match +may contain the XkbSI_LevelOneOnly bit, in which case the modifier match +criteria specified by +.I mods +and +.I match +applies only if +.I sym +is in level one of its group; otherwise, +.I mods +and +.I match are ignored and the symbol matches a condition where no modifiers are set. .nf \&#define XkbSI_LevelOneOnly (0x80) /\&* use mods + match only if sym is level 1 */ - -.fi -If no matching symbol interpretation is found, the server uses a default + +.fi +If no matching symbol interpretation is found, the server uses a default interpretation where: .nf @@ -316,43 +316,43 @@ interpretation where: mods = 0 virtual_mod = XkbNoModifier act = SA_NoAction - -.fi -When a matching symbol interpretation is found in step 2a, the interpretation is + +.fi +When a matching symbol interpretation is found in step 2a, the interpretation is applied to modify the Xkb map as follows. -The -.I act -field specifies a single action to be bound to the symbol position; any key event that selects the symbol +The +.I act +field specifies a single action to be bound to the symbol position; any key event that selects the symbol causes the action to be taken. Valid actions are defined in Key Actions. -If the Xkb keyboard map for the key does not have its ExplicitVModMap control set, the XkbSI_LevelOneOnly bit +If the Xkb keyboard map for the key does not have its ExplicitVModMap control set, the XkbSI_LevelOneOnly bit and symbol position are examined. If the XkbSI_LevelOneOnly bit is not set in -.I match -or the symbol is in position G1L1, the -.I virtual_mod -field is examined. If -.I virtual_mod -is not XkbNoModifier, -.I virtual_mod -specifies a single virtual modifier to be added to the virtual modifier map for the key. -.I virtual_mod -is specified as an index in the range [0..15]. +.I match +or the symbol is in position G1L1, the +.I virtual_mod +field is examined. If +.I virtual_mod +is not XkbNoModifier, +.I virtual_mod +specifies a single virtual modifier to be added to the virtual modifier map for the key. +.I virtual_mod +is specified as an index in the range [0..15]. -If the matching symbol is in position G1L1 of the key, two bits in the flags field potentially specify +If the matching symbol is in position G1L1 of the key, two bits in the flags field potentially specify additional behavior modifications: .nf \&#define XkbSI_AutoRepeat (1<<0) /\&* key repeats if sym is in position G1L1 */ \&#define XkbSI_LockingKey (1<<1) /\&* set KB_Lock behavior if sym is in psn G1L1 */ - + .fi -If the Xkb keyboard map for the key does not have its ExplicitAutoRepeat control set, its auto repeat behavior -is set based on the value of the XkbSI_AutoRepeat bit. If the XkbSI_AutoRepeat bit is set, the auto-repeat +If the Xkb keyboard map for the key does not have its ExplicitAutoRepeat control set, its auto repeat behavior +is set based on the value of the XkbSI_AutoRepeat bit. If the XkbSI_AutoRepeat bit is set, the auto-repeat behavior of the key is turned on; otherwise, it is turned off. -If the Xkb keyboard map for the key does not have its ExplicitBehavior control set, its locking behavior is -set based on the value of the XkbSI_LockingKey bit. If XkbSI_LockingKey is set, the key behavior is set to +If the Xkb keyboard map for the key does not have its ExplicitBehavior control set, its locking behavior is +set based on the value of the XkbSI_LockingKey bit. If XkbSI_LockingKey is set, the key behavior is set to KB_Lock; otherwise, it is turned off. .SH "SEE ALSO" .BR XkbKeyAction (__libmansuffix__), diff --git a/man/xkb/XkbBell.man b/man/xkb/XkbBell.man index d0b611aa..557c6f7b 100644 --- a/man/xkb/XkbBell.man +++ b/man/xkb/XkbBell.man @@ -47,85 +47,85 @@ relative volume, which can range from -100 to 100 inclusive a bell name, or NULL .SH DESCRIPTION .LP -The core X protocol allows only applications to explicitly sound the system bell -with a -given duration, pitch, and volume. Xkb extends this capability by allowing -clients to -attach symbolic names to bells, disable audible bells, and receive an event -whenever the -keyboard bell is rung. For the purposes of this document, the -.I audible -bell is defined to be the system bell, or the default keyboard bell, as opposed -to any -other audible sound generated elsewhere in the system. -You can ask to receive XkbBellNotify events when any client rings any one of the +The core X protocol allows only applications to explicitly sound the system bell +with a +given duration, pitch, and volume. Xkb extends this capability by allowing +clients to +attach symbolic names to bells, disable audible bells, and receive an event +whenever the +keyboard bell is rung. For the purposes of this document, the +.I audible +bell is defined to be the system bell, or the default keyboard bell, as opposed +to any +other audible sound generated elsewhere in the system. +You can ask to receive XkbBellNotify events when any client rings any one of the following: .IP \(bu 5 The default bell .IP \(bu 5 -Any bell on an input device that can be specified by a bell_class and bell_id +Any bell on an input device that can be specified by a bell_class and bell_id pair .IP \(bu 5 -Any bell specified only by an arbitrary name. (This is, from the server's point -of view, -merely a name, and not connected with any physical sound-generating device. Some -client -application must generate the sound, or visual feedback, if any, that is -associated with +Any bell specified only by an arbitrary name. (This is, from the server's point +of view, +merely a name, and not connected with any physical sound-generating device. Some +client +application must generate the sound, or visual feedback, if any, that is +associated with the name.) .LP -You can also ask to receive XkbBellNotify events when the server rings the -default bell -or if any client has requested events only (without the bell sounding) for any -of the +You can also ask to receive XkbBellNotify events when the server rings the +default bell +or if any client has requested events only (without the bell sounding) for any +of the bell types previously listed. -You can disable audible bells on a global basis. For example, a client that -replaces the -keyboard bell with some other audible cue might want to turn off the AudibleBell -control -to prevent the server from also generating a sound and avoid cacophony. If you -disable -audible bells and request to receive XkbBellNotify events, you can generate -feedback +You can disable audible bells on a global basis. For example, a client that +replaces the +keyboard bell with some other audible cue might want to turn off the AudibleBell +control +to prevent the server from also generating a sound and avoid cacophony. If you +disable +audible bells and request to receive XkbBellNotify events, you can generate +feedback different from the default bell. -You can, however, override the AudibleBell control by calling one of the -functions that -force the ringing of a bell in spite of the setting of the AudibleBell control - -.I XkbForceDeviceBell -or -.I XkbForceBell. +You can, however, override the AudibleBell control by calling one of the +functions that +force the ringing of a bell in spite of the setting of the AudibleBell control - +.I XkbForceDeviceBell +or +.I XkbForceBell. In this case the server does not generate a bell event. -Just as some keyboards can produce keyclicks to indicate when a key is pressed -or -repeating, Xkb can provide feedback for the controls by using special beep -codes. The -AccessXFeedback control is used to configure the specific types of operations -that +Just as some keyboards can produce keyclicks to indicate when a key is pressed +or +repeating, Xkb can provide feedback for the controls by using special beep +codes. The +AccessXFeedback control is used to configure the specific types of operations +that generate feedback. Bell Names -You can associate a name to an act of ringing a bell by converting the name to -an Atom -and then using this name when you call the functions listed in this chapter. If -an event -is generated as a result, the name is then passed to all other clients -interested in -receiving XkbBellNotify events. Note that these are arbitrary names and that -there is no -binding to any sounds. Any sounds or other effects (such as visual bells on the -screen) -must be generated by a client application upon receipt of the bell event -containing the -name. There is no default name for the default keyboard bell. The server does -generate -some predefined bells for the AccessX controls. These named bells are shown in -Table 1 below; the name is included in any bell event sent to clients that have +You can associate a name to an act of ringing a bell by converting the name to +an Atom +and then using this name when you call the functions listed in this chapter. If +an event +is generated as a result, the name is then passed to all other clients +interested in +receiving XkbBellNotify events. Note that these are arbitrary names and that +there is no +binding to any sounds. Any sounds or other effects (such as visual bells on the +screen) +must be generated by a client application upon receipt of the bell event +containing the +name. There is no default name for the default keyboard bell. The server does +generate +some predefined bells for the AccessX controls. These named bells are shown in +Table 1 below; the name is included in any bell event sent to clients that have requested to receive XkbBellNotify events. .TS @@ -155,51 +155,51 @@ StickyKeys key unlocked AX_StickyUnlock Audible Bells -Using Xkb you can generate bell events that do not necessarily ring the system -bell. This -is useful if you need to use an audio server instead of the system beep. For -example, -when an audio client starts, it could disable the audible bell (the system bell) -and then -listen for XkbBellNotify events. When it receives a XkbBellNotify event, the -audio client +Using Xkb you can generate bell events that do not necessarily ring the system +bell. This +is useful if you need to use an audio server instead of the system beep. For +example, +when an audio client starts, it could disable the audible bell (the system bell) +and then +listen for XkbBellNotify events. When it receives a XkbBellNotify event, the +audio client could then send a request to an audio server to play a sound. You can control the audible bells feature by passing the XkbAudibleBellMask to -.I XkbChangeEnabledControls. -If you set XkbAudibleBellMask on, the server rings the system bell when a bell -event -occurs. This is the default. If you set XkbAudibleBellMask off and a bell event -occurs, -the server does not ring the system bell unless you call -.I XkbForceDeviceBell -or +.I XkbChangeEnabledControls. +If you set XkbAudibleBellMask on, the server rings the system bell when a bell +event +occurs. This is the default. If you set XkbAudibleBellMask off and a bell event +occurs, +the server does not ring the system bell unless you call +.I XkbForceDeviceBell +or .I XkbForceBell. Audible bells are also part of the per-client auto-reset controls. Bell Functions -Use the functions described in this section to ring bells and to generate bell -events. +Use the functions described in this section to ring bells and to generate bell +events. -The input extension has two types of feedbacks that can generate bells - bell -feedback +The input extension has two types of feedbacks that can generate bells - bell +feedback and keyboard feedback. Some of the functions in this section have -.I bell_class -and -.I bell_id -parameters; set them as follows: Set -.I bell_class -to BellFeedbackClass or KbdFeedbackClass. A device can have more than one -feedback of -each type; set -.I bell_id -to the particular bell feedback of -.I bell_class +.I bell_class +and +.I bell_id +parameters; set them as follows: Set +.I bell_class +to BellFeedbackClass or KbdFeedbackClass. A device can have more than one +feedback of +each type; set +.I bell_id +to the particular bell feedback of +.I bell_class type. -Table 2 shows the conditions that cause a bell to sound or an XkbBellNotifyEvent +Table 2 shows the conditions that cause a bell to sound or an XkbBellNotifyEvent to be generated when a bell function is called. .TS @@ -208,7 +208,7 @@ l l l l l l l l. Table 2 Bell Sounding and Bell Event Generating _ -Function called AudibleBell Server sounds a bell Server sends an +Function called AudibleBell Server sounds a bell Server sends an XkbBellNotifyEvent _ XkbDeviceBell On Yes Yes @@ -221,35 +221,35 @@ XkbDeviceForceBell On or Off Yes No XkbForceBell On or Off Yes No .TE -If a compatible keyboard extension isn't present in the X server, -.I XkbBell -calls -.I XBell -with the specified -.I display -and -.I percent, -and returns False. Otherwise, -.I XkbBell -calls -.I XkbDeviceBell -with the specified -.I display, window, percent, -and -.I name, -a -.I device_spec -of XkbUseCoreKbd, a -.I bell_class -of XkbDfltXIClass, and a -.I bell_id +If a compatible keyboard extension isn't present in the X server, +.I XkbBell +calls +.I XBell +with the specified +.I display +and +.I percent, +and returns False. Otherwise, +.I XkbBell +calls +.I XkbDeviceBell +with the specified +.I display, window, percent, +and +.I name, +a +.I device_spec +of XkbUseCoreKbd, a +.I bell_class +of XkbDfltXIClass, and a +.I bell_id of XkbDfltXIId, and returns True. - -If you have disabled the audible bell, the server does not ring the system bell, + +If you have disabled the audible bell, the server does not ring the system bell, although it does generate a XkbBellNotify event. - -You can call -.I XkbBell + +You can call +.I XkbBell without first initializing the keyboard extension. .SH "RETURN VALUES" .TP 15 @@ -257,31 +257,31 @@ FALSE The XkbBell function returns FALSE if XlibDisplayNoXkb is set. .SH STRUCTURES .LP -Xkb generates XkbBellNotify events for all bells except for those resulting from -calls to -.I XkbForceDeviceBell -and -.I XkbForceBell. -To receive XkbBellNotify events under all possible conditions, pass -XkbBellNotifyMask in -both the -.I bits_to_change -and -.I values_for_bits -parameters to +Xkb generates XkbBellNotify events for all bells except for those resulting from +calls to +.I XkbForceDeviceBell +and +.I XkbForceBell. +To receive XkbBellNotify events under all possible conditions, pass +XkbBellNotifyMask in +both the +.I bits_to_change +and +.I values_for_bits +parameters to .I XkbSelectEvents. -The XkbBellNotify event has no event details. It is either selected or it is -not. -However, you can call -.I XkbSelectEventDetails -using XkbBellNotify as the -.I event_type +The XkbBellNotify event has no event details. It is either selected or it is +not. +However, you can call +.I XkbSelectEventDetails +using XkbBellNotify as the +.I event_type and specifying XkbAllBellEventsMask in -.I bits_to_change -and -.I values_for_bits. -This has the same effect as a call to +.I bits_to_change +and +.I values_for_bits. +This has the same effect as a call to .I XkbSelectEvents. The structure for the XkbBellNotify event type contains: @@ -304,10 +304,10 @@ The structure for the XkbBellNotify event type contains: Window window; /\&* window associated with event */ Bool event_only; /\&* False -> the server did not produce a beep */ } XkbBellNotifyEvent; - -.fi -If your application needs to generate visual bell feedback on the screen when it -receives + +.fi +If your application needs to generate visual bell feedback on the screen when it +receives a bell event, use the window ID in the XkbBellNotifyEvent, if present. .SH "SEE ALSO" diff --git a/man/xkb/XkbBellEvent.man b/man/xkb/XkbBellEvent.man index 8c8f0a94..e14ac235 100644 --- a/man/xkb/XkbBellEvent.man +++ b/man/xkb/XkbBellEvent.man @@ -22,7 +22,7 @@ .\" .TH XkbBellEvent __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbBellEvent \- Provides a function that initiates a bell event for the keyboard +XkbBellEvent \- Provides a function that initiates a bell event for the keyboard without ringing the bell .SH SYNOPSIS .HP @@ -39,7 +39,7 @@ without ringing the bell connection to the X server .TP .I window -the event window, or None +the event window, or None .TP .I percent relative volume, which can range from -100 to 100 inclusive @@ -48,84 +48,84 @@ relative volume, which can range from -100 to 100 inclusive a bell name, or NULL .SH DESCRIPTION .LP -The core X protocol allows only applications to explicitly sound the system bell -with a -given duration, pitch, and volume. Xkb extends this capability by allowing -clients to -attach symbolic names to bells, disable audible bells, and receive an event -whenever the -keyboard bell is rung. For the purposes of this document, the -.I audible -bell is defined to be the system bell, or the default keyboard bell, as opposed -to any -other audible sound generated elsewhere in the system. -You can ask to receive XkbBellNotify events when any client rings any one of the +The core X protocol allows only applications to explicitly sound the system bell +with a +given duration, pitch, and volume. Xkb extends this capability by allowing +clients to +attach symbolic names to bells, disable audible bells, and receive an event +whenever the +keyboard bell is rung. For the purposes of this document, the +.I audible +bell is defined to be the system bell, or the default keyboard bell, as opposed +to any +other audible sound generated elsewhere in the system. +You can ask to receive XkbBellNotify events when any client rings any one of the following: .IP \(bu 5 The default bell .IP \(bu 5 -Any bell on an input device that can be specified by a bell_class and bell_id +Any bell on an input device that can be specified by a bell_class and bell_id pair .IP \(bu 5 -Any bell specified only by an arbitrary name. (This is, from the server's point -of view, -merely a name, and not connected with any physical sound-generating device. Some -client -application must generate the sound, or visual feedback, if any, that is -associated with +Any bell specified only by an arbitrary name. (This is, from the server's point +of view, +merely a name, and not connected with any physical sound-generating device. Some +client +application must generate the sound, or visual feedback, if any, that is +associated with the name.) -You can also ask to receive XkbBellNotify events when the server rings the -default bell -or if any client has requested events only (without the bell sounding) for any -of the +You can also ask to receive XkbBellNotify events when the server rings the +default bell +or if any client has requested events only (without the bell sounding) for any +of the bell types previously listed. -You can disable audible bells on a global basis. For example, a client that -replaces the -keyboard bell with some other audible cue might want to turn off the AudibleBell -control -to prevent the server from also generating a sound and avoid cacophony. If you -disable -audible bells and request to receive XkbBellNotify events, you can generate -feedback +You can disable audible bells on a global basis. For example, a client that +replaces the +keyboard bell with some other audible cue might want to turn off the AudibleBell +control +to prevent the server from also generating a sound and avoid cacophony. If you +disable +audible bells and request to receive XkbBellNotify events, you can generate +feedback different from the default bell. -You can, however, override the AudibleBell control by calling one of the -functions that -force the ringing of a bell in spite of the setting of the AudibleBell control - -.I XkbForceDeviceBell or -.I XkbForceBell. +You can, however, override the AudibleBell control by calling one of the +functions that +force the ringing of a bell in spite of the setting of the AudibleBell control - +.I XkbForceDeviceBell or +.I XkbForceBell. In this case the server does not generate a bell event. -Just as some keyboards can produce keyclicks to indicate when a key is pressed -or -repeating, Xkb can provide feedback for the controls by using special beep -codes. The -AccessXFeedback control is used to configure the specific types of operations -that +Just as some keyboards can produce keyclicks to indicate when a key is pressed +or +repeating, Xkb can provide feedback for the controls by using special beep +codes. The +AccessXFeedback control is used to configure the specific types of operations +that generate feedback. Bell Names -You can associate a name to an act of ringing a bell by converting the name to -an Atom -and then using this name when you call the functions listed in this chapter. If -an event -is generated as a result, the name is then passed to all other clients -interested in -receiving XkbBellNotify events. Note that these are arbitrary names and that -there is no -binding to any sounds. Any sounds or other effects (such as visual bells on the -screen) -must be generated by a client application upon receipt of the bell event -containing the -name. There is no default name for the default keyboard bell. The server does -generate -some predefined bells for the AccessX controls. These named bells are shown in -Table 1; the name is included in any bell event sent to clients that have -requested to +You can associate a name to an act of ringing a bell by converting the name to +an Atom +and then using this name when you call the functions listed in this chapter. If +an event +is generated as a result, the name is then passed to all other clients +interested in +receiving XkbBellNotify events. Note that these are arbitrary names and that +there is no +binding to any sounds. Any sounds or other effects (such as visual bells on the +screen) +must be generated by a client application upon receipt of the bell event +containing the +name. There is no default name for the default keyboard bell. The server does +generate +some predefined bells for the AccessX controls. These named bells are shown in +Table 1; the name is included in any bell event sent to clients that have +requested to receive XkbBellNotify events. .TS @@ -157,52 +157,52 @@ StickyKeys key unlocked AX_StickyUnlock Audible Bells -Using Xkb you can generate bell events that do not necessarily ring the system -bell. This -is useful if you need to use an audio server instead of the system beep. For -example, -when an audio client starts, it could disable the audible bell (the system bell) -and then -listen for XkbBellNotify events. When it receives a XkbBellNotify event, the -audio client +Using Xkb you can generate bell events that do not necessarily ring the system +bell. This +is useful if you need to use an audio server instead of the system beep. For +example, +when an audio client starts, it could disable the audible bell (the system bell) +and then +listen for XkbBellNotify events. When it receives a XkbBellNotify event, the +audio client could then send a request to an audio server to play a sound. You can control the audible bells feature by passing the XkbAudibleBellMask to -.I XkbChangeEnabledControls. -If you set XkbAudibleBellMask on, the server rings the system bell when a bell -event -occurs. This is the default. If you set XkbAudibleBellMask off and a bell event -occurs, -the server does not ring the system bell unless you call -.I XkbForceDeviceBell -or +.I XkbChangeEnabledControls. +If you set XkbAudibleBellMask on, the server rings the system bell when a bell +event +occurs. This is the default. If you set XkbAudibleBellMask off and a bell event +occurs, +the server does not ring the system bell unless you call +.I XkbForceDeviceBell +or .I XkbForceBell. Audible bells are also part of the per-client auto-reset controls. Bell Functions -Use the functions described in this section to ring bells and to generate bell -events. +Use the functions described in this section to ring bells and to generate bell +events. -The input extension has two types of feedbacks that can generate bells - bell -feedback +The input extension has two types of feedbacks that can generate bells - bell +feedback and keyboard feedback. Some of the functions in this section have -.I bell_class -and -.I bell_id -parameters; set them as follows: Set -.I bell_class -to BellFeedbackClass or KbdFeedbackClass. A device can have more than one -feedback of -each type; set -.I bell_id -to the particular bell feedback of -.I bell_class +.I bell_class +and +.I bell_id +parameters; set them as follows: Set +.I bell_class +to BellFeedbackClass or KbdFeedbackClass. A device can have more than one +feedback of +each type; set +.I bell_id +to the particular bell feedback of +.I bell_class type. -Table 2 shows the conditions that cause a bell to sound or an -XkbBellNotifyEvent +Table 2 shows the conditions that cause a bell to sound or an +XkbBellNotifyEvent to be generated when a bell function is called. .TS @@ -211,7 +211,7 @@ l l l l l l l l. Table 2 Bell Sounding and Bell Event Generating _ -Function called AudibleBell Server sounds a bell Server sends an +Function called AudibleBell Server sounds a bell Server sends an XkbBellNotifyEvent _ XkbDeviceBell On Yes Yes @@ -224,65 +224,65 @@ XkbDeviceForceBell On or Off Yes No XkbForceBell On or Off Yes No .TE -If a compatible keyboard extension isn't present in the X server, -.I XkbBellEvent -immediately returns False. Otherwise, -.I XkbBellEvent -calls -.I XkbDeviceBellEvent -with the specified -.I display, window, percent, -and -.I name, -a -.I device_spec -of XkbUseCoreKbd, a -.I bell_class -of XkbDfltXIClass, and a -.I bell_id -of XkbDfltXIId, and returns what -.I XkbDeviceBellEvent +If a compatible keyboard extension isn't present in the X server, +.I XkbBellEvent +immediately returns False. Otherwise, +.I XkbBellEvent +calls +.I XkbDeviceBellEvent +with the specified +.I display, window, percent, +and +.I name, +a +.I device_spec +of XkbUseCoreKbd, a +.I bell_class +of XkbDfltXIClass, and a +.I bell_id +of XkbDfltXIId, and returns what +.I XkbDeviceBellEvent returns. -.I XkbBellEvent +.I XkbBellEvent generates a XkbBellNotify event. -You can call -.I XkbBellEvent +You can call +.I XkbBellEvent without first initializing the keyboard extension. .SH "RETURN VALUES" .TP 15 False -The +The .I XkbBellEvent -immediately returns False, if a compatible keyboard extension isn't present in +immediately returns False, if a compatible keyboard extension isn't present in the X server. .SH STRUCTURES -Xkb generates XkbBellNotify events for all bells except for those resulting from -calls to -.I XkbForceDeviceBell -and -.I XkbForceBell. -To receive XkbBellNotify events under all possible conditions, pass -XkbBellNotifyMask in -both the -.I bits_to_change -and -.I values_for_bits -parameters to +Xkb generates XkbBellNotify events for all bells except for those resulting from +calls to +.I XkbForceDeviceBell +and +.I XkbForceBell. +To receive XkbBellNotify events under all possible conditions, pass +XkbBellNotifyMask in +both the +.I bits_to_change +and +.I values_for_bits +parameters to .I XkbSelectEvents. -The XkbBellNotify event has no event details. It is either selected or it is -not. -However, you can call -.I XkbSelectEventDetails -using XkbBellNotify as the -.I event_type +The XkbBellNotify event has no event details. It is either selected or it is +not. +However, you can call +.I XkbSelectEventDetails +using XkbBellNotify as the +.I event_type and specifying XkbAllBellEventsMask in -.I bits_to_change -and -.I values_for_bits. -This has the same effect as a call to +.I bits_to_change +and +.I values_for_bits. +This has the same effect as a call to .I XkbSelectEvents. The structure for the XkbBellNotify event type contains: @@ -305,10 +305,10 @@ The structure for the XkbBellNotify event type contains: Window window; /\&* window associated with event */ Bool event_only; /\&* False -> the server did not produce a beep */ } XkbBellNotifyEvent; - -.fi -If your application needs to generate visual bell feedback on the screen when it -receives + +.fi +If your application needs to generate visual bell feedback on the screen when it +receives a bell event, use the window ID in the XkbBellNotifyEvent, if present. .SH "SEE ALSO" diff --git a/man/xkb/XkbChangeControls.man b/man/xkb/XkbChangeControls.man index 81f78e74..beb177f3 100644 --- a/man/xkb/XkbChangeControls.man +++ b/man/xkb/XkbChangeControls.man @@ -22,7 +22,7 @@ .\" .TH XkbChangeControls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbChangeControls \- Provides a flexible method for updating the controls in a +XkbChangeControls \- Provides a flexible method for updating the controls in a server to match those in the changed keyboard description .SH SYNOPSIS .HP @@ -43,41 +43,41 @@ keyboard description with changed xkb->ctrls .I changes which parts of xkb->ctrls have changed .SH DESCRIPTION -The XkbControlsChangesRec structure allows applications to track modifications -to an XkbControlsRec structure and thereby reduce the amount of traffic sent -to the server. The same XkbControlsChangesRec structure may be used in several -successive modifications to the same XkbControlsRec structure, then subsequently -used to cause all of the changes, and only the changes, to be propagated to the server. +The XkbControlsChangesRec structure allows applications to track modifications +to an XkbControlsRec structure and thereby reduce the amount of traffic sent +to the server. The same XkbControlsChangesRec structure may be used in several +successive modifications to the same XkbControlsRec structure, then subsequently +used to cause all of the changes, and only the changes, to be propagated to the server. -The -.I changed_ctrls -field is a mask specifying which logical sets of data in the controls structure -have been modified. In this context, modified means -.IR set , -that is, if a value is set to the same value it previously contained, it has -still been modified, and is noted as changed. Valid values for -.I changed_ctrls -are any combination of the masks listed in Table 1 that have "ok" in the -.I changed_ctrls -column. Setting a bit implies the corresponding data fields from the "Relevant -XkbControlsRec Data Fields" column in Table 1 have been modified. The -.I enabled_ctrls_changes -field specifies which bits in the -.I enabled_ctrls -field have changed. If the number of keyboard groups has changed, the -.I num_groups_changed +The +.I changed_ctrls +field is a mask specifying which logical sets of data in the controls structure +have been modified. In this context, modified means +.IR set , +that is, if a value is set to the same value it previously contained, it has +still been modified, and is noted as changed. Valid values for +.I changed_ctrls +are any combination of the masks listed in Table 1 that have "ok" in the +.I changed_ctrls +column. Setting a bit implies the corresponding data fields from the "Relevant +XkbControlsRec Data Fields" column in Table 1 have been modified. The +.I enabled_ctrls_changes +field specifies which bits in the +.I enabled_ctrls +field have changed. If the number of keyboard groups has changed, the +.I num_groups_changed field is set to True. -Table 1 shows the actual values for the individual mask bits used to select -controls for -modification and to enable and disable the control. Note that the same mask bit -is used to -specify general modifications to the parameters used to configure the control -(which), and to -enable and disable the control (enabled_ctrls). The anomalies in the table (no -"ok" in column) -are for controls that have no configurable attributes; and for controls that are -not boolean +Table 1 shows the actual values for the individual mask bits used to select +controls for +modification and to enable and disable the control. Note that the same mask bit +is used to +specify general modifications to the parameters used to configure the control +(which), and to +enable and disable the control (enabled_ctrls). The anomalies in the table (no +"ok" in column) +are for controls that have no configurable attributes; and for controls that are +not boolean controls and therefore cannot be enabled or disabled. .TS @@ -89,9 +89,9 @@ l l l l l lw(1.5i) lw(1.5i) l lw(1.5i) l. Table 1 Xkb Controls _ -Control Control - Selection Relevant - Mask (which XkbControlsRec Boolean Control +Control Control + Selection Relevant + Mask (which XkbControlsRec Boolean Control parameter) DataFields enabled_ctrls bit Section _ T{ @@ -241,19 +241,19 @@ Xkb\%Sticky\%Keys\%Mask T} 10.6.8 .TE -Table 2 shows the actual values for the individual mask bits used to select -controls for modification and to enable and disable the control. Note that +Table 2 shows the actual values for the individual mask bits used to select +controls for modification and to enable and disable the control. Note that the same mask bit is used to specify general modifications to the parameters - used to configure the control (which), and to enable and disable the control -(enabled_ctrls). The anomalies in the table (no "ok" in column) -are for controls that have no configurable attributes; and for controls that are + used to configure the control (which), and to enable and disable the control +(enabled_ctrls). The anomalies in the table (no "ok" in column) +are for controls that have no configurable attributes; and for controls that are not boolean controls and therefore cannot be enabled or disabled. .TS c s s s l l l l l l l l -l l l l. +l l l l. Table 2 Controls Mask Bits _ Mask Bit which or Value @@ -278,24 +278,24 @@ XkbInternalModsMask ok (1L<<28) XkbIgnoreLockModsMask ok (1L<<29) XkbPerKeyRepeatMask ok (1L<<30) XkbControlsEnabledMask ok (1L<<31) -XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | +XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | XkbAccessXFeedbackMask) -XkbAllBooleanCtrlsMask ok (0x00001FFF) +XkbAllBooleanCtrlsMask ok (0x00001FFF) XkbAllControlsMask ok (0xF8001FFF) .TE -If you have an Xkb description with controls that have been modified and an -XkbControlsChangesRec that describes the changes that have been made, the -.I XkbChangeControls -function provides a flexible method for updating the controls in a server to +If you have an Xkb description with controls that have been modified and an +XkbControlsChangesRec that describes the changes that have been made, the +.I XkbChangeControls +function provides a flexible method for updating the controls in a server to match those in the changed keyboard description. -.I XkbChangeControls -copies any controls fields specified by -.I changes -from the keyboard description controls structure, -.IR xkb->ctrls , -to the server specified by +.I XkbChangeControls +copies any controls fields specified by +.I changes +from the keyboard description controls structure, +.IR xkb->ctrls , +to the server specified by .IR dpy . .SH STRUCTURES The XkbControlsChangesRec structure is defined as follows: diff --git a/man/xkb/XkbChangeDeviceInfo.man b/man/xkb/XkbChangeDeviceInfo.man index b97e6594..3d1f63d0 100644 --- a/man/xkb/XkbChangeDeviceInfo.man +++ b/man/xkb/XkbChangeDeviceInfo.man @@ -22,7 +22,7 @@ .\" .TH XkbChangeDeviceInfo __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbChangeDeviceInfo \- Update the server's description of a device with the changes noted in an +XkbChangeDeviceInfo \- Update the server's description of a device with the changes noted in an XkbDeviceChangesRec .SH SYNOPSIS .HP @@ -44,21 +44,21 @@ local copy of device state and configuration note specifying changes in device_info .SH DESCRIPTION .LP -.I XkbChangeDeviceInfo -updates the server's description of the device specified in -.I device_info->device_spec -with the changes specified in -.I changes -and contained in -.I device_info. -The update is made by an -.I XkbSetDeviceInfo +.I XkbChangeDeviceInfo +updates the server's description of the device specified in +.I device_info->device_spec +with the changes specified in +.I changes +and contained in +.I device_info. +The update is made by an +.I XkbSetDeviceInfo request. .SH STRUCTURES .LP -Changes to an Xkb extension device may be tracked by listening to XkbDeviceExtensionNotify events -and accumulating the changes in an XkbDeviceChangesRec structure. The changes noted in the -structure may then be used in subsequent operations to update either a server configuration or a +Changes to an Xkb extension device may be tracked by listening to XkbDeviceExtensionNotify events +and accumulating the changes in an XkbDeviceChangesRec structure. The changes noted in the +structure may then be used in subsequent operations to update either a server configuration or a local copy of an Xkb extension device configuration. The changes structure is defined as follows: .nf diff --git a/man/xkb/XkbChangeEnabledControls.man b/man/xkb/XkbChangeEnabledControls.man index 79755284..4b923109 100644 --- a/man/xkb/XkbChangeEnabledControls.man +++ b/man/xkb/XkbChangeEnabledControls.man @@ -44,27 +44,27 @@ keyboard device to modify 1 bit -> controls to enable / disable .TP .I values -1 bit => enable, 0 bit => disable +1 bit => enable, 0 bit => disable .SH DESCRIPTION .LP -The EnabledControls control is a bit mask where each bit that is turned on means the -corresponding control is enabled, and when turned off, disabled. It corresponds to the -.I enabled_ctrls -field of an XkbControlsRec structure (see STRUCTURES). The bits describing which controls are +The EnabledControls control is a bit mask where each bit that is turned on means the +corresponding control is enabled, and when turned off, disabled. It corresponds to the +.I enabled_ctrls +field of an XkbControlsRec structure (see STRUCTURES). The bits describing which controls are turned on or off are defined in Table 1. -Table 1 shows the actual values for the individual mask bits used to select controls for -modification and to enable and disable the control. Note that the same mask bit is used to -specify general modifications to the parameters used to configure the control (which), and to -enable and disable the control (enabled_ctrls). The anomalies in the table (no "ok" in column) -are for controls that have no configurable attributes; and for controls that are not boolean +Table 1 shows the actual values for the individual mask bits used to select controls for +modification and to enable and disable the control. Note that the same mask bit is used to +specify general modifications to the parameters used to configure the control (which), and to +enable and disable the control (enabled_ctrls). The anomalies in the table (no "ok" in column) +are for controls that have no configurable attributes; and for controls that are not boolean controls and therefore cannot be enabled or disabled. .bp .TS c s s s l l l l l l l l -l l l l. +l l l l. Table 1 Controls Mask Bits _ Mask Bit which or enabled Value @@ -88,38 +88,38 @@ XkbInternalModsMask ok (1L<<28) XkbIgnoreLockModsMask ok (1L<<29) XkbPerKeyRepeatMask ok (1L<<30) XkbControlsEnabledMask ok (1L<<31) -XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | +XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | XkbAccessXFeedbackMask) -XkbAllBooleanCtrlsMask ok (0x00001FFF) +XkbAllBooleanCtrlsMask ok (0x00001FFF) XkbAllControlsMask ok (0xF8001FFF) .TE -The -.I mask -parameter specifies the boolean controls to be enabled or disabled, and the -.I values -mask specifies the new state for those controls. Valid values for both of these -masks are composed of a bitwise inclusive OR of bits taken from the set of mask -bits in Table 1, using only those masks with "ok" in the -.I enabled_ctrls +The +.I mask +parameter specifies the boolean controls to be enabled or disabled, and the +.I values +mask specifies the new state for those controls. Valid values for both of these +masks are composed of a bitwise inclusive OR of bits taken from the set of mask +bits in Table 1, using only those masks with "ok" in the +.I enabled_ctrls column. -If the X server does not support a compatible version of Xkb or the Xkb -extension has not been properly initialized, -.I XkbChangeEnabledControls +If the X server does not support a compatible version of Xkb or the Xkb +extension has not been properly initialized, +.I XkbChangeEnabledControls returns False; otherwise, it sends the request to the X server and returns True. -Note that the EnabledControls control only enables and disables controls; it -does not configure them. Some controls, such as the AudibleBell control, have no -configuration attributes and are therefore manipulated solely by enabling and -disabling them. Others, however, have additional attributes to configure their -behavior. For example, the RepeatControl control uses -.I repeat_delay -and -.I repeat_interval -fields to describe the timing behavior of keys that repeat. The RepeatControl -behavior is turned on or off depending on the value of the XkbRepeatKeysMask -bit, but you must use other means, as described in this chapter, to configure +Note that the EnabledControls control only enables and disables controls; it +does not configure them. Some controls, such as the AudibleBell control, have no +configuration attributes and are therefore manipulated solely by enabling and +disabling them. Others, however, have additional attributes to configure their +behavior. For example, the RepeatControl control uses +.I repeat_delay +and +.I repeat_interval +fields to describe the timing behavior of keys that repeat. The RepeatControl +behavior is turned on or off depending on the value of the XkbRepeatKeysMask +bit, but you must use other means, as described in this chapter, to configure its behavior in detail. .SH "RETURN VALUES" .TP 15 @@ -135,8 +135,8 @@ 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 */ diff --git a/man/xkb/XkbChangeMap.man b/man/xkb/XkbChangeMap.man index 7849c3cd..33f598e4 100644 --- a/man/xkb/XkbChangeMap.man +++ b/man/xkb/XkbChangeMap.man @@ -22,8 +22,8 @@ .\" .TH XkbChangeMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbChangeMap \- Update only partial components of a keyboard description, modify -the appropriate fields in the server and map components of a local copy of the +XkbChangeMap \- Update only partial components of a keyboard description, modify +the appropriate fields in the server and map components of a local copy of the keyboard description .SH SYNOPSIS .HP @@ -45,49 +45,49 @@ description from which new values are taken identifies component parts to update .SH DESCRIPTION .LP -To update only partial components of a keyboard description, modify the -appropriate fields in the server and map components of a local copy of the -keyboard description, then call -.I XkbChangeMap +To update only partial components of a keyboard description, modify the +appropriate fields in the server and map components of a local copy of the +keyboard description, then call +.I XkbChangeMap with an XkbMapChangesRec structure indicating which components have changed. -.I XkbChangeMap -copies any components specified by the -.I changes -structure from the keyboard description, -.I xkb, -to the X server specified by +.I XkbChangeMap +copies any components specified by the +.I changes +structure from the keyboard description, +.I xkb, +to the X server specified by .I dpy. -If any components specified by -.I changes -are not present in the -.I xkb -parameter, -.I XkbChangeMap -returns False. Otherwise, it sends a request to the server and returns True. +If any components specified by +.I changes +are not present in the +.I xkb +parameter, +.I XkbChangeMap +returns False. Otherwise, it sends a request to the server and returns True. -.I XkbChangeMap -can generate BadAlloc, BadLength, and BadValue protocol errors. +.I XkbChangeMap +can generate BadAlloc, BadLength, and BadValue protocol errors. .SH "RETURN VALUES" .TP 15 True -The XkbChangeMap function returns True if the components specified by -.I changes -are present in the -.I xkb +The XkbChangeMap function returns True if the components specified by +.I changes +are present in the +.I xkb parameter. .TP 15 False -The XkbChangeMap function returns False if the components specified by -.I changes -are not present in the -.I xkb +The XkbChangeMap function returns False if the components specified by +.I changes +are not present in the +.I xkb parameter. .SH STRUCTURES .LP -Use the XkbMapChangesRec structure to identify and track partial modifications -to the mapping components and to reduce the amount of traffic between the server +Use the XkbMapChangesRec structure to identify and track partial modifications +to the mapping components and to reduce the amount of traffic between the server and clients. .nf @@ -120,7 +120,7 @@ typedef struct _XkbMapChanges { Unable to allocate storage .TP 15 .B BadLength -The length of a request is shorter or longer than that required to minimally +The length of a request is shorter or longer than that required to minimally contain the arguments .TP 15 .B BadValue diff --git a/man/xkb/XkbChangeNames.man b/man/xkb/XkbChangeNames.man index d3064aa9..aad20ad6 100644 --- a/man/xkb/XkbChangeNames.man +++ b/man/xkb/XkbChangeNames.man @@ -43,36 +43,36 @@ mask of names or map components to be updated keyboard description to be updated .SH DESCRIPTION .LP -.I XkbChangeNames -provides a more flexible method for changing symbolic names than -.I XkbSetNames -and requires the use of an XkbNameChangesRec structure. +.I XkbChangeNames +provides a more flexible method for changing symbolic names than +.I XkbSetNames +and requires the use of an XkbNameChangesRec structure. -.I XkbChangeNames -copies any names specified by -.I changes -from the keyboard description, -.I xkb, -to the X server specified by -.I dpy. XkbChangeNames -aborts and returns False if any illegal type names or type shift level names are +.I XkbChangeNames +copies any names specified by +.I changes +from the keyboard description, +.I xkb, +to the X server specified by +.I dpy. XkbChangeNames +aborts and returns False if any illegal type names or type shift level names are specified by changes. -To change the symbolic names in the server, first modify a local copy of the -keyboard description and then use either -.I XkbSetNames, +To change the symbolic names in the server, first modify a local copy of the +keyboard description and then use either +.I XkbSetNames, or, to save network traffic, use a XkbNameChangesRec structure and call -.I XkbChangeNames -to download the changes to the server. -.I XkbSetNames -and -.I XkbChangeNames -can generate BadAlloc, BadAtom, BadLength, BadMatch, and BadImplementation +.I XkbChangeNames +to download the changes to the server. +.I XkbSetNames +and +.I XkbChangeNames +can generate BadAlloc, BadAtom, BadLength, BadMatch, and BadImplementation errors. .SH STRUCTURES .LP -The XkbNameChangesRec allows applications to identify small modifications to the -symbolic names and +The XkbNameChangesRec allows applications to identify small modifications to the +symbolic names and effectively reduces the amount of traffic sent to the server: .nf @@ -90,20 +90,20 @@ effectively reduces the amount of traffic sent to the server: unsigned long changed_indicators; /\&* mask of indicators for which names were changed */ unsigned char changed_groups; /\&* mask of groups for which names were changed */ } XkbNameChangesRec, *XkbNameChangesPtr - -.fi -The -.I changed -field specifies the name components that have changed and is the bitwise -inclusive OR of the valid names -mask bits defined in Table 1. The rest of the fields in the structure specify -the ranges that have changed + +.fi +The +.I changed +field specifies the name components that have changed and is the bitwise +inclusive OR of the valid names +mask bits defined in Table 1. The rest of the fields in the structure specify +the ranges that have changed for the various kinds of symbolic names, as shown in Table 2. -Xkb provides several functions that work with symbolic names. Each of these -functions uses a mask to -specify individual fields of the structures described above. These masks and -their relationships to the +Xkb provides several functions that work with symbolic names. Each of these +functions uses a mask to +specify individual fields of the structures described above. These masks and +their relationships to the fields in a keyboard description are shown in Table 1. .TS @@ -168,11 +168,11 @@ A name is neither a valid Atom or None Invalid reply from server .TP 15 .B BadLength -The length of a request is shorter or longer than that required to minimally +The length of a request is shorter or longer than that required to minimally contain the arguments .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +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 XkbSetNames (__libmansuffix__) diff --git a/man/xkb/XkbChangeTypesOfKey.man b/man/xkb/XkbChangeTypesOfKey.man index f6d32e02..e6165aea 100644 --- a/man/xkb/XkbChangeTypesOfKey.man +++ b/man/xkb/XkbChangeTypesOfKey.man @@ -22,7 +22,7 @@ .\" .TH XkbChangeTypesOfKey __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbChangeTypesOfKey \- Change the number of groups and the types bound to a key +XkbChangeTypesOfKey \- Change the number of groups and the types bound to a key .SH SYNOPSIS .HP .B Status XkbChangeTypesOfKey @@ -55,52 +55,52 @@ indices for new groups specified in groups notes changes made to xkb .SH DESCRIPTION .LP -.I XkbChangeTypesOfKey -reallocates the symbols and actions bound to the key, if necessary, and -initializes any new symbols -or actions to NoSymbol or NoAction, as appropriate. If the p_changes parameter -is not NULL, -.I XkbChangeTypesOfKey -adds the XkbKeySymsMask to the changes field of -.I p_changes -and modifies the -.I first_key_sym -and -.I num_key_syms -fields of -.I p_changes -to include the -.I key -that was changed. See STRUCTURE for more information on the XkbMapChangesPtr -structure. If -successful, -.I XkbChangeTypesOfKey +.I XkbChangeTypesOfKey +reallocates the symbols and actions bound to the key, if necessary, and +initializes any new symbols +or actions to NoSymbol or NoAction, as appropriate. If the p_changes parameter +is not NULL, +.I XkbChangeTypesOfKey +adds the XkbKeySymsMask to the changes field of +.I p_changes +and modifies the +.I first_key_sym +and +.I num_key_syms +fields of +.I p_changes +to include the +.I key +that was changed. See STRUCTURE for more information on the XkbMapChangesPtr +structure. If +successful, +.I XkbChangeTypesOfKey returns Success. -The -.I n_groups -parameter specifies the new number of groups for the key. The -.I groups -parameter is a mask specifying the groups for which new types are supplied and -is a bitwise -inclusive OR of the following masks: XkbGroup1Mask, XkbGroup2Mask, +The +.I n_groups +parameter specifies the new number of groups for the key. The +.I groups +parameter is a mask specifying the groups for which new types are supplied and +is a bitwise +inclusive OR of the following masks: XkbGroup1Mask, XkbGroup2Mask, XkbGroup3Mask, and XkbGroup4Mask. -The -.I new_types_in -parameter is an integer array of length -.I n_groups. -Each entry represents the type to use for the associated group and is an index -into -.I xkb->map->types. -The -.I new_types_in -array is indexed by group index; if -.I n_groups -is four and -.I groups -only has Group1Mask and Group3Mask set, -.I new_types_in +The +.I new_types_in +parameter is an integer array of length +.I n_groups. +Each entry represents the type to use for the associated group and is an index +into +.I xkb->map->types. +The +.I new_types_in +array is indexed by group index; if +.I n_groups +is four and +.I groups +only has Group1Mask and Group3Mask set, +.I new_types_in looks like this: .nf @@ -108,9 +108,9 @@ looks like this: new_types_in[1] = ignored new_types_in[2] = type for Group3 new_types_in[3] = ignored - -.fi -For convenience, Xkb provides the following constants to use as indices to the + +.fi +For convenience, Xkb provides the following constants to use as indices to the groups: .TS @@ -127,30 +127,30 @@ XkbGroup3Index 2 XkbGroup4Index 3 .TE -If the Xkb extension has not been properly initialized, -.I XkbChangeTypesOfKey -returns BadAccess. If the -.I xkb -parameter it not valid (that is, it is NULL or it does not contain a valid -client map), -.I XkbChangeTypesOfKey -returns BadMatch. If the -.I key -is not a valid keycode, -.I n_groups -is greater than XkbNumKbdGroups, or the -.I groups -mask does not contain any of the valid group mask bits, -.I XkbChangeTypesOfKey -returns BadValue. If it is necessary to resize the key symbols or key actions -arrays and any -allocation errors occur, -.I XkbChangeTypesOfKey +If the Xkb extension has not been properly initialized, +.I XkbChangeTypesOfKey +returns BadAccess. If the +.I xkb +parameter it not valid (that is, it is NULL or it does not contain a valid +client map), +.I XkbChangeTypesOfKey +returns BadMatch. If the +.I key +is not a valid keycode, +.I n_groups +is greater than XkbNumKbdGroups, or the +.I groups +mask does not contain any of the valid group mask bits, +.I XkbChangeTypesOfKey +returns BadValue. If it is necessary to resize the key symbols or key actions +arrays and any +allocation errors occur, +.I XkbChangeTypesOfKey returns BadAlloc. .SH STRUCTURES .LP -Use the XkbMapChangesRec structure to identify and track partial modifications -to the mapping +Use the XkbMapChangesRec structure to identify and track partial modifications +to the mapping components and to reduce the amount of traffic between the server and clients. .nf @@ -186,8 +186,8 @@ The Xkb extension has not been properly initialized Unable to allocate storage .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has -correct type and +A compatible version of Xkb was not available in the server or an argument has +correct type and range, but is otherwise invalid .TP 15 .B BadValue diff --git a/man/xkb/XkbComputeRowBounds.man b/man/xkb/XkbComputeRowBounds.man index 2d75c6e9..20e57c9f 100644 --- a/man/xkb/XkbComputeRowBounds.man +++ b/man/xkb/XkbComputeRowBounds.man @@ -42,9 +42,9 @@ section that contains the row row to be examined and updated .SH DESCRIPTION .LP -.I XkbComputeRowBounds -checks the bounds of all keys in the -.I row -and updates the bounding box of the row if necessary. -.I XkbComputeRowBounds +.I XkbComputeRowBounds +checks the bounds of all keys in the +.I row +and updates the bounding box of the row if necessary. +.I XkbComputeRowBounds returns False if any of the arguments is NULL; otherwise, it returns True. diff --git a/man/xkb/XkbComputeSectionBounds.man b/man/xkb/XkbComputeSectionBounds.man index ce718846..5eb0fc0a 100644 --- a/man/xkb/XkbComputeSectionBounds.man +++ b/man/xkb/XkbComputeSectionBounds.man @@ -38,13 +38,13 @@ geometry that contains the section section to be examined and updated .SH DESCRIPTION .LP - If you add or delete a row to or from a section, or if you change the geometry -of any of the rows in that section, you may need to update the bounding box for -that section. - -.I XkbComputeSectionBounds -examines all the rows of the -.I section + If you add or delete a row to or from a section, or if you change the geometry +of any of the rows in that section, you may need to update the bounding box for +that section. + +.I XkbComputeSectionBounds +examines all the rows of the +.I section and updates the bounding box of that section so that it contains all rows. -.I XkbComputeSectionBounds +.I XkbComputeSectionBounds returns False if any of the arguments is NULL; otherwise, it returns True. diff --git a/man/xkb/XkbComputeShapeBounds.man b/man/xkb/XkbComputeShapeBounds.man index 75ac7af0..c9eb1c8d 100644 --- a/man/xkb/XkbComputeShapeBounds.man +++ b/man/xkb/XkbComputeShapeBounds.man @@ -34,28 +34,28 @@ XkbComputeShapeBounds \- Updates the bounding box of a shape shape to be examined .SH DESCRIPTION .LP -Xkb provides a number of convenience functions to help use a keyboard geometry. These include -functions to return the bounding box of a shape's top surface and to update the bounding box +Xkb provides a number of convenience functions to help use a keyboard geometry. These include +functions to return the bounding box of a shape's top surface and to update the bounding box of a shape row or section. -A shape is made up of a number of outlines. Each outline is a polygon made up of a number of -points. The bounding box of a shape is a rectangle that contains all the outlines of that -shape. +A shape is made up of a number of outlines. Each outline is a polygon made up of a number of +points. The bounding box of a shape is a rectangle that contains all the outlines of that +shape. -A ShapeRec contains a BoundsRec that describes the bounds of the shape. If you add or delete +A ShapeRec contains a BoundsRec that describes the bounds of the shape. If you add or delete an outline to or from a shape, the bounding box must be updated. -.I XkbComputeShapeBounds -updates the BoundsRec contained in the -.I shape -by examining all the outlines of the shape and setting the BoundsRec to the minimum x and -minimum y, and maximum x and maximum y values found in those outlines. -.I XkbComputeShapeBounds -returns False if -.I shape +.I XkbComputeShapeBounds +updates the BoundsRec contained in the +.I shape +by examining all the outlines of the shape and setting the BoundsRec to the minimum x and +minimum y, and maximum x and maximum y values found in those outlines. +.I XkbComputeShapeBounds +returns False if +.I shape is NULL or if there are no outlines for the shape; otherwise, it returns True. -If you add or delete a key to or from a row, or if you update the shape of one of the keys in that row, you may need to update the bounding box of that row. To update the bounding box of a row, use +If you add or delete a key to or from a row, or if you update the shape of one of the keys in that row, you may need to update the bounding box of that row. To update the bounding box of a row, use .I XkbComputeRowBounds. .SH STRUCTURES .LP diff --git a/man/xkb/XkbComputeShapeTop.man b/man/xkb/XkbComputeShapeTop.man index 8454d5e8..6100feb4 100644 --- a/man/xkb/XkbComputeShapeTop.man +++ b/man/xkb/XkbComputeShapeTop.man @@ -38,30 +38,30 @@ shape to be examined backfilled with the bounding box for the shape .SH DESCRIPTION .LP -Xkb provides a number of convenience functions to help use a keyboard geometry. -These include functions to return the bounding box of a shape's top surface and +Xkb provides a number of convenience functions to help use a keyboard geometry. +These include functions to return the bounding box of a shape's top surface and to update the bounding box of a shape row or section. -A shape is made up of a number of outlines. Each outline is a polygon made up of -a number of points. The bounding box of a shape is a rectangle that contains all -the outlines of that shape. +A shape is made up of a number of outlines. Each outline is a polygon made up of +a number of points. The bounding box of a shape is a rectangle that contains all +the outlines of that shape. -.I XkbComputeShapeTop +.I XkbComputeShapeTop returns a BoundsRec that contains two x and y coordinates. These coordinates -describe the corners of a rectangle that contains the outline that describes the -top surface of the shape. The top surface is defined to be the approximating -outline if the -.I approx -field of -.I shape -is not NULL. If -.I approx -is NULL, the top surface is defined as the last outline in the -.I shape's -array of outlines. -.I XkbComputeShapeTop -returns False if -.I shape +describe the corners of a rectangle that contains the outline that describes the +top surface of the shape. The top surface is defined to be the approximating +outline if the +.I approx +field of +.I shape +is not NULL. If +.I approx +is NULL, the top surface is defined as the last outline in the +.I shape's +array of outlines. +.I XkbComputeShapeTop +returns False if +.I shape is NULL or if there are no outlines for the shape; otherwise, it returns True. .SH STRUCTURES .LP diff --git a/man/xkb/XkbCopyKeyType.man b/man/xkb/XkbCopyKeyType.man index 88aa0d61..496bf4ea 100644 --- a/man/xkb/XkbCopyKeyType.man +++ b/man/xkb/XkbCopyKeyType.man @@ -38,43 +38,43 @@ pointer to XkbKeyTypeRec to be copied pointer to XkbKeyTypeRec to be changed .SH DESCRIPTION .LP -.I XkbCopyKeyType -copies the key type specified by -.I from -to the key type specified by -.I into. -Both must point to legal XkbKeyTypeRec structures. Xkb assumes -.I from -and -.I into -point to different places. As a result, overlaps can be fatal. -.I XkbCopyKeyType -frees any existing -.I map, preserve, -and -.I level_names -in -.I into -prior to copying. If any allocation errors occur while copying -.I from -to -.I into, XkbCopyKeyType -returns BadAlloc. Otherwise, -.I XkbCopyKeyType -copies -.I from -to -.I into -and returns Success. +.I XkbCopyKeyType +copies the key type specified by +.I from +to the key type specified by +.I into. +Both must point to legal XkbKeyTypeRec structures. Xkb assumes +.I from +and +.I into +point to different places. As a result, overlaps can be fatal. +.I XkbCopyKeyType +frees any existing +.I map, preserve, +and +.I level_names +in +.I into +prior to copying. If any allocation errors occur while copying +.I from +to +.I into, XkbCopyKeyType +returns BadAlloc. Otherwise, +.I XkbCopyKeyType +copies +.I from +to +.I into +and returns Success. .SH STRUCTURES .LP -Key types are used to determine the shift level of a key given the current state of the +Key types are used to determine the shift level of a key given the current state of the keyboard. The set of all possible key types for the Xkb keyboard description are held in the -.I types -field of the client map, whose total size is stored in -.I size_types, -and whose total number of valid entries is stored in -.I num_types. +.I types +field of the client map, whose total size is stored in +.I size_types, +and whose total number of valid entries is stored in +.I num_types. Key types are defined using the following structure: .nf diff --git a/man/xkb/XkbCopyKeyTypes.man b/man/xkb/XkbCopyKeyTypes.man index 975f1a28..11a3fa95 100644 --- a/man/xkb/XkbCopyKeyTypes.man +++ b/man/xkb/XkbCopyKeyTypes.man @@ -42,55 +42,55 @@ pointer to array of XkbKeyTypeRecs to change number of types to copy .SH DESCRIPTION .LP -.I XkbCopyKeyTypes -copies -.I num_types -XkbKeyTypeRec structures from the array specified by -.I from -into the array specified by -.I into. -It is intended for copying between, rather than within, keyboard descriptions, -so it -doesn't check for overlaps. The same rules that apply to the -.I from -and -.I into -parameters in -.I XkbCopyKeyType -apply to each entry of the -.I from -and -.I into -arrays of -.I XkbCopyKeyTypes. -If any allocation errors occur while copying -.I from -to -.I into, XkbCopyKeyTypes -returns BadAlloc. Otherwise, -.I XkbCopyKeyTypes -copies -.I from -to -.I into +.I XkbCopyKeyTypes +copies +.I num_types +XkbKeyTypeRec structures from the array specified by +.I from +into the array specified by +.I into. +It is intended for copying between, rather than within, keyboard descriptions, +so it +doesn't check for overlaps. The same rules that apply to the +.I from +and +.I into +parameters in +.I XkbCopyKeyType +apply to each entry of the +.I from +and +.I into +arrays of +.I XkbCopyKeyTypes. +If any allocation errors occur while copying +.I from +to +.I into, XkbCopyKeyTypes +returns BadAlloc. Otherwise, +.I XkbCopyKeyTypes +copies +.I from +to +.I into and returns Success. .SH "RETURN VALUES" .TP 15 Success -The XkbCopyKeyTypes function returns Success when there are no allocation +The XkbCopyKeyTypes function returns Success when there are no allocation errors. .SH STRUCTURES .LP -Key types are used to determine the shift level of a key given the current state -of the -keyboard. The set of all possible key types for the Xkb keyboard description are -held in +Key types are used to determine the shift level of a key given the current state +of the +keyboard. The set of all possible key types for the Xkb keyboard description are +held in the -.I types -field of the client map, whose total size is stored in -.I size_types, -and whose total number of valid entries is stored in -.I num_types. +.I types +field of the client map, whose total size is stored in +.I size_types, +and whose total number of valid entries is stored in +.I num_types. Key types are defined using the following structure: .nf diff --git a/man/xkb/XkbDeviceBell.man b/man/xkb/XkbDeviceBell.man index 407643c0..fce32132 100644 --- a/man/xkb/XkbDeviceBell.man +++ b/man/xkb/XkbDeviceBell.man @@ -59,14 +59,14 @@ bell volume, from -100 to 100 inclusive a name for the bell, or NULL .SH DESCRIPTION .LP -The core X protocol allows only applications to explicitly sound the system bell with a -given duration, pitch, and volume. Xkb extends this capability by allowing clients to -attach symbolic names to bells, disable audible bells, and receive an event whenever the -keyboard bell is rung. For the purposes of this document, the -.I audible -bell is defined to be the system bell, or the default keyboard bell, as opposed to any -other audible sound generated elsewhere in the system. -You can ask to receive XkbBellNotify events when any client rings any one of the +The core X protocol allows only applications to explicitly sound the system bell with a +given duration, pitch, and volume. Xkb extends this capability by allowing clients to +attach symbolic names to bells, disable audible bells, and receive an event whenever the +keyboard bell is rung. For the purposes of this document, the +.I audible +bell is defined to be the system bell, or the default keyboard bell, as opposed to any +other audible sound generated elsewhere in the system. +You can ask to receive XkbBellNotify events when any client rings any one of the following: .IP \(bu 5 @@ -74,44 +74,44 @@ The default bell .IP \(bu 5 Any bell on an input device that can be specified by a bell_class and bell_id pair .IP \(bu 5 -Any bell specified only by an arbitrary name. (This is, from the server's point of view, -merely a name, and not connected with any physical sound-generating device. Some client -application must generate the sound, or visual feedback, if any, that is associated with +Any bell specified only by an arbitrary name. (This is, from the server's point of view, +merely a name, and not connected with any physical sound-generating device. Some client +application must generate the sound, or visual feedback, if any, that is associated with the name.) -You can also ask to receive XkbBellNotify events when the server rings the default bell -or if any client has requested events only (without the bell sounding) for any of the +You can also ask to receive XkbBellNotify events when the server rings the default bell +or if any client has requested events only (without the bell sounding) for any of the bell types previously listed. -You can disable audible bells on a global basis. For example, a client that replaces the -keyboard bell with some other audible cue might want to turn off the AudibleBell control -to prevent the server from also generating a sound and avoid cacophony. If you disable -audible bells and request to receive XkbBellNotify events, you can generate feedback +You can disable audible bells on a global basis. For example, a client that replaces the +keyboard bell with some other audible cue might want to turn off the AudibleBell control +to prevent the server from also generating a sound and avoid cacophony. If you disable +audible bells and request to receive XkbBellNotify events, you can generate feedback different from the default bell. -You can, however, override the AudibleBell control by calling one of the functions that -force the ringing of a bell in spite of the setting of the AudibleBell control - -.I XkbForceDeviceBell -or -.I XkbForceBell. +You can, however, override the AudibleBell control by calling one of the functions that +force the ringing of a bell in spite of the setting of the AudibleBell control - +.I XkbForceDeviceBell +or +.I XkbForceBell. In this case the server does not generate a bell event. -Just as some keyboards can produce keyclicks to indicate when a key is pressed or -repeating, Xkb can provide feedback for the controls by using special beep codes. The -AccessXFeedback control is used to configure the specific types of operations that +Just as some keyboards can produce keyclicks to indicate when a key is pressed or +repeating, Xkb can provide feedback for the controls by using special beep codes. The +AccessXFeedback control is used to configure the specific types of operations that generate feedback. Bell Names -You can associate a name to an act of ringing a bell by converting the name to an Atom -and then using this name when you call the functions listed in this chapter. If an event -is generated as a result, the name is then passed to all other clients interested in -receiving XkbBellNotify events. Note that these are arbitrary names and that there is no -binding to any sounds. Any sounds or other effects (such as visual bells on the screen) -must be generated by a client application upon receipt of the bell event containing the -name. There is no default name for the default keyboard bell. The server does generate +You can associate a name to an act of ringing a bell by converting the name to an Atom +and then using this name when you call the functions listed in this chapter. If an event +is generated as a result, the name is then passed to all other clients interested in +receiving XkbBellNotify events. Note that these are arbitrary names and that there is no +binding to any sounds. Any sounds or other effects (such as visual bells on the screen) +must be generated by a client application upon receipt of the bell event containing the +name. There is no default name for the default keyboard bell. The server does generate some predefined bells for the AccessX controls. These named bells are shown in the Table 1 -; the name is included in any bell event sent to clients that have requested to +; the name is included in any bell event sent to clients that have requested to receive XkbBellNotify events. .TS @@ -143,42 +143,42 @@ StickyKeys key unlocked AX_StickyUnlock Audible Bells -Using Xkb you can generate bell events that do not necessarily ring the system bell. This -is useful if you need to use an audio server instead of the system beep. For example, -when an audio client starts, it could disable the audible bell (the system bell) and then -listen for XkbBellNotify events. When it receives a XkbBellNotify event, the audio client +Using Xkb you can generate bell events that do not necessarily ring the system bell. This +is useful if you need to use an audio server instead of the system beep. For example, +when an audio client starts, it could disable the audible bell (the system bell) and then +listen for XkbBellNotify events. When it receives a XkbBellNotify event, the audio client could then send a request to an audio server to play a sound. You can control the audible bells feature by passing the XkbAudibleBellMask to -.I XkbChangeEnabledControls. -If you set XkbAudibleBellMask on, the server rings the system bell when a bell event -occurs. This is the default. If you set XkbAudibleBellMask off and a bell event occurs, -the server does not ring the system bell unless you call -.I XkbForceDeviceBell -or +.I XkbChangeEnabledControls. +If you set XkbAudibleBellMask on, the server rings the system bell when a bell event +occurs. This is the default. If you set XkbAudibleBellMask off and a bell event occurs, +the server does not ring the system bell unless you call +.I XkbForceDeviceBell +or .I XkbForceBell. Audible bells are also part of the per-client auto-reset controls. Bell Functions -Use the functions described in this section to ring bells and to generate bell events. +Use the functions described in this section to ring bells and to generate bell events. -The input extension has two types of feedbacks that can generate bells - bell feedback +The input extension has two types of feedbacks that can generate bells - bell feedback and keyboard feedback. Some of the functions in this section have -.I bell_class -and -.I bell_id -parameters; set them as follows: Set -.I bell_class -to BellFeedbackClass or KbdFeedbackClass. A device can have more than one feedback of -each type; set -.I bell_id -to the particular bell feedback of -.I bell_class +.I bell_class +and +.I bell_id +parameters; set them as follows: Set +.I bell_class +to BellFeedbackClass or KbdFeedbackClass. A device can have more than one feedback of +each type; set +.I bell_id +to the particular bell feedback of +.I bell_class type. -The Table 2 shows the conditions that cause a bell to sound or an XkbBellNotifyEvent +The Table 2 shows the conditions that cause a bell to sound or an XkbBellNotifyEvent to be generated when a bell function is called. .TS @@ -187,7 +187,7 @@ l l l l l l l l. Table 2 Bell Sounding and Bell Event Generating _ -Function called AudibleBell Server sounds a bell Server sends an +Function called AudibleBell Server sounds a bell Server sends an XkbBellNotifyEvent _ XkbDeviceBell On Yes Yes @@ -200,58 +200,58 @@ XkbDeviceForceBell On or Off Yes No XkbForceBell On or Off Yes No .TE -Set -.I percent +Set +.I percent to be the volume relative to the base volume for the keyboard as described for .I XBell. -Note that -.I bell_class -and -.I bell_id -indicate the bell to physically ring. -.I name +Note that +.I bell_class +and +.I bell_id +indicate the bell to physically ring. +.I name is simply an arbitrary moniker for the client application's use. -To determine the current feedback settings of an extension input device, use -.I XGetFeedbackControl. +To determine the current feedback settings of an extension input device, use +.I XGetFeedbackControl. See the X input extension documentation for more information on -.I XGetFeedbackControl +.I XGetFeedbackControl and related data structures. -If a compatible keyboard extension is not present in the X server, -.I XkbDeviceBell -immediately returns False. Otherwise, -.I XkbDeviceBell -rings the bell as specified for the display and keyboard device and returns True. If you have disabled the audible bell, the server does not ring the system bell, although it does generate a -.I XkbBellNotify +If a compatible keyboard extension is not present in the X server, +.I XkbDeviceBell +immediately returns False. Otherwise, +.I XkbDeviceBell +rings the bell as specified for the display and keyboard device and returns True. If you have disabled the audible bell, the server does not ring the system bell, although it does generate a +.I XkbBellNotify event. -You can call -.I XkbDeviceBell +You can call +.I XkbDeviceBell without first initializing the keyboard extension. .SH STRUCTURES -Xkb generates XkbBellNotify events for all bells except for those resulting from calls to -.I XkbForceDeviceBell -and -.I XkbForceBell. -To receive XkbBellNotify events under all possible conditions, pass XkbBellNotifyMask in -both the -.I bits_to_change -and -.I values_for_bits -parameters to +Xkb generates XkbBellNotify events for all bells except for those resulting from calls to +.I XkbForceDeviceBell +and +.I XkbForceBell. +To receive XkbBellNotify events under all possible conditions, pass XkbBellNotifyMask in +both the +.I bits_to_change +and +.I values_for_bits +parameters to .I XkbSelectEvents. -The XkbBellNotify event has no event details. It is either selected or it is not. -However, you can call -.I XkbSelectEventDetails -using XkbBellNotify as the -.I event_type +The XkbBellNotify event has no event details. It is either selected or it is not. +However, you can call +.I XkbSelectEventDetails +using XkbBellNotify as the +.I event_type and specifying XkbAllBellEventsMask in -.I bits_to_change -and -.I values_for_bits. -This has the same effect as a call to +.I bits_to_change +and +.I values_for_bits. +This has the same effect as a call to .I XkbSelectEvents. The structure for the XkbBellNotify event type contains: @@ -274,9 +274,9 @@ The structure for the XkbBellNotify event type contains: Window window; /\&* window associated with event */ Bool event_only; /\&* False -> the server did not produce a beep */ } XkbBellNotifyEvent; - -.fi -If your application needs to generate visual bell feedback on the screen when it receives + +.fi +If your application needs to generate visual bell feedback on the screen when it receives a bell event, use the window ID in the XkbBellNotifyEvent, if present. .SH "SEE ALSO" diff --git a/man/xkb/XkbDeviceBellEvent.man b/man/xkb/XkbDeviceBellEvent.man index 57387f05..40d16334 100644 --- a/man/xkb/XkbDeviceBellEvent.man +++ b/man/xkb/XkbDeviceBellEvent.man @@ -22,7 +22,7 @@ .\" .TH XkbDeviceBellEvent __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbDeviceBellEvent \- Creates a bell event for an X input extension device or +XkbDeviceBellEvent \- Creates a bell event for an X input extension device or for the keyboard, without ringing the corresponding bell .SH SYNOPSIS .HP @@ -48,10 +48,10 @@ event window, or None device ID, or XkbUseCoreKbd .TP .I bell_class -input extension bell class for the event +input extension bell class for the event .TP .I bell_id -input extension bell ID for the event +input extension bell ID for the event .TP .I percent volume for the bell, which can range from -100 to 100 inclusive @@ -60,17 +60,17 @@ volume for the bell, which can range from -100 to 100 inclusive a bell name, or NULL .SH DESCRIPTION .LP -The core X protocol allows only applications to explicitly sound the system bell with -a -given duration, pitch, and volume. Xkb extends this capability by allowing clients to -attach symbolic names to bells, disable audible bells, and receive an event whenever -the -keyboard bell is rung. For the purposes of this document, the -.I audible -bell is defined to be the system bell, or the default keyboard bell, as opposed to -any -other audible sound generated elsewhere in the system. -You can ask to receive XkbBellNotify events when any client rings any one of the +The core X protocol allows only applications to explicitly sound the system bell with +a +given duration, pitch, and volume. Xkb extends this capability by allowing clients to +attach symbolic names to bells, disable audible bells, and receive an event whenever +the +keyboard bell is rung. For the purposes of this document, the +.I audible +bell is defined to be the system bell, or the default keyboard bell, as opposed to +any +other audible sound generated elsewhere in the system. +You can ask to receive XkbBellNotify events when any client rings any one of the following: .IP \(bu 5 @@ -78,59 +78,59 @@ The default bell .IP \(bu 5 Any bell on an input device that can be specified by a bell_class and bell_id pair .IP \(bu 5 -Any bell specified only by an arbitrary name. (This is, from the server's point of -view, -merely a name, and not connected with any physical sound-generating device. Some -client -application must generate the sound, or visual feedback, if any, that is associated -with +Any bell specified only by an arbitrary name. (This is, from the server's point of +view, +merely a name, and not connected with any physical sound-generating device. Some +client +application must generate the sound, or visual feedback, if any, that is associated +with the name.) -You can also ask to receive XkbBellNotify events when the server rings the default -bell -or if any client has requested events only (without the bell sounding) for any of the +You can also ask to receive XkbBellNotify events when the server rings the default +bell +or if any client has requested events only (without the bell sounding) for any of the bell types previously listed. -You can disable audible bells on a global basis. For example, a client that replaces -the -keyboard bell with some other audible cue might want to turn off the AudibleBell -control -to prevent the server from also generating a sound and avoid cacophony. If you -disable -audible bells and request to receive XkbBellNotify events, you can generate feedback +You can disable audible bells on a global basis. For example, a client that replaces +the +keyboard bell with some other audible cue might want to turn off the AudibleBell +control +to prevent the server from also generating a sound and avoid cacophony. If you +disable +audible bells and request to receive XkbBellNotify events, you can generate feedback different from the default bell. -You can, however, override the AudibleBell control by calling one of the functions -that -force the ringing of a bell in spite of the setting of the AudibleBell control - -.I XkbForceDeviceBell -or -.I XkbForceBell. +You can, however, override the AudibleBell control by calling one of the functions +that +force the ringing of a bell in spite of the setting of the AudibleBell control - +.I XkbForceDeviceBell +or +.I XkbForceBell. In this case the server does not generate a bell event. -Just as some keyboards can produce keyclicks to indicate when a key is pressed or -repeating, Xkb can provide feedback for the controls by using special beep codes. The -AccessXFeedback control is used to configure the specific types of operations that +Just as some keyboards can produce keyclicks to indicate when a key is pressed or +repeating, Xkb can provide feedback for the controls by using special beep codes. The +AccessXFeedback control is used to configure the specific types of operations that generate feedback. Bell Names -You can associate a name to an act of ringing a bell by converting the name to an -Atom -and then using this name when you call the functions listed in this chapter. If an -event -is generated as a result, the name is then passed to all other clients interested in -receiving XkbBellNotify events. Note that these are arbitrary names and that there is -no -binding to any sounds. Any sounds or other effects (such as visual bells on the -screen) -must be generated by a client application upon receipt of the bell event containing -the -name. There is no default name for the default keyboard bell. The server does -generate -some predefined bells for the AccessX controls. These named bells are shown in the +You can associate a name to an act of ringing a bell by converting the name to an +Atom +and then using this name when you call the functions listed in this chapter. If an +event +is generated as a result, the name is then passed to all other clients interested in +receiving XkbBellNotify events. Note that these are arbitrary names and that there is +no +binding to any sounds. Any sounds or other effects (such as visual bells on the +screen) +must be generated by a client application upon receipt of the bell event containing +the +name. There is no default name for the default keyboard bell. The server does +generate +some predefined bells for the AccessX controls. These named bells are shown in the Table 1 -below; the name is included in any bell event sent to clients that have requested to +below; the name is included in any bell event sent to clients that have requested to receive XkbBellNotify events. .TS @@ -162,49 +162,49 @@ StickyKeys key unlocked AX_StickyUnlock Audible Bells -Using Xkb you can generate bell events that do not necessarily ring the system bell. -This -is useful if you need to use an audio server instead of the system beep. For example, -when an audio client starts, it could disable the audible bell (the system bell) and -then -listen for XkbBellNotify events. When it receives a XkbBellNotify event, the audio -client +Using Xkb you can generate bell events that do not necessarily ring the system bell. +This +is useful if you need to use an audio server instead of the system beep. For example, +when an audio client starts, it could disable the audible bell (the system bell) and +then +listen for XkbBellNotify events. When it receives a XkbBellNotify event, the audio +client could then send a request to an audio server to play a sound. You can control the audible bells feature by passing the XkbAudibleBellMask to -.I XkbChangeEnabledControls. -If you set XkbAudibleBellMask on, the server rings the system bell when a bell event -occurs. This is the default. If you set XkbAudibleBellMask off and a bell event -occurs, -the server does not ring the system bell unless you call -.I XkbForceDeviceBell -or +.I XkbChangeEnabledControls. +If you set XkbAudibleBellMask on, the server rings the system bell when a bell event +occurs. This is the default. If you set XkbAudibleBellMask off and a bell event +occurs, +the server does not ring the system bell unless you call +.I XkbForceDeviceBell +or .I XkbForceBell. Audible bells are also part of the per-client auto-reset controls. Bell Functions -Use the functions described in this section to ring bells and to generate bell -events. +Use the functions described in this section to ring bells and to generate bell +events. -The input extension has two types of feedbacks that can generate bells - bell -feedback +The input extension has two types of feedbacks that can generate bells - bell +feedback and keyboard feedback. Some of the functions in this section have -.I bell_class -and -.I bell_id -parameters; set them as follows: Set -.I bell_class -to BellFeedbackClass or KbdFeedbackClass. A device can have more than one feedback of -each type; set -.I bell_id -to the particular bell feedback of -.I bell_class +.I bell_class +and +.I bell_id +parameters; set them as follows: Set +.I bell_class +to BellFeedbackClass or KbdFeedbackClass. A device can have more than one feedback of +each type; set +.I bell_id +to the particular bell feedback of +.I bell_class type. -Table 2 shows the conditions that cause a bell to sound or an -XkbBellNotifyEvent +Table 2 shows the conditions that cause a bell to sound or an +XkbBellNotifyEvent to be generated when a bell function is called. .TS @@ -213,7 +213,7 @@ l l l l l l l l. Table 2 Bell Sounding and Bell Event Generating _ -Function called AudibleBell Server sounds a bell Server sends an +Function called AudibleBell Server sounds a bell Server sends an XkbBellNotifyEvent _ XkbDeviceBell On Yes Yes @@ -226,59 +226,59 @@ XkbDeviceForceBell On or Off Yes No XkbForceBell On or Off Yes No .TE -If a compatible keyboard extension isn't present in the X server, -.I XkbDeviceBellEvent -immediately returns False. Otherwise, -.I XkbDeviceBellEvent -causes an XkbBellNotify event to be sent to all interested clients and returns -True. Set -.I percent -to be the volume relative to the base volume for the keyboard as described for +If a compatible keyboard extension isn't present in the X server, +.I XkbDeviceBellEvent +immediately returns False. Otherwise, +.I XkbDeviceBellEvent +causes an XkbBellNotify event to be sent to all interested clients and returns +True. Set +.I percent +to be the volume relative to the base volume for the keyboard as described for .I XBell. -In addition, -.I XkbDeviceBellEvent -may generate Atom protocol errors as well as XkbBellNotify events. You can call -.I XkbBell +In addition, +.I XkbDeviceBellEvent +may generate Atom protocol errors as well as XkbBellNotify events. You can call +.I XkbBell without first initializing the keyboard extension. .SH "RETURN VALUES" .TP 15 True -The -.I XkbDeviceBellEvent -sends an XkbBellNotify event to to all interested clients and returns +The +.I XkbDeviceBellEvent +sends an XkbBellNotify event to to all interested clients and returns True. .TP 15 False -If a compatible keyboard extension isn't present in the X server, -.I XkbDeviceBellEvent +If a compatible keyboard extension isn't present in the X server, +.I XkbDeviceBellEvent immediately returns False .SH STRUCTURES .TP -Xkb generates XkbBellNotify events for all bells except for those resulting from -calls to -.I XkbForceDeviceBell -and -.I XkbForceBell. -To receive XkbBellNotify events under all possible conditions, pass XkbBellNotifyMask -in -both the -.I bits_to_change -and -.I values_for_bits -parameters to +Xkb generates XkbBellNotify events for all bells except for those resulting from +calls to +.I XkbForceDeviceBell +and +.I XkbForceBell. +To receive XkbBellNotify events under all possible conditions, pass XkbBellNotifyMask +in +both the +.I bits_to_change +and +.I values_for_bits +parameters to .I XkbSelectEvents. -The XkbBellNotify event has no event details. It is either selected or it is not. -However, you can call -.I XkbSelectEventDetails -using XkbBellNotify as the -.I event_type +The XkbBellNotify event has no event details. It is either selected or it is not. +However, you can call +.I XkbSelectEventDetails +using XkbBellNotify as the +.I event_type and specifying XkbAllBellEventsMask in -.I bits_to_change -and -.I values_for_bits. -This has the same effect as a call to +.I bits_to_change +and +.I values_for_bits. +This has the same effect as a call to .I XkbSelectEvents. The structure for the XkbBellNotify event type contains: @@ -301,10 +301,10 @@ The structure for the XkbBellNotify event type contains: Window window; /\&* window associated with event */ Bool event_only; /\&* False -> the server did not produce a beep */ } XkbBellNotifyEvent; - -.fi -If your application needs to generate visual bell feedback on the screen when it -receives + +.fi +If your application needs to generate visual bell feedback on the screen when it +receives a bell event, use the window ID in the XkbBellNotifyEvent, if present. .SH "SEE ALSO" diff --git a/man/xkb/XkbFindOverlayForKey.man b/man/xkb/XkbFindOverlayForKey.man index f5f5ec57..5489c532 100644 --- a/man/xkb/XkbFindOverlayForKey.man +++ b/man/xkb/XkbFindOverlayForKey.man @@ -21,7 +21,7 @@ .\" .TH XkbFindOverlayForKey __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbFindOverlayForKey \- Find the alternate name by using the primary name for a +XkbFindOverlayForKey \- Find the alternate name by using the primary name for a key that is part of an overlay .SH SYNOPSIS .HP @@ -43,10 +43,10 @@ section to be searched for matching keys primary name of the key to be considered .SH DESCRIPTION .LP -Keys that can generate multiple keycodes may be associated with multiple names. +Keys that can generate multiple keycodes may be associated with multiple names. Such keys have a primary name and an alternate name. -.I XkbFindOverlayForKey -uses the primary name of the key, +.I XkbFindOverlayForKey +uses the primary name of the key, .I under, to look up the alternate name, which it returns. diff --git a/man/xkb/XkbForceBell.man b/man/xkb/XkbForceBell.man index 9f546f14..25407399 100644 --- a/man/xkb/XkbForceBell.man +++ b/man/xkb/XkbForceBell.man @@ -22,7 +22,7 @@ .\" .TH XkbForceBell __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbForceBell \- Overrides user preference settings for audible bells to ring the +XkbForceBell \- Overrides user preference settings for audible bells to ring the bell on the default keyboard .SH SYNOPSIS .HP @@ -40,18 +40,18 @@ connection to the X server volume for the bell, which can range from -100 to 100 inclusive .SH DESCRIPTION .LP -The core X protocol allows only applications to explicitly sound the system bell -with a -given duration, pitch, and volume. Xkb extends this capability by allowing clients -to -attach symbolic names to bells, disable audible bells, and receive an event whenever -the -keyboard bell is rung. For the purposes of this document, the -.I audible -bell is defined to be the system bell, or the default keyboard bell, as opposed to -any -other audible sound generated elsewhere in the system. -You can ask to receive XkbBellNotify events when any client rings any one of the +The core X protocol allows only applications to explicitly sound the system bell +with a +given duration, pitch, and volume. Xkb extends this capability by allowing clients +to +attach symbolic names to bells, disable audible bells, and receive an event whenever +the +keyboard bell is rung. For the purposes of this document, the +.I audible +bell is defined to be the system bell, or the default keyboard bell, as opposed to +any +other audible sound generated elsewhere in the system. +You can ask to receive XkbBellNotify events when any client rings any one of the following: .IP \(bu 5 @@ -59,61 +59,61 @@ The default bell .IP \(bu 5 Any bell on an input device that can be specified by a bell_class and bell_id pair .IP \(bu 5 -Any bell specified only by an arbitrary name. (This is, from the server's point of -view, -merely a name, and not connected with any physical sound-generating device. Some -client -application must generate the sound, or visual feedback, if any, that is associated -with +Any bell specified only by an arbitrary name. (This is, from the server's point of +view, +merely a name, and not connected with any physical sound-generating device. Some +client +application must generate the sound, or visual feedback, if any, that is associated +with the name.) .LP -You can also ask to receive XkbBellNotify events when the server rings the default -bell -or if any client has requested events only (without the bell sounding) for any of -the +You can also ask to receive XkbBellNotify events when the server rings the default +bell +or if any client has requested events only (without the bell sounding) for any of +the bell types previously listed. -You can disable audible bells on a global basis. For example, a client that replaces -the -keyboard bell with some other audible cue might want to turn off the AudibleBell -control -to prevent the server from also generating a sound and avoid cacophony. If you -disable -audible bells and request to receive XkbBellNotify events, you can generate feedback +You can disable audible bells on a global basis. For example, a client that replaces +the +keyboard bell with some other audible cue might want to turn off the AudibleBell +control +to prevent the server from also generating a sound and avoid cacophony. If you +disable +audible bells and request to receive XkbBellNotify events, you can generate feedback different from the default bell. -You can, however, override the AudibleBell control by calling one of the functions -that -force the ringing of a bell in spite of the setting of the AudibleBell control - -.I XkbForceDeviceBell -or -.I XkbForceBell. +You can, however, override the AudibleBell control by calling one of the functions +that +force the ringing of a bell in spite of the setting of the AudibleBell control - +.I XkbForceDeviceBell +or +.I XkbForceBell. In this case the server does not generate a bell event. -Just as some keyboards can produce keyclicks to indicate when a key is pressed or -repeating, Xkb can provide feedback for the controls by using special beep codes. -The -AccessXFeedback control is used to configure the specific types of operations that +Just as some keyboards can produce keyclicks to indicate when a key is pressed or +repeating, Xkb can provide feedback for the controls by using special beep codes. +The +AccessXFeedback control is used to configure the specific types of operations that generate feedback. .B Bell Names -You can associate a name to an act of ringing a bell by converting the name to an -Atom -and then using this name when you call the functions listed in this chapter. If an -event -is generated as a result, the name is then passed to all other clients interested in -receiving XkbBellNotify events. Note that these are arbitrary names and that there -is no -binding to any sounds. Any sounds or other effects (such as visual bells on the -screen) -must be generated by a client application upon receipt of the bell event containing -the -name. There is no default name for the default keyboard bell. The server does -generate -some predefined bells for the AccessX controls. These named bells are shown in the -Table 1; the name is included in any bell event sent to clients that have requested to +You can associate a name to an act of ringing a bell by converting the name to an +Atom +and then using this name when you call the functions listed in this chapter. If an +event +is generated as a result, the name is then passed to all other clients interested in +receiving XkbBellNotify events. Note that these are arbitrary names and that there +is no +binding to any sounds. Any sounds or other effects (such as visual bells on the +screen) +must be generated by a client application upon receipt of the bell event containing +the +name. There is no default name for the default keyboard bell. The server does +generate +some predefined bells for the AccessX controls. These named bells are shown in the +Table 1; the name is included in any bell event sent to clients that have requested to receive XkbBellNotify events. .TS @@ -145,50 +145,50 @@ StickyKeys key unlocked AX_StickyUnlock .B Audible Bells -Using Xkb you can generate bell events that do not necessarily ring the system bell. -This -is useful if you need to use an audio server instead of the system beep. For -example, -when an audio client starts, it could disable the audible bell (the system bell) and -then -listen for XkbBellNotify events. When it receives a XkbBellNotify event, the audio -client +Using Xkb you can generate bell events that do not necessarily ring the system bell. +This +is useful if you need to use an audio server instead of the system beep. For +example, +when an audio client starts, it could disable the audible bell (the system bell) and +then +listen for XkbBellNotify events. When it receives a XkbBellNotify event, the audio +client could then send a request to an audio server to play a sound. You can control the audible bells feature by passing the XkbAudibleBellMask to -.I XkbChangeEnabledControls. -If you set XkbAudibleBellMask on, the server rings the system bell when a bell event -occurs. This is the default. If you set XkbAudibleBellMask off and a bell event -occurs, -the server does not ring the system bell unless you call -.I XkbForceDeviceBell -or +.I XkbChangeEnabledControls. +If you set XkbAudibleBellMask on, the server rings the system bell when a bell event +occurs. This is the default. If you set XkbAudibleBellMask off and a bell event +occurs, +the server does not ring the system bell unless you call +.I XkbForceDeviceBell +or .I XkbForceBell. Audible bells are also part of the per-client auto-reset controls. Bell Functions -Use the functions described in this section to ring bells and to generate bell -events. +Use the functions described in this section to ring bells and to generate bell +events. -The input extension has two types of feedbacks that can generate bells - bell -feedback +The input extension has two types of feedbacks that can generate bells - bell +feedback and keyboard feedback. Some of the functions in this section have -.I bell_class -and -.I bell_id -parameters; set them as follows: Set -.I bell_class -to BellFeedbackClass or KbdFeedbackClass. A device can have more than one feedback -of -each type; set -.I bell_id -to the particular bell feedback of -.I bell_class +.I bell_class +and +.I bell_id +parameters; set them as follows: Set +.I bell_class +to BellFeedbackClass or KbdFeedbackClass. A device can have more than one feedback +of +each type; set +.I bell_id +to the particular bell feedback of +.I bell_class type. -Table 2 shows the conditions that cause a bell to sound or an XkbBellNotifyEvent to be generated when a bell function is +Table 2 shows the conditions that cause a bell to sound or an XkbBellNotifyEvent to be generated when a bell function is called. .TS @@ -197,7 +197,7 @@ l l l l l l l l. Table 2 Bell Sounding and Bell Event Generating _ -Function called AudibleBell Server sounds a bell Server sends an +Function called AudibleBell Server sounds a bell Server sends an XkbBellNotifyEvent _ XkbDeviceBell On Yes Yes @@ -211,72 +211,72 @@ XkbForceBell On or Off Yes No .TE -If a compatible keyboard extension isn't present in the X server, -.I XkbForceBell -calls -.I XBell -with the specified -.I display -and -.I percent -and returns False. Otherwise, -.I XkbForceBell -calls -.I XkbForceDeviceBell -with the specified -.I display -and -.I percent, device_spec -=XkbUseCoreKbd, -.I bell_class -= XkbDfltXIClass, -.I bell_id -= XkbDfltXIId, -.I window -= None, and -.I name -= NULL, and returns what -.I XkbForceDeviceBell +If a compatible keyboard extension isn't present in the X server, +.I XkbForceBell +calls +.I XBell +with the specified +.I display +and +.I percent +and returns False. Otherwise, +.I XkbForceBell +calls +.I XkbForceDeviceBell +with the specified +.I display +and +.I percent, device_spec +=XkbUseCoreKbd, +.I bell_class += XkbDfltXIClass, +.I bell_id += XkbDfltXIId, +.I window += None, and +.I name += NULL, and returns what +.I XkbForceDeviceBell returns. -.I XkbForceBell +.I XkbForceBell does not cause an XkbBellNotify event. -You can call -.I XkbBell +You can call +.I XkbBell without first initializing the keyboard extension. .SH "RETURNS VALUES" .TP 15 False -The -.I XkbForceBell +The +.I XkbForceBell function returns False when a compatible keyboard extension isn't present in the X server. .SH STRUCTURES .LP -Xkb generates XkbBellNotify events for all bells except for those resulting from -calls to -.I XkbForceDeviceBell -and -.I XkbForceBell. -To receive XkbBellNotify events under all possible conditions, pass -XkbBellNotifyMask in -both the -.I bits_to_change -and -.I values_for_bits -parameters to +Xkb generates XkbBellNotify events for all bells except for those resulting from +calls to +.I XkbForceDeviceBell +and +.I XkbForceBell. +To receive XkbBellNotify events under all possible conditions, pass +XkbBellNotifyMask in +both the +.I bits_to_change +and +.I values_for_bits +parameters to .I XkbSelectEvents. -The XkbBellNotify event has no event details. It is either selected or it is not. -However, you can call -.I XkbSelectEventDetails -using XkbBellNotify as the -.I event_type +The XkbBellNotify event has no event details. It is either selected or it is not. +However, you can call +.I XkbSelectEventDetails +using XkbBellNotify as the +.I event_type and specifying XkbAllBellEventsMask in -.I bits_to_change -and -.I values_for_bits. -This has the same effect as a call to +.I bits_to_change +and +.I values_for_bits. +This has the same effect as a call to .I XkbSelectEvents. The structure for the XkbBellNotify event type contains: @@ -299,10 +299,10 @@ The structure for the XkbBellNotify event type contains: Window window; /\&* window associated with event */ Bool event_only; /\&* False -> the server did not produce a beep */ } XkbBellNotifyEvent; - -.fi -If your application needs to generate visual bell feedback on the screen when it -receives + +.fi +If your application needs to generate visual bell feedback on the screen when it +receives a bell event, use the window ID in the XkbBellNotifyEvent, if present. .SH "SEE ALSO" diff --git a/man/xkb/XkbForceDeviceBell.man b/man/xkb/XkbForceDeviceBell.man index e10a5586..cb6b5296 100644 --- a/man/xkb/XkbForceDeviceBell.man +++ b/man/xkb/XkbForceDeviceBell.man @@ -22,7 +22,7 @@ .\" .TH XkbForceDeviceBell __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbForceDeviceBell \- Rings the bell on any keyboard, overriding user preference +XkbForceDeviceBell \- Rings the bell on any keyboard, overriding user preference settings for audible bells .SH SYNOPSIS .HP @@ -47,27 +47,27 @@ event window, or None device ID, or XkbUseCoreKbd .TP .I bell_class -input extension class of the bell to be rung +input extension class of the bell to be rung .TP .I bell_id input extension ID of the bell to be rung .TP .I percent -relative volume, which can range from -100 to 100 inclusive +relative volume, which can range from -100 to 100 inclusive .SH DESCRIPTION .LP -The core X protocol allows only applications to explicitly sound the system bell -with a -given duration, pitch, and volume. Xkb extends this capability by allowing clients -to -attach symbolic names to bells, disable audible bells, and receive an event -whenever the -keyboard bell is rung. For the purposes of this document, the -.I audible -bell is defined to be the system bell, or the default keyboard bell, as opposed to -any -other audible sound generated elsewhere in the system. -You can ask to receive XkbBellNotify events when any client rings any one of the +The core X protocol allows only applications to explicitly sound the system bell +with a +given duration, pitch, and volume. Xkb extends this capability by allowing clients +to +attach symbolic names to bells, disable audible bells, and receive an event +whenever the +keyboard bell is rung. For the purposes of this document, the +.I audible +bell is defined to be the system bell, or the default keyboard bell, as opposed to +any +other audible sound generated elsewhere in the system. +You can ask to receive XkbBellNotify events when any client rings any one of the following: .IP \(bu 5 @@ -75,53 +75,53 @@ The default bell .IP \(bu 5 Any bell on an input device that can be specified by a bell_class and bell_id pair .IP \(bu 5 -Any bell specified only by an arbitrary name. (This is, from the server's point of -view, -merely a name, and not connected with any physical sound-generating device. Some -client -application must generate the sound, or visual feedback, if any, that is associated -with +Any bell specified only by an arbitrary name. (This is, from the server's point of +view, +merely a name, and not connected with any physical sound-generating device. Some +client +application must generate the sound, or visual feedback, if any, that is associated +with the name.) .LP -You can also ask to receive XkbBellNotify events when the server rings the default -bell -or if any client has requested events only (without the bell sounding) for any of -the +You can also ask to receive XkbBellNotify events when the server rings the default +bell +or if any client has requested events only (without the bell sounding) for any of +the bell types previously listed. -You can disable audible bells on a global basis. For example, a client that -replaces the -keyboard bell with some other audible cue might want to turn off the AudibleBell -control -to prevent the server from also generating a sound and avoid cacophony. If you -disable -audible bells and request to receive XkbBellNotify events, you can generate -feedback +You can disable audible bells on a global basis. For example, a client that +replaces the +keyboard bell with some other audible cue might want to turn off the AudibleBell +control +to prevent the server from also generating a sound and avoid cacophony. If you +disable +audible bells and request to receive XkbBellNotify events, you can generate +feedback different from the default bell. -You can, however, override the AudibleBell control by calling one of the functions -that -force the ringing of a bell in spite of the setting of the AudibleBell control - -.I XkbForceDeviceBell -or -.I XkbForceBell. +You can, however, override the AudibleBell control by calling one of the functions +that +force the ringing of a bell in spite of the setting of the AudibleBell control - +.I XkbForceDeviceBell +or +.I XkbForceBell. In this case the server does not generate a bell event. -Just as some keyboards can produce keyclicks to indicate when a key is pressed or repeating, Xkb -can provide feedback for the controls by using special beep codes. The AccessXFeedback control +Just as some keyboards can produce keyclicks to indicate when a key is pressed or repeating, Xkb +can provide feedback for the controls by using special beep codes. The AccessXFeedback control is used to configure the specific types of operations that generate feedback. Bell Names -You can associate a name to an act of ringing a bell by converting the name to an Atom -and then using this name when you call the functions listed in this chapter. If an event -is generated as a result, the name is then passed to all other clients interested in receiving -XkbBellNotify events. Note that these are arbitrary names and that there is no binding to any -sounds. Any sounds or other effects (such as visual bells on the screen) must be generated by a -client application upon receipt of the bell event containing the name. There is no default name -for the default keyboard bell. The server does generate some predefined bells for the AccessX -controls. These named bells are shown in Table 1; the name is included in any bell event sent to +You can associate a name to an act of ringing a bell by converting the name to an Atom +and then using this name when you call the functions listed in this chapter. If an event +is generated as a result, the name is then passed to all other clients interested in receiving +XkbBellNotify events. Note that these are arbitrary names and that there is no binding to any +sounds. Any sounds or other effects (such as visual bells on the screen) must be generated by a +client application upon receipt of the bell event containing the name. There is no default name +for the default keyboard bell. The server does generate some predefined bells for the AccessX +controls. These named bells are shown in Table 1; the name is included in any bell event sent to clients that have requested to receive XkbBellNotify events. .TS @@ -153,42 +153,42 @@ StickyKeys key unlocked AX_StickyUnlock Audible Bells -Using Xkb you can generate bell events that do not necessarily ring the system bell. This -is useful if you need to use an audio server instead of the system beep. For example, -when an audio client starts, it could disable the audible bell (the system bell) and then -listen for XkbBellNotify events. When it receives a XkbBellNotify event, the audio client could +Using Xkb you can generate bell events that do not necessarily ring the system bell. This +is useful if you need to use an audio server instead of the system beep. For example, +when an audio client starts, it could disable the audible bell (the system bell) and then +listen for XkbBellNotify events. When it receives a XkbBellNotify event, the audio client could then send a request to an audio server to play a sound. You can control the audible bells feature by passing the XkbAudibleBellMask to -.I XkbChangeEnabledControls. -If you set XkbAudibleBellMask on, the server rings the system bell when a bell event occurs. -This is the default. If you set XkbAudibleBellMask off and a bell event occurs, the server does -not ring the system bell unless you call -.I XkbForceDeviceBell -or +.I XkbChangeEnabledControls. +If you set XkbAudibleBellMask on, the server rings the system bell when a bell event occurs. +This is the default. If you set XkbAudibleBellMask off and a bell event occurs, the server does +not ring the system bell unless you call +.I XkbForceDeviceBell +or .I XkbForceBell. Audible bells are also part of the per-client auto-reset controls. Bell Functions -Use the functions described in this section to ring bells and to generate bell events. +Use the functions described in this section to ring bells and to generate bell events. -The input extension has two types of feedbacks that can generate bells - bell feedback and +The input extension has two types of feedbacks that can generate bells - bell feedback and keyboard feedback. Some of the functions in this section have -.I bell_class -and -.I bell_id -parameters; set them as follows: Set -.I bell_class -to BellFeedbackClass or KbdFeedbackClass. A device can have more than one feedback of each type; -set -.I bell_id -to the particular bell feedback of -.I bell_class +.I bell_class +and +.I bell_id +parameters; set them as follows: Set +.I bell_class +to BellFeedbackClass or KbdFeedbackClass. A device can have more than one feedback of each type; +set +.I bell_id +to the particular bell feedback of +.I bell_class type. -Table 2 shows the conditions that cause a bell to sound or an XkbBellNotifyEvent to be generated +Table 2 shows the conditions that cause a bell to sound or an XkbBellNotifyEvent to be generated when a bell function is called. .TS @@ -197,7 +197,7 @@ l l l l l l l l. Table 2 Bell Sounding and Bell Event Generating _ -Function called AudibleBell Server sounds a bell Server sends an +Function called AudibleBell Server sounds a bell Server sends an XkbBellNotifyEvent _ XkbDeviceBell On Yes Yes @@ -211,51 +211,51 @@ XkbForceBell On or Off Yes No .TE -If a compatible keyboard extension isn't present in the X server, -.I XkbForceDeviceBell -immediately returns False. Otherwise, -.I XkbForceDeviceBell -rings the bell as specified for the display and keyboard device and returns -True. Set -.I percent +If a compatible keyboard extension isn't present in the X server, +.I XkbForceDeviceBell +immediately returns False. Otherwise, +.I XkbForceDeviceBell +rings the bell as specified for the display and keyboard device and returns +True. Set +.I percent to be the volume relative to the base volume for the keyboard as described for .I XBell. -There is no -.I name -parameter because -.I XkbForceDeviceBell +There is no +.I name +parameter because +.I XkbForceDeviceBell does not cause an XkbBellNotify event. -You can call -.I XkbBell +You can call +.I XkbBell without first initializing the keyboard extension. .SH STRUCTURES .LP -Xkb generates XkbBellNotify events for all bells except for those resulting from -calls to -.I XkbForceDeviceBell -and -.I XkbForceBell. -To receive XkbBellNotify events under all possible conditions, pass -XkbBellNotifyMask in -both the -.I bits_to_change -and -.I values_for_bits -parameters to +Xkb generates XkbBellNotify events for all bells except for those resulting from +calls to +.I XkbForceDeviceBell +and +.I XkbForceBell. +To receive XkbBellNotify events under all possible conditions, pass +XkbBellNotifyMask in +both the +.I bits_to_change +and +.I values_for_bits +parameters to .I XkbSelectEvents. -The XkbBellNotify event has no event details. It is either selected or it is not. -However, you can call -.I XkbSelectEventDetails -using XkbBellNotify as the -.I event_type +The XkbBellNotify event has no event details. It is either selected or it is not. +However, you can call +.I XkbSelectEventDetails +using XkbBellNotify as the +.I event_type and specifying XkbAllBellEventsMask in -.I bits_to_change -and -.I values_for_bits. -This has the same effect as a call to +.I bits_to_change +and +.I values_for_bits. +This has the same effect as a call to .I XkbSelectEvents. The structure for the XkbBellNotify event type contains: @@ -278,10 +278,10 @@ The structure for the XkbBellNotify event type contains: Window window; /\&* window associated with event */ Bool event_only; /\&* False -> the server did not produce a beep */ } XkbBellNotifyEvent; - -.fi -If your application needs to generate visual bell feedback on the screen when it -receives + +.fi +If your application needs to generate visual bell feedback on the screen when it +receives a bell event, use the window ID in the XkbBellNotifyEvent, if present. .SH "SEE ALSO" .BR XBell (__libmansuffix__), diff --git a/man/xkb/XkbFreeClientMap.man b/man/xkb/XkbFreeClientMap.man index 39455673..b76ddeb8 100644 --- a/man/xkb/XkbFreeClientMap.man +++ b/man/xkb/XkbFreeClientMap.man @@ -22,7 +22,7 @@ .\" .TH XkbFreeClientMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbFreeClientMap \- Free memory used by the client map member of an XkbDescRec +XkbFreeClientMap \- Free memory used by the client map member of an XkbDescRec structure .SH SYNOPSIS .HP @@ -41,32 +41,32 @@ keyboard description containing client map to free mask identifying components of map to free .TP .I free_all -True => free all client components and map itself +True => free all client components and map itself .SH DESCRIPTION .LP -.I XkbFreeClientMap -frees the components of client map specified by -.I which -in the XkbDescRec structure specified by the -.I xkb +.I XkbFreeClientMap +frees the components of client map specified by +.I which +in the XkbDescRec structure specified by the +.I xkb parameter and sets the corresponding structure component values to NULL. The -.I which +.I which parameter specifies a combination of the client map masks shown in Table 1. -If -.I free_all -is True, -.I which -is ignored; -.I XkbFreeClientMap -frees every non-NULL structure component in the client map, frees the -XkbClientMapRec -structure referenced by the -.I map -member of the -.I xkb -parameter, and sets the -.I map +If +.I free_all +is True, +.I which +is ignored; +.I XkbFreeClientMap +frees every non-NULL structure component in the client map, frees the +XkbClientMapRec +structure referenced by the +.I map +member of the +.I xkb +parameter, and sets the +.I map member to NULL. .TS @@ -78,42 +78,42 @@ _ Mask Effect _ XkbKeyTypesMask T{ -The type_count field specifies the number of entries to preallocate for the -types field of the client map. If the type_count field is less than +The type_count field specifies the number of entries to preallocate for the +types field of the client map. If the type_count field is less than XkbNumRequiredTypes returns BadValue. T} .sp XkbKeySymsMask T{ -The min_key_code and max_key_code fields of the xkb parameter are used to -allocate the syms and key_sym_map fields of the client map. The fields are -allocated to contain the maximum number of entries necessary for max_key_code - +The min_key_code and max_key_code fields of the xkb parameter are used to +allocate the syms and key_sym_map fields of the client map. The fields are +allocated to contain the maximum number of entries necessary for max_key_code - min_key_code + 1 keys. T} .sp XkbModifierMapMask T{ -The min_key_code and max_key_code fields of the xkb parameter are used to -allocate the modmap field of the client map. The field is allocated to contain -the maximum number of entries necessary for max_key_code - min_key_code + 1 +The min_key_code and max_key_code fields of the xkb parameter are used to +allocate the modmap field of the client map. The field is allocated to contain +the maximum number of entries necessary for max_key_code - min_key_code + 1 keys. T} .TE -NOTE: The -.I min_key_code -and -.I max_key_code -fields of the -.I xkb -parameter must be legal values if the XkbKeySymsMask or XkbModifierMapMask masks -are set in the -.I which -parameter. If they are not valid, -.I XkbAllocClientMap -returns BadValue. +NOTE: The +.I min_key_code +and +.I max_key_code +fields of the +.I xkb +parameter must be legal values if the XkbKeySymsMask or XkbModifierMapMask masks +are set in the +.I which +parameter. If they are not valid, +.I XkbAllocClientMap +returns BadValue. .SH STRUCTURES .LP -The complete description of an Xkb keyboard is given by an XkbDescRec. The -component +The complete description of an Xkb keyboard is given by an XkbDescRec. The +component structures in the XkbDescRec represent the major Xkb components. .nf @@ -133,27 +133,27 @@ typedef struct { } XkbDescRec, *XkbDescPtr; .fi -The -.I display -field points to an X display structure. The -.I flags field is private to the library: modifying -.I flags -may yield unpredictable results. The -.I device_spec -field specifies the device identifier of the keyboard input device, or -XkbUseCoreKeyboard, which specifies the core keyboard device. The +The +.I display +field points to an X display structure. The +.I flags field is private to the library: modifying +.I flags +may yield unpredictable results. The +.I device_spec +field specifies the device identifier of the keyboard input device, or +XkbUseCoreKeyboard, which specifies the core keyboard device. The .I min_key_code -and -.I max_key_code -fields specify the least and greatest keycode that can be returned by the -keyboard. +and +.I max_key_code +fields specify the least and greatest keycode that can be returned by the +keyboard. -Each structure component has a corresponding mask bit that is used in function -calls to -indicate that the structure should be manipulated in some manner, such as -allocating it -or freeing it. These masks and their relationships to the fields in the -XkbDescRec are +Each structure component has a corresponding mask bit that is used in function +calls to +indicate that the structure should be manipulated in some manner, such as +allocating it +or freeing it. These masks and their relationships to the fields in the +XkbDescRec are shown in Table 2. .TS @@ -174,13 +174,13 @@ XkbGeometryMask geom (1L<<6) XkbAllComponentsMask All Fields (0x7f) .TE -The -.I map -field of the complete Xkb keyboard description is a pointer to the Xkb client -map, which is +The +.I map +field of the complete Xkb keyboard description is a pointer to the Xkb client +map, which is of type XkbClientMapRec: .nf - + typedef struct { /\&* Client Map */ unsigned char size_types; /\&* # occupied entries in types */ unsigned char num_types; /\&* # entries in types */ diff --git a/man/xkb/XkbFreeCompatMap.man b/man/xkb/XkbFreeCompatMap.man index 6d76f791..df3b24cb 100644 --- a/man/xkb/XkbFreeCompatMap.man +++ b/man/xkb/XkbFreeCompatMap.man @@ -43,9 +43,9 @@ mask of compatibility map components to free True => free XkbCompatMap structure itself .SH DESCRIPTION .LP -.I which -specifies the compatibility map components to be freed (see XkbGetCompatMap). -.I which +.I which +specifies the compatibility map components to be freed (see XkbGetCompatMap). +.I which is an inclusive OR of the bits shown in Table 1. .TS @@ -60,15 +60,15 @@ XkbGroupCompatMask (1<<1) Group maps XkbAllCompatMask (0x3) All compatibility map components .TE -.I free_map -indicates whether the XkbCompatMap structure itself should be freed. If -.I free_map -is True, -.I which -is ignored, all non-NULL compatibility map components are freed, and the -.I compat -field in the XkbDescRec referenced by -.I xkb +.I free_map +indicates whether the XkbCompatMap structure itself should be freed. If +.I free_map +is True, +.I which +is ignored, all non-NULL compatibility map components are freed, and the +.I compat +field in the XkbDescRec referenced by +.I xkb is set to NULL. .SH STRUCTURES .LP @@ -80,10 +80,10 @@ is set to NULL. unsigned short num_si; /\&* # structures used in sym_interpret */ unsigned short size_si; /\&* # structures allocated in sym_interpret */ } XkbCompatMapRec, *XkbCompatMapPtr; - + .fi -The complete description of an Xkb keyboard is given by an XkbDescRec. The component +The complete description of an Xkb keyboard is given by an XkbDescRec. The component structures in the XkbDescRec represent the major Xkb components outlined in Figure 1.1. .nf @@ -103,22 +103,22 @@ typedef struct { } XkbDescRec, *XkbDescPtr; .fi -The -.I display -field points to an X display structure. The -.I flags field is private to the library: modifying -.I flags -may yield unpredictable results. The -.I device_spec -field specifies the device identifier of the keyboard input device, or -XkbUseCoreKeyboard, which specifies the core keyboard device. The +The +.I display +field points to an X display structure. The +.I flags field is private to the library: modifying +.I flags +may yield unpredictable results. The +.I device_spec +field specifies the device identifier of the keyboard input device, or +XkbUseCoreKeyboard, which specifies the core keyboard device. The .I min_key_code -and -.I max_key_code -fields specify the least and greatest keycode that can be returned by the keyboard. -The other fields specify structure components of the keyboard description and are -described in detail in other sections of this document. Table 2 identifies the -subsequent sections of this document that discuss the individual components of the +and +.I max_key_code +fields specify the least and greatest keycode that can be returned by the keyboard. +The other fields specify structure components of the keyboard description and are +described in detail in other sections of this document. Table 2 identifies the +subsequent sections of this document that discuss the individual components of the XkbDescRec. .TS @@ -138,9 +138,9 @@ compat Chapter 17 geom Chapter 13 .TE -Each structure component has a corresponding mask bit that is used in function calls to -indicate that the structure should be manipulated in some manner, such as allocating it -or freeing it. These masks and their relationships to the fields in the XkbDescRec are +Each structure component has a corresponding mask bit that is used in function calls to +indicate that the structure should be manipulated in some manner, such as allocating it +or freeing it. These masks and their relationships to the fields in the XkbDescRec are shown in Table 3. .TS @@ -150,7 +150,7 @@ l l l. Table 3 Mask Bits for XkbDescRec _ Mask Bit XkbDescRec Field Value -_ +_ XkbControlsMask ctrls (1L<<0) XkbServerMapMask server (1L<<1) XkbIClientMapMask map (1L<<2) diff --git a/man/xkb/XkbFreeComponentList.man b/man/xkb/XkbFreeComponentList.man index 8778b2cc..bcdd8c40 100644 --- a/man/xkb/XkbFreeComponentList.man +++ b/man/xkb/XkbFreeComponentList.man @@ -22,7 +22,7 @@ .\" .TH XkbFreeComponentList __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbFreeComponentList \- Free the structure returned by +XkbFreeComponentList \- Free the structure returned by .I XkbListComponents .SH SYNOPSIS .HP @@ -36,9 +36,9 @@ XkbFreeComponentList \- Free the structure returned by pointer to XkbComponentListRec to free .SH DESCRIPTION .LP -When you are done using the structure returned by -.I XkbListComponents, -free it using +When you are done using the structure returned by +.I XkbListComponents, +free it using .I XkbFreeComponentList. .SH "SEE ALSO" .BR XkbListComponents (__libmansuffix__) diff --git a/man/xkb/XkbFreeControls.man b/man/xkb/XkbFreeControls.man index 5403ad09..315c4a09 100644 --- a/man/xkb/XkbFreeControls.man +++ b/man/xkb/XkbFreeControls.man @@ -43,34 +43,34 @@ mask of components of ctrls to free True => free everything + ctrls itself .SH DESCRIPTION .LP -.I XkbFreeControls -frees the specified components of the -.I ctrls -field in the -.I xkb -keyboard description and sets the corresponding structure component values to NULL or zero. The -.I which -mask specifies the fields of -.I ctrls +.I XkbFreeControls +frees the specified components of the +.I ctrls +field in the +.I xkb +keyboard description and sets the corresponding structure component values to NULL or zero. The +.I which +mask specifies the fields of +.I ctrls to be freed and can contain any of the controls components specified in Table 1. -Table 1 shows the actual values for the individual mask bits used to select -controls for -modification and to enable and disable the control. Note that the same mask bit -is used to -specify general modifications to the parameters used to configure the control -(which), and to -enable and disable the control (enabled_ctrls). The anomalies in the table (no -"ok" in column) -are for controls that have no configurable attributes; and for controls that are -not boolean +Table 1 shows the actual values for the individual mask bits used to select +controls for +modification and to enable and disable the control. Note that the same mask bit +is used to +specify general modifications to the parameters used to configure the control +(which), and to +enable and disable the control (enabled_ctrls). The anomalies in the table (no +"ok" in column) +are for controls that have no configurable attributes; and for controls that are +not boolean controls and therefore cannot be enabled or disabled. .TS c s s s l l l l l l l l -l l l l. +l l l l. Table 1 Controls Mask Bits _ Mask Bit which or enabled Value @@ -94,20 +94,20 @@ XkbInternalModsMask ok (1L<<28) XkbIgnoreLockModsMask ok (1L<<29) XkbPerKeyRepeatMask ok (1L<<30) XkbControlsEnabledMask ok (1L<<31) -XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | +XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | XkbAccessXFeedbackMask) -XkbAllBooleanCtrlsMask ok (0x00001FFF) +XkbAllBooleanCtrlsMask ok (0x00001FFF) XkbAllControlsMask ok (0xF8001FFF) .TE -If -.I free_all -is True, -.I XkbFreeControls -frees every non-NULL structure component in the controls, frees the XkbControlsRec structure referenced by the -.I ctrls -member of -.I xkb, -and sets -.I ctrls +If +.I free_all +is True, +.I XkbFreeControls +frees every non-NULL structure component in the controls, frees the XkbControlsRec structure referenced by the +.I ctrls +member of +.I xkb, +and sets +.I ctrls to NULL. diff --git a/man/xkb/XkbFreeDeviceInfo.man b/man/xkb/XkbFreeDeviceInfo.man index 587761c3..35491f8c 100644 --- a/man/xkb/XkbFreeDeviceInfo.man +++ b/man/xkb/XkbFreeDeviceInfo.man @@ -43,81 +43,81 @@ mask of components of device_info to free True => free everything, including device_info .SH DESCRIPTION .LP -If -.I free_all -is True, the -.I XkbFreeDeviceInfo -frees all components of -.I device_info -and the XkbDeviceInfoRec structure pointed to by -.I device_info -itself. If -.I free_all -is False, the value of -.I which -determines which subcomponents are freed. -.I which -is an inclusive OR of one or more of the values from Table 1. If -.I which -contains XkbXI_ButtonActionsMask, all button actions associated with -.I device_info -are freed, -.I device_info->btn_acts -is set to NULL, and -.I device_info->num_btns -is set to zero. If -.I which -contains all bits in XkbXI_IndicatorsMask, all XkbDeviceLedInfoRec structures associated with -.I device_info -are freed, -.I device_info->leds -is set to NULL, and -.I device_info->sz_leds -and -.I device_info->num_leds -are set to zero. If -.I which -contains XkbXI_IndicatorMapsMask, all indicator maps associated with -.I device_info -are cleared, but the number of LEDs and the leds structures themselves is preserved. If -.I which +If +.I free_all +is True, the +.I XkbFreeDeviceInfo +frees all components of +.I device_info +and the XkbDeviceInfoRec structure pointed to by +.I device_info +itself. If +.I free_all +is False, the value of +.I which +determines which subcomponents are freed. +.I which +is an inclusive OR of one or more of the values from Table 1. If +.I which +contains XkbXI_ButtonActionsMask, all button actions associated with +.I device_info +are freed, +.I device_info->btn_acts +is set to NULL, and +.I device_info->num_btns +is set to zero. If +.I which +contains all bits in XkbXI_IndicatorsMask, all XkbDeviceLedInfoRec structures associated with +.I device_info +are freed, +.I device_info->leds +is set to NULL, and +.I device_info->sz_leds +and +.I device_info->num_leds +are set to zero. If +.I which +contains XkbXI_IndicatorMapsMask, all indicator maps associated with +.I device_info +are cleared, but the number of LEDs and the leds structures themselves is preserved. If +.I which contains XkbXI_IndicatorNamesMask, all indicator names associated with -.I device_info -are cleared, but the number of LEDs and the leds structures themselves is preserved. If -.I which +.I device_info +are cleared, but the number of LEDs and the leds structures themselves is preserved. If +.I which contains XkbXI_IndicatorStateMask, the indicator state associated with the -.I device_info +.I device_info leds are set to zeros but the number of LEDs and the leds structures themselves is preserved. .bp .nf - Table 1 XkbDeviceInfoRec Mask Bits + Table 1 XkbDeviceInfoRec Mask Bits ____________________________________________________________________________________ Name XkbDeviceInfoRec Value Capability If Set - Fields Effected + Fields Effected ____________________________________________________________________________________ XkbXI_KeyboardsMask (1L <<0) Clients can use all Xkb requests and events - with KeyClass devices + with KeyClass devices supported by the input device extension. -XkbXI_ButtonActionsMask num_btns (1L <<1) Clients can assign key - btn_acts actions to buttons +XkbXI_ButtonActionsMask num_btns (1L <<1) Clients can assign key + btn_acts actions to buttons non-KeyClass input extension devices. - + XkbXI_IndicatorNamesMask leds->names (1L <<2) Clients can assign names to indicators on non-KeyClass input extension devices. - + XkbXI_IndicatorMapsMask leds->maps (1L <<3) Clients can assign indicator maps to - indicators on + indicators on non-KeyClass input extension devices. -XkbXI_IndicatorStateMask leds->state (1L <<4) Clients can request +XkbXI_IndicatorStateMask leds->state (1L <<4) Clients can request the status of indicators on non-KeyClass input extension devices. @@ -130,7 +130,7 @@ XkbXI_UnsupportedFeaturesMask unsupported (1L <<15) XkbXI_AllDeviceFeaturesMask Those selected (0x1e) XkbXI_IndicatorsMask | by Value Column XkbSI_ButtonActionsMask - masks + masks XkbXI_AllFeaturesMask Those selected (0x1f) XkbSI_AllDeviceFeaturesMask | by Value Column XkbSI_KeyboardsMask @@ -142,7 +142,7 @@ XkbXI_AllDetailsMask Those selected (0x801f) XkbXI_AllFeaturesMask | .fi .SH STRUCTURES .LP -Information about X Input Extension devices is transferred between a client program and the Xkb +Information about X Input Extension devices is transferred between a client program and the Xkb extension in an XkbDeviceInfoRec structure: .nf @@ -161,7 +161,7 @@ typedef struct { 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 */ @@ -173,4 +173,4 @@ typedef struct { XkbIndicatorMapRec maps; /\&* indicator maps for each LED */ } XkbDeviceLedInfoRec, *XkbDeviceLedInfoPtr; -.fi +.fi diff --git a/man/xkb/XkbFreeGeomColors.man b/man/xkb/XkbFreeGeomColors.man index f7378fd2..fcdc0f84 100644 --- a/man/xkb/XkbFreeGeomColors.man +++ b/man/xkb/XkbFreeGeomColors.man @@ -34,10 +34,10 @@ XkbFreeGeomColors \- Free geometry colors .SH ARGUMENTS .TP .I geom -geometry in which colors should be freed +geometry in which colors should be freed .TP .I first -first color to be freed +first color to be freed .TP .I count number of colors to be freed @@ -46,30 +46,30 @@ number of colors to be freed True => all colors are freed .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -If -.I free_all -is True, all colors are freed regardless of the value of +If +.I free_all +is True, all colors are freed regardless of the value of .I first -or -.I count. -Otherwise, -.I count -colors are freed beginning with the one specified by +or +.I count. +Otherwise, +.I count +colors are freed beginning with the one specified by .I first. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbFreeGeomDoodads.man b/man/xkb/XkbFreeGeomDoodads.man index 53e83e85..b3af08a3 100644 --- a/man/xkb/XkbFreeGeomDoodads.man +++ b/man/xkb/XkbFreeGeomDoodads.man @@ -33,7 +33,7 @@ XkbFreeGeomDoodads \- Free geometry doodads .SH ARGUMENTS .TP .I doodads -doodads to be freed +doodads to be freed .TP .I count number of doodads to be freed @@ -42,32 +42,32 @@ number of doodads to be freed True => all doodads are freed .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -If -.I free_all -is True, all doodads in the array are freed, regardless of the value of -.I count. -Otherwise, -.I count +If +.I free_all +is True, all doodads in the array are freed, regardless of the value of +.I count. +Otherwise, +.I count doodads are freed. .SH "RETURN VALUES" .TP 15 Success -The XkbFreeGeomDoodads function returns Success if there are no allocation +The XkbFreeGeomDoodads function returns Success if there are no allocation errors. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbFreeGeomKeyAliases.man b/man/xkb/XkbFreeGeomKeyAliases.man index 11cd0c24..e4c05092 100644 --- a/man/xkb/XkbFreeGeomKeyAliases.man +++ b/man/xkb/XkbFreeGeomKeyAliases.man @@ -46,39 +46,39 @@ number of key aliases to be freed True => all key aliases are freed .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -If -.I free_all -is True, all aliases in the top level of the specified geometry -.I geom -are freed regardless of the value of -.I first -or -.I count. -Otherwise, -.I count -aliases in -.I geom -are freed beginning with the one specified by +If +.I free_all +is True, all aliases in the top level of the specified geometry +.I geom +are freed regardless of the value of +.I first +or +.I count. +Otherwise, +.I count +aliases in +.I geom +are freed beginning with the one specified by .I first. .SH "RETURN VALUES" .TP 15 Success -The XkbFreeGeomKeyAliases function returns Success if there are no allocation +The XkbFreeGeomKeyAliases function returns Success if there are no allocation errors. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbFreeGeomKeys.man b/man/xkb/XkbFreeGeomKeys.man index 0338ec39..20de1f2b 100644 --- a/man/xkb/XkbFreeGeomKeys.man +++ b/man/xkb/XkbFreeGeomKeys.man @@ -34,7 +34,7 @@ XkbFreeGeomKeys \- Free geometry keys .SH ARGUMENTS .TP .I row -row in which keys should be freed +row in which keys should be freed .TP .I first first key to be freed @@ -46,13 +46,13 @@ number of keys to be freed True => all keys are freed .SH DESCRIPTION .LP -If -.I free_all -is True, all keys are freed regardless of the value of -.I first -or -.I count. -Otherwise, -.I count -keys are freed beginning with the one specified by +If +.I free_all +is True, all keys are freed regardless of the value of +.I first +or +.I count. +Otherwise, +.I count +keys are freed beginning with the one specified by .I first. diff --git a/man/xkb/XkbFreeGeomOutlines.man b/man/xkb/XkbFreeGeomOutlines.man index d5255fe7..9a45d0d8 100644 --- a/man/xkb/XkbFreeGeomOutlines.man +++ b/man/xkb/XkbFreeGeomOutlines.man @@ -46,13 +46,13 @@ number of outlines to be freed True => all outlines are freed .SH DESCRIPTION .LP -If -.I free_all -is True, all outlines are freed regardless of the value of -.I first -or -.I count. -Otherwise, -.I count -outlines are freed beginning with the one specified by +If +.I free_all +is True, all outlines are freed regardless of the value of +.I first +or +.I count. +Otherwise, +.I count +outlines are freed beginning with the one specified by .I first. diff --git a/man/xkb/XkbFreeGeomOverlayKeys.man b/man/xkb/XkbFreeGeomOverlayKeys.man index 5f2314b5..fb61fce4 100644 --- a/man/xkb/XkbFreeGeomOverlayKeys.man +++ b/man/xkb/XkbFreeGeomOverlayKeys.man @@ -34,7 +34,7 @@ XkbFreeGeomOverlayKeys \- Free keys in an overlay row .SH ARGUMENTS .TP .I row -row in which keys should be freed +row in which keys should be freed .TP .I first first key to be freed @@ -46,36 +46,36 @@ number of keys to be freed True => all keys are freed .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -If -.I free_all -is True, all keys are freed regardless of the value of -.I first -and -.I count. -Otherwise, the number of keys specified by -.I count -are freed, beginning with the key specified by -.I first +If +.I free_all +is True, all keys are freed regardless of the value of +.I first +and +.I count. +Otherwise, the number of keys specified by +.I count +are freed, beginning with the key specified by +.I first in the specified row. .SH "RETURN VALUES" .TP 15 Success -The XkbFreeGeomOverlayKeys function returns Success if there are no allocation +The XkbFreeGeomOverlayKeys function returns Success if there are no allocation or argument errors. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbFreeGeomOverlayRows.man b/man/xkb/XkbFreeGeomOverlayRows.man index 3f700d18..5ef9a713 100644 --- a/man/xkb/XkbFreeGeomOverlayRows.man +++ b/man/xkb/XkbFreeGeomOverlayRows.man @@ -46,36 +46,36 @@ number of rows to be freed True => all rows are freed .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -If -.I free_all -is True, all rows are freed regardless of the value of -.I first -and -.I count. -Otherwise, the number of rows specified by -.I count -are freed, beginning with the row specified by -.I first +If +.I free_all +is True, all rows are freed regardless of the value of +.I first +and +.I count. +Otherwise, the number of rows specified by +.I count +are freed, beginning with the row specified by +.I first in the specified overlay. .SH "RETURN VALUES" .TP 15 Success -The XkbFreeGeomOverlayRows function returns Success if there are no allocation +The XkbFreeGeomOverlayRows function returns Success if there are no allocation or argument errors. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbFreeGeomOverlays.man b/man/xkb/XkbFreeGeomOverlays.man index f8bb578e..8a24b49e 100644 --- a/man/xkb/XkbFreeGeomOverlays.man +++ b/man/xkb/XkbFreeGeomOverlays.man @@ -34,7 +34,7 @@ XkbFreeGeomOverlays \- Free rows in a section .SH ARGUMENTS .TP .I section -section in which overlays should be freed +section in which overlays should be freed .TP .I first first overlay to be freed @@ -46,36 +46,36 @@ number of overlays to be freed True => all overlays are freed .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -If -.I free_all -is True, all overlays are freed regardless of the value of -.I first -and -.I count. -Otherwise, the number of overlays specified by -.I count -are freed, beginning with the overlay specified by -.I first +If +.I free_all +is True, all overlays are freed regardless of the value of +.I first +and +.I count. +Otherwise, the number of overlays specified by +.I count +are freed, beginning with the overlay specified by +.I first in the specified section. .SH "RETURN VALUES" .TP 15 Success -The XkbFreeGeomOverlays functions returns Success if there are no allocation or +The XkbFreeGeomOverlays functions returns Success if there are no allocation or argument errors. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbFreeGeomPoints.man b/man/xkb/XkbFreeGeomPoints.man index a270b905..20d65806 100644 --- a/man/xkb/XkbFreeGeomPoints.man +++ b/man/xkb/XkbFreeGeomPoints.man @@ -43,39 +43,39 @@ first point to be freed number of points to be freed .TP .I free_all -True => all points are freed +True => all points are freed .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -If -.I free_all -is True, all points are freed regardless of the value of ->i first -and -.I count. -Otherwise, the number of points specified by -.I count -are freed, beginning with the point specified by -.I first +If +.I free_all +is True, all points are freed regardless of the value of +>i first +and +.I count. +Otherwise, the number of points specified by +.I count +are freed, beginning with the point specified by +.I first in the specified outline. .SH "RETURN VALUES" .TP 15 Success -The XkbFreeGeomPoints function returns Success when there are no allocation or +The XkbFreeGeomPoints function returns Success when there are no allocation or argument errors. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbFreeGeomProperties.man b/man/xkb/XkbFreeGeomProperties.man index 91b84ef5..dd5793b3 100644 --- a/man/xkb/XkbFreeGeomProperties.man +++ b/man/xkb/XkbFreeGeomProperties.man @@ -37,44 +37,44 @@ XkbFreeGeomProperties \- Free geometry properties geometry in which properties should be freed .TP .I first -first property to be freed +first property to be freed .TP .I count -number of properties to be freed +number of properties to be freed .TP .I free_all True => all properties are freed .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -If -.I free_all -is True, all properties are freed regardless of the value of -.I first -or -.I count. -Otherwise, -.I count -properties are freed beginning with the one specified by +If +.I free_all +is True, all properties are freed regardless of the value of +.I first +or +.I count. +Otherwise, +.I count +properties are freed beginning with the one specified by .I first. .SH "RETURN VALUES" .TP 15 Success -The XkbFreeGeomProperties function returns Success when there are no allocation +The XkbFreeGeomProperties function returns Success when there are no allocation or argument errors. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbFreeGeomRows.man b/man/xkb/XkbFreeGeomRows.man index 4d38d22b..729ae661 100644 --- a/man/xkb/XkbFreeGeomRows.man +++ b/man/xkb/XkbFreeGeomRows.man @@ -34,7 +34,7 @@ XkbFreeGeomRows \- Free rows in a section .SH ARGUMENTS .TP .I section -section in which rows should be freed +section in which rows should be freed .TP .I first first row to be freed @@ -46,36 +46,36 @@ number of rows to be freed True => all rows are freed .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -If -.I free_all -is True, all rows are freed regardless of the value of -.I first -and -.I count. -Otherwise, the number of rows specified by -.I count -are freed, beginning with the row specified by -.I first +If +.I free_all +is True, all rows are freed regardless of the value of +.I first +and +.I count. +Otherwise, the number of rows specified by +.I count +are freed, beginning with the row specified by +.I first in the specified section. .SH "RETURN VALUES" .TP 15 Success -The XkbFreeGeomRows function returns Success when there are no allocation +The XkbFreeGeomRows function returns Success when there are no allocation or argument errors. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbFreeGeomSections.man b/man/xkb/XkbFreeGeomSections.man index 3c093526..015ecb2d 100644 --- a/man/xkb/XkbFreeGeomSections.man +++ b/man/xkb/XkbFreeGeomSections.man @@ -40,42 +40,42 @@ geometry in which sections should be freed first section to be freed .TP .I count -number of sections to be freed +number of sections to be freed .TP .I free_all True => all sections are freed .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -If -.I free_all -is True, all sections are freed regardless of the value of -.I first -and -.I count. -Otherwise, the number of sections specified by -.I count -are freed, beginning with the section specified by -.I first +If +.I free_all +is True, all sections are freed regardless of the value of +.I first +and +.I count. +Otherwise, the number of sections specified by +.I count +are freed, beginning with the section specified by +.I first in the specified geometry. .SH "RETURN VALUES" .TP 15 Success -The XkbFreeGeomSections function returns Success when there are no allocation +The XkbFreeGeomSections function returns Success when there are no allocation or argument errors. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbFreeGeomShapes.man b/man/xkb/XkbFreeGeomShapes.man index ee89ecd4..e308cb19 100644 --- a/man/xkb/XkbFreeGeomShapes.man +++ b/man/xkb/XkbFreeGeomShapes.man @@ -40,41 +40,41 @@ geometry in which shapes should be freed first shape to be freed .TP .I count -number of shapes to be freed +number of shapes to be freed .TP .I free_all True => all shapes are freed .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -If -.I free_all -is True, all shapes in the geometry are freed regardless of the values of -.I first -and -.I count. -Otherwise, -.I count -shapes are freed, beginning with the shape specified by +If +.I free_all +is True, all shapes in the geometry are freed regardless of the values of +.I first +and +.I count. +Otherwise, +.I count +shapes are freed, beginning with the shape specified by .I first. .SH "RETURN VALUES" .TP 15 Success -The XkbFreeGeomShapes function returns Success when there are no allocation +The XkbFreeGeomShapes function returns Success when there are no allocation or argument errors. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbFreeGeometry.man b/man/xkb/XkbFreeGeometry.man index 4447d416..8cb9f03f 100644 --- a/man/xkb/XkbFreeGeometry.man +++ b/man/xkb/XkbFreeGeometry.man @@ -36,33 +36,33 @@ XkbFreeGeometry \- Free an entire geometry geometry to be freed .TP .I which -mask of geometry components to be freed +mask of geometry components to be freed .TP .I free_all True => the entire geometry is freed .SH DESCRIPTION .LP -Xkb provides a number of functions to allocate and free subcomponents of a -keyboard geometry. Use these functions to create or modify keyboard geometries. -Note that these functions merely allocate space for the new element(s), and it -is up to you to fill in the values explicitly in your code. These allocation -functions increase -.I sz_* -but never touch -.I num_* -(unless there is an allocation failure, in which case they reset both -.I sz_* -and -.I num_* -to zero). These functions return Success if they succeed, BadAlloc if they are +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. -The values of -.I which -and -.I free_all +The values of +.I which +and +.I free_all determine how much of the specified geometry is freed. The valid values for -.I which +.I which are: .nf @@ -73,14 +73,14 @@ are: #define XkbGeomDoodadsMask (1<<4) #define XkbGeomKeyAliasesMask (1<<5) #define XkbGeomAllMask (0x3f) - -.fi -If -.I free_all -is True, the entire geometry is freed regardless of the value of -.I which. -Otherwise, the portions of the geometry specified by -.I which + +.fi +If +.I free_all +is True, the entire geometry is freed regardless of the value of +.I which. +Otherwise, the portions of the geometry specified by +.I which are freed. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbFreeIndicatorMaps.man b/man/xkb/XkbFreeIndicatorMaps.man index 09877975..36312d9e 100644 --- a/man/xkb/XkbFreeIndicatorMaps.man +++ b/man/xkb/XkbFreeIndicatorMaps.man @@ -21,8 +21,8 @@ .\" .TH XkbFreeIndicatorMaps __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbFreeIndicatorMaps \- Frees memory used by the -.I indicators +XkbFreeIndicatorMaps \- Frees memory used by the +.I indicators member of an XkbDescRec structure .SH SYNOPSIS .HP @@ -36,15 +36,15 @@ member of an XkbDescRec structure keyboard description structure .SH DESCRIPTION .LP -If the -.I indicators -member of the keyboard description record pointed to by -.I xkb -is not NULL, -.I XkbFreeIndicatorMaps -frees the memory associated with the -.I indicators -member of +If the +.I indicators +member of the keyboard description record pointed to by +.I xkb +is not NULL, +.I XkbFreeIndicatorMaps +frees the memory associated with the +.I indicators +member of .I xkb. If xkb is NULL, no operation is performed. diff --git a/man/xkb/XkbFreeKeyboard.man b/man/xkb/XkbFreeKeyboard.man index c68dcf7f..a3c8e9ef 100644 --- a/man/xkb/XkbFreeKeyboard.man +++ b/man/xkb/XkbFreeKeyboard.man @@ -21,7 +21,7 @@ .\" .TH XkbFreeKeyboard __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbFreeKeyboard \- Destroys either an entire XkbDescRec or just some of its +XkbFreeKeyboard \- Destroys either an entire XkbDescRec or just some of its members .SH SYNOPSIS .HP @@ -34,30 +34,30 @@ members .SH ARGUMENTS .TP .I xkb -keyboard description with components to free +keyboard description with components to free .TP .I which mask selecting components to free .TP .I free_all -True => free all components and +True => free all components and .I xkb .SH DESCRIPTION .LP -.I XkbFreeKeyboard -frees the components of -.I xkb -specified by -.I which -and sets the corresponding values to NULL. If +.I XkbFreeKeyboard +frees the components of +.I xkb +specified by +.I which +and sets the corresponding values to NULL. If .I -free_all -is True, -.I XkbFreeKeyboard -frees every non-NULL component of -.I xkb -and then frees the -.I xkb +free_all +is True, +.I XkbFreeKeyboard +frees every non-NULL component of +.I xkb +and then frees the +.I xkb structure itself. If kbd is NULL, no operation is performed. diff --git a/man/xkb/XkbFreeNames.man b/man/xkb/XkbFreeNames.man index a88daaed..2ba377b9 100644 --- a/man/xkb/XkbFreeNames.man +++ b/man/xkb/XkbFreeNames.man @@ -43,22 +43,22 @@ mask of names components to be freed True => XkbNamesRec structure itself should be freed .SH DESCRIPTION .LP -Do not free symbolic names structures directly using -.I free -or -.I XFree. -Use -.I XkbFreeNames +Do not free symbolic names structures directly using +.I free +or +.I XFree. +Use +.I XkbFreeNames instead. -The -.I which -parameter is the bitwise inclusive OR of the valid names mask bits defined in +The +.I which +parameter is the bitwise inclusive OR of the valid names mask bits defined in Table 1. -Xkb provides several functions that work with symbolic names. Each of these -functions uses a mask to specify individual fields of the structures described -above. These masks and their relationships to the fields in a keyboard +Xkb provides several functions that work with symbolic names. Each of these +functions uses a mask to specify individual fields of the structures described +above. These masks and their relationships to the fields in a keyboard description are shown in Table 1. .TS diff --git a/man/xkb/XkbFreeServerMap.man b/man/xkb/XkbFreeServerMap.man index b4c00eb8..01efbb2c 100644 --- a/man/xkb/XkbFreeServerMap.man +++ b/man/xkb/XkbFreeServerMap.man @@ -22,7 +22,7 @@ .\" .TH XkbFreeServerMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbFreeServerMap \- Free memory used by the server member of an XkbDescRec +XkbFreeServerMap \- Free memory used by the server member of an XkbDescRec structure .SH SYNOPSIS .HP @@ -44,28 +44,28 @@ mask identifying components of map to free True => free all server map components and server itself .SH DESCRIPTION .LP -The -.I XkbFreeServerMap -function frees the specified components of server map in the XkbDescRec -structure specified by the -.I xkb +The +.I XkbFreeServerMap +function frees the specified components of server map in the XkbDescRec +structure specified by the +.I xkb parameter and sets the corresponding structure component values to NULL. The -.I which parameter specifies a combination of the server map masks and is a -bitwise inclusive OR -of the masks listed in Table 1. If -.I free_all -is True, -.I which -is ignored and -.I XkbFreeServerMap -frees every non-NULL structure component in the server map, frees the -XkbServerMapRec structure -referenced by the -.I server -member of the -.I xkb -parameter, and sets the -.I server +.I which parameter specifies a combination of the server map masks and is a +bitwise inclusive OR +of the masks listed in Table 1. If +.I free_all +is True, +.I which +is ignored and +.I XkbFreeServerMap +frees every non-NULL structure component in the server map, frees the +XkbServerMapRec structure +referenced by the +.I server +member of the +.I xkb +parameter, and sets the +.I server member to NULL. .TS @@ -82,30 +82,30 @@ allocate the explicit field of the server map. T} .sp XkbKeyActionsMask T{ -The min_key_code and max_key_code fields of the xkb parameter are used to -allocate the key_acts -field of the server map. The count_acts parameter is used to allocate the acts -field of the +The min_key_code and max_key_code fields of the xkb parameter are used to +allocate the key_acts +field of the server map. The count_acts parameter is used to allocate the acts +field of the server map. T} .sp XkbKeyBehaviorsMask T{ -The min_key_code and max_key_code fields of the xkb parameter are used to -allocate the behaviors +The min_key_code and max_key_code fields of the xkb parameter are used to +allocate the behaviors field of the server map. T} .sp XkbVirtualModMapMask T{ -The min_key_code and max_key_code fields of the xkb parameter are used to -allocate the vmodmap +The min_key_code and max_key_code fields of the xkb parameter are used to +allocate the vmodmap field of the server map. T} .TE .SH STRUCTURES .LP -The complete description of an Xkb keyboard is given by an XkbDescRec. The -component +The complete description of an Xkb keyboard is given by an XkbDescRec. The +component structures in the XkbDescRec represent the major Xkb components. .nf @@ -125,27 +125,27 @@ typedef struct { } XkbDescRec, *XkbDescPtr; .fi -The -.I display -field points to an X display structure. The -.I flags field is private to the library: modifying -.I flags -may yield unpredictable results. The -.I device_spec -field specifies the device identifier of the keyboard input device, or -XkbUseCoreKeyboard, which specifies the core keyboard device. The +The +.I display +field points to an X display structure. The +.I flags field is private to the library: modifying +.I flags +may yield unpredictable results. The +.I device_spec +field specifies the device identifier of the keyboard input device, or +XkbUseCoreKeyboard, which specifies the core keyboard device. The .I min_key_code -and -.I max_key_code -fields specify the least and greatest keycode that can be returned by the -keyboard. +and +.I max_key_code +fields specify the least and greatest keycode that can be returned by the +keyboard. -Each structure component has a corresponding mask bit that is used in function -calls to -indicate that the structure should be manipulated in some manner, such as -allocating it -or freeing it. These masks and their relationships to the fields in the -XkbDescRec are +Each structure component has a corresponding mask bit that is used in function +calls to +indicate that the structure should be manipulated in some manner, such as +allocating it +or freeing it. These masks and their relationships to the fields in the +XkbDescRec are shown in Table 2. .TS @@ -166,8 +166,8 @@ XkbGeometryMask geom (1L<<6) XkbAllComponentsMask All Fields (0x7f) .TE -The Xkb server map contains the information the server needs to interpret key -events and is of +The Xkb server map contains the information the server needs to interpret key +events and is of type XkbServerMapRec: .nf diff --git a/man/xkb/XkbGetAutoRepeatRate.man b/man/xkb/XkbGetAutoRepeatRate.man index 3fb816b8..c6d422fb 100644 --- a/man/xkb/XkbGetAutoRepeatRate.man +++ b/man/xkb/XkbGetAutoRepeatRate.man @@ -21,7 +21,7 @@ .\" .TH XkbGetAutoRepeatRate __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetAutoRepeatRate \- Gets the current attributes of the RepeatKeys control +XkbGetAutoRepeatRate \- Gets the current attributes of the RepeatKeys control for a keyboard device .SH SYNOPSIS .HP @@ -47,38 +47,38 @@ backfilled with initial repeat delay, ms backfilled with subsequent repeat delay, ms .SH DESCRIPTION .LP -The core protocol allows only control over whether or not the entire keyboard or -individual keys should auto-repeat when held down. RepeatKeys is a boolean -control that extends this capability by adding control over the delay until a -key begins to repeat and the rate at which it repeats. RepeatKeys is coupled -with the core auto-repeat control: when RepeatKeys is enabled or disabled, the +The core protocol allows only control over whether or not the entire keyboard or +individual keys should auto-repeat when held down. RepeatKeys is a boolean +control that extends this capability by adding control over the delay until a +key begins to repeat and the rate at which it repeats. RepeatKeys is coupled +with the core auto-repeat control: when RepeatKeys is enabled or disabled, the core auto-repeat is enabled or disabled and vice versa. -Auto-repeating keys are controlled by two attributes. The first, -.I timeout, -is the delay after the initial press of an auto-repeating key and the first -generated repeat event. The second, -.I interval, -is the delay between all subsequent generated repeat events. As with all boolean -controls, configuring the attributes that determine how the control operates +Auto-repeating keys are controlled by two attributes. The first, +.I timeout, +is the delay after the initial press of an auto-repeating key and the first +generated repeat event. The second, +.I interval, +is the delay between all subsequent generated repeat events. As with all boolean +controls, configuring the attributes that determine how the control operates does not automatically enable the control as a whole. -.I XkbGetAutoRepeatRate -queries the server for the current values of the RepeatControls control -attributes, backfills -.I timeout_rtrn -and -.I interval_rtrn -with them, and returns True. If a compatible version of the Xkb extension is not -available in the server -.I XkbGetAutoRepeatRate +.I XkbGetAutoRepeatRate +queries the server for the current values of the RepeatControls control +attributes, backfills +.I timeout_rtrn +and +.I interval_rtrn +with them, and returns True. If a compatible version of the Xkb extension is not +available in the server +.I XkbGetAutoRepeatRate returns False. .SH "RETURN VALUES" .TP 15 True -The XkbGetAutoRepeatRate function returns True if a compatible version of the +The XkbGetAutoRepeatRate function returns True if a compatible version of the Xkb extension is available in the server. .TP 15 False -The XkbGetAutoRepeatRate function returns False if a compatible version of the +The XkbGetAutoRepeatRate function returns False if a compatible version of the Xkb extension is not available in the server. diff --git a/man/xkb/XkbGetAutoResetControls.man b/man/xkb/XkbGetAutoResetControls.man index 53e9a022..ee953b50 100644 --- a/man/xkb/XkbGetAutoResetControls.man +++ b/man/xkb/XkbGetAutoResetControls.man @@ -42,50 +42,50 @@ specifies which bits in auto_values are relevant 1 bit => corresponding control has auto-reset on .SH DESCRIPTION .LP -You can configure the boolean controls to automatically be enabled or -disabled when a program exits. This capability is controlled via two masks -maintained in the X server on a per-client basis. There is no client-side Xkb -data structure corresponding to these masks. Whenever the client exits for -any reason, any boolean controls specified in the -.I auto-reset mask -are set to the corresponding value from the -.I auto-reset values -mask. This makes it -possible for clients to "clean up after themselves" automatically, even if -abnormally terminated. The bits used in the masks correspond to the +You can configure the boolean controls to automatically be enabled or +disabled when a program exits. This capability is controlled via two masks +maintained in the X server on a per-client basis. There is no client-side Xkb +data structure corresponding to these masks. Whenever the client exits for +any reason, any boolean controls specified in the +.I auto-reset mask +are set to the corresponding value from the +.I auto-reset values +mask. This makes it +possible for clients to "clean up after themselves" automatically, even if +abnormally terminated. The bits used in the masks correspond to the EnabledControls control bits. -For example, a client that replaces the keyboard bell with some other audible -cue might want to turn off the AudibleBell control to prevent the server from -also generating a sound and avoid cacophony. If the client were to exit -without resetting the AudibleBell control, the user would be left without any -feedback at all. Setting AudibleBell in both the auto-reset mask and -auto-reset values guarantees that the audible bell will be turned back on +For example, a client that replaces the keyboard bell with some other audible +cue might want to turn off the AudibleBell control to prevent the server from +also generating a sound and avoid cacophony. If the client were to exit +without resetting the AudibleBell control, the user would be left without any +feedback at all. Setting AudibleBell in both the auto-reset mask and +auto-reset values guarantees that the audible bell will be turned back on when the client exits. -.I XkbGetAutoResetControls -backfills -.I auto_ctrls -and -.I auto_values -with the AutoReset control attributes for this particular client. It returns +.I XkbGetAutoResetControls +backfills +.I auto_ctrls +and +.I auto_values +with the AutoReset control attributes for this particular client. It returns True if successful, and False otherwise. .SH "RETURN VALUES" .TP 15 True -The -.I XkbGetAutoResetControls -function returns True when it successfully backfills -.I auto_ctrls -and -.I auto_values +The +.I XkbGetAutoResetControls +function returns True when it successfully backfills +.I auto_ctrls +and +.I auto_values with the AutoReset control attributes for this particular client. .TP 15 False -The -.I XkbGetAutoResetControls +The +.I XkbGetAutoResetControls function returns False when it does not successfully backfill -.I auto_ctrls -and -.I auto_values +.I auto_ctrls +and +.I auto_values with the AutoReset control attributes for this particular client. diff --git a/man/xkb/XkbGetCompatMap.man b/man/xkb/XkbGetCompatMap.man index 35cea885..2eed7c26 100644 --- a/man/xkb/XkbGetCompatMap.man +++ b/man/xkb/XkbGetCompatMap.man @@ -22,7 +22,7 @@ .\" .TH XkbGetCompatMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetCompatMap \- Fetch any combination of the current compatibility map +XkbGetCompatMap \- Fetch any combination of the current compatibility map components from the server .SH SYNOPSIS .HP @@ -44,26 +44,26 @@ mask of compatibility map components to fetch keyboard description where results placed .SH DESCRIPTION .LP -When another client modifies the compatibility map, you are notified if you have -selected for XkbCompatMapNotify events. -.I XkbGetCompatMap -is particularly useful when you receive an event of this type, as it allows you -to update your program's version of the compatibility map to match the modified -version now in the server. If your program is dealing with multiple servers and -needs to configure them all in a similar manner, the updated compatibility map -may be used to reconfigure other servers. +When another client modifies the compatibility map, you are notified if you have +selected for XkbCompatMapNotify events. +.I XkbGetCompatMap +is particularly useful when you receive an event of this type, as it allows you +to update your program's version of the compatibility map to match the modified +version now in the server. If your program is dealing with multiple servers and +needs to configure them all in a similar manner, the updated compatibility map +may be used to reconfigure other servers. -.I XkbGetCompatMap -fetches the components of the compatibility map specified in -.I which -from the server specified by -.I display -and places them in the -.I compat -structure of the keyboard description -.I xkb. -Valid values for -.I which +.I XkbGetCompatMap +fetches the components of the compatibility map specified in +.I which +from the server specified by +.I display +and places them in the +.I compat +structure of the keyboard description +.I xkb. +Valid values for +.I which are an inclusive OR of the values shown in Table 1. .TS @@ -79,29 +79,29 @@ XkbGroupCompatMask (1<<1) Group maps XkbAllCompatMask (0x3) All compatibility map components .TE -If no compatibility map structure is allocated in -.I xkb -upon entry, -.I XkbGetCompatMap -allocates one. If one already exists, its contents are overwritten with the +If no compatibility map structure is allocated in +.I xkb +upon entry, +.I XkbGetCompatMap +allocates one. If one already exists, its contents are overwritten with the returned results. -.I XkbGetCompatMap +.I XkbGetCompatMap fetches compatibility map information for the device specified by the -.I device_spec -field of -.I xkb. -Unless you have specifically modified this field, it is the default keyboard -device. -.I XkbGetCompatMap -returns Success if successful, BadAlloc if it is unable to obtain necessary -storage for either the return values or work space, BadMatch if the -.I dpy -field of the -.I xkb -argument is non-NULL and does not match the -.I display -argument, and BadLength under certain conditions caused by server or Xkb +.I device_spec +field of +.I xkb. +Unless you have specifically modified this field, it is the default keyboard +device. +.I XkbGetCompatMap +returns Success if successful, BadAlloc if it is unable to obtain necessary +storage for either the return values or work space, BadMatch if the +.I dpy +field of the +.I xkb +argument is non-NULL and does not match the +.I display +argument, and BadLength under certain conditions caused by server or Xkb implementation errors. .SH DIAGNOSTICS .TP 15 @@ -112,5 +112,5 @@ Unable to allocate storage The length of a request is shorter or longer than that required to minimally contain the arguments .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid diff --git a/man/xkb/XkbGetControls.man b/man/xkb/XkbGetControls.man index 3dd7f71b..b7839984 100644 --- a/man/xkb/XkbGetControls.man +++ b/man/xkb/XkbGetControls.man @@ -43,37 +43,37 @@ mask of controls requested keyboard description for controls information .SH DESCRIPTION .LP -.I XkbGetControls -queries the server for the requested control information, waits for a reply, and -then copies the server's values for the requested information into the -.I ctrls -structure of the -.I xkb -argument. Only those components specified by the -.I which -parameter are copied. Valid values for -.I which +.I XkbGetControls +queries the server for the requested control information, waits for a reply, and +then copies the server's values for the requested information into the +.I ctrls +structure of the +.I xkb +argument. Only those components specified by the +.I which +parameter are copied. Valid values for +.I which are any combination of the masks listed in Table 1 that have "ok" in the -.I which +.I which column. -Table 1 shows the actual values for the individual mask bits used to select -controls for -modification and to enable and disable the control. Note that the same mask bit -is used to -specify general modifications to the parameters used to configure the control -(which), and to -enable and disable the control (enabled_ctrls). The anomalies in Table 1 (no -"ok" in column) -are for controls that have no configurable attributes; and for controls that are -not boolean +Table 1 shows the actual values for the individual mask bits used to select +controls for +modification and to enable and disable the control. Note that the same mask bit +is used to +specify general modifications to the parameters used to configure the control +(which), and to +enable and disable the control (enabled_ctrls). The anomalies in Table 1 (no +"ok" in column) +are for controls that have no configurable attributes; and for controls that are +not boolean controls and therefore cannot be enabled or disabled. .TS c s s s l l l l l l l l -l l l l. +l l l l. Table 1 Controls Mask Bits _ Mask Bit which or enabled Value @@ -97,54 +97,54 @@ XkbInternalModsMask ok (1L<<28) XkbIgnoreLockModsMask ok (1L<<29) XkbPerKeyRepeatMask ok (1L<<30) XkbControlsEnabledMask ok (1L<<31) -XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | +XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | XkbAccessXFeedbackMask) -XkbAllBooleanCtrlsMask ok (0x00001FFF) +XkbAllBooleanCtrlsMask ok (0x00001FFF) XkbAllControlsMask ok (0xF8001FFF) .TE -If -.I xkb->ctrls -is NULL, -.I XkbGetControls -allocates and initializes it before obtaining the values specified by -.I which. -If -.I xkb->ctrls -is not NULL, -.I XkbGetControls -modifies only those portions of -.I xkb->ctrls -corresponding to the values specified by +If +.I xkb->ctrls +is NULL, +.I XkbGetControls +allocates and initializes it before obtaining the values specified by +.I which. +If +.I xkb->ctrls +is not NULL, +.I XkbGetControls +modifies only those portions of +.I xkb->ctrls +corresponding to the values specified by .I which. -.I XkbGetControls -returns Success if successful; otherwise, it returns BadAlloc if it cannot -obtain sufficient storage, BadMatch if -.I xkb -is NULL or -.I which +.I XkbGetControls +returns Success if successful; otherwise, it returns BadAlloc if it cannot +obtain sufficient storage, BadMatch if +.I xkb +is NULL or +.I which is empty, or BadImplementation. -To free the -.I ctrls -member of a keyboard description, use +To free the +.I ctrls +member of a keyboard description, use .I XkbFreeControls. -The -.I num_groups -field in the -.I ctrls -structure is always filled in by -.I XkbGetControls, -regardless of which bits are selected by +The +.I num_groups +field in the +.I ctrls +structure is always filled in by +.I XkbGetControls, +regardless of which bits are selected by .I which. .SH "RETURN VALUES" .TP 15 Success -The -.I XkbGetControls +The +.I XkbGetControls function returns Success if successful. .SH DIAGNOSTICS .TP 15 @@ -155,7 +155,7 @@ Unable to allocate storage Invalid reply from server .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +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" diff --git a/man/xkb/XkbGetControlsChanges.man b/man/xkb/XkbGetControlsChanges.man index 48a79551..4d50abd1 100644 --- a/man/xkb/XkbGetControlsChanges.man +++ b/man/xkb/XkbGetControlsChanges.man @@ -22,7 +22,7 @@ .\" .TH XkbGetControlsChanges __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetControlsChanges \- Updates a local copy of a keyboard description with the +XkbGetControlsChanges \- Updates a local copy of a keyboard description with the changes previously noted by one or more calls to XkbNoteControlsChanges .SH SYNOPSIS .HP @@ -44,42 +44,42 @@ xkb->ctrls will be updated indicates which parts of xkb->ctrls to update .SH DESCRIPTION .LP -Whenever a field in the controls structure changes in the server's keyboard -description, the server sends an XkbControlsNotify event to all interested +Whenever a field in the controls structure changes in the server's keyboard +description, the server sends an XkbControlsNotify event to all interested clients.To receive XkbControlsNotify events under all possible conditions, use -.I XkbSelectEvents -and pass XkbControlsNotifyMask in both -.I bits_to_change -and +.I XkbSelectEvents +and pass XkbControlsNotifyMask in both +.I bits_to_change +and .I values_for_bits. To receive XkbControlsNotify events only under certain conditions, use -.I XkbSelectEventDetails -using XkbControlsNotify as the -.I event_type -and specifying the desired state changes in -.I bits_to_change -and -.I values_for_bits +.I XkbSelectEventDetails +using XkbControlsNotify 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 1. -Table 1 shows the actual values for the individual mask bits used to select -controls for -modification and to enable and disable the control. Note that the same mask bit -is used to -specify general modifications to the parameters used to configure the control -(which), and to -enable and disable the control (enabled_ctrls). The anomalies in the table (no -"ok" in column) -are for controls that have no configurable attributes; and for controls that are -not boolean +Table 1 shows the actual values for the individual mask bits used to select +controls for +modification and to enable and disable the control. Note that the same mask bit +is used to +specify general modifications to the parameters used to configure the control +(which), and to +enable and disable the control (enabled_ctrls). The anomalies in the table (no +"ok" in column) +are for controls that have no configurable attributes; and for controls that are +not boolean controls and therefore cannot be enabled or disabled. .TS c s s s l l l l l l l l -l l l l. +l l l l. Table 1 Controls Mask Bits _ Mask Bit which or enabled Value @@ -103,89 +103,89 @@ XkbInternalModsMask ok (1L<<28) XkbIgnoreLockModsMask ok (1L<<29) XkbPerKeyRepeatMask ok (1L<<30) XkbControlsEnabledMask ok (1L<<31) -XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | +XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | XkbAccessXFeedbackMask) -XkbAllBooleanCtrlsMask ok (0x00001FFF) +XkbAllBooleanCtrlsMask ok (0x00001FFF) XkbAllControlsMask ok (0xF8001FFF) .TE -The -.I changed_ctrls -field specifies the controls components that have changed and consists of bits -taken from the masks defined in Table 10.7 with "ok" in the -.I changed_ctrls +The +.I changed_ctrls +field specifies the controls components that have changed and consists of bits +taken from the masks defined in Table 10.7 with "ok" in the +.I changed_ctrls column. -The controls currently enabled in the server are reported in the -.I enabled_ctrls -field. If any controls were just enabled or disabled (that is, the contents of -the -.I enabled_ctrls -field changed), they are flagged in the -.I enabled_ctrl_changes -field. The valid bits for these fields are the masks listed in Table 10.7 with -"ok" in the -.I enabled_ctrls -column. The -.I num_groups -field reports the number of groups bound to the key belonging to the most number +The controls currently enabled in the server are reported in the +.I enabled_ctrls +field. If any controls were just enabled or disabled (that is, the contents of +the +.I enabled_ctrls +field changed), they are flagged in the +.I enabled_ctrl_changes +field. The valid bits for these fields are the masks listed in Table 10.7 with +"ok" in the +.I enabled_ctrls +column. The +.I num_groups +field reports the number of groups bound to the key belonging to the most number of groups and is automatically updated when the keyboard mapping changes. -If the change was caused by a request from a client, the -.I keycode -and -.I event_type -fields are set to zero and the -.I req_major -and -.I req_minor -fields identify the request. The +If the change was caused by a request from a client, the +.I keycode +and +.I event_type +fields are set to zero and the +.I req_major +and +.I req_minor +fields identify the request. The .I req_major value is the same as the major extension opcode. Otherwise, -.I event_type -is set to the type of event that caused the change (one of KeyPress, KeyRelease, -DeviceKeyPress, DeviceKeyRelease, ButtonPress or ButtonRelease), and -.I req_major -and -.I req_minor -are undefined. If -.I event_type -is KeyPress, KeyRelease, DeviceKeyPress, or DeviceKeyRelease, the -.I keycode -field is set to the key that caused the change. If -.I event_type -is ButtonPress or ButtonRelease, -.I keycode -contains the button number. +.I event_type +is set to the type of event that caused the change (one of KeyPress, KeyRelease, +DeviceKeyPress, DeviceKeyRelease, ButtonPress or ButtonRelease), and +.I req_major +and +.I req_minor +are undefined. If +.I event_type +is KeyPress, KeyRelease, DeviceKeyPress, or DeviceKeyRelease, the +.I keycode +field is set to the key that caused the change. If +.I event_type +is ButtonPress or ButtonRelease, +.I keycode +contains the button number. -When a client receives an XkbControlsNotify event, it can note the changes in a -changes structure using +When a client receives an XkbControlsNotify event, it can note the changes in a +changes structure using .I XkbNoteControlsChanges. -.I XkbGetControlsChanges -examines the -.I changes -parameter, queries the server for the necessary information, and copies the -results into the -.I xkb->ctrls -keyboard description. If the -.I ctrls -field of -.I xkb -is NULL, -.I XkbGetControlsChanges -allocates and initializes it. To free the -.I ctrls -field, use +.I XkbGetControlsChanges +examines the +.I changes +parameter, queries the server for the necessary information, and copies the +results into the +.I xkb->ctrls +keyboard description. If the +.I ctrls +field of +.I xkb +is NULL, +.I XkbGetControlsChanges +allocates and initializes it. To free the +.I ctrls +field, use XkbFreeControls. -.I XkbGetControlsChanges -returns Success if successful and can generate BadAlloc, BadImplementation, and +.I XkbGetControlsChanges +returns Success if successful and can generate BadAlloc, BadImplementation, and BadMatch errors. .SH "RETURN VALUES" .TP 15 Success -The -.I XkbGetControlsChanges +The +.I XkbGetControlsChanges function returns Success if the query of the server was successful. .SH STRUCTURES .LP @@ -219,7 +219,7 @@ Unable to allocate storage Invalid reply from server .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +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 XkbFreeControls (__libmansuffix__), diff --git a/man/xkb/XkbGetDeviceButtonActions.man b/man/xkb/XkbGetDeviceButtonActions.man index 2bdb1c65..eae350c8 100644 --- a/man/xkb/XkbGetDeviceButtonActions.man +++ b/man/xkb/XkbGetDeviceButtonActions.man @@ -22,7 +22,7 @@ .\" .TH XkbGetDeviceButtonActions __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetDeviceButtonActions \- Query the button actions associated with an X Input +XkbGetDeviceButtonActions \- Query the button actions associated with an X Input Extension device .SH SYNOPSIS .HP @@ -52,49 +52,49 @@ number of first button for which info is desired number of buttons for which info is desired .SH DESCRIPTION .LP -.I XkbGetDeviceButtonActions -queries the server for the desired button information for the device indicated -by the -.I device_spec -field of -.I device_info -and waits for a reply. If successful, -.I XkbGetDeviceButtonActions -backfills the button actions -.I (btn_acts -field of -.I device_info) -for only the requested buttons, updates the -.I name, type, supported, -and -.I unsupported +.I XkbGetDeviceButtonActions +queries the server for the desired button information for the device indicated +by the +.I device_spec +field of +.I device_info +and waits for a reply. If successful, +.I XkbGetDeviceButtonActions +backfills the button actions +.I (btn_acts +field of +.I device_info) +for only the requested buttons, updates the +.I name, type, supported, +and +.I unsupported fields, and returns Success. -.I all_buttons, first_button -and -.I num_buttons +.I all_buttons, first_button +and +.I num_buttons specify the device buttons for which actions should be returned. Setting -.I all_buttons -to True requests actions for all device buttons; if -.I all_buttons -is False, -.I first_button -and -.I num_buttons +.I all_buttons +to True requests actions for all device buttons; if +.I all_buttons +is False, +.I first_button +and +.I num_buttons specify a range of buttons for which actions are requested. -If a compatible version of Xkb is not available in the server or the Xkb -extension has not been properly initialized, -.I XkbGetDeviceButtonActions -returns BadAccess. If allocation errors occur, a BadAlloc status is returned. If -the specified device -.I (device_info->device_spec) -is invalid, a BadKeyboard status is returned. If the device has no buttons, a -BadMatch status is returned. If -.I first_button -and -.I num_buttons -specify illegal buttons, a BadValue status is returned. +If a compatible version of Xkb is not available in the server or the Xkb +extension has not been properly initialized, +.I XkbGetDeviceButtonActions +returns BadAccess. If allocation errors occur, a BadAlloc status is returned. If +the specified device +.I (device_info->device_spec) +is invalid, a BadKeyboard status is returned. If the device has no buttons, a +BadMatch status is returned. If +.I first_button +and +.I num_buttons +specify illegal buttons, a BadValue status is returned. .SH DIAGNOSTICS .TP 15 .B BadAccess @@ -107,7 +107,7 @@ Unable to allocate storage The device specified was not a valid core or input extension device .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid .TP 15 .B BadValue diff --git a/man/xkb/XkbGetDeviceInfo.man b/man/xkb/XkbGetDeviceInfo.man index b79ae6ad..0aec8dcf 100644 --- a/man/xkb/XkbGetDeviceInfo.man +++ b/man/xkb/XkbGetDeviceInfo.man @@ -22,8 +22,8 @@ .\" .TH XkbGetDeviceInfo __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetDeviceInfo \- Determine whether the X server allows Xkb access to particular capabilities of input devices other than -the core X keyboard, or to determine the status of indicator maps, indicator names or button actions on a non-KeyClass +XkbGetDeviceInfo \- Determine whether the X server allows Xkb access to particular capabilities of input devices other than +the core X keyboard, or to determine the status of indicator maps, indicator names or button actions on a non-KeyClass extension device .SH SYNOPSIS .HP @@ -53,55 +53,55 @@ feedback class for indicator requests feedback ID for indicator requests .SH DESCRIPTION .LP -To determine whether the X server allows Xkb access to particular capabilities of input devices other than the core X -keyboard, or to determine the status of indicator maps, indicator names or button actions on a non-KeyClass extension -device, use -.I XkbGetDeviceInfo. +To determine whether the X server allows Xkb access to particular capabilities of input devices other than the core X +keyboard, or to determine the status of indicator maps, indicator names or button actions on a non-KeyClass extension +device, use +.I XkbGetDeviceInfo. -.I XkbGetDeviceInfo -returns information about the input device specified by -.I device_spec. -Unlike the -.I device_spec -parameter of most Xkb functions, -.I device_spec -does not need to be a keyboard device. It must, however, indicate either the core keyboard or a valid X Input Extension -device. +.I XkbGetDeviceInfo +returns information about the input device specified by +.I device_spec. +Unlike the +.I device_spec +parameter of most Xkb functions, +.I device_spec +does not need to be a keyboard device. It must, however, indicate either the core keyboard or a valid X Input Extension +device. -The -.I which -parameter is a mask specifying optional information to be returned. It is an inclusive OR of one or more of the values from +The +.I which +parameter is a mask specifying optional information to be returned. It is an inclusive OR of one or more of the values from Table 1 and causes the returned XkbDeviceInfoRec to contain values for the corresponding fields specified in the table. .nf - Table 1 XkbDeviceInfoRec Mask Bits + Table 1 XkbDeviceInfoRec Mask Bits ____________________________________________________________________________________ Name XkbDeviceInfoRec Value Capability If Set - Fields Effected + Fields Effected ____________________________________________________________________________________ XkbXI_KeyboardsMask (1L <<0) Clients can use all Xkb requests and events - with KeyClass devices + with KeyClass devices supported by the input device extension. -XkbXI_ButtonActionsMask num_btns (1L <<1) Clients can assign key - btn_acts actions to buttons +XkbXI_ButtonActionsMask num_btns (1L <<1) Clients can assign key + btn_acts actions to buttons non-KeyClass input extension devices. - + XkbXI_IndicatorNamesMask leds->names (1L <<2) Clients can assign names to indicators on non-KeyClass input extension devices. - + XkbXI_IndicatorMapsMask leds->maps (1L <<3) Clients can assign indicator maps to - indicators on + indicators on non-KeyClass input extension devices. -XkbXI_IndicatorStateMask leds->state (1L <<4) Clients can request +XkbXI_IndicatorStateMask leds->state (1L <<4) Clients can request the status of indicators on non-KeyClass input extension devices. @@ -114,7 +114,7 @@ XkbXI_UnsupportedFeaturesMask unsupported (1L <<15) XkbXI_AllDeviceFeaturesMask Those selected (0x1e) XkbXI_IndicatorsMask | by Value Column XkbSI_ButtonActionsMask - masks + masks XkbXI_AllFeaturesMask Those selected (0x1f) XkbSI_AllDeviceFeaturesMask | by Value Column XkbSI_KeyboardsMask @@ -125,103 +125,103 @@ XkbXI_AllDetailsMask Those selected (0x801f) XkbXI_AllFeaturesMask | masks .fi -The XkbDeviceInfoRec returned by -.I XkbGetDeviceInfo -always has values for -.I name -(may be a null string, ""), -.I type, supported, unsupported, has_own_state, dflt_kbd_fd, -and -.I dflt_kbd_fb. -Other fields are filled in as specified by +The XkbDeviceInfoRec returned by +.I XkbGetDeviceInfo +always has values for +.I name +(may be a null string, ""), +.I type, supported, unsupported, has_own_state, dflt_kbd_fd, +and +.I dflt_kbd_fb. +Other fields are filled in as specified by .I which. -Upon return, the -.I supported -field will be set to the inclusive OR of zero or more bits from Table 1; each bit set indicates an optional Xkb extension +Upon return, the +.I supported +field will be set to the inclusive OR of zero or more bits from Table 1; each bit set indicates an optional Xkb extension device feature supported by the server implementation, and a client may modify the associated behavior. -If the XkbButtonActionsMask bit is set in -.I which, -the XkbDeviceInfoRec returned will have the button actions -.I (btn_acts +If the XkbButtonActionsMask bit is set in +.I which, +the XkbDeviceInfoRec returned will have the button actions +.I (btn_acts field) filled in for all buttons. -If -.I which +If +.I which includes one of the bits in XkbXI_IndicatorsMask, the feedback class of the indicators must be specified in -.I ind_class, -and the feedback ID of the indicators must be specified in -.I ind_id. -If the request does not include any of the bits in XkbXI_IndicatorsMask, the -.I ind_class -and -.I ind_id -parameters are ignored. The class and ID can be obtained via the input device extension -.I XListInputDevices -request. +.I ind_class, +and the feedback ID of the indicators must be specified in +.I ind_id. +If the request does not include any of the bits in XkbXI_IndicatorsMask, the +.I ind_class +and +.I ind_id +parameters are ignored. The class and ID can be obtained via the input device extension +.I XListInputDevices +request. -If any of the XkbXI_IndicatorsMask bits are set in -.I which, -the XkbDeviceInfoRec returned will have filled in the portions of the -.I leds -structure corresponding to the indicator feedback identified by -.I ind_class -and -.I ind_id. -The -.I leds -vector of the XkbDeviceInfoRec is allocated if necessary and -.I sz_leds -and -.I num_leds -filled in. The -.I led_class, led_id -and -.I phys_indicators -fields of the -.I leds -entry corresponding to -.I ind_class -and -.I ind_id -are always filled in. If -.I which -contains XkbXI_IndicatorNamesMask, the -.I names_present -and -.I names -fields of the -.I leds -structure corresponding to -.I ind_class -and -.I ind_id -are returned. If -.I which -contains XkbXI_IndicatorStateMask, the corresponding -.I state -field is updated. If -.I which -contains XkbXI_IndicatorMapsMask, the -.I maps_present -and -.I maps +If any of the XkbXI_IndicatorsMask bits are set in +.I which, +the XkbDeviceInfoRec returned will have filled in the portions of the +.I leds +structure corresponding to the indicator feedback identified by +.I ind_class +and +.I ind_id. +The +.I leds +vector of the XkbDeviceInfoRec is allocated if necessary and +.I sz_leds +and +.I num_leds +filled in. The +.I led_class, led_id +and +.I phys_indicators +fields of the +.I leds +entry corresponding to +.I ind_class +and +.I ind_id +are always filled in. If +.I which +contains XkbXI_IndicatorNamesMask, the +.I names_present +and +.I names +fields of the +.I leds +structure corresponding to +.I ind_class +and +.I ind_id +are returned. If +.I which +contains XkbXI_IndicatorStateMask, the corresponding +.I state +field is updated. If +.I which +contains XkbXI_IndicatorMapsMask, the +.I maps_present +and +.I maps fields are updated. -Xkb provides convenience functions to request subsets of the information available via -.I XkbGetDeviceInfo. -These convenience functions mirror some of the mask bits. The functions all take an XkbDeviceInfoPtr as an input argument -and operate on the X Input Extension device specified by the -.I device_spec -field of the structure. Only the parts of the structure indicated in the function description are updated. The -XkbDeviceInfoRec structure used in the function call can be obtained by calling -.I XkbGetDeviceInfo -or can be allocated by calling +Xkb provides convenience functions to request subsets of the information available via +.I XkbGetDeviceInfo. +These convenience functions mirror some of the mask bits. The functions all take an XkbDeviceInfoPtr as an input argument +and operate on the X Input Extension device specified by the +.I device_spec +field of the structure. Only the parts of the structure indicated in the function description are updated. The +XkbDeviceInfoRec structure used in the function call can be obtained by calling +.I XkbGetDeviceInfo +or can be allocated by calling .I XkbAllocDeviceInfo. .SH STRUCTURES .LP -Information about X Input Extension devices is transferred between a client program and the Xkb extension in an +Information about X Input Extension devices is transferred between a client program and the Xkb extension in an XkbDeviceInfoRec structure: .nf @@ -240,7 +240,7 @@ typedef struct { unsigned short dflt_led_fb; /\&* input extension ID of default indicator feedback */ XkbDeviceLedInfoPtr leds; /\&* LED descriptions */ } XkbDeviceInfoRec, *XkbDeviceInfoPtr; - + .fi .SH "SEE ALSO" .BR XkbAllocDeviceInfo (__libmansuffix__), diff --git a/man/xkb/XkbGetDeviceInfoChanges.man b/man/xkb/XkbGetDeviceInfoChanges.man index ab681002..4d0ffbb1 100644 --- a/man/xkb/XkbGetDeviceInfoChanges.man +++ b/man/xkb/XkbGetDeviceInfoChanges.man @@ -22,8 +22,8 @@ .\" .TH XkbGetDeviceInfoChanges __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetDeviceInfoChanges \- Query the changes that have occurred in the button -actions or indicator names and indicator maps associated with an input extension +XkbGetDeviceInfoChanges \- Query the changes that have occurred in the button +actions or indicator names and indicator maps associated with an input extension device .SH SYNOPSIS .HP @@ -45,18 +45,18 @@ structure to update with results contains notes of changes that have occurred .SH DESCRIPTION .LP -The -.I changes->changed -field indicates which attributes of the device specified in -.I changes->device -have changed. The parameters describing the changes are contained in the other -fields of -.I changes. XkbGetDeviceInfoChanges -uses that information to call -.I XkbGetDeviceInfo -to obtain the current status of those attributes that have changed. It then -updates the local description of the device in -.I device_info +The +.I changes->changed +field indicates which attributes of the device specified in +.I changes->device +have changed. The parameters describing the changes are contained in the other +fields of +.I changes. XkbGetDeviceInfoChanges +uses that information to call +.I XkbGetDeviceInfo +to obtain the current status of those attributes that have changed. It then +updates the local description of the device in +.I device_info with the new information. .SH "SEE ALSO" .BR XkbGetDeviceInfo (__libmansuffix__) diff --git a/man/xkb/XkbGetDeviceLedInfo.man b/man/xkb/XkbGetDeviceLedInfo.man index 704ca019..37c86b12 100644 --- a/man/xkb/XkbGetDeviceLedInfo.man +++ b/man/xkb/XkbGetDeviceLedInfo.man @@ -22,7 +22,7 @@ .\" .TH XkbGetDeviceLedInfo __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetDeviceLedInfo \- Query the indicator names, maps, and state associated +XkbGetDeviceLedInfo \- Query the indicator names, maps, and state associated with an LED feedback of an input extension device .SH SYNOPSIS .HP @@ -52,91 +52,91 @@ LED feedback ID assigned by input extension mask indicating desired information .SH DESCRIPTION .LP -.I XkbGetDeviceLedInfo +.I XkbGetDeviceLedInfo queries the server for the desired LED information for the feedback specified by -.I led_class -and -.I led_id -for the X input extension device indicated by -.I device_spec->device_info -and waits for a reply. If successful, -.I XkbGetDeviceLedInfo -backfills the relevant fields of -.I device_info -as determined by -.I which -with the results and returns Success. Valid values for -.I which -are the inclusive OR of any of XkbXI_IndicatorNamesMask, +.I led_class +and +.I led_id +for the X input extension device indicated by +.I device_spec->device_info +and waits for a reply. If successful, +.I XkbGetDeviceLedInfo +backfills the relevant fields of +.I device_info +as determined by +.I which +with the results and returns Success. Valid values for +.I which +are the inclusive OR of any of XkbXI_IndicatorNamesMask, XkbXI_IndicatorMapsMask, and XkbXI_IndicatorStateMask. -The fields of -.I device_info -that are filled in when this request succeeds are -.I name, type, supported, -and -.I unsupported, -and portions of the -.I leds -structure corresponding to -.I led_class -and -.I led_id -as indicated by the bits set in -.I which. -The -.I device_info->leds -vector is allocated if necessary and -.I sz_leds -and -.I num_leds -filled in. The -.I led_class, led_id -and -.I phys_indicators -fields of the -.I device_info->leds -entry corresponding to -.I led_class -and -.I led_id -are always filled in. +The fields of +.I device_info +that are filled in when this request succeeds are +.I name, type, supported, +and +.I unsupported, +and portions of the +.I leds +structure corresponding to +.I led_class +and +.I led_id +as indicated by the bits set in +.I which. +The +.I device_info->leds +vector is allocated if necessary and +.I sz_leds +and +.I num_leds +filled in. The +.I led_class, led_id +and +.I phys_indicators +fields of the +.I device_info->leds +entry corresponding to +.I led_class +and +.I led_id +are always filled in. -If -.I which -contains XkbXI_IndicatorNamesMask, the -.I names_present -and -.I names -fields of the -.I device_info->leds -structure corresponding to -.I led_class -and -.I led_id -are updated, if -.I which -contains XkbXI_IndicatorStateMask, the corresponding -.I state -field is updated, and if -.I which -contains XkbXI_IndicatorMapsMask, the -.I maps_present -and -.I maps +If +.I which +contains XkbXI_IndicatorNamesMask, the +.I names_present +and +.I names +fields of the +.I device_info->leds +structure corresponding to +.I led_class +and +.I led_id +are updated, if +.I which +contains XkbXI_IndicatorStateMask, the corresponding +.I state +field is updated, and if +.I which +contains XkbXI_IndicatorMapsMask, the +.I maps_present +and +.I maps fields are updated. -If a compatible version of Xkb is not available in the server or the Xkb -extension has not been properly initialized, -.I XkbGetDeviceLedInfo -returns BadAccess. If allocation errors occur, a BadAlloc status is returned. If -the device has no indicators, a BadMatch error is returned. If -.I ledClass -or -.I ledID -have illegal values, a BadValue error is returned. If they have legal values but -do not specify a feedback that contains LEDs and is associated with the -specified device, a BadMatch error is returned. +If a compatible version of Xkb is not available in the server or the Xkb +extension has not been properly initialized, +.I XkbGetDeviceLedInfo +returns BadAccess. If allocation errors occur, a BadAlloc status is returned. If +the device has no indicators, a BadMatch error is returned. If +.I ledClass +or +.I ledID +have illegal values, a BadValue error is returned. If they have legal values but +do not specify a feedback that contains LEDs and is associated with the +specified device, a BadMatch error is returned. .SH DIAGNOSTICS .TP 15 .B BadAccess @@ -146,7 +146,7 @@ The Xkb extension has not been properly initialized Unable to allocate storage .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid .TP 15 .B BadValue diff --git a/man/xkb/XkbGetGeometry.man b/man/xkb/XkbGetGeometry.man index 38624c33..7126ea7d 100644 --- a/man/xkb/XkbGetGeometry.man +++ b/man/xkb/XkbGetGeometry.man @@ -21,7 +21,7 @@ .\" .TH XkbGetGeometry __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetGeometry \- Loads a keyboard geometry if you already have the keyboard +XkbGetGeometry \- Loads a keyboard geometry if you already have the keyboard description .SH SYNOPSIS .HP @@ -36,20 +36,20 @@ description connection to the X server .TP .I xkb -keyboard description that contains the ID for the keyboard and into which the +keyboard description that contains the ID for the keyboard and into which the geometry should be loaded .SH DESCRIPTION .LP You can load a keyboard geometry as part of the keyboard description returned by -.I XkbGetKeyboard. -However, if a keyboard description has been previously loaded, you can instead -obtain the geometry by calling the -.I XkbGetGeometry. -In this case, the geometry returned is the one associated with the keyboard +.I XkbGetKeyboard. +However, if a keyboard description has been previously loaded, you can instead +obtain the geometry by calling the +.I XkbGetGeometry. +In this case, the geometry returned is the one associated with the keyboard whose device ID is contained in the keyboard description. -.I XkbGetGeometry -can return BadValue, BadImplementation, BadName, BadAlloc, or BadLength errors +.I XkbGetGeometry +can return BadValue, BadImplementation, BadName, BadAlloc, or BadLength errors or Success if it succeeds. .SH DIAGNOSTICS .TP 15 @@ -60,7 +60,7 @@ Unable to allocate storage Invalid reply from server .TP 15 .B BadLength -The length of a request is shorter or longer than that required to minimally +The length of a request is shorter or longer than that required to minimally contain the arguments .TP 15 .B BadName diff --git a/man/xkb/XkbGetIndicatorMap.man b/man/xkb/XkbGetIndicatorMap.man index 52e40bc0..63642bb4 100644 --- a/man/xkb/XkbGetIndicatorMap.man +++ b/man/xkb/XkbGetIndicatorMap.man @@ -21,7 +21,7 @@ .\" .TH XkbGetIndicatorMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetIndicatorMap \- Gets the map for one or more indicators, using a mask to +XkbGetIndicatorMap \- Gets the map for one or more indicators, using a mask to specify the indicators .SH SYNOPSIS .HP @@ -43,32 +43,32 @@ mask of indicators for which maps should be returned keyboard description to be updated .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 +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 +.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 XkbGetIndicatorMap -obtains the maps from the server for only those indicators specified by the -.I which -mask and copies the values into the keyboard description specified by -.I desc. -If the -.I indicators -field of the -.I desc -parameter is NULL, -.I XkbGetIndicatorMap +.I XkbGetIndicatorMap +obtains the maps from the server for only those indicators specified by the +.I which +mask and copies the values into the keyboard description specified by +.I desc. +If the +.I indicators +field of the +.I desc +parameter is NULL, +.I XkbGetIndicatorMap allocates and initializes it. -To free the indicator maps, use +To free the indicator maps, use .I XkbFreeIndicatorMaps. .SH DIAGNOSTICS .TP 15 @@ -76,7 +76,7 @@ To free the indicator maps, use Unable to allocate storage .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid .TP 15 .B BadImplementation diff --git a/man/xkb/XkbGetIndicatorState.man b/man/xkb/XkbGetIndicatorState.man index 1e6030b4..0ce51304 100644 --- a/man/xkb/XkbGetIndicatorState.man +++ b/man/xkb/XkbGetIndicatorState.man @@ -42,37 +42,37 @@ device ID, or XkbUseCoreKbd 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 +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 +.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. +.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 +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 +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__) diff --git a/man/xkb/XkbGetKeyActions.man b/man/xkb/XkbGetKeyActions.man index 3c1076ed..0fad9b04 100644 --- a/man/xkb/XkbGetKeyActions.man +++ b/man/xkb/XkbGetKeyActions.man @@ -21,7 +21,7 @@ .\" .TH XkbGetKeyActions __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetKeyActions \- Update the actions (the key_acts array) for a subset of the +XkbGetKeyActions \- Update the actions (the key_acts array) for a subset of the keys in a keyboard description .SH SYNOPSIS .HP @@ -47,39 +47,39 @@ number of keys desired pointer to keyboard description where result is stored .SH DESCRIPTION .LP -.I XkbGetKeyActions -sends a request to the server to obtain the actions for -.I num -keys on the keyboard starting with key -.I first. -It waits for a reply and returns the actions in the -.I server->key_acts -field of -.I xkb. -If successful, -.I XkbGetKeyActions -returns Success. The -.I xkb +.I XkbGetKeyActions +sends a request to the server to obtain the actions for +.I num +keys on the keyboard starting with key +.I first. +It waits for a reply and returns the actions in the +.I server->key_acts +field of +.I xkb. +If successful, +.I XkbGetKeyActions +returns Success. The +.I xkb parameter must be a pointer to a valid Xkb keyboard description. -If the -.I server -map, in the -.I xkb -parameter, has not been allocated, -.I XkbGetKeyActions +If the +.I server +map, in the +.I xkb +parameter, has not been allocated, +.I XkbGetKeyActions allocates and initializes it before obtaining the actions. -If the server does not have a compatible version of Xkb, or the Xkb extension -has not been properly initialized, -.I XkbGetKeyActions -returns BadAccess. If -.I num -is less than 1 or greater than XkbMaxKeyCount, -.I XkbGetKeyActions -returns BadValue. If any allocation errors occur, -.I XkbGetKeyActions -returns BadAlloc. +If the server does not have a compatible version of Xkb, or the Xkb extension +has not been properly initialized, +.I XkbGetKeyActions +returns BadAccess. If +.I num +is less than 1 or greater than XkbMaxKeyCount, +.I XkbGetKeyActions +returns BadValue. If any allocation errors occur, +.I XkbGetKeyActions +returns BadAlloc. .SH DIAGNOSTICS .TP 15 .B BadAccess diff --git a/man/xkb/XkbGetKeyBehaviors.man b/man/xkb/XkbGetKeyBehaviors.man index 02522d4c..1de0c0ba 100644 --- a/man/xkb/XkbGetKeyBehaviors.man +++ b/man/xkb/XkbGetKeyBehaviors.man @@ -47,37 +47,37 @@ number of keys for which behaviors are desired Xkb description to contain the result .SH DESCRIPTION .LP -.I XkbGetKeyBehaviors -sends a request to the server to obtain the behaviors for -.I num -keys on the keyboard starting with the key whose keycode is -.I first. -It waits for a reply and returns the behaviors in the -.I server->behaviors -field of -.I xkb. -If successful, -.I XkbGetKeyBehaviors +.I XkbGetKeyBehaviors +sends a request to the server to obtain the behaviors for +.I num +keys on the keyboard starting with the key whose keycode is +.I first. +It waits for a reply and returns the behaviors in the +.I server->behaviors +field of +.I xkb. +If successful, +.I XkbGetKeyBehaviors returns Success. -If the -.I server -map in the -.I xkb -parameter has not been allocated, -.I XkbGetKeyBehaviors +If the +.I server +map in the +.I xkb +parameter has not been allocated, +.I XkbGetKeyBehaviors allocates and initializes it before obtaining the actions. -If the server does not have a compatible version of Xkb, or the Xkb extension has not been -properly initialized, -.I XkbGetKeyBehaviors -returns BadAccess. If -.I num -is less than 1 or greater than XkbMaxKeyCount, -.I XkbGetKeyBehaviors -returns BadValue. If any allocation errors occur, -.I XkbGetKeyBehaviors -returns BadAlloc. +If the server does not have a compatible version of Xkb, or the Xkb extension has not been +properly initialized, +.I XkbGetKeyBehaviors +returns BadAccess. If +.I num +is less than 1 or greater than XkbMaxKeyCount, +.I XkbGetKeyBehaviors +returns BadValue. If any allocation errors occur, +.I XkbGetKeyBehaviors +returns BadAlloc. .SH DIAGNOSTICS .TP 15 .B BadAccess diff --git a/man/xkb/XkbGetKeyExplicitComponents.man b/man/xkb/XkbGetKeyExplicitComponents.man index c9be4c75..48a8dac3 100644 --- a/man/xkb/XkbGetKeyExplicitComponents.man +++ b/man/xkb/XkbGetKeyExplicitComponents.man @@ -22,7 +22,7 @@ .\" .TH XkbGetKeyExplicitComponents __libmansuffix__ "20 Jul 1999" "X v11 Rel. 6.4" "XKB FUNCTION" .SH NAME -XkbGetKeyExplicitComponents \- Obtain the explicit components (the explicit +XkbGetKeyExplicitComponents \- Obtain the explicit components (the explicit array) for a subset of the keys in a keyboard description .SH SYNOPSIS .HP @@ -48,24 +48,24 @@ number of keys for which to get explicit info Xkb description in which to put results .SH DESCRIPTION .LP -Whenever a client remaps the keyboard using core protocol requests, Xkb examines -the map to determine likely default values for the components that cannot be -specified using the core protocol (see Core Keyboard Mapping to Xkb Keyboard -Mapping Transformation for more information on how Xkb chooses the default +Whenever a client remaps the keyboard using core protocol requests, Xkb examines +the map to determine likely default values for the components that cannot be +specified using the core protocol (see Core Keyboard Mapping to Xkb Keyboard +Mapping Transformation for more information on how Xkb chooses the default values). -DO THE FOUR PAGES OF "CORE KEYBOARD MAPPING TO XKB KEYBOARD MAPPING +DO THE FOUR PAGES OF "CORE KEYBOARD MAPPING TO XKB KEYBOARD MAPPING TRANSFORMATION" NEED TO BE ADDED HERE? -This automatic remapping might replace definitions explicitly requested by an -application, so the Xkb keyboard description defines an explicit components mask -for each key. Any aspects of the automatic remapping listed in the explicit +This automatic remapping might replace definitions explicitly requested by an +application, so the Xkb keyboard description defines an explicit components mask +for each key. Any aspects of the automatic remapping listed in the explicit components mask for a key are not changed by the automatic keyboard mapping. - -The explicit components masks are held in the -.I explicit -field of the server map, which is an array indexed by keycode. Each entry in -this array is a mask that is a bitwise inclusive OR of the values shown in Table + +The explicit components masks are held in the +.I explicit +field of the server map, which is an array indexed by keycode. Each entry in +this array is a mask that is a bitwise inclusive OR of the values shown in Table 1. .TS c s s @@ -88,55 +88,55 @@ ExplicitKeyType4 (1<<3) T{ Automatic determination of the key type associated with Group4. T} ExplicitInterpret (1<<4) T{ -Application of any of the fields of a symbol interpretation to the key in +Application of any of the fields of a symbol interpretation to the key in question. T} ExplicitAutoRepeat (1<<5) T{ -Automatic determination of auto-repeat status for the key, as specified in a +Automatic determination of auto-repeat status for the key, as specified in a symbol interpretation. T} ExplicitBehavior (1<<6) T{ -Automatic assignment of the XkbKB_Lock behavior to the key, if the +Automatic assignment of the XkbKB_Lock behavior to the key, if the XkbSI_LockingKey flag is set in a symbol interpretation. T} ExplicitVModMap (1<<7) T{ -Automatic determination of the virtual modifier map for the key based on the +Automatic determination of the virtual modifier map for the key based on the actions assigned to the key and the symbol interpretations that match the key. T} .TE -.I XkbGetKeyExplicitComponents -sends a request to the server to obtain the explicit components for -.I num -keys on the keyboard starting with key -.I first. -It waits for a reply and returns the explicit components in the -.I server->explicit -array of -.I xkb. -If successful, -.I XkbGetKeyExplicitComponents -returns Success. The -.I xkb +.I XkbGetKeyExplicitComponents +sends a request to the server to obtain the explicit components for +.I num +keys on the keyboard starting with key +.I first. +It waits for a reply and returns the explicit components in the +.I server->explicit +array of +.I xkb. +If successful, +.I XkbGetKeyExplicitComponents +returns Success. The +.I xkb parameter must be a pointer to a valid Xkb keyboard description. -If the -.I server -map in the -.I xkb -parameter has not been allocated, -.I XkbGetKeyExplicitComponents +If the +.I server +map in the +.I xkb +parameter has not been allocated, +.I XkbGetKeyExplicitComponents allocates and initializes it before obtaining the actions. -If the server does not have a compatible version of Xkb, or the Xkb extension -has not been properly initialized, -.I XkbGetKeyExplicitComponents -returns BadMatch. If -.I num -is less than 1 or greater than XkbMaxKeyCount, -.I XkbGetKeyExplicitComponents -returns BadValue. If any allocation errors occur, -.I XkbGetKeyExplicitComponents +If the server does not have a compatible version of Xkb, or the Xkb extension +has not been properly initialized, +.I XkbGetKeyExplicitComponents +returns BadMatch. If +.I num +is less than 1 or greater than XkbMaxKeyCount, +.I XkbGetKeyExplicitComponents +returns BadValue. If any allocation errors occur, +.I XkbGetKeyExplicitComponents returns BadAlloc. .SH DIAGNOSTICS .TP 15 @@ -144,7 +144,7 @@ returns BadAlloc. Unable to allocate storage .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid .TP 15 .B BadValue diff --git a/man/xkb/XkbGetKeyModifierMap.man b/man/xkb/XkbGetKeyModifierMap.man index 5a999364..b3a83d6a 100644 --- a/man/xkb/XkbGetKeyModifierMap.man +++ b/man/xkb/XkbGetKeyModifierMap.man @@ -21,7 +21,7 @@ .\" .TH XkbGetKeyModifierMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetKeyModifierMap \- Update the modifier map for one or more of the keys in a +XkbGetKeyModifierMap \- Update the modifier map for one or more of the keys in a keyboard description .SH SYNOPSIS .HP @@ -47,42 +47,42 @@ number of keys for which information is desired keyboard description to update .SH DESCRIPTION .LP -The -.I modmap -entry of the client map is an array, indexed by keycode, specifying the real -modifiers bound to a key. Each entry is a mask composed of a bitwise inclusive -OR of the legal real modifiers: ShiftMask, LockMask, ControlMask, Mod1Mask, -Mod2Mask, Mod3Mask, Mod4Mask, and Mod5Mask. If a bit is set in a -.I modmap +The +.I modmap +entry of the client map is an array, indexed by keycode, specifying the real +modifiers bound to a key. Each entry is a mask composed of a bitwise inclusive +OR of the legal real modifiers: ShiftMask, LockMask, ControlMask, Mod1Mask, +Mod2Mask, Mod3Mask, Mod4Mask, and Mod5Mask. If a bit is set in a +.I modmap entry, the corresponding key is bound to that modifier. -Pressing or releasing the key bound to a modifier changes the modifier set and -unset state. The particular manner in which the modifier set and unset state +Pressing or releasing the key bound to a modifier changes the modifier set and +unset state. The particular manner in which the modifier set and unset state changes is determined by the behavior and actions assigned to the key. -.I XkbGetKeyModifierMap -sends a request to the server for the modifier mappings for -.I num -keys starting with the key whose keycode is -.I first. -It waits for a reply and places the results in the -.I xkb->map->modmap -array. If successful, -.I XkbGetKeyModifier +.I XkbGetKeyModifierMap +sends a request to the server for the modifier mappings for +.I num +keys starting with the key whose keycode is +.I first. +It waits for a reply and places the results in the +.I xkb->map->modmap +array. If successful, +.I XkbGetKeyModifier returns Success. - -If the map component of the -.I xkb -parameter has not been allocated, -.I XkbGetKeyModifierMap -allocates and initializes it. -If a compatible version of Xkb is not available in the server or the Xkb -extension has not been properly initialized, -.I XkbGetKeySyms -returns BadAccess. If any allocation errors occur while obtaining the modifier -map, -.I XkbGetKeyModifierMap +If the map component of the +.I xkb +parameter has not been allocated, +.I XkbGetKeyModifierMap +allocates and initializes it. + +If a compatible version of Xkb is not available in the server or the Xkb +extension has not been properly initialized, +.I XkbGetKeySyms +returns BadAccess. If any allocation errors occur while obtaining the modifier +map, +.I XkbGetKeyModifierMap returns BadAlloc. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbGetKeySyms.man b/man/xkb/XkbGetKeySyms.man index 59efd6ad..aa7a1d3b 100644 --- a/man/xkb/XkbGetKeySyms.man +++ b/man/xkb/XkbGetKeySyms.man @@ -21,7 +21,7 @@ .\" .TH XkbGetKeySyms __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetKeySyms \- Obtain the symbols for a subset of the keys in a keyboard +XkbGetKeySyms \- Obtain the symbols for a subset of the keys in a keyboard description .SH SYNOPSIS .HP @@ -41,52 +41,52 @@ connection to X server keycode of first key to get .TP .I num -number of keycodes for which syms desired +number of keycodes for which syms desired .TP .I xkb Xkb description to be updated .SH DESCRIPTION .LP -.I XkbGetKeySyms -sends a request to the server to obtain the set of keysyms bound to -.I num -keys starting with the key whose keycode is -.I first. -It waits for a reply and returns the keysyms in the -.I map.syms -field of -.I xkb. -If successful, -.I XkbGetKeySyms -returns Success. The -.I xkb +.I XkbGetKeySyms +sends a request to the server to obtain the set of keysyms bound to +.I num +keys starting with the key whose keycode is +.I first. +It waits for a reply and returns the keysyms in the +.I map.syms +field of +.I xkb. +If successful, +.I XkbGetKeySyms +returns Success. The +.I xkb parameter must be a pointer to a valid Xkb keyboard description. -If the client -.I map -in the xkb parameter has not been allocated, -.I XkbGetKeySyms -allocates and initializes it before obtaining the symbols. +If the client +.I map +in the xkb parameter has not been allocated, +.I XkbGetKeySyms +allocates and initializes it before obtaining the symbols. -If a compatible version of Xkb is not available in the server or the Xkb -extension has not been properly initialized, -.I XkbGetKeySyms -returns BadAccess. If -.I num -is less than 1 or greater than XkbMaxKeyCount, -.I XkbGetKeySyms -returns BadValue. If any allocation errors occur, -.I XkbGetKeySyms +If a compatible version of Xkb is not available in the server or the Xkb +extension has not been properly initialized, +.I XkbGetKeySyms +returns BadAccess. If +.I num +is less than 1 or greater than XkbMaxKeyCount, +.I XkbGetKeySyms +returns BadValue. If any allocation errors occur, +.I XkbGetKeySyms returns BadAlloc. .SH "RETURN VALUES" .TP 15 Success -The -.I XkbGetKeySyms -function returns Success if it gets a reply to a request to the server to obtain the set of keysyms bound to -.I num -keys starting with the key whose keycode is -.I first. +The +.I XkbGetKeySyms +function returns Success if it gets a reply to a request to the server to obtain the set of keysyms bound to +.I num +keys starting with the key whose keycode is +.I first. .SH DIAGNOSTICS .TP 15 .B BadAccess diff --git a/man/xkb/XkbGetKeyTypes.man b/man/xkb/XkbGetKeyTypes.man index d904ac6f..08443c5b 100644 --- a/man/xkb/XkbGetKeyTypes.man +++ b/man/xkb/XkbGetKeyTypes.man @@ -22,7 +22,7 @@ .\" .TH XkbGetKeyTypes __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetKeyTypes \- Obtain the list of available key types in the server's +XkbGetKeyTypes \- Obtain the list of available key types in the server's keyboard mapping .SH SYNOPSIS .HP @@ -48,26 +48,26 @@ number of key types to be returned keyboard description containing client map to update .SH DESCRIPTION .LP -.I XkbGetKeyTypes -queries the server for the desired types, waits for a reply, and returns the -desired types in the -.I xkb->map->types. +.I XkbGetKeyTypes +queries the server for the desired types, waits for a reply, and returns the +desired types in the +.I xkb->map->types. If successful, it returns Success. -.I XkbGetKeyTypes -returns BadAccess if the Xkb extension has not been properly initialized and -BadValue if the combination of -.I first -and -.I num +.I XkbGetKeyTypes +returns BadAccess if the Xkb extension has not been properly initialized and +BadValue if the combination of +.I first +and +.I num results in numbers out of valid range. -.B NOTE: -.I XkbGetKeyTypes -is used to obtain descriptions of the key types themselves, not the key types -bound to individual keys. To obtain the key types bound to an individual key, -refer to the -.I key_sym_map +.B NOTE: +.I XkbGetKeyTypes +is used to obtain descriptions of the key types themselves, not the key types +bound to individual keys. To obtain the key types bound to an individual key, +refer to the +.I key_sym_map field of the client map. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbGetKeyVirtualModMap.man b/man/xkb/XkbGetKeyVirtualModMap.man index e82b84c7..db9d8747 100644 --- a/man/xkb/XkbGetKeyVirtualModMap.man +++ b/man/xkb/XkbGetKeyVirtualModMap.man @@ -21,7 +21,7 @@ .\" .TH XkbGetKeyVirtualModMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetKeyVirtualModMap \- Obtain the virtual modifier map (the vmodmap array) +XkbGetKeyVirtualModMap \- Obtain the virtual modifier map (the vmodmap array) for a subset of the keys in a keyboard description .SH SYNOPSIS .HP @@ -47,56 +47,56 @@ number of keys for which virtual mod maps are desired Xkb description where results will be placed .SH DESCRIPTION .LP -.I XkbGetKeyVirutalModmap -sends a request to the server to obtain the virtual modifier mappings for -.I num -keys on the keyboard starting with key -.I first. +.I XkbGetKeyVirutalModmap +sends a request to the server to obtain the virtual modifier mappings for +.I num +keys on the keyboard starting with key +.I first. It waits for a reply and returns the virtual modifier mappings in the -.I server->vmodmap -array of -.I xkb. -If successful, -.I XkbGetKeyVirtualModMap -returns Success. The -.I xkb +.I server->vmodmap +array of +.I xkb. +If successful, +.I XkbGetKeyVirtualModMap +returns Success. The +.I xkb parameter must be a pointer to a valid Xkb keyboard description. -If the -.I server -map in the -.I xkb -parameter has not been allocated, -.I XkbGetKeyVirtualModMap +If the +.I server +map in the +.I xkb +parameter has not been allocated, +.I XkbGetKeyVirtualModMap allocates and initializes it before obtaining the virtual modifier mappings. -If the server does not have a compatible version of Xkb, or the Xkb extension -has not been properly initialized, -.I XkbGetKeyVirtualModMap -returns BadMatch. If -.I num -is less than 1 or greater than XkbMaxKeyCount, -.I XkbGetKeyVirtualModMap -returns BadValue. If any allocation errors occur, -.I XkbGetKeyVirtualModMap +If the server does not have a compatible version of Xkb, or the Xkb extension +has not been properly initialized, +.I XkbGetKeyVirtualModMap +returns BadMatch. If +.I num +is less than 1 or greater than XkbMaxKeyCount, +.I XkbGetKeyVirtualModMap +returns BadValue. If any allocation errors occur, +.I XkbGetKeyVirtualModMap returns BadAlloc. .SH "RETURN VALUES" .TP 15 Success -The -.I XkbGetKeyVirutalModmap -function returns Success following a successful reply from the server to obtain -the virtual modifier mappings for -.I num -keys on the keyboard starting with key -.I first. +The +.I XkbGetKeyVirutalModmap +function returns Success following a successful reply from the server to obtain +the virtual modifier mappings for +.I num +keys on the keyboard starting with key +.I first. .SH DIAGNOSTICS .TP 15 .B BadAlloc Unable to allocate storage .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid .TP 15 .B BadValue diff --git a/man/xkb/XkbGetKeyboard.man b/man/xkb/XkbGetKeyboard.man index c5daf5b0..8cf2d6c9 100644 --- a/man/xkb/XkbGetKeyboard.man +++ b/man/xkb/XkbGetKeyboard.man @@ -22,7 +22,7 @@ .\" .TH XkbGetKeyboard __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetKeyboard \- Retrieves one or more components of a keyboard device +XkbGetKeyboard \- Retrieves one or more components of a keyboard device description .SH SYNOPSIS .HP @@ -35,7 +35,7 @@ description .SH ARGUMENTS .TP .I display -connection to the X server +connection to the X server .TP .I device_spec device ID, or XkbUseCoreKbd @@ -48,14 +48,14 @@ determines events to be selected / deselected .SH DESCRIPTION .LP .B XkbGetKeyboard -allocates and returns a pointer to a keyboard description. It queries the server for those -components specified in the -.I which -parameter for device -.I device_spec -and copies the results to the XkbDescRec it allocated. The remaining fields in the keyboard -description are set to NULL. The valid masks for -.I which +allocates and returns a pointer to a keyboard description. It queries the server for those +components specified in the +.I which +parameter for device +.I device_spec +and copies the results to the XkbDescRec it allocated. The remaining fields in the keyboard +description are set to NULL. The valid masks for +.I which are those listed in Table 1. .TS @@ -81,9 +81,9 @@ is used to read the current description for one or more components of a keyboard .BR XkbGetKeyboardByName (__libmansuffix__) as follows: -.I XkbGetKeyboardByName(dpy, device_spec, -NULL, -.I which, which, +.I XkbGetKeyboardByName(dpy, device_spec, +NULL, +.I which, which, False). .LP If successful, diff --git a/man/xkb/XkbGetKeyboardByName.man b/man/xkb/XkbGetKeyboardByName.man index 4eabdb7a..632167fd 100644 --- a/man/xkb/XkbGetKeyboardByName.man +++ b/man/xkb/XkbGetKeyboardByName.man @@ -22,8 +22,8 @@ .\" .TH XkbGetKeyboardByName __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetKeyboardByName \- Build a new keyboard description from a set of named -components, and to optionally have the server use the resulting description to +XkbGetKeyboardByName \- Build a new keyboard description from a set of named +components, and to optionally have the server use the resulting description to replace an active one .SH SYNOPSIS .HP @@ -54,140 +54,140 @@ desired structures in returned record mandatory structures in returned record .TP .I load -True => load into +True => load into .I device_spec .SH DESCRIPTION .LP -A client may request that the server fetch one or more components from its -database and use those components to build a new server keyboard description. -The new keyboard description may be built from scratch, or it may be built -starting with the current keyboard description for a particular device. Once the -keyboard description is built, all or part of it may be returned to the client. -The parts returned to the client need not include all of the parts used to build -the description. At the time it requests the server to build a new keyboard -description, a client may also request that the server use the new description -internally to replace the current keyboard description for a specific device, in +A client may request that the server fetch one or more components from its +database and use those components to build a new server keyboard description. +The new keyboard description may be built from scratch, or it may be built +starting with the current keyboard description for a particular device. Once the +keyboard description is built, all or part of it may be returned to the client. +The parts returned to the client need not include all of the parts used to build +the description. At the time it requests the server to build a new keyboard +description, a client may also request that the server use the new description +internally to replace the current keyboard description for a specific device, in which case the behavior of the device changes accordingly. -To build a new keyboard description from a set of named components, and to -optionally have the server use the resulting description to replace an active -one, use +To build a new keyboard description from a set of named components, and to +optionally have the server use the resulting description to replace an active +one, use .I XkbGetKeyboardByName. -.I names -contains a set of expressions describing the keyboard components the -server should use to build the new keyboard description. -.I want -and -.I need -are bit fields describing the parts of the resulting keyboard description that +.I names +contains a set of expressions describing the keyboard components the +server should use to build the new keyboard description. +.I want +and +.I need +are bit fields describing the parts of the resulting keyboard description that should be present in the returned XkbDescRec. - -The individual fields in -.I names -are -.I component expressions + +The individual fields in +.I names +are +.I component expressions composed of keyboard component names (no wildcarding as may be used in -.I XkbListComponents), -the special component name symbol `%', and the special operator characters `+' +.I XkbListComponents), +the special component name symbol `%', and the special operator characters `+' and `|'. A component expression is parsed left to right, as follows: .IP \(bu 5 -The special component name "computed" may be used in keycodes component -expressions and refers to a component consisting of a set of keycodes computed +The special component name "computed" may be used in keycodes component +expressions and refers to a component consisting of a set of keycodes computed automatically by the server as needed. .IP \(bu 5 -The special component name "canonical" may be used in types component -expressions and refers to a partial component defining the four standard key +The special component name "canonical" may be used in types component +expressions and refers to a partial component defining the four standard key types: ALPHABETIC, ONE_LEVEL, TWO_LEVEL, and KEYPAD. .IP \(bu 5 -The special component name `%' refers to the keyboard description for the device -specified in device_spec or the keymap names component. If a keymap names -component is specified that does not begin with `+' or `|' and does not contain -`%', then `%' refers to the description generated by the keymap names component. +The special component name `%' refers to the keyboard description for the device +specified in device_spec or the keymap names component. If a keymap names +component is specified that does not begin with `+' or `|' and does not contain +`%', then `%' refers to the description generated by the keymap names component. Otherwise, it refers to the keyboard description for device_spec. .IP \(bu 5 -The `+' operator specifies that the following component should override the -currently assembled description; any definitions that are present in both +The `+' operator specifies that the following component should override the +currently assembled description; any definitions that are present in both components are taken from the second. .IP \(bu 5 -The `|' operator specifies that the next specified component should augment the -currently assembled description; any definitions that are present in both +The `|' operator specifies that the next specified component should augment the +currently assembled description; any definitions that are present in both components are taken from the first. .IP \(bu 5 If the component expression begins with an operator, a leading `%' is implied. .IP \(bu 5 -If any unknown or illegal characters appear anywhere in the expression, the +If any unknown or illegal characters appear anywhere in the expression, the entire expression is invalid and is ignored. -For example, if -.I names->symbols -contained the expression "+de", it specifies that -the default member of the "de" class of symbols should be applied to the current -keyboard mapping, overriding any existing definitions (it could also be written +For example, if +.I names->symbols +contained the expression "+de", it specifies that +the default member of the "de" class of symbols should be applied to the current +keyboard mapping, overriding any existing definitions (it could also be written "+de(default)"). -Here is a slightly more involved example: the expression -"acme(ascii)+de(basic)|iso9995-3" constructs a German (de) mapping for the ASCII -keyboard supplied by the "acme" vendor. The new definition begins with the -symbols for the ASCII keyboard for Acme -.I (acme(ascii)), -overrides them with definitions for the basic German keyboard -.I (de(basic)), -and then applies the definitions from the default iso9995-3 keyboard -.I (iso9995-3) -to any undefined keys or groups of keys (part three of the iso9995 standard -defines a common set of bindings for the secondary group, but allows national -layouts to override those definitions where necessary). +Here is a slightly more involved example: the expression +"acme(ascii)+de(basic)|iso9995-3" constructs a German (de) mapping for the ASCII +keyboard supplied by the "acme" vendor. The new definition begins with the +symbols for the ASCII keyboard for Acme +.I (acme(ascii)), +overrides them with definitions for the basic German keyboard +.I (de(basic)), +and then applies the definitions from the default iso9995-3 keyboard +.I (iso9995-3) +to any undefined keys or groups of keys (part three of the iso9995 standard +defines a common set of bindings for the secondary group, but allows national +layouts to override those definitions where necessary). -.B NOTE -The interpretation of the above expression components (acme, ascii, de, basic, +.B NOTE +The interpretation of the above expression components (acme, ascii, de, basic, iso9995-3) is not defined by Xkb; only the operations and their ordering are. -Note that the presence of a keymap -.I names -component that does not contain `%' (either explicit or implied by virtue of an -expression starting with an operator) indicates a description that is -independent of the keyboard description for the device specified in -.I device_spec. -The same is true of requests in which the keymap names component is empty and -all five other names components contain expressions void of references to `%'. -Requests of this form allow you to deal with keyboard definitions independent of +Note that the presence of a keymap +.I names +component that does not contain `%' (either explicit or implied by virtue of an +expression starting with an operator) indicates a description that is +independent of the keyboard description for the device specified in +.I device_spec. +The same is true of requests in which the keymap names component is empty and +all five other names components contain expressions void of references to `%'. +Requests of this form allow you to deal with keyboard definitions independent of any actual device. -The server parses all non-NULL fields in -.I names -and uses them to build a keyboard description. However, before parsing the -expressions in -.I names, -the server ORs the bits in -.I want -and -.I need -together and examines the result in relationship to the expressions in -.I names. -Table 1 identifies the components that are required for each of the possible -bits in -.I want -or -.I need. -If a required component has not been specified in the -.I names structure (the corresponding field is NULL), the server substitutes the -expression "%", resulting in the component values being taken from -.I device_spec. -In addition, if -.I load -is True, the server modifies -.I names -if necessary (again using a "%" entry) to ensure all of the following fields are -non-NULL: -.I types, keycodes, symbols, -and +The server parses all non-NULL fields in +.I names +and uses them to build a keyboard description. However, before parsing the +expressions in +.I names, +the server ORs the bits in +.I want +and +.I need +together and examines the result in relationship to the expressions in +.I names. +Table 1 identifies the components that are required for each of the possible +bits in +.I want +or +.I need. +If a required component has not been specified in the +.I names structure (the corresponding field is NULL), the server substitutes the +expression "%", resulting in the component values being taken from +.I device_spec. +In addition, if +.I load +is True, the server modifies +.I names +if necessary (again using a "%" entry) to ensure all of the following fields are +non-NULL: +.I types, keycodes, symbols, +and .I compat. .bp .TS c s s -l l l. +l l l. Table 1 Want and Need Mask Bits and Required Names Components _ want or need mask bit Required names Components value @@ -204,57 +204,57 @@ XkbGBN_OtherNamesMask Types + Symbols + Keycodes + Compat + Geometry (1L<<7) XkbGBN_AllComponentsMask (0xff) .TE -.I need -specifies a set of keyboard components that the server must be able to -resolve in order for -.I XkbGetKeyboardByName -to succeed; if any of the components specified in -.I need -cannot be successfully resolved, -.I XkbGetKeyboardByName +.I need +specifies a set of keyboard components that the server must be able to +resolve in order for +.I XkbGetKeyboardByName +to succeed; if any of the components specified in +.I need +cannot be successfully resolved, +.I XkbGetKeyboardByName fails. -.I want -specifies a set of keyboard components that the server should attempt to -resolve, but that are not mandatory. If the server is unable to resolve any of -these components, -.I XkbGetKeyboardByName -still succeeds. Bits specified in -.I want -that are also specified in -.I need -have no effect in the context of +.I want +specifies a set of keyboard components that the server should attempt to +resolve, but that are not mandatory. If the server is unable to resolve any of +these components, +.I XkbGetKeyboardByName +still succeeds. Bits specified in +.I want +that are also specified in +.I need +have no effect in the context of .I want. -If -.I load -is True, the server updates its keyboard description for -.I device_spec -to match the result of the keyboard description just built. If load is False, -the -server's description for device -.I device_spec -is not updated. In all cases, the parts specified by -.I want -and -.I need +If +.I load +is True, the server updates its keyboard description for +.I device_spec +to match the result of the keyboard description just built. If load is False, +the +server's description for device +.I device_spec +is not updated. In all cases, the parts specified by +.I want +and +.I need from the just-built keyboard description are returned. -The -.I names -structure in an XkbDescRec keyboard description record contains one field for -each of the five component types used to build a keyboard description. When a -keyboard description is built from a set of database components, the -corresponding fields in this -.I names -structure are set to match the expressions used to build the component. +The +.I names +structure in an XkbDescRec keyboard description record contains one field for +each of the five component types used to build a keyboard description. When a +keyboard description is built from a set of database components, the +corresponding fields in this +.I names +structure are set to match the expressions used to build the component. Building a New Keyboard Description from the Server Database -The information returned to the client in the XkbDescRec is essentially the -result of a series of calls to extract information from a fictitious device -whose description matches the one just built. The calls corresponding to each of -the mask bits are summarized in Table 2, together with the XkbDescRec +The information returned to the client in the XkbDescRec is essentially the +result of a series of calls to extract information from a fictitious device +whose description matches the one just built. The calls corresponding to each of +the mask bits are summarized in Table 2, together with the XkbDescRec components that are filled in. .TS @@ -265,17 +265,17 @@ _ Request (want+need) Fills in Xkb components Equivalent Function Call _ XkbGBN_TypesMask map.types XkbGetUpdatedMap(dpy, XkbTypesMask, Xkb) -XkbGBN_ServerSymbolsMask server XkbGetUpdatedMap(dpy, +XkbGBN_ServerSymbolsMask server XkbGetUpdatedMap(dpy, XkbAllClientInfoMask, Xkb) -XkbGBN_ClientSymbolsMask map, including map.types +XkbGBN_ClientSymbolsMask map, including map.types XkbGetUpdatedMap(dpy, XkbAllServerInfoMask, Xkb) -XkbGBN_IndicatorMaps indicators XkbGetIndicatorMap(dpy, +XkbGBN_IndicatorMaps indicators XkbGetIndicatorMap(dpy, XkbAllIndicators, Xkb) XkbGBN_CompatMapMask compat XkbGetCompatMap(dpy, XkbAllCompatMask, Xkb) XkbGBN_GeometryMask geom XkbGetGeometry(dpy, Xkb) XkbGBN_KeyNamesMask names.keys XkbGetNames(dpy, XkbKeyNamesMask | names.key_aliases XkbKeyAliasesMask, Xkb) -XkbGBN_OtherNamesMask names.keycodes XkbGetNames(dpy, XkbAllNamesMask & +XkbGBN_OtherNamesMask names.keycodes XkbGetNames(dpy, XkbAllNamesMask & names.geometry ~(XkbKeyNamesMask | XkbKeyAliasesMask), names.symbols Xkb) names.types @@ -288,33 +288,33 @@ XkbGBN_OtherNamesMask names.keycodes XkbGetNames(dpy, XkbAllNamesMask & names.phys_symbols .TE -There is no way to determine which components specified in -.I want -(but not in -.I need) -were actually fetched, other than breaking the call into successive calls to -.I XkbGetKeyboardByName +There is no way to determine which components specified in +.I want +(but not in +.I need) +were actually fetched, other than breaking the call into successive calls to +.I XkbGetKeyboardByName and specifying individual components. -.I XkbGetKeyboardByName -always sets -.I min_key_code -and -.I max_key_code +.I XkbGetKeyboardByName +always sets +.I min_key_code +and +.I max_key_code in the returned XkbDescRec structure. -.I XkbGetKeyboardByName -is synchronous; it sends the request to the server to build a new keyboard -description and waits for the reply. If successful, the return value is -non-NULL. -.I XkbGetKeyboardByName -generates a BadMatch protocol error if errors are encountered when building the +.I XkbGetKeyboardByName +is synchronous; it sends the request to the server to build a new keyboard +description and waits for the reply. If successful, the return value is +non-NULL. +.I XkbGetKeyboardByName +generates a BadMatch protocol error if errors are encountered when building the keyboard description. .SH STRUCTURES .LP -The complete description of an Xkb keyboard is given by an XkbDescRec. The -component -structures in the XkbDescRec represent the major Xkb components outlined in +The complete description of an Xkb keyboard is given by an XkbDescRec. The +component +structures in the XkbDescRec represent the major Xkb components outlined in Figure 1.1. .nf @@ -334,27 +334,27 @@ typedef struct { } XkbDescRec, *XkbDescPtr; .fi -The -.I display -field points to an X display structure. The -.I flags field is private to the library: modifying -.I flags -may yield unpredictable results. The -.I device_spec -field specifies the device identifier of the keyboard input device, or -XkbUseCoreKeyboard, which specifies the core keyboard device. The +The +.I display +field points to an X display structure. The +.I flags field is private to the library: modifying +.I flags +may yield unpredictable results. The +.I device_spec +field specifies the device identifier of the keyboard input device, or +XkbUseCoreKeyboard, which specifies the core keyboard device. The .I min_key_code -and -.I max_key_code -fields specify the least and greatest keycode that can be returned by the -keyboard. +and +.I max_key_code +fields specify the least and greatest keycode that can be returned by the +keyboard. -Each structure component has a corresponding mask bit that is used in function -calls to -indicate that the structure should be manipulated in some manner, such as -allocating it -or freeing it. These masks and their relationships to the fields in the -XkbDescRec are +Each structure component has a corresponding mask bit that is used in function +calls to +indicate that the structure should be manipulated in some manner, such as +allocating it +or freeing it. These masks and their relationships to the fields in the +XkbDescRec are shown in Table 3. .TS @@ -377,7 +377,7 @@ XkbAllComponentsMask All Fields (0x7f) .SH DIAGNOSTICS .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +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 XkbListComponents (__libmansuffix__) diff --git a/man/xkb/XkbGetMap.man b/man/xkb/XkbGetMap.man index b5d2f3fc..eab36ba1 100644 --- a/man/xkb/XkbGetMap.man +++ b/man/xkb/XkbGetMap.man @@ -22,8 +22,8 @@ .\" .TH XkbGetMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetMap \- Allocate an XkbDescRec structure and populate it with the server's -keyboard +XkbGetMap \- Allocate an XkbDescRec structure and populate it with the server's +keyboard client map and server map .SH SYNOPSIS .HP @@ -45,74 +45,74 @@ mask selecting subcomponents to populate device_id, or XkbUseCoreKbd .SH DESCRIPTION .LP -Xkb provides two functions to obtain the keyboard mapping components from the -server. The -first function, -.I XkbGetMap, -allocates an XkbDescRec structure, retrieves mapping components from the server, -and -stores them in the XkbDescRec structure it just allocated. The second function, -.I XkbGetUpdatedMap, -retrieves mapping components from the server and stores them in an XkbDescRec -structure +Xkb provides two functions to obtain the keyboard mapping components from the +server. The +first function, +.I XkbGetMap, +allocates an XkbDescRec structure, retrieves mapping components from the server, +and +stores them in the XkbDescRec structure it just allocated. The second function, +.I XkbGetUpdatedMap, +retrieves mapping components from the server and stores them in an XkbDescRec +structure that has previously been allocated. -To allocate an XkbDescRec structure and populate it with the server's keyboard -client map -and server map, use -.I XkbGetMap. XkbGetMap -is similar to +To allocate an XkbDescRec structure and populate it with the server's keyboard +client map +and server map, use +.I XkbGetMap. XkbGetMap +is similar to .I XkbGetKeyboard, -but is used only for obtaining the address of an XkbDescRec structure that is -populated -with keyboard mapping components. It allows finer control over which -substructures of the +but is used only for obtaining the address of an XkbDescRec structure that is +populated +with keyboard mapping components. It allows finer control over which +substructures of the keyboard mapping components are to be populated. -.I XkbGetKeyboard -always returns fully populated components, while -.I XkbGetMap +.I XkbGetKeyboard +always returns fully populated components, while +.I XkbGetMap can be instructed to return a partially populated component. -The -.I which mask is a bitwise inclusive OR of the masks defined in Table 14.1. Only -those -portions of the keyboard server map and the keyboard client maps that are -specified in -.I which -are allocated and populated. +The +.I which mask is a bitwise inclusive OR of the masks defined in Table 14.1. Only +those +portions of the keyboard server map and the keyboard client maps that are +specified in +.I which +are allocated and populated. In addition to allocating and obtaining the server map and the client map, -.I XkbGetMap -also sets the -.I device_spec, -the -.I min_key_code, -and -.I max_key_code -fields of the keyboard description. +.I XkbGetMap +also sets the +.I device_spec, +the +.I min_key_code, +and +.I max_key_code +fields of the keyboard description. -.I XkbGetMap -is synchronous; it queries the server for the desired information, waits for a -reply, and -then returns. If successful, -.I XkbGetMap +.I XkbGetMap +is synchronous; it queries the server for the desired information, waits for a +reply, and +then returns. If successful, +.I XkbGetMap returns a pointer to the XkbDescRec structure it allocated. If unsuccessful, -.I XkbGetMap -returns NULL. When unsuccessful, one of the following protocol errors is also -generated: -BadAlloc (unable to allocate the XkbDescRec structure), BadValue (some mask bits -in -.I which -are undefined), or BadImplementation (a compatible version of the Xkb extension -is not +.I XkbGetMap +returns NULL. When unsuccessful, one of the following protocol errors is also +generated: +BadAlloc (unable to allocate the XkbDescRec structure), BadValue (some mask bits +in +.I which +are undefined), or BadImplementation (a compatible version of the Xkb extension +is not available in the server). To free the returned data, use .I XkbFreeKeyboard. -Xkb also provides convenience functions to get partial component definitions -from the -server. These functions are specified in the "convenience functions" column in -Table -1. Refer to the sections listed in the table for more information on these +Xkb also provides convenience functions to get partial component definitions +from the +server. These functions are specified in the "convenience functions" column in +Table +1. Refer to the sections listed in the table for more information on these functions. .TS @@ -214,29 +214,29 @@ T} .nf .bp Xkb defines combinations of these masks for convenience: - + #define XkbResizableInfoMask (XkbKeyTypesMask) #define XkbAllClientInfoMask (XkbKeyTypesMask | XkbKeySymsMask | XkbModifierMapMask) #define XkbAllServerInfoMask (XkbExplicitComponentsMask | - XkbKeyActionsMask | + XkbKeyActionsMask | XkbKeyBehaviorsMask | - XkbVirtualModsMask | + XkbVirtualModsMask | XkbVirtualModMapMask) - #define XkbAllMapComponentsMask XkbAllClientInfoMask | + #define XkbAllMapComponentsMask XkbAllClientInfoMask | XkbAllServerInfoMask) - -.fi -Key types, symbol maps, and actions are all interrelated: changes in one require -changes -in the others. The convenience functions make it easier to edit these components -and -handle the interdependencies. + +.fi +Key types, symbol maps, and actions are all interrelated: changes in one require +changes +in the others. The convenience functions make it easier to edit these components +and +handle the interdependencies. .SH STRUCTURES .LP -The complete description of an Xkb keyboard is given by an XkbDescRec. The -component +The complete description of an Xkb keyboard is given by an XkbDescRec. The +component structures in the XkbDescRec represent the major Xkb components. .nf @@ -256,27 +256,27 @@ typedef struct { } XkbDescRec, *XkbDescPtr; .fi -The -.I display -field points to an X display structure. The -.I flags field is private to the library: modifying -.I flags -may yield unpredictable results. The -.I device_spec -field specifies the device identifier of the keyboard input device, or -XkbUseCoreKeyboard, which specifies the core keyboard device. The +The +.I display +field points to an X display structure. The +.I flags field is private to the library: modifying +.I flags +may yield unpredictable results. The +.I device_spec +field specifies the device identifier of the keyboard input device, or +XkbUseCoreKeyboard, which specifies the core keyboard device. The .I min_key_code -and -.I max_key_code -fields specify the least and greatest keycode that can be returned by the -keyboard. +and +.I max_key_code +fields specify the least and greatest keycode that can be returned by the +keyboard. -Each structure component has a corresponding mask bit that is used in function -calls to -indicate that the structure should be manipulated in some manner, such as -allocating it -or freeing it. These masks and their relationships to the fields in the -XkbDescRec are +Each structure component has a corresponding mask bit that is used in function +calls to +indicate that the structure should be manipulated in some manner, such as +allocating it +or freeing it. These masks and their relationships to the fields in the +XkbDescRec are shown in Table 2. .TS diff --git a/man/xkb/XkbGetNamedGeometry.man b/man/xkb/XkbGetNamedGeometry.man index c8a4bb1b..039c6336 100644 --- a/man/xkb/XkbGetNamedGeometry.man +++ b/man/xkb/XkbGetNamedGeometry.man @@ -22,7 +22,7 @@ .\" .TH XkbGetNamedGeometry __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetNamedGeometry \- Loads a keyboard geometry description from this database +XkbGetNamedGeometry \- Loads a keyboard geometry description from this database by name .SH SYNOPSIS .HP @@ -42,18 +42,18 @@ keyboard description into which the geometry should be loaded name of the geometry to be loaded .SH DESCRIPTION .LP -It is also possible to load a keyboard geometry by name. The X server maintains -a database +It is also possible to load a keyboard geometry by name. The X server maintains +a database of keyboard components (see below). -.I XkbGetNamedGeometry +.I XkbGetNamedGeometry can return BadName if the name cannot be found. -The X server maintains a database of keyboard components, identified by -component type. -The database contains all the information necessary to build a complete keyboard -description for a particular device, as well as to assemble partial -descriptions. Table 1 identifies the component types and the type of information +The X server maintains a database of keyboard components, identified by +component type. +The database contains all the information necessary to build a complete keyboard +description for a particular device, as well as to assemble partial +descriptions. Table 1 identifies the component types and the type of information they contain. .TS @@ -68,7 +68,7 @@ Type _ Keymap T{ Complete keyboard description -.br +.br Normally assembled using a complete component from each of the other types T} .sp @@ -117,39 +117,39 @@ Description of indicators physically present T} .TE -While a keymap is a database entry for a complete keyboard description, and -therefore -logically different from the individual component database entries, the rules -for -processing keymap entries are identical to those for the individual components. -In the -discussion that follows, the term component is used to refer to either -individual +While a keymap is a database entry for a complete keyboard description, and +therefore +logically different from the individual component database entries, the rules +for +processing keymap entries are identical to those for the individual components. +In the +discussion that follows, the term component is used to refer to either +individual components or a keymap. -There may be multiple entries for each of the component types. An entry may be +There may be multiple entries for each of the component types. An entry may be either -.I complete -or -.I partial. -Partial entries describe only a piece of the corresponding keyboard component -and are -designed to be combined with other entries of the same type to form a complete +.I complete +or +.I partial. +Partial entries describe only a piece of the corresponding keyboard component +and are +designed to be combined with other entries of the same type to form a complete entry. -For example, a partial symbols map might describe the differences between a -common ASCII -keyboard and some national layout. Such a partial map is not useful on its own -because it -does not include those symbols that are the same on both the ASCII and national -layouts -(such as function keys). On the other hand, this partial map can be used to -configure -.I any +For example, a partial symbols map might describe the differences between a +common ASCII +keyboard and some national layout. Such a partial map is not useful on its own +because it +does not include those symbols that are the same on both the ASCII and national +layouts +(such as function keys). On the other hand, this partial map can be used to +configure +.I any ASCII keyboard to use a national layout. -When a keyboard description is built, the components are processed in the order -in which +When a keyboard description is built, the components are processed in the order +in which they appear in Table 1; later definitions override earlier ones. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbGetNamedIndicator.man b/man/xkb/XkbGetNamedIndicator.man index 35a2990b..07ca7e61 100644 --- a/man/xkb/XkbGetNamedIndicator.man +++ b/man/xkb/XkbGetNamedIndicator.man @@ -21,7 +21,7 @@ .\" .TH XkbGetNamedIndicator __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetNamedIndicator \- Look up the indicator map and other information for an +XkbGetNamedIndicator \- Look up the indicator map and other information for an indicator by name .SH SYNOPSIS .HP @@ -48,7 +48,7 @@ indicator by name .SH ARGUMENTS .TP .I dpy -connection to the X server +connection to the X server .TP .I dev_spec keyboard device ID, or XkbUseCoreKbd @@ -69,41 +69,41 @@ backfilled with the index of the retrieved indicator backfilled with the current state of the retrieved indicator .TP .I map_rtrn -backfilled with the mapping for the retrieved indicator +backfilled with the mapping for the retrieved indicator .TP .I real_rtrn backfilled with True if the named indicator is real (physical) .SH DESCRIPTION .LP -Xkb also allows applications to refer to indicators by name. Use -.I XkbGetNames -to get the indicator names. Using names eliminates the need for hard-coding -bitmask values for particular keyboards. For example, instead of using -vendor-specific constants such as WSKBLed_ScrollLock mask on Digital +Xkb also allows applications to refer to indicators by name. Use +.I XkbGetNames +to get the indicator names. Using names eliminates the need for hard-coding +bitmask values for particular keyboards. For example, instead of using +vendor-specific constants such as WSKBLed_ScrollLock mask on Digital workstations or XLED_SCROLL_LOCK on Sun workstations, you can instead use .I XkbGetNamedDeviceIndicator -to look up information on the indicator named "Scroll Lock." +to look up information on the indicator named "Scroll Lock." -If the device specified by -.I device_spec -has an indicator named +If the device specified by +.I device_spec +has an indicator named .IR name ", " XkbGetNamedDeviceIndicator -returns True and populates the rest of the parameters with information about the -indicator. Otherwise, +returns True and populates the rest of the parameters with information about the +indicator. Otherwise, .I XkbGetNamedDeviceIndicator returns False. -The -.I ndx_rtrn -field returns the zero-based index of the named indicator. This index 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 state_rtrn -returns the current state of the named indicator (True = on, False = off). -.I map_rtrn -returns the indicator map for the named indicator. In addition, if the indicator -is mapped to a physical LED, the -.I real_rtrn +The +.I ndx_rtrn +field returns the zero-based index of the named indicator. This index 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 state_rtrn +returns the current state of the named indicator (True = on, False = off). +.I map_rtrn +returns the indicator map for the named indicator. In addition, if the indicator +is mapped to a physical LED, the +.I real_rtrn parameter is set to True. Each of the " @@ -134,19 +134,19 @@ It returns the return value from .SH "RETURN VALUES" .TP 15 True -The +The .IR XkbGetNamedIndicator " and " XkbGetNamedDeviceIndicator functions return True if the device specified by -.I device_spec -has an indicator named +.I device_spec +has an indicator named .IR name . .TP 15 False -The +The .IR XkbGetNamedIndicator " and " XkbGetNamedDeviceIndicator functions return False if the device specified by -.I device_spec -does not have an indicator named +.I device_spec +does not have an indicator named .IR name . .SH "SEE ALSO" .BR XkbGetNames (__libmansuffix__) diff --git a/man/xkb/XkbGetNames.man b/man/xkb/XkbGetNames.man index 40a882d2..60ff5a9b 100644 --- a/man/xkb/XkbGetNames.man +++ b/man/xkb/XkbGetNames.man @@ -43,11 +43,11 @@ mask of names or map components to be updated keyboard description to be updated .SH DESCRIPTION .LP -.I XkbGetNames -retrieves symbolic names for the components of the keyboard extension from the X server. The -.I which -parameter specifies the name components to be updated in the -.I xkb +.I XkbGetNames +retrieves symbolic names for the components of the keyboard extension from the X server. The +.I which +parameter specifies the name components to be updated in the +.I xkb parameter, and is the bitwise inclusive OR of the valid names mask bits defined in Table 1. @@ -82,39 +82,39 @@ XkbComponentNamesMask (0x3f) Xkb->names keycodes, XkbAllNamesMask (0x3fff) Xkb->names all name components .TE -If the -.I names -field of the keyboard description -.I xkb -is NULL, -.I XkbGetNames -allocates and initializes the -.I names +If the +.I names +field of the keyboard description +.I xkb +is NULL, +.I XkbGetNames +allocates and initializes the +.I names component of the keyboard description before obtaining the values specified by -.I which. -If the -.I names field of -.I xkb -is not NULL, -.I XkbGetNames -obtains the values specified by -.I which -and copies them into the keyboard description +.I which. +If the +.I names field of +.I xkb +is not NULL, +.I XkbGetNames +obtains the values specified by +.I which +and copies them into the keyboard description .I Xkb. -If the -.I map -component of the -.I xkb -parameter is NULL, -.I XkbGetNames -does not retrieve type or shift level names, even if XkbKeyTypeNamesMask or XkbKTLevelNamesMask are set in +If the +.I map +component of the +.I xkb +parameter is NULL, +.I XkbGetNames +does not retrieve type or shift level names, even if XkbKeyTypeNamesMask or XkbKTLevelNamesMask are set in .I which. -.I XkbGetNames +.I XkbGetNames can return Success, or BadAlloc, BadLength, BadMatch, and BadImplementation errors. -To free symbolic names, use +To free symbolic names, use .I XkbFreeNames. .SH DIAGNOSTICS .TP 15 @@ -128,7 +128,7 @@ Invalid reply from server The length of a request is shorter or longer than that required to minimally contain the arguments .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has correct type and range, but +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 XkbFreeNames (__libmansuffix__) diff --git a/man/xkb/XkbGetState.man b/man/xkb/XkbGetState.man index e46002db..f41e0c5c 100644 --- a/man/xkb/XkbGetState.man +++ b/man/xkb/XkbGetState.man @@ -21,7 +21,7 @@ .\" .TH XkbGetState __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetState \- Obtains the keyboard state +XkbGetState \- Obtains the keyboard state .SH SYNOPSIS .HP .B Status XkbGetState @@ -33,7 +33,7 @@ XkbGetState \- Obtains the keyboard state .SH ARGUMENTS .TP .I display -connection to the X server +connection to the X server .TP .I device_spec device ID, or XkbUseCoreKbd @@ -42,14 +42,14 @@ device ID, or XkbUseCoreKbd backfilled with Xkb state .SH DESCRIPTION .LP -The -.I XkbGetState -function queries the server for the current keyboard state, waits -for a reply, and then backfills -.I state_return +The +.I XkbGetState +function queries the server for the current keyboard state, waits +for a reply, and then backfills +.I state_return with the results. -All group values are expressed as group indices in the range [0..3]. Modifiers -and the compatibility modifier state values are expressed as the bitwise union -of the core X11 modifier masks. The pointer button state is reported as in the +All group values are expressed as group indices in the range [0..3]. Modifiers +and the compatibility modifier state values are expressed as the bitwise union +of the core X11 modifier masks. The pointer button state is reported as in the core X11 protocol. diff --git a/man/xkb/XkbGetUpdatedMap.man b/man/xkb/XkbGetUpdatedMap.man index fd391c2e..7ad1ea44 100644 --- a/man/xkb/XkbGetUpdatedMap.man +++ b/man/xkb/XkbGetUpdatedMap.man @@ -22,7 +22,7 @@ .\" .TH XkbGetUpdatedMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetUpdatedMap \- Update the client or server map information in an existing +XkbGetUpdatedMap \- Update the client or server map information in an existing keyboard description .SH SYNOPSIS .HP @@ -44,18 +44,18 @@ mask selecting subcomponents to populate keyboard description to be updated .SH DESCRIPTION .LP -The -.I which -parameter is a bitwise inclusive OR of the masks in Table 1. If the needed -components of the -.I xkb -structure are not already allocated, -.I XkbGetUpdatedMap -allocates them. -.I XkbGetUpdatedMap -fetches the requested information for the device specified in the XkbDescRec -passed in the -.I xkb +The +.I which +parameter is a bitwise inclusive OR of the masks in Table 1. If the needed +components of the +.I xkb +structure are not already allocated, +.I XkbGetUpdatedMap +allocates them. +.I XkbGetUpdatedMap +fetches the requested information for the device specified in the XkbDescRec +passed in the +.I xkb parameter. .TS @@ -154,27 +154,27 @@ XkbGetVirtualModMap T} .TE -.I XkbGetUpdatedMap -is synchronous; it queries the server for the desired information, waits for a -reply, and then returns. If successful, -.I XkbGetUpdatedMap -returns Success. If unsuccessful, -.I XkbGetUpdatedMap -returns one of the following: BadAlloc (unable to allocate a component in the -XkbDescRec structure), BadValue (some mask bits in -.I which -are undefined), BadImplementation (a compatible version of the Xkb extension is +.I XkbGetUpdatedMap +is synchronous; it queries the server for the desired information, waits for a +reply, and then returns. If successful, +.I XkbGetUpdatedMap +returns Success. If unsuccessful, +.I XkbGetUpdatedMap +returns one of the following: BadAlloc (unable to allocate a component in the +XkbDescRec structure), BadValue (some mask bits in +.I which +are undefined), BadImplementation (a compatible version of the Xkb extension is not available in the server or the reply from the server was invalid). .SH "RETURN VALUES" .TP 15 Success -The -.I XkbGetUpdatedMap +The +.I XkbGetUpdatedMap function returns Success if a reply is received to the server query for the desired information. .SH STRUCTURES .LP -The complete description of an Xkb keyboard is given by an XkbDescRec. The -component +The complete description of an Xkb keyboard is given by an XkbDescRec. The +component structures in the XkbDescRec represent the major Xkb components. .nf @@ -194,28 +194,28 @@ typedef struct { } XkbDescRec, *XkbDescPtr; .fi -The -.I display -field points to an X display structure. The -.I flags -field is private to the library: modifying -.I flags -may yield unpredictable results. The -.I device_spec -field specifies the device identifier of the keyboard input device, or -XkbUseCoreKeyboard, which specifies the core keyboard device. The +The +.I display +field points to an X display structure. The +.I flags +field is private to the library: modifying +.I flags +may yield unpredictable results. The +.I device_spec +field specifies the device identifier of the keyboard input device, or +XkbUseCoreKeyboard, which specifies the core keyboard device. The .I min_key_code -and -.I max_key_code -fields specify the least and greatest keycode that can be returned by the -keyboard. +and +.I max_key_code +fields specify the least and greatest keycode that can be returned by the +keyboard. -Each structure component has a corresponding mask bit that is used in function -calls to -indicate that the structure should be manipulated in some manner, such as -allocating it -or freeing it. These masks and their relationships to the fields in the -XkbDescRec are +Each structure component has a corresponding mask bit that is used in function +calls to +indicate that the structure should be manipulated in some manner, such as +allocating it +or freeing it. These masks and their relationships to the fields in the +XkbDescRec are shown in Table 2. .bp .TS diff --git a/man/xkb/XkbGetVirtualMods.man b/man/xkb/XkbGetVirtualMods.man index a8602dff..2db963ea 100644 --- a/man/xkb/XkbGetVirtualMods.man +++ b/man/xkb/XkbGetVirtualMods.man @@ -22,7 +22,7 @@ .\" .TH XkbGetVirtualMods __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbGetVirtualMods \- Obtain a subset of the virtual modifier bindings (the vmods +XkbGetVirtualMods \- Obtain a subset of the virtual modifier bindings (the vmods array) in a keyboard description .SH SYNOPSIS .HP @@ -44,98 +44,98 @@ mask indicating virtual modifier bindings to get Xkb description where results will be placed .SH DESCRIPTION .LP -.I XkbGetVirtualMods -sends a request to the server to obtain the -.I vmods -entries for the virtual modifiers specified in the mask, -.I which, -and waits for a reply. +.I XkbGetVirtualMods +sends a request to the server to obtain the +.I vmods +entries for the virtual modifiers specified in the mask, +.I which, +and waits for a reply. -Virtual modifiers are named by converting their string name to an X Atom and storing the Atom in the -.I names.vmods -array in an XkbDescRec structure. The position of a name Atom in the -.I names.vmods -array defines the bit position used to represent the virtual modifier and also the index used when -accessing virtual modifier information in arrays: the name in the i-th (0 relative) entry of -.I names.vmods -is the i-th virtual modifier, represented by the mask (1<vmods -array of -.I xkb. -The -.I xkb +For each bit set in +.I which, XkbGetVirtualMods +updates the corresponding virtual modifier definition in the +.I server->vmods +array of +.I xkb. +The +.I xkb parameter must be a pointer to a valid Xkb keyboard description. If successful, -.I XkbGetVirtualMods +.I XkbGetVirtualMods returns Success. .B Virtual Modifier Names and Masks -Virtual modifiers are named by converting their string name to an X Atom and -storing the Atom in the -.I names.vmods -array in an XkbDescRec structure. The position of a name Atom in the -.I names.vmods -array defines the bit position used to represent the virtual modifier and also -the index used when accessing virtual modifier information in arrays: the name -in the i-th (0 relative) entry of -.I names.vmods -is the i-th virtual modifier, represented by the mask (1<vmods -array of -.I xkb. +The +.I XkbGetVirtualMods +function returns Success when it successfully updates the corresponding virtual modifier definition +in the +.I server->vmods +array of +.I xkb. .SH STRUCTURES .LP -The complete description of an Xkb keyboard is given by an XkbDescRec. The -component +The complete description of an Xkb keyboard is given by an XkbDescRec. The +component structures in the XkbDescRec represent the major Xkb components. .nf @@ -155,27 +155,27 @@ typedef struct { } XkbDescRec, *XkbDescPtr; .fi -The -.I display -field points to an X display structure. The -.I flags -field is private to the library: modifying -.I flags -may yield unpredictable results. The -.I device_spec -field specifies the device identifier of the keyboard input device, or XkbUseCoreKeyboard, which -specifies the core keyboard device. The +The +.I display +field points to an X display structure. The +.I flags +field is private to the library: modifying +.I flags +may yield unpredictable results. The +.I device_spec +field specifies the device identifier of the keyboard input device, or XkbUseCoreKeyboard, which +specifies the core keyboard device. The .I min_key_code -and -.I max_key_code +and +.I max_key_code fields specify the least and greatest keycode that can be returned by the keyboard. -Each structure component has a corresponding mask bit that is used in function -calls to -indicate that the structure should be manipulated in some manner, such as -allocating it -or freeing it. These masks and their relationships to the fields in the -XkbDescRec are +Each structure component has a corresponding mask bit that is used in function +calls to +indicate that the structure should be manipulated in some manner, such as +allocating it +or freeing it. These masks and their relationships to the fields in the +XkbDescRec are shown in Table 1. .TS @@ -201,7 +201,7 @@ XkbAllComponentsMask All Fields (0x7f) Unable to allocate storage .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +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 XkbGetNames (__libmansuffix__), diff --git a/man/xkb/XkbGetXlibControls.man b/man/xkb/XkbGetXlibControls.man index 4b72fadf..60f541c2 100644 --- a/man/xkb/XkbGetXlibControls.man +++ b/man/xkb/XkbGetXlibControls.man @@ -35,10 +35,10 @@ XkbGetXlibControls \- Determines the current state of the Library Controls connection to X server .SH DESCRIPTION .LP -.I XkbGetXlibControls -returns the current state of the Library Controls as a bit mask that is an -inclusive OR of the control masks from Table 1 for the controls that are -enabled. For the optional compose processing controls, the fact that a control +.I XkbGetXlibControls +returns the current state of the Library Controls as a bit mask that is an +inclusive OR of the control masks from Table 1 for the controls that are +enabled. For the optional compose processing controls, the fact that a control is enabled does not imply that it is actually implemented. .TS diff --git a/man/xkb/XkbIgnoreExtension.man b/man/xkb/XkbIgnoreExtension.man index 1ecf3868..983a7ede 100644 --- a/man/xkb/XkbIgnoreExtension.man +++ b/man/xkb/XkbIgnoreExtension.man @@ -21,7 +21,7 @@ .\" .TH XkbIgnoreExtension __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbIgnoreExtension \- Prevents core X library keyboard functions from using the +XkbIgnoreExtension \- Prevents core X library keyboard functions from using the X Keyboard Extension .SH SYNOPSIS .HP @@ -35,45 +35,45 @@ X Keyboard Extension True means ignore the extension .SH DESCRIPTION .LP -If a server supports the Xkb extension, the X library normally implements preXkb -keyboard functions using the Xkb keyboard description and state. The server Xkb -keyboard state may differ from the preXkb keyboard state. This difference does -not affect most clients, but there are exceptions. To allow these clients to +If a server supports the Xkb extension, the X library normally implements preXkb +keyboard functions using the Xkb keyboard description and state. The server Xkb +keyboard state may differ from the preXkb keyboard state. This difference does +not affect most clients, but there are exceptions. To allow these clients to work properly, you may instruct the extension not to use Xkb functionality. -Call -.I XkbIgnoreExtension -to prevent core X library keyboard functions from using -the X Keyboard Extension. You must call -.I XkbIgnoreExtension -before you open a -server connection; Xkb does not provide a way to enable or disable use of the +Call +.I XkbIgnoreExtension +to prevent core X library keyboard functions from using +the X Keyboard Extension. You must call +.I XkbIgnoreExtension +before you open a +server connection; Xkb does not provide a way to enable or disable use of the extension once a connection is established. -.I XkbIgnoreExtension -tells the X library whether to use the X Keyboard Extension -on any subsequently opened X display connections. If ignore is True, the library -does not initialize the Xkb extension when it opens a new display. This forces -the X server to use compatibility mode and communicate with the client using -only core protocol requests and events. If ignore is False, the library treats -subsequent calls to -.I XOpenDisplay -normally and uses Xkb extension requests, -events, and state. Do not explicitly use Xkb on a connection for which it is -disabled. -.I XkbIgnoreExtension -returns False if it was unable to apply the ignore +.I XkbIgnoreExtension +tells the X library whether to use the X Keyboard Extension +on any subsequently opened X display connections. If ignore is True, the library +does not initialize the Xkb extension when it opens a new display. This forces +the X server to use compatibility mode and communicate with the client using +only core protocol requests and events. If ignore is False, the library treats +subsequent calls to +.I XOpenDisplay +normally and uses Xkb extension requests, +events, and state. Do not explicitly use Xkb on a connection for which it is +disabled. +.I XkbIgnoreExtension +returns False if it was unable to apply the ignore request. .SH "RETURN VALUES" .TP 15 True -The -.I XkbIgnoreExtension -returns True if +The +.I XkbIgnoreExtension +returns True if .TP 15 False -The -.I XkbIgnoreExtension +The +.I XkbIgnoreExtension function returns False if it was unable to apply the ignore request. .SH "SEE ALSO" .BR XOpenDisplay (__libmansuffix__) diff --git a/man/xkb/XkbKeyAction.man b/man/xkb/XkbKeyAction.man index 10a6fe59..009c0423 100644 --- a/man/xkb/XkbKeyAction.man +++ b/man/xkb/XkbKeyAction.man @@ -42,75 +42,75 @@ keycode of interest index for group and shift level .SH DESCRIPTION .LP -A key action defines the effect key presses and releases have on the internal -state of the server. For -example, the expected key action associated with pressing the Shift key is to -set the Shift modifier. +A key action defines the effect key presses and releases have on the internal +state of the server. For +example, the expected key action associated with pressing the Shift key is to +set the Shift modifier. There is zero or one key action associated with each keysym bound to each key. Just as the entire list of key symbols for the keyboard mapping is held in the -.I syms -field of the client map, the entire list of key actions for the keyboard mapping -is held in the -.I acts -array of the server map. The total size of -.I acts -is specified by -.I size_acts, -and the number of entries is specified by -.I num_acts. +.I syms +field of the client map, the entire list of key actions for the keyboard mapping +is held in the +.I acts +array of the server map. The total size of +.I acts +is specified by +.I size_acts, +and the number of entries is specified by +.I num_acts. -The -.I key_acts +The +.I key_acts array, indexed by keycode, describes the actions associated with a key. The -.I key_acts -array has -.I min_key_code +.I key_acts +array has +.I min_key_code unused entries at the start to allow direct indexing using a keycode. If a -.I key_acts -entry is zero, it means the key does not have any actions associated with it. If -an entry is not zero, -the entry represents an index into the -.I acts -field of the server map, much as the -.I offset -field of a KeySymMapRec structure is an index into the -.I syms -field of the client map. +.I key_acts +entry is zero, it means the key does not have any actions associated with it. If +an entry is not zero, +the entry represents an index into the +.I acts +field of the server map, much as the +.I offset +field of a KeySymMapRec structure is an index into the +.I syms +field of the client map. -The reason the -.I acts -field is a linear list of XkbActions is to reduce the memory consumption -associated with a keymap. -Because Xkb allows individual keys to have multiple shift levels and a different -number of groups per -key, a single two-dimensional array of KeySyms would potentially be very large -and sparse. Instead, Xkb -provides a small two-dimensional array of XkbActions for each key. To store all -of these individual -arrays, Xkb concatenates each array together in the -.I acts +The reason the +.I acts +field is a linear list of XkbActions is to reduce the memory consumption +associated with a keymap. +Because Xkb allows individual keys to have multiple shift levels and a different +number of groups per +key, a single two-dimensional array of KeySyms would potentially be very large +and sparse. Instead, Xkb +provides a small two-dimensional array of XkbActions for each key. To store all +of these individual +arrays, Xkb concatenates each array together in the +.I acts field of the server map. -The key action structures consist only of fields of type char or unsigned char. -This is done to -optimize data transfer when the server sends bytes over the wire. If the fields -are anything but bytes, -the server has to sift through all of the actions and swap any nonbyte fields. -Because they consist of +The key action structures consist only of fields of type char or unsigned char. +This is done to +optimize data transfer when the server sends bytes over the wire. If the fields +are anything but bytes, +the server has to sift through all of the actions and swap any nonbyte fields. +Because they consist of nothing but bytes, it can just copy them out. -.I XkbKeyAction -returns the key action indexed by -.I idx -in the two-dimensional array of key actions associated with the key -corresponding to -.I keycode.idx +.I XkbKeyAction +returns the key action indexed by +.I idx +in the two-dimensional array of key actions associated with the key +corresponding to +.I keycode.idx may be computed from the group and shift level of interest as follows: .nf idx = group_index * key_width + shift_level -.fi +.fi .SH STRUCTURES .LP The KeySymMapRec structure is defined as follows: @@ -118,7 +118,7 @@ The KeySymMapRec structure is defined as follows: #define XkbNumKbdGroups 4 #define XkbMaxKbdGroup (XkbNumKbdGroups-1) - + typedef struct { /\&* map to keysyms for a single keycode */ unsigned char kt_index[XkbNumKbdGroups]; /\&* key type index for each group */ unsigned char group_info; /\&* # of groups and out of range group handling */ diff --git a/man/xkb/XkbKeyActionEntry.man b/man/xkb/XkbKeyActionEntry.man index 5d54ab58..0fdb1edd 100644 --- a/man/xkb/XkbKeyActionEntry.man +++ b/man/xkb/XkbKeyActionEntry.man @@ -49,71 +49,71 @@ shift level within group group index for group of interest .SH DESCRIPTION .LP -A key action defines the effect key presses and releases have on the internal -state of the server. For example, -the expected key action associated with pressing the Shift key is to set the -Shift modifier. There is zero or one +A key action defines the effect key presses and releases have on the internal +state of the server. For example, +the expected key action associated with pressing the Shift key is to set the +Shift modifier. There is zero or one key action associated with each keysym bound to each key. Just as the entire list of key symbols for the keyboard mapping is held in the -.I syms -field of the client map, the entire list of key actions for the keyboard mapping -is held in the -.I acts -array of the server map. The total size of -.I acts -is specified by -.I size_acts, -and the number of entries is specified by -.I num_acts. +.I syms +field of the client map, the entire list of key actions for the keyboard mapping +is held in the +.I acts +array of the server map. The total size of +.I acts +is specified by +.I size_acts, +and the number of entries is specified by +.I num_acts. -The -.I key_acts +The +.I key_acts array, indexed by keycode, describes the actions associated with a key. The -.I key_acts -array has -.I min_key_code +.I key_acts +array has +.I min_key_code unused entries at the start to allow direct indexing using a keycode. If a -.I key_acts -entry is zero, it means the key does not have any actions associated with it. If -an entry is not zero, the entry -represents an index into the -.I acts -field of the server map, much as the -.I offset -field of a KeySymMapRec structure is an index into the -.I syms -field of the client map. +.I key_acts +entry is zero, it means the key does not have any actions associated with it. If +an entry is not zero, the entry +represents an index into the +.I acts +field of the server map, much as the +.I offset +field of a KeySymMapRec structure is an index into the +.I syms +field of the client map. -The reason the -.I acts -field is a linear list of XkbActions is to reduce the memory consumption -associated with a keymap. Because Xkb -allows individual keys to have multiple shift levels and a different number of -groups per key, a single -two-dimensional array of KeySyms would potentially be very large and sparse. -Instead, Xkb provides a small -two-dimensional array of XkbActions for each key. To store all of these -individual arrays, Xkb concatenates each -array together in the -.I acts +The reason the +.I acts +field is a linear list of XkbActions is to reduce the memory consumption +associated with a keymap. Because Xkb +allows individual keys to have multiple shift levels and a different number of +groups per key, a single +two-dimensional array of KeySyms would potentially be very large and sparse. +Instead, Xkb provides a small +two-dimensional array of XkbActions for each key. To store all of these +individual arrays, Xkb concatenates each +array together in the +.I acts field of the server map. -The key action structures consist only of fields of type char or unsigned char. -This is done to optimize data -transfer when the server sends bytes over the wire. If the fields are anything -but bytes, the server has to sift -through all of the actions and swap any nonbyte fields. Because they consist of -nothing but bytes, it can just +The key action structures consist only of fields of type char or unsigned char. +This is done to optimize data +transfer when the server sends bytes over the wire. If the fields are anything +but bytes, the server has to sift +through all of the actions and swap any nonbyte fields. Because they consist of +nothing but bytes, it can just copy them out. -.I XkbKeyActionEntry -returns the key action corresponding to group -.I grp -and shift level -.I lvl -from the two-dimensional table of key actions associated with the key -corresponding to +.I XkbKeyActionEntry +returns the key action corresponding to group +.I grp +and shift level +.I lvl +from the two-dimensional table of key actions associated with the key +corresponding to .I keycode. .SH STRUCTURES .LP @@ -122,7 +122,7 @@ The KeySymMapRec structure is defined as follows: #define XkbNumKbdGroups 4 #define XkbMaxKbdGroup (XkbNumKbdGroups-1) - + typedef struct { /\&* map to keysyms for a single keycode */ unsigned char kt_index[XkbNumKbdGroups]; /\&* key type index for each group */ unsigned char group_info; /\&* # of groups and out of range group handling */ diff --git a/man/xkb/XkbKeyActionsPtr.man b/man/xkb/XkbKeyActionsPtr.man index 809fbb0c..1d115ea9 100644 --- a/man/xkb/XkbKeyActionsPtr.man +++ b/man/xkb/XkbKeyActionsPtr.man @@ -22,8 +22,8 @@ .\" .TH XkbKeyActionsPtr __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeyActionsPtr \- Returns a pointer to the two-dimensional array of key -actions associated with +XkbKeyActionsPtr \- Returns a pointer to the two-dimensional array of key +actions associated with the key corresponding to keycode .SH SYNOPSIS .HP @@ -35,78 +35,78 @@ the key corresponding to keycode .SH ARGUMENTS .TP .I xkb -Xkb description of interest +Xkb description of interest .TP .I keycode keycode of interest .SH DESCRIPTION .LP -A key action defines the effect key presses and releases have on the internal -state of the server. -For example, the expected key action associated with pressing the Shift key is -to set the Shift -modifier. There is zero or one key action associated with each keysym bound to +A key action defines the effect key presses and releases have on the internal +state of the server. +For example, the expected key action associated with pressing the Shift key is +to set the Shift +modifier. There is zero or one key action associated with each keysym bound to each key. Just as the entire list of key symbols for the keyboard mapping is held in the -.I syms -field of the client map, the entire list of key actions for the keyboard mapping -is held in the -.I acts -array of the server map. The total size of -.I acts -is specified by -.I size_acts, -and the number of entries is specified by -.I num_acts. +.I syms +field of the client map, the entire list of key actions for the keyboard mapping +is held in the +.I acts +array of the server map. The total size of +.I acts +is specified by +.I size_acts, +and the number of entries is specified by +.I num_acts. -The -.I key_acts +The +.I key_acts array, indexed by keycode, describes the actions associated with a key. The -.I key_acts -array has -.I min_key_code +.I key_acts +array has +.I min_key_code unused entries at the start to allow direct indexing using a keycode. If a -.I key_acts -entry is zero, it means the key does not have any actions associated with it. If -an entry is not -zero, the entry represents an index into the -.I acts -field of the server map, much as the -.I offset -field of a KeySymMapRec structure is an index into the -.I syms -field of the client map. +.I key_acts +entry is zero, it means the key does not have any actions associated with it. If +an entry is not +zero, the entry represents an index into the +.I acts +field of the server map, much as the +.I offset +field of a KeySymMapRec structure is an index into the +.I syms +field of the client map. -The reason the -.I acts -field is a linear list of XkbActions is to reduce the memory consumption -associated with a keymap. -Because Xkb allows individual keys to have multiple shift levels and a different -number of groups per -key, a single two-dimensional array of KeySyms would potentially be very large -and sparse. Instead, -Xkb provides a small two-dimensional array of XkbActions for each key. To store -all of these -individual arrays, Xkb concatenates each array together in the -.I acts +The reason the +.I acts +field is a linear list of XkbActions is to reduce the memory consumption +associated with a keymap. +Because Xkb allows individual keys to have multiple shift levels and a different +number of groups per +key, a single two-dimensional array of KeySyms would potentially be very large +and sparse. Instead, +Xkb provides a small two-dimensional array of XkbActions for each key. To store +all of these +individual arrays, Xkb concatenates each array together in the +.I acts field of the server map. -The key action structures consist only of fields of type char or unsigned char. -This is done to -optimize data transfer when the server sends bytes over the wire. If the fields -are anything but -bytes, the server has to sift through all of the actions and swap any nonbyte -fields. Because they +The key action structures consist only of fields of type char or unsigned char. +This is done to +optimize data transfer when the server sends bytes over the wire. If the fields +are anything but +bytes, the server has to sift through all of the actions and swap any nonbyte +fields. Because they consist of nothing but bytes, it can just copy them out. -.I XkbKeyActionsPtr -returns a pointer to the two-dimensional array of key actions associated with -the key corresponding -to -.I keycode. -Use -.I XkbKeyActionsPtr +.I XkbKeyActionsPtr +returns a pointer to the two-dimensional array of key actions associated with +the key corresponding +to +.I keycode. +Use +.I XkbKeyActionsPtr only if the key actually has some actions associated with it, that is, .I XkbKeyNumActions (xkb, keycode) returns something greater than zero. @@ -117,7 +117,7 @@ The KeySymMapRec structure is defined as follows: #define XkbNumKbdGroups 4 #define XkbMaxKbdGroup (XkbNumKbdGroups-1) - + typedef struct { /\&* map to keysyms for a single keycode */ unsigned char kt_index[XkbNumKbdGroups]; /\&* key type index for each group */ unsigned char group_info; /\&* # of groups and out of range group handling */ diff --git a/man/xkb/XkbKeyGroupInfo.man b/man/xkb/XkbKeyGroupInfo.man index c57ebad3..7b4d3705 100644 --- a/man/xkb/XkbKeyGroupInfo.man +++ b/man/xkb/XkbKeyGroupInfo.man @@ -22,8 +22,8 @@ .\" .TH XkbKeyGroupInfo __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeyGroupInfo \- Returns the number of groups of symbols bound to the key -corresponding to +XkbKeyGroupInfo \- Returns the number of groups of symbols bound to the key +corresponding to keycode .SH SYNOPSIS .HP @@ -41,58 +41,58 @@ Xkb description of interest keycode of interest .SH DESCRIPTION .LP -The -.I group_info -field of an XkbSymMapRec is an encoded value containing the number of groups of -symbols bound -to the -key as well as the specification of the treatment of out-of-range groups. It is -legal for a -key to -have zero groups, in which case it also has zero symbols and all events from -that key yield -NoSymbol. -To obtain the number of groups of symbols bound to the key, use -.I XkbKeyNumGroups. -To change the number of groups bound to a key, use -.I XkbChangeTypesOfKey. +The +.I group_info +field of an XkbSymMapRec is an encoded value containing the number of groups of +symbols bound +to the +key as well as the specification of the treatment of out-of-range groups. It is +legal for a +key to +have zero groups, in which case it also has zero symbols and all events from +that key yield +NoSymbol. +To obtain the number of groups of symbols bound to the key, use +.I XkbKeyNumGroups. +To change the number of groups bound to a key, use +.I XkbChangeTypesOfKey. To obtain a mask that determines the treatment of out-of-range groups, use -.I XkbKeyGroupInfo -and +.I XkbKeyGroupInfo +and .I XkbOutOfRangeGroupInfo. -The keyboard controls contain a -.I groups_wrap -field specifying the handling of illegal groups on a global basis. That is, when -the user -performs an -action causing the effective group to go out of the legal range, the -.I groups_wrap -field specifies how to normalize the effective keyboard group to a group that is -legal for the -keyboard as a whole, but there is no guarantee that the normalized group will be -within the -range of -legal groups for any individual key. The per-key -.I group_info -field specifies how a key treats a legal effective group if the key does not -have a type -specified for -the group of concern. For example, the Enter key usually has just one group -defined. If the -user -performs an action causing the global keyboard group to change to Group2, the -.I group_info +The keyboard controls contain a +.I groups_wrap +field specifying the handling of illegal groups on a global basis. That is, when +the user +performs an +action causing the effective group to go out of the legal range, the +.I groups_wrap +field specifies how to normalize the effective keyboard group to a group that is +legal for the +keyboard as a whole, but there is no guarantee that the normalized group will be +within the +range of +legal groups for any individual key. The per-key +.I group_info +field specifies how a key treats a legal effective group if the key does not +have a type +specified for +the group of concern. For example, the Enter key usually has just one group +defined. If the +user +performs an action causing the global keyboard group to change to Group2, the +.I group_info field for the Enter key describes how to handle this situation. -Out-of-range groups for individual keys are mapped to a legal group using the -same options as -are used -for the overall keyboard group. The particular type of mapping used is -controlled by the bits -set in -the -.I group_info +Out-of-range groups for individual keys are mapped to a legal group using the +same options as +are used +for the overall keyboard group. The particular type of mapping used is +controlled by the bits +set in +the +.I group_info flag, as shown in Table 1. .bp .TS @@ -108,9 +108,9 @@ XkbClampIntoRange XkbClampIntoRange none of the above XkbWrapIntoRange .TE -.I XkbKeyGroupInfo -returns the group_info field from the XkbSymMapRec structure associated with the -key corresponding to +.I XkbKeyGroupInfo +returns the group_info field from the XkbSymMapRec structure associated with the +key corresponding to .I keycode. .SH STRUCTURES .LP @@ -119,7 +119,7 @@ The KeySymMapRec structure is defined as follows: \&#define XkbNumKbdGroups 4 \&#define XkbMaxKbdGroup (XkbNumKbdGroups-1) - + typedef struct { /\&* map to keysyms for a single keycode */ unsigned char kt_index[XkbNumKbdGroups]; /\&* key type index for each group */ unsigned char group_info; /\&* # of groups and out of range group handling */ @@ -134,7 +134,7 @@ 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 */ @@ -166,7 +166,7 @@ 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 */ diff --git a/man/xkb/XkbKeyGroupWidth.man b/man/xkb/XkbKeyGroupWidth.man index 33d4d9a7..fbab4e93 100644 --- a/man/xkb/XkbKeyGroupWidth.man +++ b/man/xkb/XkbKeyGroupWidth.man @@ -23,8 +23,8 @@ .TH XkbKeyGroupWidth __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME XkbKeyGroupWidth \- Computes the width of the type associated with the group -.I grp -for the key corresponding to +.I grp +for the key corresponding to .I keycode .SH SYNOPSIS .HP @@ -46,27 +46,27 @@ keycode of interest group of interest .SH DESCRIPTION .LP -The key width and number of groups associated with a key are used to form a -small two-dimensional array of KeySyms for a key. This array may be different -sizes for different keys. The array for a single key is stored as a linear list, -in row-major order. The arrays for all of the keys are stored in the -.I syms -field of the client map. There is one row for each group associated with a key -and one column for each level. The index corresponding to a given group and +The key width and number of groups associated with a key are used to form a +small two-dimensional array of KeySyms for a key. This array may be different +sizes for different keys. The array for a single key is stored as a linear list, +in row-major order. The arrays for all of the keys are stored in the +.I syms +field of the client map. There is one row for each group associated with a key +and one column for each level. The index corresponding to a given group and shift level is computed as: .nf idx = group_index * key_width + shift_level - + .fi -The -.I offset -field of the -.I key_sym_map +The +.I offset +field of the +.I key_sym_map entry for a key is used to access the beginning of the array. -.I XkbKeyGroupWidth -computes the width of the type associated with the group -.I grp -for the key corresponding to +.I XkbKeyGroupWidth +computes the width of the type associated with the group +.I grp +for the key corresponding to .I keycode. diff --git a/man/xkb/XkbKeyGroupsWidth.man b/man/xkb/XkbKeyGroupsWidth.man index c42afa6b..c5555833 100644 --- a/man/xkb/XkbKeyGroupsWidth.man +++ b/man/xkb/XkbKeyGroupsWidth.man @@ -21,8 +21,8 @@ .\" .TH XkbKeyGroupsWidth __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeyGroupsWidth \- Computes the maximum width associated with the key -corresponding to +XkbKeyGroupsWidth \- Computes the maximum width associated with the key +corresponding to .I keycode .SH SYNOPSIS .HP @@ -40,25 +40,25 @@ Xkb description of interest keycode of interest .SH DESCRIPTION .LP -The key width and number of groups associated with a key are used to form a -small two-dimensional array of KeySyms for a key. This array may be different -sizes for different keys. The array for a single key is stored as a linear list, -in row-major order. The arrays for all of the keys are stored in the -.I syms -field of the client map. There is one row for each group associated with a key -and one column for each level. The index corresponding to a given group and +The key width and number of groups associated with a key are used to form a +small two-dimensional array of KeySyms for a key. This array may be different +sizes for different keys. The array for a single key is stored as a linear list, +in row-major order. The arrays for all of the keys are stored in the +.I syms +field of the client map. There is one row for each group associated with a key +and one column for each level. The index corresponding to a given group and shift level is computed as: .nf idx = group_index * key_width + shift_level - + .fi -The -.I offset -field of the -.I key_sym_map +The +.I offset +field of the +.I key_sym_map entry for a key is used to access the beginning of the array. -.I XkbKeyGroupsWidth -computes the maximum width associated with the key corresponding to +.I XkbKeyGroupsWidth +computes the maximum width associated with the key corresponding to .I keycode. diff --git a/man/xkb/XkbKeyHasActions.man b/man/xkb/XkbKeyHasActions.man index 4d05d926..eb99b3f3 100644 --- a/man/xkb/XkbKeyHasActions.man +++ b/man/xkb/XkbKeyHasActions.man @@ -21,7 +21,7 @@ .\" .TH XkbKeyHasActions __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeyHasActions \- Determines if the key corresponding to +XkbKeyHasActions \- Determines if the key corresponding to .I keycode has any actions associated with it .SH SYNOPSIS @@ -37,75 +37,75 @@ has any actions associated with it Xkb description of interest .TP .I keycode -keycode of interest +keycode of interest .SH DESCRIPTION .LP -A key action defines the effect key presses and releases have on the internal state of the -server. For example, the expected key action associated with pressing the Shift key is to set -the Shift modifier. There is zero or one key action associated with each keysym bound to each +A key action defines the effect key presses and releases have on the internal state of the +server. For example, the expected key action associated with pressing the Shift key is to set +the Shift modifier. There is zero or one key action associated with each keysym bound to each key. Just as the entire list of key symbols for the keyboard mapping is held in the -.I syms -field of the client map, the entire list of key actions for the keyboard mapping is held in the -.I acts -array of the server map. The total size of -.I acts -is specified by -.I size_acts, -and the number of entries is specified by -.I num_acts. +.I syms +field of the client map, the entire list of key actions for the keyboard mapping is held in the +.I acts +array of the server map. The total size of +.I acts +is specified by +.I size_acts, +and the number of entries is specified by +.I num_acts. -The -.I key_acts +The +.I key_acts array, indexed by keycode, describes the actions associated with a key. The -.I key_acts -array has -.I min_key_code +.I key_acts +array has +.I min_key_code unused entries at the start to allow direct indexing using a keycode. If a -.I key_acts -entry is zero, it means the key does not have any actions associated with it. If an entry is not -zero, the entry represents an index into the -.I acts -field of the server map, much as the -.I offset -field of a KeySymMapRec structure is an index into the -.I syms -field of the client map. +.I key_acts +entry is zero, it means the key does not have any actions associated with it. If an entry is not +zero, the entry represents an index into the +.I acts +field of the server map, much as the +.I offset +field of a KeySymMapRec structure is an index into the +.I syms +field of the client map. -The reason the -.I acts -field is a linear list of XkbActions is to reduce the memory consumption associated with a -keymap. Because Xkb allows individual keys to have multiple shift levels and a different number -of groups per key, a single two-dimensional array of KeySyms would potentially be very large and -sparse. Instead, Xkb provides a small two-dimensional array of XkbActions for each key. To store -all of these individual arrays, Xkb concatenates each array together in the -.I acts +The reason the +.I acts +field is a linear list of XkbActions is to reduce the memory consumption associated with a +keymap. Because Xkb allows individual keys to have multiple shift levels and a different number +of groups per key, a single two-dimensional array of KeySyms would potentially be very large and +sparse. Instead, Xkb provides a small two-dimensional array of XkbActions for each key. To store +all of these individual arrays, Xkb concatenates each array together in the +.I acts field of the server map. -The key action structures consist only of fields of type char or unsigned char. This is done to -optimize data transfer when the server sends bytes over the wire. If the fields are anything but -bytes, the server has to sift through all of the actions and swap any nonbyte fields. Because +The key action structures consist only of fields of type char or unsigned char. This is done to +optimize data transfer when the server sends bytes over the wire. If the fields are anything but +bytes, the server has to sift through all of the actions and swap any nonbyte fields. Because they consist of nothing but bytes, it can just copy them out. -.I XkbKeyHasActions -returns True if the key corresponding to -.I keycode +.I XkbKeyHasActions +returns True if the key corresponding to +.I keycode has any actions associated with it; otherwise, it returns False. .SH "RETURN VALUES" .TP 15 True -The -.I XkbKeyHasActions -function will return True if the key corresponding to -.I keycode +The +.I XkbKeyHasActions +function will return True if the key corresponding to +.I keycode has any actions associated with it. .TP 15 False -The -.I XkbKeyHasActions -function will return False if the key corresponding to -.I keycode +The +.I XkbKeyHasActions +function will return False if the key corresponding to +.I keycode does not have any actions associated with it. .SH STRUCTURES .LP @@ -114,7 +114,7 @@ The KeySymMapRec structure is defined as follows: #define XkbNumKbdGroups 4 #define XkbMaxKbdGroup (XkbNumKbdGroups-1) - + typedef struct { /\&* map to keysyms for a single keycode */ unsigned char kt_index[XkbNumKbdGroups]; /\&* key type index for each group */ unsigned char group_info; /\&* # of groups and out of range group handling */ diff --git a/man/xkb/XkbKeyKeyType.man b/man/xkb/XkbKeyKeyType.man index 1dfd224a..85f8b238 100644 --- a/man/xkb/XkbKeyKeyType.man +++ b/man/xkb/XkbKeyKeyType.man @@ -44,14 +44,14 @@ group index .SH DESCRIPTION .LP .I XkbKeyKeyType -returns a pointer to the key type in the -.I types -vector of the client map in -.I xkb -corresponding to the given -.I keycode -and -.I group +returns a pointer to the key type in the +.I types +vector of the client map in +.I xkb +corresponding to the given +.I keycode +and +.I group index. .SH STRUCTURES .LP diff --git a/man/xkb/XkbKeyKeyTypeIndex.man b/man/xkb/XkbKeyKeyTypeIndex.man index 677c085f..88c3eb9a 100644 --- a/man/xkb/XkbKeyKeyTypeIndex.man +++ b/man/xkb/XkbKeyKeyTypeIndex.man @@ -44,13 +44,13 @@ group index .SH DESCRIPTION .LP .I XkbKeyKeyTypeIndex -computes an index into the -.I types -vector of the client map in -.I xkb -from the given -.I keycode -and -.I group +computes an index into the +.I types +vector of the client map in +.I xkb +from the given +.I keycode +and +.I group index. diff --git a/man/xkb/XkbKeyNumActions.man b/man/xkb/XkbKeyNumActions.man index 7d249dde..66d20acc 100644 --- a/man/xkb/XkbKeyNumActions.man +++ b/man/xkb/XkbKeyNumActions.man @@ -22,7 +22,7 @@ .\" .TH XkbKeyNumActions __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeyNumActions \- Computes the number of actions associated with the key corresponding to +XkbKeyNumActions \- Computes the number of actions associated with the key corresponding to keycode .SH SYNOPSIS .HP @@ -37,61 +37,61 @@ keycode Xkb description of interest .TP .I keycode -keycode of interest +keycode of interest .SH DESCRIPTION .LP -A key action defines the effect key presses and releases have on the internal state of the -server. For example, the expected key action associated with pressing the Shift key is to set -the Shift modifier. There is zero or one key action associated with each keysym bound to each +A key action defines the effect key presses and releases have on the internal state of the +server. For example, the expected key action associated with pressing the Shift key is to set +the Shift modifier. There is zero or one key action associated with each keysym bound to each key. Just as the entire list of key symbols for the keyboard mapping is held in the -.I syms -field of the client map, the entire list of key actions for the keyboard mapping is held in the -.I acts -array of the server map. The total size of -.I acts -is specified by -.I size_acts, -and the number of entries is specified by -.I num_acts. +.I syms +field of the client map, the entire list of key actions for the keyboard mapping is held in the +.I acts +array of the server map. The total size of +.I acts +is specified by +.I size_acts, +and the number of entries is specified by +.I num_acts. -The -.I key_acts +The +.I key_acts array, indexed by keycode, describes the actions associated with a key. The -.I key_acts -array has -.I min_key_code +.I key_acts +array has +.I min_key_code unused entries at the start to allow direct indexing using a keycode. If a -.I key_acts -entry is zero, it means the key does not have any actions associated with it. If an entry is not -zero, the entry represents an index into the -.I acts -field of the server map, much as the -.I offset -field of a KeySymMapRec structure is an index into the -.I syms -field of the client map. +.I key_acts +entry is zero, it means the key does not have any actions associated with it. If an entry is not +zero, the entry represents an index into the +.I acts +field of the server map, much as the +.I offset +field of a KeySymMapRec structure is an index into the +.I syms +field of the client map. -The reason the -.I acts -field is a linear list of XkbActions is to reduce the memory consumption associated with a -keymap. Because Xkb allows individual keys to have multiple shift levels and a different number -of groups per key, a single two-dimensional array of KeySyms would potentially be very large and -sparse. Instead, Xkb provides a small two-dimensional array of XkbActions for each key. To store -all of these individual arrays, Xkb concatenates each array together in the -.I acts +The reason the +.I acts +field is a linear list of XkbActions is to reduce the memory consumption associated with a +keymap. Because Xkb allows individual keys to have multiple shift levels and a different number +of groups per key, a single two-dimensional array of KeySyms would potentially be very large and +sparse. Instead, Xkb provides a small two-dimensional array of XkbActions for each key. To store +all of these individual arrays, Xkb concatenates each array together in the +.I acts field of the server map. -The key action structures consist only of fields of type char or unsigned char. This is done to -optimize data transfer when the server sends bytes over the wire. If the fields are anything but -bytes, the server has to sift through all of the actions and swap any nonbyte fields. Because +The key action structures consist only of fields of type char or unsigned char. This is done to +optimize data transfer when the server sends bytes over the wire. If the fields are anything but +bytes, the server has to sift through all of the actions and swap any nonbyte fields. Because they consist of nothing but bytes, it can just copy them out. -.I XkbKeyNumActions -computes the number of actions associated with the key corresponding to -.I keycode. -This should be the same value as the result of +.I XkbKeyNumActions +computes the number of actions associated with the key corresponding to +.I keycode. +This should be the same value as the result of .I XkbKeyNumSyms. .SH STRUCTURES .LP @@ -100,7 +100,7 @@ The KeySymMapRec structure is defined as follows: #define XkbNumKbdGroups 4 #define XkbMaxKbdGroup (XkbNumKbdGroups-1) - + typedef struct { /\&* map to keysyms for a single keycode */ unsigned char kt_index[XkbNumKbdGroups]; /\&* key type index for each group */ unsigned char group_info; /\&* # of groups and out of range group handling */ diff --git a/man/xkb/XkbKeyNumGroups.man b/man/xkb/XkbKeyNumGroups.man index fbb7c31f..fc47edb5 100644 --- a/man/xkb/XkbKeyNumGroups.man +++ b/man/xkb/XkbKeyNumGroups.man @@ -22,7 +22,7 @@ .\" .TH XkbKeyNumGroups __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeyNumGroups \- Returns the number of groups of symbols bound to the key +XkbKeyNumGroups \- Returns the number of groups of symbols bound to the key corresponding to keycode .SH SYNOPSIS .HP @@ -40,49 +40,49 @@ Xkb description of interest keycode of interest .SH DESCRIPTION .LP -The -.I group_info -field of an XkbSymMapRec is an encoded value containing the number of groups of -symbols bound to the -key as well as the specification of the treatment of out-of-range groups. It is -legal for a key to -have zero groups, in which case it also has zero symbols and all events from -that key yield NoSymbol. -To obtain the number of groups of symbols bound to the key, use -.I XkbKeyNumGroups. -To change the number of groups bound to a key, use -.I XkbChangeTypesOfKey. +The +.I group_info +field of an XkbSymMapRec is an encoded value containing the number of groups of +symbols bound to the +key as well as the specification of the treatment of out-of-range groups. It is +legal for a key to +have zero groups, in which case it also has zero symbols and all events from +that key yield NoSymbol. +To obtain the number of groups of symbols bound to the key, use +.I XkbKeyNumGroups. +To change the number of groups bound to a key, use +.I XkbChangeTypesOfKey. To obtain a mask that determines the treatment of out-of-range groups, use -.I XkbKeyGroupInfo -and +.I XkbKeyGroupInfo +and .I XkbOutOfRangeGroupInfo. -The keyboard controls contain a -.I groups_wrap -field specifying the handling of illegal groups on a global basis. That is, when -the user performs an -action causing the effective group to go out of the legal range, the -.I groups_wrap -field specifies how to normalize the effective keyboard group to a group that is -legal for the -keyboard as a whole, but there is no guarantee that the normalized group will be -within the range of -legal groups for any individual key. The per-key -.I group_info -field specifies how a key treats a legal effective group if the key does not -have a type specified for -the group of concern. For example, the Enter key usually has just one group -defined. If the user -performs an action causing the global keyboard group to change to Group2, the -.I group_info +The keyboard controls contain a +.I groups_wrap +field specifying the handling of illegal groups on a global basis. That is, when +the user performs an +action causing the effective group to go out of the legal range, the +.I groups_wrap +field specifies how to normalize the effective keyboard group to a group that is +legal for the +keyboard as a whole, but there is no guarantee that the normalized group will be +within the range of +legal groups for any individual key. The per-key +.I group_info +field specifies how a key treats a legal effective group if the key does not +have a type specified for +the group of concern. For example, the Enter key usually has just one group +defined. If the user +performs an action causing the global keyboard group to change to Group2, the +.I group_info field for the Enter key describes how to handle this situation. -Out-of-range groups for individual keys are mapped to a legal group using the -same options as are used -for the overall keyboard group. The particular type of mapping used is -controlled by the bits set in -the -.I group_info +Out-of-range groups for individual keys are mapped to a legal group using the +same options as are used +for the overall keyboard group. The particular type of mapping used is +controlled by the bits set in +the +.I group_info flag, as shown in Table 1. .bp .TS @@ -99,52 +99,52 @@ none of the above XkbWrapIntoRange .TE .LP .\"--- Chapter 10 -The Xkb extension is composed of two parts: a server extension, and a -client-side X library extension. -This chapter discusses functions used to modify controls effecting the behavior -of the server portion -of the Xkb extension. X Library Controls discusses functions used to modify -controls that affect only -the behavior of the client portion of the extension; those controls are known as +The Xkb extension is composed of two parts: a server extension, and a +client-side X library extension. +This chapter discusses functions used to modify controls effecting the behavior +of the server portion +of the Xkb extension. X Library Controls discusses functions used to modify +controls that affect only +the behavior of the client portion of the extension; those controls are known as Library Controls. -Xkb contains control features that affect the entire keyboard, known as global -keyboard controls. Some -of the controls may be selectively enabled and disabled; these controls are -known as the -.I Boolean Controls. -Boolean Controls can be turned on or off under program control and can also be -automatically set to an -on or off condition when a client program exits. The remaining controls, known -as the -.I Non-Boolean Controls, -are always active. The XkbControlsRec structure describes the current state of -most of the global -controls and the attributes effecting the behavior of each of these Xkb -features. This chapter +Xkb contains control features that affect the entire keyboard, known as global +keyboard controls. Some +of the controls may be selectively enabled and disabled; these controls are +known as the +.I Boolean Controls. +Boolean Controls can be turned on or off under program control and can also be +automatically set to an +on or off condition when a client program exits. The remaining controls, known +as the +.I Non-Boolean Controls, +are always active. The XkbControlsRec structure describes the current state of +most of the global +controls and the attributes effecting the behavior of each of these Xkb +features. This chapter describes the Xkb controls and how to manipulate them. -There are two possible components for each of the Boolean Controls: attributes -describing how the -control should work, and a state describing whether the behavior as a whole is -enabled or disabled. -The attributes and state for most of these controls are held in the +There are two possible components for each of the Boolean Controls: attributes +describing how the +control should work, and a state describing whether the behavior as a whole is +enabled or disabled. +The attributes and state for most of these controls are held in the XkbControlsRec structure. -You can manipulate the Xkb controls individually, via convenience functions, or -as a whole. To treat -them as a group, modify an XkbControlsRec structure to describe all of the -changes to be made, and -then pass that structure and appropriate flags to an Xkb library function, or -use a -XkbControlsChangesRec to reduce network traffic. When using a convenience -function to manipulate one +You can manipulate the Xkb controls individually, via convenience functions, or +as a whole. To treat +them as a group, modify an XkbControlsRec structure to describe all of the +changes to be made, and +then pass that structure and appropriate flags to an Xkb library function, or +use a +XkbControlsChangesRec to reduce network traffic. When using a convenience +function to manipulate one control individually, you do not use an XkbControlsRec structure directly. The Xkb controls are grouped as shown in Table 2. .ad l .TS -c s s +c s s l l l lw(2i) l l. Table 2 Xkb Keyboard Controls @@ -197,8 +197,8 @@ _ .ad n .LP -The individual categories and controls are described first, together with -functions for manipulating +The individual categories and controls are described first, together with +functions for manipulating them. .SH STRUCTURES .LP @@ -207,7 +207,7 @@ The KeySymMapRec structure is defined as follows: #define XkbNumKbdGroups 4 #define XkbMaxKbdGroup (XkbNumKbdGroups-1) - + typedef struct { /\&* map to keysyms for a single keycode */ unsigned char kt_index[XkbNumKbdGroups]; /\&* key type index for each group */ unsigned char group_info; /\&* # of groups and out of range group handling */ @@ -222,8 +222,8 @@ 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 */ @@ -255,7 +255,7 @@ 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 */ diff --git a/man/xkb/XkbKeyNumSyms.man b/man/xkb/XkbKeyNumSyms.man index f8539307..bbe4bbfd 100644 --- a/man/xkb/XkbKeyNumSyms.man +++ b/man/xkb/XkbKeyNumSyms.man @@ -22,8 +22,8 @@ .\" .TH XkbKeyNumSyms __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeyNumSyms \- Returns the total number of keysyms for the key corresponding -to +XkbKeyNumSyms \- Returns the total number of keysyms for the key corresponding +to .I keycode .SH SYNOPSIS .HP @@ -41,25 +41,25 @@ Xkb description of interest keycode of interest .SH DESCRIPTION .LP -The key width and number of groups associated with a key are used to form a -small two-dimensional array of KeySyms for a key. This array may be different -sizes for different keys. The array for a single key is stored as a linear list, -in row-major order. The arrays for all of the keys are stored in the -.I syms -field of the client map. There is one row for each group associated with a key -and one column for each level. The index corresponding to a given group and +The key width and number of groups associated with a key are used to form a +small two-dimensional array of KeySyms for a key. This array may be different +sizes for different keys. The array for a single key is stored as a linear list, +in row-major order. The arrays for all of the keys are stored in the +.I syms +field of the client map. There is one row for each group associated with a key +and one column for each level. The index corresponding to a given group and shift level is computed as: .nf idx = group_index * key_width + shift_level - + .fi -The -.I offset -field of the -.I key_sym_map +The +.I offset +field of the +.I key_sym_map entry for a key is used to access the beginning of the array. -.I XkbKeyNumSyms -returns the total number of keysyms for the key corresponding to +.I XkbKeyNumSyms +returns the total number of keysyms for the key corresponding to .I keycode. diff --git a/man/xkb/XkbKeySymEntry.man b/man/xkb/XkbKeySymEntry.man index fa221d56..38249122 100644 --- a/man/xkb/XkbKeySymEntry.man +++ b/man/xkb/XkbKeySymEntry.man @@ -21,11 +21,11 @@ .\" .TH XkbKeySymEntry __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeySymEntry \- Returns the keysym corresponding to shift level -.I shift -and group -.I grp -from the two-dimensional array of keysyms for the key corresponding to +XkbKeySymEntry \- Returns the keysym corresponding to shift level +.I shift +and group +.I grp +from the two-dimensional array of keysyms for the key corresponding to .I keycode .SH SYNOPSIS .HP @@ -42,7 +42,7 @@ from the two-dimensional array of keysyms for the key corresponding to Xkb description of interest .TP .I keycode -keycode of interest +keycode of interest .TP .I shift shift level of interest @@ -51,29 +51,29 @@ shift level of interest group of interest .SH DESCRIPTION .LP -The key width and number of groups associated with a key are used to form a -small two-dimensional array of KeySyms for a key. This array may be different -sizes for different keys. The array for a single key is stored as a linear list, -in row-major order. The arrays for all of the keys are stored in the -.I syms -field of the client map. There is one row for each group associated with a key -and one column for each level. The index corresponding to a given group and +The key width and number of groups associated with a key are used to form a +small two-dimensional array of KeySyms for a key. This array may be different +sizes for different keys. The array for a single key is stored as a linear list, +in row-major order. The arrays for all of the keys are stored in the +.I syms +field of the client map. There is one row for each group associated with a key +and one column for each level. The index corresponding to a given group and shift level is computed as: .nf idx = group_index * key_width + shift_level - + .fi -The -.I offset -field of the -.I key_sym_map +The +.I offset +field of the +.I key_sym_map entry for a key is used to access the beginning of the array. -.I XkbKeySymEntry -returns the keysym corresponding to shift level -.I shift -and group -.I grp -from the two-dimensional array of keysyms for the key corresponding to +.I XkbKeySymEntry +returns the keysym corresponding to shift level +.I shift +and group +.I grp +from the two-dimensional array of keysyms for the key corresponding to .I keycode. diff --git a/man/xkb/XkbKeySymsPtr.man b/man/xkb/XkbKeySymsPtr.man index 191a7b67..482a908f 100644 --- a/man/xkb/XkbKeySymsPtr.man +++ b/man/xkb/XkbKeySymsPtr.man @@ -22,8 +22,8 @@ .\" .TH XkbKeySymsPtr __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeySymsPtr \- Returns the pointer to the two-dimensional array of keysyms for -the key corresponding to +XkbKeySymsPtr \- Returns the pointer to the two-dimensional array of keysyms for +the key corresponding to .I keycode .SH SYNOPSIS .HP @@ -41,26 +41,26 @@ Xkb description of interest keycode of interest .SH DESCRIPTION .LP -The key width and number of groups associated with a key are used to form a -small two-dimensional array of KeySyms for a key. This array may be different -sizes for different keys. The array for a single key is stored as a linear list, -in row-major order. The arrays for all of the keys are stored in the -.I syms -field of the client map. There is one row for each group associated with a key -and one column for each level. The index corresponding to a given group and +The key width and number of groups associated with a key are used to form a +small two-dimensional array of KeySyms for a key. This array may be different +sizes for different keys. The array for a single key is stored as a linear list, +in row-major order. The arrays for all of the keys are stored in the +.I syms +field of the client map. There is one row for each group associated with a key +and one column for each level. The index corresponding to a given group and shift level is computed as: .nf idx = group_index * key_width + shift_level - + .fi -The -.I offset -field of the -.I key_sym_map +The +.I offset +field of the +.I key_sym_map entry for a key is used to access the beginning of the array. -.I XkbKeySymsPtr -returns the pointer to the two-dimensional array of keysyms for the key -corresponding to +.I XkbKeySymsPtr +returns the pointer to the two-dimensional array of keysyms for the key +corresponding to .I keycode. diff --git a/man/xkb/XkbKeyTypesForCoreSymbols.man b/man/xkb/XkbKeyTypesForCoreSymbols.man index 3d6b40b9..763e8623 100644 --- a/man/xkb/XkbKeyTypesForCoreSymbols.man +++ b/man/xkb/XkbKeyTypesForCoreSymbols.man @@ -22,7 +22,7 @@ .\" .TH XkbKeyTypesForCoreSymbols __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeyTypesForCoreSymbols \- Determine the Xkb key types appropriate for the +XkbKeyTypesForCoreSymbols \- Determine the Xkb key types appropriate for the symbols bound to a key in a core keyboard mapping .SH SYNOPSIS .HP @@ -56,23 +56,23 @@ backfilled with the canonical types bound to groups one and two for the key backfilled with symbols bound to the key in the Xkb mapping .SH DESCRIPTION .LP -.I XkbKeyTypesForCoreSymbols -expands the symbols in -.I core_syms -and types in +.I XkbKeyTypesForCoreSymbols +expands the symbols in +.I core_syms +and types in .I types_inout, -then chooses canonical key types (canonical key types are -defined The Canonical Key Types) for groups 1 and 2 using the rules specified by +then chooses canonical key types (canonical key types are +defined The Canonical Key Types) for groups 1 and 2 using the rules specified by the Xkb protocol and places them in xkb_syms_rtrn, which will be non-NULL. .B The Canonical Key Types -Xkb allows up to XkbMaxKeyTypes (255) key types to be defined, but requires at -least XkbNumRequiredTypes (4) predefined types to be in a key map. These -predefined key types are referred to as the canonical key types and describe the -types of keys available on most keyboards. The definitions for the canonical key -types are held in the first XkbNumRequiredTypes entries of the -.I types +Xkb allows up to XkbMaxKeyTypes (255) key types to be defined, but requires at +least XkbNumRequiredTypes (4) predefined types to be in a key map. These +predefined key types are referred to as the canonical key types and describe the +types of keys available on most keyboards. The definitions for the canonical key +types are held in the first XkbNumRequiredTypes entries of the +.I types field of the client map and are indexed using the following constants: .nf @@ -80,14 +80,14 @@ field of the client map and are indexed using the following constants: XkbTwoLevelIndex XkbAlphabeticIndex XkbKeypadIndex - + .fi - + ONE_LEVEL -The ONE_LEVEL key type describes groups that have only one symbol. The default -ONE_LEVEL key type has no map entries and does not pay attention to any -modifiers. A symbolic representation of this key type could look like the +The ONE_LEVEL key type describes groups that have only one symbol. The default +ONE_LEVEL key type has no map entries and does not pay attention to any +modifiers. A symbolic representation of this key type could look like the following: .nf @@ -96,17 +96,17 @@ following: map[None]= Level1; level_name[Level1]= "Any"; }; - -.fi -The description of the ONE_LEVEL key type is stored in the + +.fi +The description of the ONE_LEVEL key type is stored in the types[XkbOneLevelIndex] entry of the client key map. TWO_LEVEL -The TWO_LEVEL key type describes groups that consist of two symbols but are -neither alphabetic nor numeric keypad keys. The default TWO_LEVEL type uses only -the Shift modifier. It returns shift level two if Shift is set, and level one if -it is not. A symbolic representation of this key type could look like the +The TWO_LEVEL key type describes groups that consist of two symbols but are +neither alphabetic nor numeric keypad keys. The default TWO_LEVEL type uses only +the Shift modifier. It returns shift level two if Shift is set, and level one if +it is not. A symbolic representation of this key type could look like the following: .nf @@ -116,17 +116,17 @@ following: level_name[Level1]= "Base"; level_name[Level2]= "Shift"; }; - + .fi - -The description of the TWO_LEVEL key type is stored in the + +The description of the TWO_LEVEL key type is stored in the types[XkbTwoLevelIndex] entry of the client key map. ALPHABETIC -The ALPHABETIC key type describes groups consisting of two symbols: the -lowercase form of a symbol followed by the uppercase form of the same symbol. -The default ALPHABETIC type implements locale-sensitive "Shift cancels CapsLock" +The ALPHABETIC key type describes groups consisting of two symbols: the +lowercase form of a symbol followed by the uppercase form of the same symbol. +The default ALPHABETIC type implements locale-sensitive "Shift cancels CapsLock" behavior using both the Shift and Lock modifiers as follows: .IP \(bu 5 @@ -134,9 +134,9 @@ If Shift and Lock are both set, the default ALPHABETIC type yields level one. .IP \(bu 5 If Shift alone is set, it yields level two. .IP \(bu 5 -If Lock alone is set, it yields level one, but preserves the Lock modifier so -Xlib notices and applies the appropriate capitalization rules. The Xlib -functions are locale-sensitive and apply different capitalization rules for +If Lock alone is set, it yields level one, but preserves the Lock modifier so +Xlib notices and applies the appropriate capitalization rules. The Xlib +functions are locale-sensitive and apply different capitalization rules for different locales. .IP \(bu 5 If neither Shift nor Lock is set, it yields level one. @@ -151,17 +151,17 @@ A symbolic representation of this key type could look like the following: level_name[Level1]= "Base"; level_name[Level2]= "Caps"; }; - -.fi -The description of the ALPHABETIC key type is stored in the + +.fi +The description of the ALPHABETIC key type is stored in the types[XkbAlphabeticIndex] entry of the client key map. KEYPAD -The KEYPAD key type describes groups that consist of two symbols, at least one -of which is a numeric keypad symbol. The numeric keypad symbol is assumed to -reside at level two. The default KEYPAD key type implements "Shift cancels -NumLock" behavior using the Shift modifier and the real modifier bound to the +The KEYPAD key type describes groups that consist of two symbols, at least one +of which is a numeric keypad symbol. The numeric keypad symbol is assumed to +reside at level two. The default KEYPAD key type implements "Shift cancels +NumLock" behavior using the Shift modifier and the real modifier bound to the virtual modifier named "NumLock," known as the NumLock modifier, as follows: .IP \(bu 5 @@ -185,44 +185,44 @@ A symbolic representation of this key type could look like the following: level_name[Level1]= "Base"; level_name[Level2]= "Caps"; }; - -.fi -The description of the KEYPAD key type is stored in the types[XkbKeypadIndex] + +.fi +The description of the KEYPAD key type is stored in the types[XkbKeypadIndex] entry of the client key map. -A core keymap is a two-dimensional array of keysyms. It has -.I map_width -columns and -.I max_key_code -rows. -.I XkbKeyTypesForCoreSymbols -takes a single row from a core keymap, determines the number of groups -associated with it, the type of each group, and the symbols bound to each group. -The return value is the number of groups, -.I types_inout -has the types for each group, and -.I xkb_syms_rtrn -has the symbols in Xkb order (that is, groups are contiguous, regardless of +A core keymap is a two-dimensional array of keysyms. It has +.I map_width +columns and +.I max_key_code +rows. +.I XkbKeyTypesForCoreSymbols +takes a single row from a core keymap, determines the number of groups +associated with it, the type of each group, and the symbols bound to each group. +The return value is the number of groups, +.I types_inout +has the types for each group, and +.I xkb_syms_rtrn +has the symbols in Xkb order (that is, groups are contiguous, regardless of size). -.I protected -contains the explicitly protected key types. There is one explicit override -control associated with each of the four possible groups for each Xkb key, -ExplicitKeyType1 through ExplicitKeyType4; -.I protected -is an inclusive OR of these controls. -.I map_width +.I protected +contains the explicitly protected key types. There is one explicit override +control associated with each of the four possible groups for each Xkb key, +ExplicitKeyType1 through ExplicitKeyType4; +.I protected +is an inclusive OR of these controls. +.I map_width is the width of the core keymap and is not dependent on any Xkb definitions. -.I types_inout -is an array of four type indices. On input, -.I types_inout -contains the indices of any types already assigned to the key, in case they are +.I types_inout +is an array of four type indices. On input, +.I types_inout +contains the indices of any types already assigned to the key, in case they are explicitly protected from change. -Upon return, -.I types_inout -contains any automatically selected (that is, canonical) types plus any -protected types. Canonical types are assigned to all four groups if there are -enough symbols to do so. The four entries in -.I types_inout -correspond to the four groups for the key in question. +Upon return, +.I types_inout +contains any automatically selected (that is, canonical) types plus any +protected types. Canonical types are assigned to all four groups if there are +enough symbols to do so. The four entries in +.I types_inout +correspond to the four groups for the key in question. diff --git a/man/xkb/XkbKeycodeToKeysym.man b/man/xkb/XkbKeycodeToKeysym.man index 849f45d2..f86228fb 100644 --- a/man/xkb/XkbKeycodeToKeysym.man +++ b/man/xkb/XkbKeycodeToKeysym.man @@ -21,7 +21,7 @@ .\" .TH XkbKeycodeToKeysym __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeycodeToKeysym \- Finds the keysym bound to a particular key at a specified +XkbKeycodeToKeysym \- Finds the keysym bound to a particular key at a specified group and shift level .SH SYNOPSIS .HP @@ -35,26 +35,26 @@ group and shift level .SH ARGUMENTS .TP .I dpy -connection to X server +connection to X server .TP .I kc -key of interest +key of interest .TP .I group -group of interest +group of interest .TP .I level -shift level of interest +shift level of interest .SH DESCRIPTION .LP -.I XkbKeycodeToKeysym -returns the keysym bound to a particular group and shift level for a particular -key on the core keyboard. If -.I kc -is not a legal keycode for the core keyboard, or if -.I group -or -.I level -are out of range for the specified key, -.I XkbKeycodeToKeysym +.I XkbKeycodeToKeysym +returns the keysym bound to a particular group and shift level for a particular +key on the core keyboard. If +.I kc +is not a legal keycode for the core keyboard, or if +.I group +or +.I level +are out of range for the specified key, +.I XkbKeycodeToKeysym returns NoSymbol. diff --git a/man/xkb/XkbKeysymToModifiers.man b/man/xkb/XkbKeysymToModifiers.man index 1fcfb682..b5081344 100644 --- a/man/xkb/XkbKeysymToModifiers.man +++ b/man/xkb/XkbKeysymToModifiers.man @@ -21,7 +21,7 @@ .\" .TH XkbKeysymToModifiers __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeysymToModifiers \- Finds the set of modifiers bound to a particular keysym +XkbKeysymToModifiers \- Finds the set of modifiers bound to a particular keysym on the core keyboard .SH SYNOPSIS .HP @@ -39,14 +39,14 @@ connection to X server keysym of interest .SH DESCRIPTION .LP -.I XkbKeysymToModifiers -finds the set of modifiers currently bound to the keysym -.I ks -on the core keyboard. The value returned is the mask of modifiers bound to the -keysym -.I ks. -If no modifiers are bound to the keysym, -.I XkbKeysymToModifiers -returns zero; otherwise, it returns the inclusive OR of zero or more of the -following: ShiftMask, ControlMask, LockMask, Mod1Mask, Mod2Mask, Mod3Mask, +.I XkbKeysymToModifiers +finds the set of modifiers currently bound to the keysym +.I ks +on the core keyboard. The value returned is the mask of modifiers bound to the +keysym +.I ks. +If no modifiers are bound to the keysym, +.I XkbKeysymToModifiers +returns zero; otherwise, it returns the inclusive OR of zero or more of the +following: ShiftMask, ControlMask, LockMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, and Mod5Mask. diff --git a/man/xkb/XkbLatchGroup.man b/man/xkb/XkbLatchGroup.man index 3cc1fd35..670d223b 100644 --- a/man/xkb/XkbLatchGroup.man +++ b/man/xkb/XkbLatchGroup.man @@ -34,7 +34,7 @@ XkbLatchGroup \- Latches the keysym group .SH ARGUMENTS .TP .I display -connection to the X server +connection to the X server .TP .I device_spec device ID, or XkbUseCoreKbd @@ -44,11 +44,11 @@ index of the keysym group to latch .SH DESCRIPTION .LP -.I XkbLatchGroup -sends a request to the server to latch the specified +.I XkbLatchGroup +sends a request to the server to latch the specified .I group -and -does not wait for a reply. It returns True if the request was sent and False +and +does not wait for a reply. It returns True if the request was sent and False otherwise. Reference the keysym group indices with these symbolic constants: @@ -69,14 +69,14 @@ XkbGroup4Index 3 .SH "RETURN VALUES" .TP 15 True -The -.I XkbLatchGroup -function returns True if a request was sent to the server to latch the specified +The +.I XkbLatchGroup +function returns True if a request was sent to the server to latch the specified .I group. .TP 15 False -The -.I XkbLatchGroup +The +.I XkbLatchGroup function returns False if the request was not sent. diff --git a/man/xkb/XkbLatchModifiers.man b/man/xkb/XkbLatchModifiers.man index a810139e..a7278fb4 100644 --- a/man/xkb/XkbLatchModifiers.man +++ b/man/xkb/XkbLatchModifiers.man @@ -22,7 +22,7 @@ .\" .TH XkbLatchModifiers __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbLatchModifiers \- Latches and unlatches any of the eight real keyboard +XkbLatchModifiers \- Latches and unlatches any of the eight real keyboard modifiers .SH SYNOPSIS .HP @@ -36,7 +36,7 @@ modifiers .SH ARGUMENTS .TP .I display -connection to the X server +connection to the X server .TP .I device_spec device ID, or XkbUseCoreKbd @@ -48,27 +48,27 @@ mask of real modifiers whose lock state is to change 1 => lock, 0 => unlock; only for modifiers selected by affect .SH DESCRIPTION .LP -.I XkbLatchModifiers -sends a request to the server to latch the real modifiers -selected by both -.I affect -and -.I values -and to unlatch the real modifiers selected by +.I XkbLatchModifiers +sends a request to the server to latch the real modifiers +selected by both .I affect -, but not selected by -.I values. +and +.I values +and to unlatch the real modifiers selected by +.I affect +, but not selected by +.I values. -.I XkbLatchModifiers -does not wait for a reply from the server. It returns True if +.I XkbLatchModifiers +does not wait for a reply from the server. It returns True if the request was sent, and False otherwise. -The functions in this section that change the use of modifiers use a mask in the -parameter affect. It is a bitwise inclusive OR of the legal modifier masks: +The functions in this section that change the use of modifiers use a mask in the +parameter affect. It is a bitwise inclusive OR of the legal modifier masks: .TS -c -l +c +l l. Table 1 Real Modifier Masks _ @@ -86,19 +86,19 @@ Mod5Mask .SH "RETURN VALUES" .TP 15 True -The -.I XkbLatchModifiers -function returns True if a request was sent to the server to latch the real modifiers selected by both -.I affect -and -.I values -and to unlatch the real modifiers selected by +The +.I XkbLatchModifiers +function returns True if a request was sent to the server to latch the real modifiers selected by both .I affect -, but not selected by -.I values. +and +.I values +and to unlatch the real modifiers selected by +.I affect +, but not selected by +.I values. .TP 15 False -The -.I XkbLatchModifiers +The +.I XkbLatchModifiers function returns False if the request was not sent. diff --git a/man/xkb/XkbLibraryVersion.man b/man/xkb/XkbLibraryVersion.man index cbc64cc6..5c0de52b 100644 --- a/man/xkb/XkbLibraryVersion.man +++ b/man/xkb/XkbLibraryVersion.man @@ -38,53 +38,53 @@ Specifies and returns the major Xkb library version. Specifies and returns the minor Xkb library version. .SH DESCRIPTION .LP -If an application is dynamically linked, both the X server and the client-side X -library must contain the Xkb extension in order for the client to use the Xkb -extension capabilities. Therefore a dynamically linked application must check -both the library and the server for compatibility before using Xkb function -calls. A properly written program must check for compatibility between the -version of the Xkb library that is dynamically loaded and the one used when the -application was built. It must then check the server version for compatibility +If an application is dynamically linked, both the X server and the client-side X +library must contain the Xkb extension in order for the client to use the Xkb +extension capabilities. Therefore a dynamically linked application must check +both the library and the server for compatibility before using Xkb function +calls. A properly written program must check for compatibility between the +version of the Xkb library that is dynamically loaded and the one used when the +application was built. It must then check the server version for compatibility with the version of Xkb in the library. -If your application is statically linked, you must still check for server -compatibility and may check library compatibility. (It is possible to compile -against one set of header files and link against a different, incompatible, +If your application is statically linked, you must still check for server +compatibility and may check library compatibility. (It is possible to compile +against one set of header files and link against a different, incompatible, version of the library, although this should not normally occur.) -Pass the symbolic value XkbMajorVersion in -.I lib_major_in_out -and XkbMinorVersion in -.I lib_minor_in_out. -These arguments represent the version of the library used -at compile time. The -.I XkbLibraryVersion -function backfills the major and minor version numbers of the library used at -run time in -.I lib_major_in_out and -.I lib_minor_in_out. -If the versions of the compile time and run time libraries are -compatible, -.I XkbLibraryVersion +Pass the symbolic value XkbMajorVersion in +.I lib_major_in_out +and XkbMinorVersion in +.I lib_minor_in_out. +These arguments represent the version of the library used +at compile time. The +.I XkbLibraryVersion +function backfills the major and minor version numbers of the library used at +run time in +.I lib_major_in_out and +.I lib_minor_in_out. +If the versions of the compile time and run time libraries are +compatible, +.I XkbLibraryVersion returns True, otherwise, it returns False. -In addition, in order to use the Xkb extension, you must ensure that the -extension is present in the server and that the server supports the version of -the extension expected by the client. Use -.I XkbQueryExtension +In addition, in order to use the Xkb extension, you must ensure that the +extension is present in the server and that the server supports the version of +the extension expected by the client. Use +.I XkbQueryExtension to do this, as described in the next section. .SH "RETURN VALUES" .TP 15 True -The -.I XkbLibraryVersion -returns True if the versions of the compile time and run time libraries are +The +.I XkbLibraryVersion +returns True if the versions of the compile time and run time libraries are compatible. .TP 15 False -The -.I XkbLibraryVersion -returns False if the versions of the compile time and run time libraries are not +The +.I XkbLibraryVersion +returns False if the versions of the compile time and run time libraries are not compatible. .SH "SEE ALSO" .BR XkbMajorVersion (__libmansuffix__), diff --git a/man/xkb/XkbListComponents.man b/man/xkb/XkbListComponents.man index 95d97f52..5d107b12 100644 --- a/man/xkb/XkbListComponents.man +++ b/man/xkb/XkbListComponents.man @@ -47,78 +47,78 @@ namelist for components of interest max # returned names, # left over .SH DESCRIPTION .LP -You may ask the server for a list of components for one or more component types. The request takes the -form of a set of patterns, one pattern for each of the component types, including a pattern for the -complete keyboard description. To obtain this list, use +You may ask the server for a list of components for one or more component types. The request takes the +form of a set of patterns, one pattern for each of the component types, including a pattern for the +complete keyboard description. To obtain this list, use .I XkbListComponents. -.I XkbListComponents -queries the server for a list of component names matching the patterns specified in -.I ptrns. -It waits for a reply and returns the matching component names in an XkbComponentListRec structure. -When you are done using the structure, you should free it using -.I XkbFreeComponentList. device_spec -indicates a particular device in which the caller is interested. A server is allowed (but not -required) to restrict its reply to portions of the database that are relevant for that particular +.I XkbListComponents +queries the server for a list of component names matching the patterns specified in +.I ptrns. +It waits for a reply and returns the matching component names in an XkbComponentListRec structure. +When you are done using the structure, you should free it using +.I XkbFreeComponentList. device_spec +indicates a particular device in which the caller is interested. A server is allowed (but not +required) to restrict its reply to portions of the database that are relevant for that particular device. -.I ptrns -is a pointer to an XkbComponentNamesRec. Each of the fields in -.I ptrns -contains a pattern naming the components of interest. Each of the patterns is composed of characters -from the ISO Latin1 encoding, but can contain only parentheses, the wildcard characters `?' and `*', -and characters permitted in a component class or member name. A pattern may be NULL, in which case no -components for that type is returned. Pattern matches with component names are case sensitive. The `?' -wildcard matches any single character, except a left or right parenthesis; the `*' wildcard matches -any number of characters, except a left or right parenthesis. If an implementation allows additional -characters in a component class or member name other than those required by the Xkb extension, the -result of comparing one of the additional characters to either of the wildcard characters is +.I ptrns +is a pointer to an XkbComponentNamesRec. Each of the fields in +.I ptrns +contains a pattern naming the components of interest. Each of the patterns is composed of characters +from the ISO Latin1 encoding, but can contain only parentheses, the wildcard characters `?' and `*', +and characters permitted in a component class or member name. A pattern may be NULL, in which case no +components for that type is returned. Pattern matches with component names are case sensitive. The `?' +wildcard matches any single character, except a left or right parenthesis; the `*' wildcard matches +any number of characters, except a left or right parenthesis. If an implementation allows additional +characters in a component class or member name other than those required by the Xkb extension, the +result of comparing one of the additional characters to either of the wildcard characters is implementation-dependent. -If a pattern contains illegal characters, the illegal characters are ignored. The matching process is +If a pattern contains illegal characters, the illegal characters are ignored. The matching process is carried out as if the illegal characters were omitted from the pattern. -.I max_inout -is used to throttle the amount of data passed to and from the server. On input, it specifies the -maximum number of names to be returned (the total number of names in all component categories). Upon -return from -.I XkbListComponents, -max_inout contains the number of names that matched the request but were not returned because of the +.I max_inout +is used to throttle the amount of data passed to and from the server. On input, it specifies the +maximum number of names to be returned (the total number of names in all component categories). Upon +return from +.I XkbListComponents, +max_inout contains the number of names that matched the request but were not returned because of the limit. .B Component Names -Component names have the form -.I "class(member)" -where -.I class -describes a subset of the available components for a particular type and the optional -.I member -identifies a specific component from that subset. For example, the name "atlantis(acme)" for a symbols -component might specify the symbols used for the atlantis national keyboard layout by the vendor -"acme." Each class has an optional -.I default -member - references that specify a class but not a member refer to the default member of the class, if -one exists. Xkb places no constraints on the interpretation of the class and member names used in +Component names have the form +.I "class(member)" +where +.I class +describes a subset of the available components for a particular type and the optional +.I member +identifies a specific component from that subset. For example, the name "atlantis(acme)" for a symbols +component might specify the symbols used for the atlantis national keyboard layout by the vendor +"acme." Each class has an optional +.I default +member - references that specify a class but not a member refer to the default member of the class, if +one exists. Xkb places no constraints on the interpretation of the class and member names used in component names. -The -.I class -and -.I member -names are both specified using characters from the Latin-1 character set. Xkb implementations must -accept all alphanumeric characters, minus (`-') and underscore (`_') in class or member names, and -must not accept parentheses, plus, vertical bar, percent sign, asterisk, question mark, or white +The +.I class +and +.I member +names are both specified using characters from the Latin-1 character set. Xkb implementations must +accept all alphanumeric characters, minus (`-') and underscore (`_') in class or member names, and +must not accept parentheses, plus, vertical bar, percent sign, asterisk, question mark, or white space. The use of other characters is implementation-dependent. .SH STRUCTURES .LP The component name patterns used to describe the request are passed to -.I XkbListComponents -using an XkbComponentNamesRec structure. This structure has no special allocation constraints or -interrelationships with other structures; allocate and free this structure using standard -.I malloc -and -.I free +.I XkbListComponents +using an XkbComponentNamesRec structure. This structure has no special allocation constraints or +interrelationships with other structures; allocate and free this structure using standard +.I malloc +and +.I free calls or their equivalent: .nf @@ -130,9 +130,9 @@ calls or their equivalent: char * symbols; /\&* symbol names */ char * geometry; /\&* geometry names */ } XkbComponentNamesRec, *XkbComponentNamesPtr; - -.fi -.I XkbListComponents + +.fi +.I XkbListComponents returns a pointer to an XkbComponentListRec: .nf @@ -150,16 +150,16 @@ returns a pointer to an XkbComponentListRec: XkbComponentNamePtr symbols; /\&* symbol names */ XkbComponentNamePtr geometry; /\&* geometry names */ } XkbComponentListRec, *XkbComponentListPtr; - + typedef struct _XkbComponentName { unsigned short flags; /\&* hints regarding component name */ char * name; /\&* name of component */ } XkbComponentNameRec, *XkbComponentNamePtr; - -.fi + +.fi .SH "SEE ALSO" -.BR XkbFreeComponentList (__libmansuffix__) +.BR XkbFreeComponentList (__libmansuffix__) .SH NOTES .LP -Note that the structure used to specify patterns on input is an XkbComponentNamesRec, and that used to +Note that the structure used to specify patterns on input is an XkbComponentNamesRec, and that used to hold the individual component names upon return is an XkbComponentNameRec (no trailing `s' in Name). diff --git a/man/xkb/XkbLockGroup.man b/man/xkb/XkbLockGroup.man index 09bf7269..98d0cf04 100644 --- a/man/xkb/XkbLockGroup.man +++ b/man/xkb/XkbLockGroup.man @@ -34,7 +34,7 @@ XkbLockGroup \- Locks the keysym group .SH ARGUMENTS .TP .I display -connection to the X server +connection to the X server .TP .I device_spec device ID, or XkbUseCoreKbd @@ -43,10 +43,10 @@ device ID, or XkbUseCoreKbd index of the keysym group to lock .SH DESCRIPTION .LP -.I XkbLockGroup -sends a request to the server to lock the specified -.I group -and does not wait for a reply. It returns True if the request was sent and +.I XkbLockGroup +sends a request to the server to lock the specified +.I group +and does not wait for a reply. It returns True if the request was sent and False otherwise. Reference the keysym group indices with these symbolic constants: @@ -67,15 +67,15 @@ XkbGroup4Index 3 .SH "RETURN VALUES" .TP 15 True -The +The .I XkbLockGroup -function returns True when a request was sent to the server to lock the -specified +function returns True when a request was sent to the server to lock the +specified .I group and does not wait for a reply. .TP 15 False -The +The .I XkbLockGroup function returns False if the request was not sent. diff --git a/man/xkb/XkbLockModifiers.man b/man/xkb/XkbLockModifiers.man index 2286ed01..41ed9362 100644 --- a/man/xkb/XkbLockModifiers.man +++ b/man/xkb/XkbLockModifiers.man @@ -35,7 +35,7 @@ XkbLockModifiers \- Locks and unlocks any of the eight real keyboard modifiers .SH ARGUMENTS .TP .I display -connection to the X server +connection to the X server .TP .I device_spec device ID, or XkbUseCoreKbd @@ -47,25 +47,25 @@ mask of real modifiers whose lock state is to change 1 => lock, 0 => unlock; only for modifiers selected by affect .SH DESCRIPTION .LP -.I XkbLockModifiers -sends a request to the server to lock the real modifiers -selected by both -.I affect -and +.I XkbLockModifiers +sends a request to the server to lock the real modifiers +selected by both +.I affect +and .I values -and to unlock the real modifiers selected by -.I affect, -but not selected by -.I values. XkbLockModifiers -does not wait for a reply from the server. It returns True if the request was +and to unlock the real modifiers selected by +.I affect, +but not selected by +.I values. XkbLockModifiers +does not wait for a reply from the server. It returns True if the request was sent, and False otherwise. -The functions in this section that change the use of modifiers use a mask in the -parameter affect. It is a bitwise inclusive OR of the legal modifier masks: +The functions in this section that change the use of modifiers use a mask in the +parameter affect. It is a bitwise inclusive OR of the legal modifier masks: .TS -c -l +c +l l. Table 1 Real Modifier Masks _ @@ -83,20 +83,20 @@ Mod5Mask .SH "RETURN VALUES" .TP 15 True -The -.I XkbLockModifiers -function returns True if a request is sent to the server to lock the real -modifiers -selected by both -.I affect -and +The +.I XkbLockModifiers +function returns True if a request is sent to the server to lock the real +modifiers +selected by both +.I affect +and .I values -and to unlock the real modifiers selected by -.I affect, -but not selected by +and to unlock the real modifiers selected by +.I affect, +but not selected by .I values. .TP 15 False -The -.I XkbLockModifiers +The +.I XkbLockModifiers function returns False if the request was not sent. diff --git a/man/xkb/XkbLookupKeyBinding.man b/man/xkb/XkbLookupKeyBinding.man index 25354c66..45790a79 100644 --- a/man/xkb/XkbLookupKeyBinding.man +++ b/man/xkb/XkbLookupKeyBinding.man @@ -54,29 +54,29 @@ size of buffer in bytes backfilled with number bytes overflow .SH DESCRIPTION .LP -.I XkbLookupKeyBinding -is the equivalent of the core -.I XLookupString +.I XkbLookupKeyBinding +is the equivalent of the core +.I XLookupString function. -.I XRebindKeysym -binds an ASCII string to a specified keysym, so that the string and keysym are -returned when the key is pressed and a specified list of modifiers are also -being held down. -.I XkbLookupKeyBinding -returns in -.I buf -the string associated with the keysym -.I sym -and modifier state -.I state. buf -is NULL terminated unless there's an overflow. If the string returned is larger -than -.I nbytes, -a count of bytes that does not fit into the buffer is returned in -.I extra_rtrn. -.I XkbTranslateKeySym -returns the number of bytes that it placed into +.I XRebindKeysym +binds an ASCII string to a specified keysym, so that the string and keysym are +returned when the key is pressed and a specified list of modifiers are also +being held down. +.I XkbLookupKeyBinding +returns in +.I buf +the string associated with the keysym +.I sym +and modifier state +.I state. buf +is NULL terminated unless there's an overflow. If the string returned is larger +than +.I nbytes, +a count of bytes that does not fit into the buffer is returned in +.I extra_rtrn. +.I XkbTranslateKeySym +returns the number of bytes that it placed into .I buf. .SH "SEE ALSO" .BR XkbTranslateKeySym (__libmansuffix__), diff --git a/man/xkb/XkbLookupKeySym.man b/man/xkb/XkbLookupKeySym.man index 2aeb0c81..b2b35fef 100644 --- a/man/xkb/XkbLookupKeySym.man +++ b/man/xkb/XkbLookupKeySym.man @@ -50,21 +50,21 @@ backfilled with consumed modifiers backfilled with symbol associated with key + state .SH DESCRIPTION .LP -.I XkbLookupKeySym -is the equivalent of the core -.I XLookupKeySym -function. For the core keyboard, given a keycode -.I key -and an Xkb state -.I state, XkbLookupKeySym -returns the symbol associated with the key in -.I sym_rtrn -and the list of modifiers that should still be applied in -.I mods_rtrn. -The -.I state -parameter is the state from a KeyPress or KeyRelease event. -.I XkbLookupKeySym +.I XkbLookupKeySym +is the equivalent of the core +.I XLookupKeySym +function. For the core keyboard, given a keycode +.I key +and an Xkb state +.I state, XkbLookupKeySym +returns the symbol associated with the key in +.I sym_rtrn +and the list of modifiers that should still be applied in +.I mods_rtrn. +The +.I state +parameter is the state from a KeyPress or KeyRelease event. +.I XkbLookupKeySym returns True if it succeeds. .SH "SEE ALSO" .BR XLookupKeySym (__libmansuffix__) diff --git a/man/xkb/XkbModActionVMods.man b/man/xkb/XkbModActionVMods.man index 8d7e2e7c..0d9195f5 100644 --- a/man/xkb/XkbModActionVMods.man +++ b/man/xkb/XkbModActionVMods.man @@ -22,7 +22,7 @@ .\" .TH XkbModActionVMods __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbModActionVMods \- Returns the vmods1 and vmods2 fields of act converted to the vmods format of an +XkbModActionVMods \- Returns the vmods1 and vmods2 fields of act converted to the vmods format of an Xkb modifier description .SH SYNOPSIS .HP @@ -36,13 +36,13 @@ Xkb modifier description action from which to extract virtual mods .SH DESCRIPTION .LP -.I XkbModActionVMods -returns the -.I vmods1 -and -.I vmods2 -fields of -.I act -converted to the -.I vmods +.I XkbModActionVMods +returns the +.I vmods1 +and +.I vmods2 +fields of +.I act +converted to the +.I vmods format of an Xkb modifier description. diff --git a/man/xkb/XkbNoteControlsChanges.man b/man/xkb/XkbNoteControlsChanges.man index 372e5ef8..e823b7ac 100644 --- a/man/xkb/XkbNoteControlsChanges.man +++ b/man/xkb/XkbNoteControlsChanges.man @@ -22,7 +22,7 @@ .\" .TH XkbNoteControlsChanges __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbNoteControlsChanges \- Notes the changes in a changes structure when a client receives an XkbControlsNotify +XkbNoteControlsChanges \- Notes the changes in a changes structure when a client receives an XkbControlsNotify event .SH SYNOPSIS .HP @@ -44,42 +44,42 @@ tells which things have changed tells which parts of new to record in changes .SH DESCRIPTION .LP -Whenever a field in the controls structure changes in the server's keyboard description, the server sends an -XkbControlsNotify event to all interested clients.To receive XkbControlsNotify events under all possible +Whenever a field in the controls structure changes in the server's keyboard description, the server sends an +XkbControlsNotify event to all interested clients.To receive XkbControlsNotify events under all possible conditions, use -.I XkbSelectEvents -and pass XkbControlsNotifyMask in both -.I bits_to_change -and +.I XkbSelectEvents +and pass XkbControlsNotifyMask in both +.I bits_to_change +and .I values_for_bits. To receive XkbControlsNotify events only under certain conditions, use -.I XkbSelectEventDetails -using XkbControlsNotify as the -.I event_type -and specifying the desired state changes in -.I bits_to_change -and -.I values_for_bits +.I XkbSelectEventDetails +using XkbControlsNotify 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 1. -Table 1 shows the actual values for the individual mask bits used to select -controls for -modification and to enable and disable the control. Note that the same mask bit -is used to -specify general modifications to the parameters used to configure the control -(which), and to -enable and disable the control (enabled_ctrls). The anomalies in the table (no -"ok" in column) -are for controls that have no configurable attributes; and for controls that are -not boolean +Table 1 shows the actual values for the individual mask bits used to select +controls for +modification and to enable and disable the control. Note that the same mask bit +is used to +specify general modifications to the parameters used to configure the control +(which), and to +enable and disable the control (enabled_ctrls). The anomalies in the table (no +"ok" in column) +are for controls that have no configurable attributes; and for controls that are +not boolean controls and therefore cannot be enabled or disabled. .TS c s s s l l l l l l l l -l l l l. +l l l l. Table 1 Controls Mask Bits _ Mask Bit which or enabled Value @@ -103,74 +103,74 @@ XkbInternalModsMask ok (1L<<28) XkbIgnoreLockModsMask ok (1L<<29) XkbPerKeyRepeatMask ok (1L<<30) XkbControlsEnabledMask ok (1L<<31) -XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | +XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | XkbAccessXFeedbackMask) -XkbAllBooleanCtrlsMask ok (0x00001FFF) +XkbAllBooleanCtrlsMask ok (0x00001FFF) XkbAllControlsMask ok (0xF8001FFF) .TE -The -.I changed_ctrls -field specifies the controls components that have changed and consists of bits taken from the masks defined in -Table 1 with "ok" in the -.I changed_ctrls +The +.I changed_ctrls +field specifies the controls components that have changed and consists of bits taken from the masks defined in +Table 1 with "ok" in the +.I changed_ctrls column. -The controls currently enabled in the server are reported in the -.I enabled_ctrls -field. If any controls were just enabled or disabled (that is, the contents of the -.I enabled_ctrls -field changed), they are flagged in the -.I enabled_ctrl_changes -field. The valid bits for these fields are the masks listed in Table 1 with "ok" in the -.I enabled_ctrls -column. The -.I num_groups -field reports the number of groups bound to the key belonging to the most number of groups and is automatically -updated +The controls currently enabled in the server are reported in the +.I enabled_ctrls +field. If any controls were just enabled or disabled (that is, the contents of the +.I enabled_ctrls +field changed), they are flagged in the +.I enabled_ctrl_changes +field. The valid bits for these fields are the masks listed in Table 1 with "ok" in the +.I enabled_ctrls +column. The +.I num_groups +field reports the number of groups bound to the key belonging to the most number of groups and is automatically +updated when the keyboard mapping changes. -If the change was caused by a request from a client, the -.I keycode -and -.I event_type -fields are set to zero and the -.I req_major -and -.I req_minor -fields identify the request. The +If the change was caused by a request from a client, the +.I keycode +and +.I event_type +fields are set to zero and the +.I req_major +and +.I req_minor +fields identify the request. The .I req_major value is the same as the major extension opcode. Otherwise, -.I event_type -is set to the type of event that caused the change (one of KeyPress, KeyRelease, DeviceKeyPress, -DeviceKeyRelease, -ButtonPress or ButtonRelease), and -.I req_major -and -.I req_minor -are undefined. If -.I event_type -is KeyPress, KeyRelease, DeviceKeyPress, or DeviceKeyRelease, the -.I keycode -field is set to the key that caused the change. If -.I event_type -is ButtonPress or ButtonRelease, -.I keycode -contains the button number. +.I event_type +is set to the type of event that caused the change (one of KeyPress, KeyRelease, DeviceKeyPress, +DeviceKeyRelease, +ButtonPress or ButtonRelease), and +.I req_major +and +.I req_minor +are undefined. If +.I event_type +is KeyPress, KeyRelease, DeviceKeyPress, or DeviceKeyRelease, the +.I keycode +field is set to the key that caused the change. If +.I event_type +is ButtonPress or ButtonRelease, +.I keycode +contains the button number. -When a client receives an XkbControlsNotify event, it can note the changes in a changes structure using +When a client receives an XkbControlsNotify event, it can note the changes in a changes structure using .I XkbNoteControlsChanges. -The -.I wanted -parameter is a bitwise inclusive OR of bits taken from the set of masks specified in Table 1 with "ok" in the -.I changed_ctrls -column. -.I XkbNoteControlsChanges -copies any changes reported in -.I new -and specified in -.I wanted -into the changes record specified by +The +.I wanted +parameter is a bitwise inclusive OR of bits taken from the set of masks specified in Table 1 with "ok" in the +.I changed_ctrls +column. +.I XkbNoteControlsChanges +copies any changes reported in +.I new +and specified in +.I wanted +into the changes record specified by .I old. .SH STRUCTURES .LP diff --git a/man/xkb/XkbNoteDeviceChanges.man b/man/xkb/XkbNoteDeviceChanges.man index ff538802..26519868 100644 --- a/man/xkb/XkbNoteDeviceChanges.man +++ b/man/xkb/XkbNoteDeviceChanges.man @@ -43,52 +43,52 @@ event indicating state changes mask indicating changes to note .SH DESCRIPTION .LP -The -.I wanted -field specifies the changes that should be noted in -.I old, +The +.I wanted +field specifies the changes that should be noted in +.I old, and is composed of the bitwise inclusive OR of one or more of the masks from Table 1. The -.I reason -field of the event in -.I new -indicates the types of changes the event is reporting. -.I XkbNoteDeviceChanges -updates the XkbDeviceChangesRec specified by -.I old -with the changes that are both specified in -.I wanted -and contained in +.I reason +field of the event in +.I new +indicates the types of changes the event is reporting. +.I XkbNoteDeviceChanges +updates the XkbDeviceChangesRec specified by +.I old +with the changes that are both specified in +.I wanted +and contained in .I new->reason. .nf - Table 1 XkbDeviceInfoRec Mask Bits + Table 1 XkbDeviceInfoRec Mask Bits ____________________________________________________________________________________ Name XkbDeviceInfoRec Value Capability If Set - Fields Effected + Fields Effected ____________________________________________________________________________________ XkbXI_KeyboardsMask (1L <<0) Clients can use all Xkb requests and events - with KeyClass devices + with KeyClass devices supported by the input device extension. -XkbXI_ButtonActionsMask num_btns (1L <<1) Clients can assign key - btn_acts actions to buttons +XkbXI_ButtonActionsMask num_btns (1L <<1) Clients can assign key + btn_acts actions to buttons non-KeyClass input extension devices. - + XkbXI_IndicatorNamesMask leds->names (1L <<2) Clients can assign names to indicators on non-KeyClass input extension devices. - + XkbXI_IndicatorMapsMask leds->maps (1L <<3) Clients can assign indicator maps to - indicators on + indicators on non-KeyClass input extension devices. -XkbXI_IndicatorStateMask leds->state (1L <<4) Clients can request +XkbXI_IndicatorStateMask leds->state (1L <<4) Clients can request the status of indicators on non-KeyClass input extension devices. @@ -101,7 +101,7 @@ XkbXI_UnsupportedFeaturesMask unsupported (1L <<15) XkbXI_AllDeviceFeaturesMask Those selected (0x1e) XkbXI_IndicatorsMask | by Value Column XkbSI_ButtonActionsMask - masks + masks XkbXI_AllFeaturesMask Those selected (0x1f) XkbSI_AllDeviceFeaturesMask | by Value Column XkbSI_KeyboardsMask @@ -112,14 +112,14 @@ XkbXI_AllDetailsMask Those selected (0x801f) XkbXI_AllFeaturesMask | masks .fi -To update a local copy of the state and configuration of an X input extension device with the changes +To update a local copy of the state and configuration of an X input extension device with the changes previously noted in an XkbDeviceChangesRec structure, use .I XkbGetDeviceInfoChanges. .SH STRUCTURES .LP -Changes to an Xkb extension device may be tracked by listening to XkbDeviceExtensionNotify events and -accumulating the changes in an XkbDeviceChangesRec structure. The changes noted in the structure may -then be used in subsequent operations to update either a server configuration or a local copy of an +Changes to an Xkb extension device may be tracked by listening to XkbDeviceExtensionNotify events and +accumulating the changes in an XkbDeviceChangesRec structure. The changes noted in the structure may +then be used in subsequent operations to update either a server configuration or a local copy of an Xkb extension device configuration. The changes structure is defined as follows: .nf diff --git a/man/xkb/XkbNoteNameChanges.man b/man/xkb/XkbNoteNameChanges.man index f0efd17b..b4c23b8d 100644 --- a/man/xkb/XkbNoteNameChanges.man +++ b/man/xkb/XkbNoteNameChanges.man @@ -43,20 +43,20 @@ event from which changes are to be copied types of names for which changes are to be noted .SH DESCRIPTION .LP -When your application receives a XkbNamesNotify event, you can note the changed -names in a changes structure using +When your application receives a XkbNamesNotify event, you can note the changed +names in a changes structure using .I XkbNoteNameChanges. -The -.I wanted -parameter is the bitwise inclusive OR of the valid names mask bits shown in -Table 1. -.I XkbNoteNameChanges -copies any changes that are reported in -.I new -and specified in -.I wanted -into the changes record specified by +The +.I wanted +parameter is the bitwise inclusive OR of the valid names mask bits shown in +Table 1. +.I XkbNoteNameChanges +copies any changes that are reported in +.I new +and specified in +.I wanted +into the changes record specified by .I old. .TS diff --git a/man/xkb/XkbOpenDisplay.man b/man/xkb/XkbOpenDisplay.man index ff84f313..f7193ad9 100644 --- a/man/xkb/XkbOpenDisplay.man +++ b/man/xkb/XkbOpenDisplay.man @@ -21,7 +21,7 @@ .\" .TH XkbOpenDisplay __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbOpenDisplay \- Checks for a compatible version of the Xkb extension in both +XkbOpenDisplay \- Checks for a compatible version of the Xkb extension in both the library and the server, and initializes the extension for use. .SH SYNOPSIS .HP @@ -37,7 +37,7 @@ the library and the server, and initializes the extension for use. .SH ARGUMENTS .TP .I display_name -hardware display name, which determines the display and communications domain to +hardware display name, which determines the display and communications domain to be used .TP .I event_rtrn @@ -50,60 +50,60 @@ backfilled with the extension base error code compile time lib major version in, server major version out .TP .I minor_in_out -compile time lib min version in, server minor version out +compile time lib min version in, server minor version out .TP .I reason_rtrn -backfilled with a status code +backfilled with a status code .SH DESCRIPTION .LP -As a convenience, you can use the function -.I XkbOpenDisplay -to perform these three -tasks at once: open a connection to an X server, check for a compatible version -of the Xkb extension in both the library and the server, and initialize the +As a convenience, you can use the function +.I XkbOpenDisplay +to perform these three +tasks at once: open a connection to an X server, check for a compatible version +of the Xkb extension in both the library and the server, and initialize the extension for use. -.I XkbOpenDisplay -is a convenience function that opens an X display connection and -initializes the X keyboard extension. In all cases, upon return -.I reason_rtrn -contains a status value indicating success or the type of failure. If -.I major_in_out -and -.I minor_in_out -are not NULL, -.I XkbOpenDisplay -first calls -.I XkbLibraryVersion -to determine whether the client library is compatible, passing -it the values pointed to by -.I major_in_out and -.I minor_in_out. If the library is -incompatible, -.I XkbOpenDisplay backfills -.I major_in_out -and -.I minor_in_out -with the -major and minor extension versions of the library being used and returns NULL. -If the library is compatible, -.I XkbOpenDisplay -next calls -.I XOpenDisplay -with the -.I display_name. -If this fails, the function returns NULL. If successful, -.I XkbOpenDisplay -calls -.I XkbQueryExtension -and backfills the major and minor Xkb -server extension version numbers in -.I major_in_out and -.I minor_in_out. If the server -extension version is not compatible with the library extension version or if the -server extension is not present, -.I XkbOpenDisplay -closes the display and returns +.I XkbOpenDisplay +is a convenience function that opens an X display connection and +initializes the X keyboard extension. In all cases, upon return +.I reason_rtrn +contains a status value indicating success or the type of failure. If +.I major_in_out +and +.I minor_in_out +are not NULL, +.I XkbOpenDisplay +first calls +.I XkbLibraryVersion +to determine whether the client library is compatible, passing +it the values pointed to by +.I major_in_out and +.I minor_in_out. If the library is +incompatible, +.I XkbOpenDisplay backfills +.I major_in_out +and +.I minor_in_out +with the +major and minor extension versions of the library being used and returns NULL. +If the library is compatible, +.I XkbOpenDisplay +next calls +.I XOpenDisplay +with the +.I display_name. +If this fails, the function returns NULL. If successful, +.I XkbOpenDisplay +calls +.I XkbQueryExtension +and backfills the major and minor Xkb +server extension version numbers in +.I major_in_out and +.I minor_in_out. If the server +extension version is not compatible with the library extension version or if the +server extension is not present, +.I XkbOpenDisplay +closes the display and returns NULL. When successful, the function returns the display connection. The possible values for reason_rtrn are: @@ -113,7 +113,7 @@ XkbOD_BadLibraryVersion indicates XkbLibraryVersion returned False. .IP \(bu 5 XkbOD_ConnectionRefused indicates the display could not be opened. .IP \(bu 5 -XkbOD_BadServerVersion indicates the library and the server have incompatible +XkbOD_BadServerVersion indicates the library and the server have incompatible extension versions. .IP \(bu 5 XkbOD_NonXkbServer indicates the extension is not present in the X server. @@ -122,23 +122,23 @@ XkbOD_Success indicates that the function succeeded. .SH "RETURN VALUES" .TP 15 NULL -The -.I XkbOpenDisplay +The +.I XkbOpenDisplay function returns NULL if the library is incompatible. .sp .in 20 -The -.I XkbOpenDisplay -function returns NULL if the call to -.I XOpenDisplay -with the +The +.I XkbOpenDisplay +function returns NULL if the call to +.I XOpenDisplay +with the .I display_name fails. .sp .in 20 -The -.I XkbOpenDisplay -function returns NULL and closes the display if the server extension version is not +The +.I XkbOpenDisplay +function returns NULL and closes the display if the server extension version is not compatible with the library extension version or if the server extension is not present. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbOutOfRangeGroupInfo.man b/man/xkb/XkbOutOfRangeGroupInfo.man index 4803f67d..11965fc7 100644 --- a/man/xkb/XkbOutOfRangeGroupInfo.man +++ b/man/xkb/XkbOutOfRangeGroupInfo.man @@ -22,7 +22,7 @@ .\" .TH XkbOutOfRangeGroupInfo __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbOutOfRangeGroupInfo \- Returns only the out-of-range processing information +XkbOutOfRangeGroupInfo \- Returns only the out-of-range processing information from the group_info field of an XkbSymMapRec structure .SH SYNOPSIS .HP @@ -36,54 +36,54 @@ from the group_info field of an XkbSymMapRec structure Xkb description of interest .SH DESCRIPTION .LP -.I XkbOutOfRangeGroupInfo -returns only the out-of-range processing information from the -.I group_info +.I XkbOutOfRangeGroupInfo +returns only the out-of-range processing information from the +.I group_info field of an XkbSymMapRec structure. -The -.I group_info -field of an XkbSymMapRec is an encoded value containing the number of groups of -symbols bound to the -key as well as the specification of the treatment of out-of-range groups. It is -legal for a key to -have zero groups, in which case it also has zero symbols and all events from -that key yield NoSymbol. -To obtain the number of groups of symbols bound to the key, use -.I XkbKeyNumGroups. -To change the number of groups bound to a key, use -.I XkbChangeTypesOfKey. +The +.I group_info +field of an XkbSymMapRec is an encoded value containing the number of groups of +symbols bound to the +key as well as the specification of the treatment of out-of-range groups. It is +legal for a key to +have zero groups, in which case it also has zero symbols and all events from +that key yield NoSymbol. +To obtain the number of groups of symbols bound to the key, use +.I XkbKeyNumGroups. +To change the number of groups bound to a key, use +.I XkbChangeTypesOfKey. To obtain a mask that determines the treatment of out-of-range groups, use -.I XkbKeyGroupInfo -and +.I XkbKeyGroupInfo +and .I XkbOutOfRangeGroupInfo. -The keyboard controls contain a -.I groups_wrap -field specifying the handling of illegal groups on a global basis. That is, when -the user performs an -action causing the effective group to go out of the legal range, the -.I groups_wrap -field specifies how to normalize the effective keyboard group to a group that is -legal for the -keyboard as a whole, but there is no guarantee that the normalized group will be -within the range of -legal groups for any individual key. The per-key -.I group_info -field specifies how a key treats a legal effective group if the key does not -have a type specified for -the group of concern. For example, the Enter key usually has just one group -defined. If the user -performs an action causing the global keyboard group to change to Group2, the -.I group_info +The keyboard controls contain a +.I groups_wrap +field specifying the handling of illegal groups on a global basis. That is, when +the user performs an +action causing the effective group to go out of the legal range, the +.I groups_wrap +field specifies how to normalize the effective keyboard group to a group that is +legal for the +keyboard as a whole, but there is no guarantee that the normalized group will be +within the range of +legal groups for any individual key. The per-key +.I group_info +field specifies how a key treats a legal effective group if the key does not +have a type specified for +the group of concern. For example, the Enter key usually has just one group +defined. If the user +performs an action causing the global keyboard group to change to Group2, the +.I group_info field for the Enter key describes how to handle this situation. -Out-of-range groups for individual keys are mapped to a legal group using the -same options as are used -for the overall keyboard group. The particular type of mapping used is -controlled by the bits set in -the -.I group_info +Out-of-range groups for individual keys are mapped to a legal group using the +same options as are used +for the overall keyboard group. The particular type of mapping used is +controlled by the bits set in +the +.I group_info flag, as shown in Table 1. .bp .TS @@ -105,7 +105,7 @@ The KeySymMapRec structure is defined as follows: #define XkbNumKbdGroups 4 #define XkbMaxKbdGroup (XkbNumKbdGroups-1) - + typedef struct { /\&* map to keysyms for a single keycode */ unsigned char kt_index[XkbNumKbdGroups]; /\&* key type index for each group */ unsigned char group_info; /\&* # of groups and out of range group handling */ @@ -120,8 +120,8 @@ 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 */ @@ -153,8 +153,8 @@ 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 */ diff --git a/man/xkb/XkbOutOfRangeGroupNumber.man b/man/xkb/XkbOutOfRangeGroupNumber.man index bab5b29d..82df3c5b 100644 --- a/man/xkb/XkbOutOfRangeGroupNumber.man +++ b/man/xkb/XkbOutOfRangeGroupNumber.man @@ -22,7 +22,7 @@ .\" .TH XkbOutOfRangeGroupNumber __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbOutOfRangeGroupNumber \- Returns the out-of-range group number, represented +XkbOutOfRangeGroupNumber \- Returns the out-of-range group number, represented as a group index, from the group_info field of an XkbSymMapRec structure .SH SYNOPSIS .HP @@ -36,54 +36,54 @@ as a group index, from the group_info field of an XkbSymMapRec structure Xkb description of interest .SH DESCRIPTION .LP -.I XkbOutOfRangeGroupNumber +.I XkbOutOfRangeGroupNumber returns the out-of-range group number, represented as a group index, from the -.I group_info +.I group_info field of an XkbSymMapRec structure. -The -.I group_info -field of an XkbSymMapRec is an encoded value containing the number of groups of -symbols bound to the -key as well as the specification of the treatment of out-of-range groups. It is -legal for a key to -have zero groups, in which case it also has zero symbols and all events from -that key yield NoSymbol. -To obtain the number of groups of symbols bound to the key, use -.I XkbKeyNumGroups. -To change the number of groups bound to a key, use -.I XkbChangeTypesOfKey. +The +.I group_info +field of an XkbSymMapRec is an encoded value containing the number of groups of +symbols bound to the +key as well as the specification of the treatment of out-of-range groups. It is +legal for a key to +have zero groups, in which case it also has zero symbols and all events from +that key yield NoSymbol. +To obtain the number of groups of symbols bound to the key, use +.I XkbKeyNumGroups. +To change the number of groups bound to a key, use +.I XkbChangeTypesOfKey. To obtain a mask that determines the treatment of out-of-range groups, use -.I XkbKeyGroupInfo -and +.I XkbKeyGroupInfo +and .I XkbOutOfRangeGroupInfo. -The keyboard controls contain a -.I groups_wrap -field specifying the handling of illegal groups on a global basis. That is, when -the user performs an -action causing the effective group to go out of the legal range, the -.I groups_wrap -field specifies how to normalize the effective keyboard group to a group that is -legal for the -keyboard as a whole, but there is no guarantee that the normalized group will be -within the range of -legal groups for any individual key. The per-key -.I group_info -field specifies how a key treats a legal effective group if the key does not -have a type specified for -the group of concern. For example, the Enter key usually has just one group -defined. If the user -performs an action causing the global keyboard group to change to Group2, the -.I group_info +The keyboard controls contain a +.I groups_wrap +field specifying the handling of illegal groups on a global basis. That is, when +the user performs an +action causing the effective group to go out of the legal range, the +.I groups_wrap +field specifies how to normalize the effective keyboard group to a group that is +legal for the +keyboard as a whole, but there is no guarantee that the normalized group will be +within the range of +legal groups for any individual key. The per-key +.I group_info +field specifies how a key treats a legal effective group if the key does not +have a type specified for +the group of concern. For example, the Enter key usually has just one group +defined. If the user +performs an action causing the global keyboard group to change to Group2, the +.I group_info field for the Enter key describes how to handle this situation. -Out-of-range groups for individual keys are mapped to a legal group using the -same options as are used -for the overall keyboard group. The particular type of mapping used is -controlled by the bits set in -the -.I group_info +Out-of-range groups for individual keys are mapped to a legal group using the +same options as are used +for the overall keyboard group. The particular type of mapping used is +controlled by the bits set in +the +.I group_info flag, as shown in Table 1. @@ -106,7 +106,7 @@ The KeySymMapRec structure is defined as follows: #define XkbNumKbdGroups 4 #define XkbMaxKbdGroup (XkbNumKbdGroups-1) - + typedef struct { /\&* map to keysyms for a single keycode */ unsigned char kt_index[XkbNumKbdGroups]; /\&* key type index for each group */ unsigned char group_info; /\&* # of groups and out of range group handling */ @@ -121,8 +121,8 @@ 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 */ @@ -154,8 +154,8 @@ 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 */ diff --git a/man/xkb/XkbPtrActionX.man b/man/xkb/XkbPtrActionX.man index 02bb0cd0..0600d59f 100644 --- a/man/xkb/XkbPtrActionX.man +++ b/man/xkb/XkbPtrActionX.man @@ -22,7 +22,7 @@ .\" .TH XkbPtrActionX __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbPtrActionX \- Returns the high_XXX and low_XXX fields of act converted to a +XkbPtrActionX \- Returns the high_XXX and low_XXX fields of act converted to a signed int .SH SYNOPSIS .HP @@ -36,24 +36,24 @@ signed int action from which to extract X .SH DESCRIPTION .LP -Actions associated with the XkbPtrAction structure move the pointer when keys +Actions associated with the XkbPtrAction structure move the pointer when keys are pressed and released. -If the MouseKeys control is not enabled, KeyPress and KeyRelease events are +If the MouseKeys control is not enabled, KeyPress and KeyRelease events are treated as though the action is XkbSA_NoAction. -If the MouseKeys control is enabled, a server action of type XkbSA_MovePtr -instructs the server to generate core pointer MotionNotify events rather than -the usual KeyPress event, and the corresponding KeyRelease event disables any -mouse keys timers that were created as a result of handling the XkbSA_MovePtr +If the MouseKeys control is enabled, a server action of type XkbSA_MovePtr +instructs the server to generate core pointer MotionNotify events rather than +the usual KeyPress event, and the corresponding KeyRelease event disables any +mouse keys timers that were created as a result of handling the XkbSA_MovePtr action. -The -.I type +The +.I type field of the XkbPtrAction structure is always XkbSA_MovePtr. -The -.I flags +The +.I flags field is a bitwise inclusive OR of the masks shown in Table 1. .TS @@ -65,28 +65,28 @@ _ Action Type Meaning _ XkbSA_NoAcceleration T{ -If not set, and the MouseKeysAccel control is enabled, the KeyPress initiates a +If not set, and the MouseKeysAccel control is enabled, the KeyPress initiates a mouse keys timer for this key; every time the timer expires, the cursor moves. T} XkbSA_MoveAbsoluteX T{ -If set, the X portion of the structure specifies the new pointer X coordinate. -Otherwise, the X portion is added to the current pointer X coordinate to +If set, the X portion of the structure specifies the new pointer X coordinate. +Otherwise, the X portion is added to the current pointer X coordinate to determine the new pointer X coordinate. T} XkbSA_MoveAbsoluteY T{ -If set, the Y portion of the structure specifies the new pointer Y coordinate. -Otherwise, the Y portion is added to the current pointer Y coordinate to +If set, the Y portion of the structure specifies the new pointer Y coordinate. +Otherwise, the Y portion is added to the current pointer Y coordinate to determine the new pointer Y coordinate. T} .TE Each of the X and Y coordinates of the XkbPtrAction structure is composed of -two signed 16-bit values, that is, the X coordinate is composed of -.I high_XXX -and -.I low_XXX, -and similarly for the Y coordinate. Xkb provides the following macros, to -convert between a signed integer and two signed 16-bit values in XkbPtrAction +two signed 16-bit values, that is, the X coordinate is composed of +.I high_XXX +and +.I low_XXX, +and similarly for the Y coordinate. Xkb provides the following macros, to +convert between a signed integer and two signed 16-bit values in XkbPtrAction structures. .SH STRUCTURES .LP @@ -101,4 +101,4 @@ structures. unsigned char low_YYY; /\&* y coordinate, low bits */ } XkbPtrAction; -.fi +.fi diff --git a/man/xkb/XkbPtrActionY.man b/man/xkb/XkbPtrActionY.man index 799d7161..069c9d1e 100644 --- a/man/xkb/XkbPtrActionY.man +++ b/man/xkb/XkbPtrActionY.man @@ -22,7 +22,7 @@ .\" .TH XkbPtrActionY __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbPtrActionY \- Returns the high_YYY and low_YYY fields of act converted to a +XkbPtrActionY \- Returns the high_YYY and low_YYY fields of act converted to a signed int .SH SYNOPSIS .HP @@ -36,24 +36,24 @@ signed int action from which to extract Y .SH DESCRIPTION .LP -Actions associated with the XkbPtrAction structure move the pointer when keys +Actions associated with the XkbPtrAction structure move the pointer when keys are pressed and released. -If the MouseKeys control is not enabled, KeyPress and KeyRelease events are +If the MouseKeys control is not enabled, KeyPress and KeyRelease events are treated as though the action is XkbSA_NoAction. -If the MouseKeys control is enabled, a server action of type XkbSA_MovePtr -instructs the server to generate core pointer MotionNotify events rather than -the usual KeyPress event, and the corresponding KeyRelease event disables any -mouse keys timers that were created as a result of handling the XkbSA_MovePtr +If the MouseKeys control is enabled, a server action of type XkbSA_MovePtr +instructs the server to generate core pointer MotionNotify events rather than +the usual KeyPress event, and the corresponding KeyRelease event disables any +mouse keys timers that were created as a result of handling the XkbSA_MovePtr action. -The -.I type +The +.I type field of the XkbPtrAction structure is always XkbSA_MovePtr. -The -.I flags +The +.I flags field is a bitwise inclusive OR of the masks shown in Table 1. .TS @@ -65,28 +65,28 @@ _ Action Type Meaning _ XkbSA_NoAcceleration T{ -If not set, and the MouseKeysAccel control is enabled, the KeyPress initiates a +If not set, and the MouseKeysAccel control is enabled, the KeyPress initiates a mouse keys timer for this key; every time the timer expires, the cursor moves. T} XkbSA_MoveAbsoluteX T{ -If set, the X portion of the structure specifies the new pointer X coordinate. -Otherwise, the X portion is added to the current pointer X coordinate to +If set, the X portion of the structure specifies the new pointer X coordinate. +Otherwise, the X portion is added to the current pointer X coordinate to determine the new pointer X coordinate. T} XkbSA_MoveAbsoluteY T{ -If set, the Y portion of the structure specifies the new pointer Y coordinate. -Otherwise, the Y portion is added to the current pointer Y coordinate to +If set, the Y portion of the structure specifies the new pointer Y coordinate. +Otherwise, the Y portion is added to the current pointer Y coordinate to determine the new pointer Y coordinate. T} .TE Each of the X and Y coordinates of the XkbPtrAction structure is composed of -two signed 16-bit values, that is, the X coordinate is composed of -.I high_XXX -and -.I low_XXX, -and similarly for the Y coordinate. Xkb provides the following macros, to -convert between a signed integer and two signed 16-bit values in XkbPtrAction +two signed 16-bit values, that is, the X coordinate is composed of +.I high_XXX +and +.I low_XXX, +and similarly for the Y coordinate. Xkb provides the following macros, to +convert between a signed integer and two signed 16-bit values in XkbPtrAction structures. .SH STRUCTURES .LP @@ -101,4 +101,4 @@ structures. unsigned char low_YYY; /\&* y coordinate, low bits */ } XkbPtrAction; -.fi +.fi diff --git a/man/xkb/XkbQueryExtension.man b/man/xkb/XkbQueryExtension.man index af2f6351..d9710674 100644 --- a/man/xkb/XkbQueryExtension.man +++ b/man/xkb/XkbQueryExtension.man @@ -51,74 +51,74 @@ backfilled with the extension base error code compile time lib major version in, server major version out .TP .I minor_in_out -compile time lib min version in, server minor version out +compile time lib min version in, server minor version out .SH DESCRIPTION .LP -Call -.I XkbQueryExtension -to check for the presence and compatibility of the -extension in the server and to initialize the extension. Because of potential -version mismatches, you cannot use the generic extension mechanism functions +Call +.I XkbQueryExtension +to check for the presence and compatibility of the +extension in the server and to initialize the extension. Because of potential +version mismatches, you cannot use the generic extension mechanism functions ( -.I XQueryExtension -and +.I XQueryExtension +and .I XInitExtension -) for checking for the presence of, and +) for checking for the presence of, and initializing the Xkb extension. - -You must call -.I XkbQueryExtension -or -.I XkbOpenDisplay -before using any other Xkb -library interfaces, unless such usage is explicitly allowed in the interface -description in this document. The exceptions are: -.I XkbIgnoreExtension, XkbLibraryVersion, -and a handful of audible-bell functions. You should not use -any other Xkb functions if the extension is not present or is uninitialized. In -general, calls to Xkb library functions made prior to initializing the Xkb + +You must call +.I XkbQueryExtension +or +.I XkbOpenDisplay +before using any other Xkb +library interfaces, unless such usage is explicitly allowed in the interface +description in this document. The exceptions are: +.I XkbIgnoreExtension, XkbLibraryVersion, +and a handful of audible-bell functions. You should not use +any other Xkb functions if the extension is not present or is uninitialized. In +general, calls to Xkb library functions made prior to initializing the Xkb extension cause BadAccess protocol errors. -.I XkbQueryExtension -both determines whether a compatible Xkb extension is present +.I XkbQueryExtension +both determines whether a compatible Xkb extension is present in the X server and initializes the extension when it is present. -The -.I XkbQueryExtension -function determines whether a compatible version of the X -Keyboard Extension is present in the server. If a compatible extension is -present, -.I XkbQueryExtension -returns True; otherwise, it returns False. +The +.I XkbQueryExtension +function determines whether a compatible version of the X +Keyboard Extension is present in the server. If a compatible extension is +present, +.I XkbQueryExtension +returns True; otherwise, it returns False. -If a compatible version of Xkb is present, -.I XkbQueryExtension -initializes the +If a compatible version of Xkb is present, +.I XkbQueryExtension +initializes the extension. It backfills the major opcode for the keyboard extension in -.I opcode_rtrn, -the base event code in -.I event_rtrn, +.I opcode_rtrn, +the base event code in +.I event_rtrn, the base error code in -.I error_rtrn, +.I error_rtrn, and the major and minor version numbers of the extension in -.I major_in_out -and -.I minor_in_out. -The major opcode is reported in the -.I req_major -fields of some Xkb events. For a discussion of the base event code. +.I major_in_out +and +.I minor_in_out. +The major opcode is reported in the +.I req_major +fields of some Xkb events. For a discussion of the base event code. .SH "RETURN VALUES" .TP 15 True -The -.I XkbQueryExtension -function returns True if it determines a compatible version of the X -Keyboard Extension is present in the server. +The +.I XkbQueryExtension +function returns True if it determines a compatible version of the X +Keyboard Extension is present in the server. .TP 15 False -The -.I XkbQueryExtension -function returns False if it determines a compatible version of the X +The +.I XkbQueryExtension +function returns False if it determines a compatible version of the X Keyboard Extension is not present in the server. .SH "SEE ALSO" .BR XkbIgnoreExtension (__libmansuffix__), diff --git a/man/xkb/XkbRefreshKeyboardMapping.man b/man/xkb/XkbRefreshKeyboardMapping.man index 46987975..d391a8f8 100644 --- a/man/xkb/XkbRefreshKeyboardMapping.man +++ b/man/xkb/XkbRefreshKeyboardMapping.man @@ -21,7 +21,7 @@ .\" .TH XkbRefreshKeyboardMapping __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbRefreshKeyboardMapping \- Update the keyboard description that is internal to the X +XkbRefreshKeyboardMapping \- Update the keyboard description that is internal to the X library .SH SYNOPSIS .HP @@ -35,31 +35,31 @@ library event initiating remapping .SH DESCRIPTION .LP -.I XkbRefreshKeyboardMapping -is the Xkb equivalent of the core -.I XRefreshKeyboardMapping -function. It requests that the X server send the current key mapping information to -this client. A client usually invokes -.I XkbRefreshKeyboardMapping -after receiving an XkbMapNotify event. -.I XkbRefreshKeyboardMapping +.I XkbRefreshKeyboardMapping +is the Xkb equivalent of the core +.I XRefreshKeyboardMapping +function. It requests that the X server send the current key mapping information to +this client. A client usually invokes +.I XkbRefreshKeyboardMapping +after receiving an XkbMapNotify event. +.I XkbRefreshKeyboardMapping returns Success if it succeeds and BadMatch if the event is not an Xkb event. -The XkbMapNotify event can be generated when some client calls -.I XkbSetMap, XkbChangeMap, XkbGetKeyboardByName, -or any of the standard X library functions that change the keyboard mapping or modifier +The XkbMapNotify event can be generated when some client calls +.I XkbSetMap, XkbChangeMap, XkbGetKeyboardByName, +or any of the standard X library functions that change the keyboard mapping or modifier mapping. .SH "RETURN VALUES" .TP 15 Success -The -.I XkbRefreshKeyboardMapping -function returns Success when the request that the X server send the current key mapping information to +The +.I XkbRefreshKeyboardMapping +function returns Success when the request that the X server send the current key mapping information to this client is successful. .SH DIAGNOSTICS .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has correct +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 XkbChangeMap (__libmansuffix__), diff --git a/man/xkb/XkbResizeDeviceButtonActions.man b/man/xkb/XkbResizeDeviceButtonActions.man index d0618cf3..969bb135 100644 --- a/man/xkb/XkbResizeDeviceButtonActions.man +++ b/man/xkb/XkbResizeDeviceButtonActions.man @@ -39,30 +39,30 @@ structure in which to allocate button actions new total number of button actions needed .SH DESCRIPTION .LP -.I XkbResizeDeviceButtonActions +.I XkbResizeDeviceButtonActions reallocates space, if necessary, to make sure there is room for a total of -.I new_total -button actions in the -.I device_info +.I new_total +button actions in the +.I device_info structure. Any new entries allocated are zeroed. If successful, -.I XkbResizeDeviceButtonActions -returns Success. If -.I new_total -is zero, all button actions are deleted, -.I device_info->num_btns -is set to zero, and -.I device_info->btn_acts -is set to NULL. If -.I device_info -is invalid or -.I new_total -is greater than 255, BadValue is returned. If a memory allocation failure occurs, a BadAlloc is returned. +.I XkbResizeDeviceButtonActions +returns Success. If +.I new_total +is zero, all button actions are deleted, +.I device_info->num_btns +is set to zero, and +.I device_info->btn_acts +is set to NULL. If +.I device_info +is invalid or +.I new_total +is greater than 255, BadValue is returned. If a memory allocation failure occurs, a BadAlloc is returned. -To free an XkbDeviceInfoRec structure, use +To free an XkbDeviceInfoRec structure, use .I XkbFreeDeviceInfo. .SH STRUCTURES .LP -Information about X Input Extension devices is transferred between a client program and the Xkb +Information about X Input Extension devices is transferred between a client program and the Xkb extension in an XkbDeviceInfoRec structure: .nf diff --git a/man/xkb/XkbResizeKeyActions.man b/man/xkb/XkbResizeKeyActions.man index b5cf3498..320a69b9 100644 --- a/man/xkb/XkbResizeKeyActions.man +++ b/man/xkb/XkbResizeKeyActions.man @@ -43,58 +43,58 @@ keycode of key to change new number of actions required .SH DESCRIPTION .LP -The -.I xkb -parameter points to the keyboard description containing the -.I key -whose number of actions is to be changed. The -.I key -parameter is the keycode of the key to change, and needed specifies the new +The +.I xkb +parameter points to the keyboard description containing the +.I key +whose number of actions is to be changed. The +.I key +parameter is the keycode of the key to change, and needed specifies the new number of actions required for the key. -.I XkbResizeKeyActions -reserves the space needed for the actions and returns a pointer to the beginning -of the new array that holds the actions. It can change the -.I acts, num_acts, -and -.I size_acts -fields of -.I xkb->server -if it is necessary to reallocate the -.I acts +.I XkbResizeKeyActions +reserves the space needed for the actions and returns a pointer to the beginning +of the new array that holds the actions. It can change the +.I acts, num_acts, +and +.I size_acts +fields of +.I xkb->server +if it is necessary to reallocate the +.I acts array. -If -.I needed -is greater than the current number of keysyms for the key, -.I XkbResizeKeyActions +If +.I needed +is greater than the current number of keysyms for the key, +.I XkbResizeKeyActions initializes all new actions in the array to NoAction. -Because the number of actions needed by a key is normally computed as width * -number of groups, and -.I XkbResizeKeyActions -does not modify either the width or number of groups for the key, a discrepancy -exists on return from -.I XkbResizeKeyActions -between the space allocated for the actions and the number required. The unused -entries in the list of actions returned by -.I XkbResizeKeyActions -are not preserved across future calls to any of the map editing functions, so -you must update the key actions (which updates the width and number of groups +Because the number of actions needed by a key is normally computed as width * +number of groups, and +.I XkbResizeKeyActions +does not modify either the width or number of groups for the key, a discrepancy +exists on return from +.I XkbResizeKeyActions +between the space allocated for the actions and the number required. The unused +entries in the list of actions returned by +.I XkbResizeKeyActions +are not preserved across future calls to any of the map editing functions, so +you must update the key actions (which updates the width and number of groups for the key) before calling another allocator function. A call to -.I XkbChangeTypesOfKey +.I XkbChangeTypesOfKey updates these. -If any allocation errors occur while resizing the number of actions bound to the -key, -.I XkbResizeKeyActions +If any allocation errors occur while resizing the number of actions bound to the +key, +.I XkbResizeKeyActions returns NULL. .SH "SEE ALSO" .BR XkbChangeTypesOfKey (__libmansuffix__), .BR XkbResizeKeySyms (__libmansuffix__) .SH NOTES .LP -A change to the number of actions bound to a key should be accompanied by a -change in the number of symbols bound to a key. Refer to -.I XkbResizeKeySyms +A change to the number of actions bound to a key should be accompanied by a +change in the number of symbols bound to a key. Refer to +.I XkbResizeKeySyms for more information on changing the number of symbols bound to a key. diff --git a/man/xkb/XkbResizeKeySyms.man b/man/xkb/XkbResizeKeySyms.man index 788a2b55..2b91a8ac 100644 --- a/man/xkb/XkbResizeKeySyms.man +++ b/man/xkb/XkbResizeKeySyms.man @@ -43,56 +43,56 @@ keycode for key to modify new number of keysyms required for key .SH DESCRIPTION .LP -.I XkbResizeKeySyms -reserves the space needed for -.I needed -keysyms and returns a pointer to the beginning of the new array that holds the -keysyms. It adjusts the -.I offset -field of the -.I key_sym_map -entry for the key if necessary and can also change the -.I syms, num_syms, -and -.I size_syms -fields of -.I xkb->map -if it is necessary to reallocate the -.I syms -array. -.I XkbResizeKeySyms +.I XkbResizeKeySyms +reserves the space needed for +.I needed +keysyms and returns a pointer to the beginning of the new array that holds the +keysyms. It adjusts the +.I offset +field of the +.I key_sym_map +entry for the key if necessary and can also change the +.I syms, num_syms, +and +.I size_syms +fields of +.I xkb->map +if it is necessary to reallocate the +.I syms +array. +.I XkbResizeKeySyms does not modify either the width or number of groups associated with the key. -If -.I needed -is greater than the current number of keysyms for the key, -.I XkbResizeKeySyms +If +.I needed +is greater than the current number of keysyms for the key, +.I XkbResizeKeySyms initializes all new keysyms in the array to NoSymbol. -Because the number of symbols needed by a key is normally computed as width * -number of groups, and -.I XkbResizeKeySyms -does not modify either the width or number of groups for the key, a discrepancy -exists upon return from -.I XkbResizeKeySyms -between the space allocated for the keysyms and the number required. The unused -entries in the list of symbols returned by -.I XkbResizeKeySyms -are not preserved across future calls to any of the map editing functions, so -you must update the key symbol mapping (which updates the width and number of +Because the number of symbols needed by a key is normally computed as width * +number of groups, and +.I XkbResizeKeySyms +does not modify either the width or number of groups for the key, a discrepancy +exists upon return from +.I XkbResizeKeySyms +between the space allocated for the keysyms and the number required. The unused +entries in the list of symbols returned by +.I XkbResizeKeySyms +are not preserved across future calls to any of the map editing functions, so +you must update the key symbol mapping (which updates the width and number of groups for the key) before calling another allocator function. A call to -.I XkbChangeTypesOfKey +.I XkbChangeTypesOfKey will update the mapping. -If any allocation errors occur while resizing the number of symbols bound to the -key, -.I XkbResizeKeySyms +If any allocation errors occur while resizing the number of symbols bound to the +key, +.I XkbResizeKeySyms returns NULL. .SH "SEE ALSO" .BR XkbChangeTypesOfKey (__libmansuffix__), .BR XkbResizeKeyActions (__libmansuffix__) .SH NOTES .LP -A change to the number of symbols bound to a key should be accompanied by a -change in the number of actions bound to a key. Refer to XkbResizeKeyActions for +A change to the number of symbols bound to a key should be accompanied by a +change in the number of actions bound to a key. Refer to XkbResizeKeyActions for more information on changing the number of actions bound to a key. diff --git a/man/xkb/XkbResizeKeyType.man b/man/xkb/XkbResizeKeyType.man index cbed3d8c..6b12430f 100644 --- a/man/xkb/XkbResizeKeyType.man +++ b/man/xkb/XkbResizeKeyType.man @@ -51,79 +51,79 @@ True => list of preserved modifiers is necessary new max # of levels for type .SH DESCRIPTION .LP -.I XkbResizeKeyType -changes the type specified by -.I xkb->map->types[type_ndx], -and reallocates the symbols and actions bound to all keys that use the type, if -necessary. -.I XkbResizeKeyType -updates only the local copy of the types in -.I xkb; -to update the server's copy for the physical device, use -.I XkbSetMap -or -.I XkbChangeMap -after calling +.I XkbResizeKeyType +changes the type specified by +.I xkb->map->types[type_ndx], +and reallocates the symbols and actions bound to all keys that use the type, if +necessary. +.I XkbResizeKeyType +updates only the local copy of the types in +.I xkb; +to update the server's copy for the physical device, use +.I XkbSetMap +or +.I XkbChangeMap +after calling .I XkbResizeKeyType. -The -.I map_count -parameter specifies the total number of map entries needed for the type, and can -be zero or greater. If -.I map_count -is zero, -.I XkbResizeKeyType -frees the existing -.I map -and -.I preserve +The +.I map_count +parameter specifies the total number of map entries needed for the type, and can +be zero or greater. If +.I map_count +is zero, +.I XkbResizeKeyType +frees the existing +.I map +and +.I preserve entries for the type if they exist and sets them to NULL. -The -.I want_preserve -parameter specifies whether a -.I preserve -list for the key should be created. If -.I want_preserve -is True, the -.I preserve -list with -.I map_count +The +.I want_preserve +parameter specifies whether a +.I preserve +list for the key should be created. If +.I want_preserve +is True, the +.I preserve +list with +.I map_count entries is allocated or reallocated if it already exists. Otherwise, if -.I want_preserve -is False, the -.I preserve +.I want_preserve +is False, the +.I preserve field is freed if necessary and set to NULL. -The -.I new_num_lvls -parameter specifies the new maximum number of shift levels for the type and is -used to calculate and resize the symbols and actions bound to all keys that use +The +.I new_num_lvls +parameter specifies the new maximum number of shift levels for the type and is +used to calculate and resize the symbols and actions bound to all keys that use the type. -If -.I type_ndx -does not specify a legal type, -.I new_num_lvls -is less than 1, or the -.I map_count -is less than zero, -.I XkbResizeKeyType -returns BadValue. If -.I XkbResizeKeyType -encounters any problems with allocation, it returns BadAlloc. Otherwise, it +If +.I type_ndx +does not specify a legal type, +.I new_num_lvls +is less than 1, or the +.I map_count +is less than zero, +.I XkbResizeKeyType +returns BadValue. If +.I XkbResizeKeyType +encounters any problems with allocation, it returns BadAlloc. Otherwise, it returns Success. .SH "RETURN VALUES" .TP 15 Success -The -.I XkbResizeKeyType -function returns Success if -.I type_ndx -specifies a legal type, -.I new_num_lvls -is greater than zero and -.I map_count +The +.I XkbResizeKeyType +function returns Success if +.I type_ndx +specifies a legal type, +.I new_num_lvls +is greater than zero and +.I map_count is positive. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbSAGroup.man b/man/xkb/XkbSAGroup.man index 3703263b..3741ff7f 100644 --- a/man/xkb/XkbSAGroup.man +++ b/man/xkb/XkbSAGroup.man @@ -33,16 +33,16 @@ XkbSAGroup \- Returns the group_XXX field of act converted to a signed int action from which to extract group .SH DESCRIPTION .LP -.I XkbSAGroup -returns the -.I group_XXX -field of -.I act -converted to a signed int. +.I XkbSAGroup +returns the +.I group_XXX +field of +.I act +converted to a signed int. .SH STRUCTURE .LP -Actions associated with the XkbGroupAction structure change the current group -state when keys are +Actions associated with the XkbGroupAction structure change the current group +state when keys are pressed and released: .nf .ft CW diff --git a/man/xkb/XkbSAPtrDfltValue.man b/man/xkb/XkbSAPtrDfltValue.man index d795c4c4..b7588ea0 100644 --- a/man/xkb/XkbSAPtrDfltValue.man +++ b/man/xkb/XkbSAPtrDfltValue.man @@ -35,22 +35,22 @@ XkbSAPtrDfltValue \- Returns the valueXXX field of act converted to a signed int action from which to extract group .SH DESCRIPTION .LP -Actions associated with the XkbPtrDfltAction structure change the mk_dflt_btn +Actions associated with the XkbPtrDfltAction structure change the mk_dflt_btn attribute of the MouseKeys control. -If the MouseKeys control is not enabled, KeyPress and KeyRelease events are -treated as though the action is XkbSA_NoAction. Otherwise, this action changes -the -.I mk_dflt_btn +If the MouseKeys control is not enabled, KeyPress and KeyRelease events are +treated as though the action is XkbSA_NoAction. Otherwise, this action changes +the +.I mk_dflt_btn attribute of the MouseKeys control. -The -.I type +The +.I type field of the XkbPtrDfltAction structure should always be XkbSA_SetPtrDflt. -The -.I flags -field is composed of the bitwise inclusive OR of the values shown in Table 1 +The +.I flags +field is composed of the bitwise inclusive OR of the values shown in Table 1 (currently there is only one value defined). .TS @@ -62,37 +62,37 @@ _ Flag Meaning _ XkbSA_DfltBtnAbsolute T{ -If set, the value field represents an absolute pointer button. Otherwise, the +If set, the value field represents an absolute pointer button. Otherwise, the value field represents the amount to be added to the current default button. T} .TE -The -.I affect -field specifies what changes as a result of this action. The only valid value -for the -.I affect +The +.I affect +field specifies what changes as a result of this action. The only valid value +for the +.I affect field is XkbSA_AffectDfltBtn. -The -.I valueXXX +The +.I valueXXX field is a signed character that represents the new button value for the -.I mk_dflt_btn -attribute of the MouseKeys control. If XkbSA_DfltBtnAbsolute is set in -.I flags, valueXXX -specifies the button to be used; otherwise, -.I valueXXX -specifies the amount to be added to the current default button. In either case, -illegal button choices are wrapped back around into range. Xkb provides macros, -to convert between the integer and signed character values in XkbPtrDfltAction +.I mk_dflt_btn +attribute of the MouseKeys control. If XkbSA_DfltBtnAbsolute is set in +.I flags, valueXXX +specifies the button to be used; otherwise, +.I valueXXX +specifies the amount to be added to the current default button. In either case, +illegal button choices are wrapped back around into range. Xkb provides macros, +to convert between the integer and signed character values in XkbPtrDfltAction structures. -.I XkbSAPtrDfltValue -returns the -.I valueXXX -field of -.I act -converted to a signed int. +.I XkbSAPtrDfltValue +returns the +.I valueXXX +field of +.I act +converted to a signed int. .SH STRUCTURES .LP .nf diff --git a/man/xkb/XkbSARedirectSetVMods.man b/man/xkb/XkbSARedirectSetVMods.man index 49a5c811..5cd36f24 100644 --- a/man/xkb/XkbSARedirectSetVMods.man +++ b/man/xkb/XkbSARedirectSetVMods.man @@ -38,58 +38,58 @@ action in which to set vmods new value for virtual modifiers .SH DESCRIPTION .LP -Actions associated with the XkbRedirectKeyAction structure generate KeyPress and KeyRelease events +Actions associated with the XkbRedirectKeyAction structure generate KeyPress and KeyRelease events containing a keycode different from the key that was pressed or released. -The -.I type +The +.I type field for the XkbRedirectKeyAction structure should always be XkbSA_RedirectKey. -Key presses cause a KeyPress event for the key specified by the -.I new_key -field instead of the actual key. The state reported in this event reports the current effective -modifiers changed as follows: any real modifiers selected by the -.I mods_mask -field are set to corresponding values from the -.I mods +Key presses cause a KeyPress event for the key specified by the +.I new_key +field instead of the actual key. The state reported in this event reports the current effective +modifiers changed as follows: any real modifiers selected by the +.I mods_mask +field are set to corresponding values from the +.I mods field. Any real modifiers bound to the virtual modifiers specified by the -.I vmods_mask0 -and -.I vmods_mask1 +.I vmods_mask0 +and +.I vmods_mask1 fields are either set or cleared, depending on the corresponding values in the -.I vmods0 -and -.I vmods1 -fields. If the real and virtual modifier definitions specify conflicting values for a single modifier, +.I vmods0 +and +.I vmods1 +fields. If the real and virtual modifier definitions specify conflicting values for a single modifier, the real modifier definition has priority. -Key releases cause a KeyRelease event for the key specified by the -.I new_key -field instead of the actual key. The state for this event consists of the effective keyboard modifiers +Key releases cause a KeyRelease event for the key specified by the +.I new_key +field instead of the actual key. The state for this event consists of the effective keyboard modifiers at the time of the release, changed as described previously. -The XkbSA_RedirectKey action normally redirects to another key on the same device as the key that -caused the event, unless that device does not belong to the input extension KeyClass, in which case -this action causes an event on the core keyboard device. (The input extension categorizes devices by -breaking them into classes. Keyboards, and other input devices with keys, are classified as KeyClass +The XkbSA_RedirectKey action normally redirects to another key on the same device as the key that +caused the event, unless that device does not belong to the input extension KeyClass, in which case +this action causes an event on the core keyboard device. (The input extension categorizes devices by +breaking them into classes. Keyboards, and other input devices with keys, are classified as KeyClass devices by the input extension.) -The -.I vmods_mask0 -and -.I vmods_mask1 -fields actually represent one -.I vmods_mask +The +.I vmods_mask0 +and +.I vmods_mask1 +fields actually represent one +.I vmods_mask value. Xkb provides macros to convert between the two formats. -.I XkbSARedirectSetVModsMask -sets the -.I vmods0 -and -.I vmods1 -of -.I act -from +.I XkbSARedirectSetVModsMask +sets the +.I vmods0 +and +.I vmods1 +of +.I act +from .I v. .SH STRUCTURES .LP @@ -105,5 +105,5 @@ from unsigned char vmods0; /\&* first half of mask of virtual mods to take values from */ unsigned char vmods1; /\&* other half of mask of virtual mods to take values from */ } XkbRedirectKeyAction; - + .fi diff --git a/man/xkb/XkbSARedirectSetVModsMask.man b/man/xkb/XkbSARedirectSetVModsMask.man index 088ae51e..8c71048c 100644 --- a/man/xkb/XkbSARedirectSetVModsMask.man +++ b/man/xkb/XkbSARedirectSetVModsMask.man @@ -22,7 +22,7 @@ .\" .TH XkbSARedirectSetVModsMask __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSARedirectSetVModsMask \- Sets the vmods_mask0 and vmods_mask1 fields of act +XkbSARedirectSetVModsMask \- Sets the vmods_mask0 and vmods_mask1 fields of act from vm .SH SYNOPSIS .HP @@ -40,66 +40,66 @@ action in which to set vmods new value for virtual modifier mask .SH DESCRIPTION .LP -Actions associated with the XkbRedirectKeyAction structure generate KeyPress and -KeyRelease events +Actions associated with the XkbRedirectKeyAction structure generate KeyPress and +KeyRelease events containing a keycode different from the key that was pressed or released. -The -.I type +The +.I type field for the XkbRedirectKeyAction structure should always be XkbSA_RedirectKey. -Key presses cause a KeyPress event for the key specified by the -.I new_key -field instead of the actual key. The state reported in this event reports the -current effective -modifiers changed as follows: any real modifiers selected by the -.I mods_mask -field are set to corresponding values from the -.I mods +Key presses cause a KeyPress event for the key specified by the +.I new_key +field instead of the actual key. The state reported in this event reports the +current effective +modifiers changed as follows: any real modifiers selected by the +.I mods_mask +field are set to corresponding values from the +.I mods field. Any real modifiers bound to the virtual modifiers specified by the -.I vmods_mask0 -and -.I vmods_mask1 +.I vmods_mask0 +and +.I vmods_mask1 fields are either set or cleared, depending on the corresponding values in the -.I vmods0 -and -.I vmods1 -fields. If the real and virtual modifier definitions specify conflicting values -for a single modifier, +.I vmods0 +and +.I vmods1 +fields. If the real and virtual modifier definitions specify conflicting values +for a single modifier, the real modifier definition has priority. -Key releases cause a KeyRelease event for the key specified by the -.I new_key -field instead of the actual key. The state for this event consists of the -effective keyboard modifiers +Key releases cause a KeyRelease event for the key specified by the +.I new_key +field instead of the actual key. The state for this event consists of the +effective keyboard modifiers at the time of the release, changed as described previously. -The XkbSA_RedirectKey action normally redirects to another key on the same -device as the key that -caused the event, unless that device does not belong to the input extension -KeyClass, in which case -this action causes an event on the core keyboard device. (The input extension -categorizes devices by -breaking them into classes. Keyboards, and other input devices with keys, are -classified as KeyClass +The XkbSA_RedirectKey action normally redirects to another key on the same +device as the key that +caused the event, unless that device does not belong to the input extension +KeyClass, in which case +this action causes an event on the core keyboard device. (The input extension +categorizes devices by +breaking them into classes. Keyboards, and other input devices with keys, are +classified as KeyClass devices by the input extension.) -The -.I vmods_mask0 -and -.I vmods_mask1 -fields actually represent one -.I vmods_mask +The +.I vmods_mask0 +and +.I vmods_mask1 +fields actually represent one +.I vmods_mask value. Xkb provides macros to convert between the two formats. -.I XkbSARedirectSetVModsMask -sets the -.I vmods_mask0 -and -.I vmods_mask1 -fields of -.I act -from -.I vm. +.I XkbSARedirectSetVModsMask +sets the +.I vmods_mask0 +and +.I vmods_mask1 +fields of +.I act +from +.I vm. .SH STRUCTURES .LP .nf @@ -114,5 +114,5 @@ from unsigned char vmods0; /\&* first half of mask of virtual mods to take values from */ unsigned char vmods1; /\&* other half of mask of virtual mods to take values from */ } XkbRedirectKeyAction; - + .fi diff --git a/man/xkb/XkbSARedirectVMods.man b/man/xkb/XkbSARedirectVMods.man index cb176755..e8b6146a 100644 --- a/man/xkb/XkbSARedirectVMods.man +++ b/man/xkb/XkbSARedirectVMods.man @@ -21,7 +21,7 @@ .\" .TH XkbSARedirectVMods __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSARedirectVMods \- Returns the vmods0 and vmods1 fields of act converted to +XkbSARedirectVMods \- Returns the vmods0 and vmods1 fields of act converted to an unsigned int .SH SYNOPSIS .HP @@ -35,65 +35,65 @@ an unsigned int action from which to extract vmods .SH DESCRIPTION .LP -Actions associated with the XkbRedirectKeyAction structure generate KeyPress and -KeyRelease events +Actions associated with the XkbRedirectKeyAction structure generate KeyPress and +KeyRelease events containing a keycode different from the key that was pressed or released. -The -.I type +The +.I type field for the XkbRedirectKeyAction structure should always be XkbSA_RedirectKey. -Key presses cause a KeyPress event for the key specified by the -.I new_key -field instead of the actual key. The state reported in this event reports the -current effective -modifiers changed as follows: any real modifiers selected by the -.I mods_mask -field are set to corresponding values from the -.I mods +Key presses cause a KeyPress event for the key specified by the +.I new_key +field instead of the actual key. The state reported in this event reports the +current effective +modifiers changed as follows: any real modifiers selected by the +.I mods_mask +field are set to corresponding values from the +.I mods field. Any real modifiers bound to the virtual modifiers specified by the -.I vmods_mask0 -and -.I vmods_mask1 +.I vmods_mask0 +and +.I vmods_mask1 fields are either set or cleared, depending on the corresponding values in the -.I vmods0 -and -.I vmods1 -fields. If the real and virtual modifier definitions specify conflicting values -for a single modifier, +.I vmods0 +and +.I vmods1 +fields. If the real and virtual modifier definitions specify conflicting values +for a single modifier, the real modifier definition has priority. -Key releases cause a KeyRelease event for the key specified by the -.I new_key -field instead of the actual key. The state for this event consists of the -effective keyboard modifiers +Key releases cause a KeyRelease event for the key specified by the +.I new_key +field instead of the actual key. The state for this event consists of the +effective keyboard modifiers at the time of the release, changed as described previously. -The XkbSA_RedirectKey action normally redirects to another key on the same -device as the key that -caused the event, unless that device does not belong to the input extension -KeyClass, in which case -this action causes an event on the core keyboard device. (The input extension -categorizes devices by -breaking them into classes. Keyboards, and other input devices with keys, are -classified as KeyClass +The XkbSA_RedirectKey action normally redirects to another key on the same +device as the key that +caused the event, unless that device does not belong to the input extension +KeyClass, in which case +this action causes an event on the core keyboard device. (The input extension +categorizes devices by +breaking them into classes. Keyboards, and other input devices with keys, are +classified as KeyClass devices by the input extension.) -The -.I vmods_mask0 -and -.I vmods_mask1 -fields actually represent one -.I vmods_mask +The +.I vmods_mask0 +and +.I vmods_mask1 +fields actually represent one +.I vmods_mask value. Xkb provides macros to convert between the two formats. -.I XkbSARedirectVModsMask -returns the -.I vmods0 -and -.I vmods1 -fields of -.I act -converted to an unsigned int. +.I XkbSARedirectVModsMask +returns the +.I vmods0 +and +.I vmods1 +fields of +.I act +converted to an unsigned int. .SH STRUCTURES .LP .nf @@ -108,5 +108,5 @@ converted to an unsigned int. unsigned char vmods0; /\&* first half of mask of virtual mods to take values from */ unsigned char vmods1; /\&* other half of mask of virtual mods to take values from */ } XkbRedirectKeyAction; - + .fi diff --git a/man/xkb/XkbSARedirectVModsMask.man b/man/xkb/XkbSARedirectVModsMask.man index ae97e6f4..311377bb 100644 --- a/man/xkb/XkbSARedirectVModsMask.man +++ b/man/xkb/XkbSARedirectVModsMask.man @@ -21,7 +21,7 @@ .\" .TH XkbSARedirectVModsMask __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSARedirectVModsMask \- Returns the vmods_mask0 and vmods_mask1 fields of act +XkbSARedirectVModsMask \- Returns the vmods_mask0 and vmods_mask1 fields of act converted to an unsigned int .SH SYNOPSIS .HP @@ -35,65 +35,65 @@ converted to an unsigned int action from which to extract vmods .SH DESCRIPTION .LP -Actions associated with the XkbRedirectKeyAction structure generate KeyPress and -KeyRelease events +Actions associated with the XkbRedirectKeyAction structure generate KeyPress and +KeyRelease events containing a keycode different from the key that was pressed or released. -The -.I type +The +.I type field for the XkbRedirectKeyAction structure should always be XkbSA_RedirectKey. -Key presses cause a KeyPress event for the key specified by the -.I new_key -field instead of the actual key. The state reported in this event reports the -current effective -modifiers changed as follows: any real modifiers selected by the -.I mods_mask -field are set to corresponding values from the -.I mods +Key presses cause a KeyPress event for the key specified by the +.I new_key +field instead of the actual key. The state reported in this event reports the +current effective +modifiers changed as follows: any real modifiers selected by the +.I mods_mask +field are set to corresponding values from the +.I mods field. Any real modifiers bound to the virtual modifiers specified by the -.I vmods_mask0 -and -.I vmods_mask1 +.I vmods_mask0 +and +.I vmods_mask1 fields are either set or cleared, depending on the corresponding values in the -.I vmods0 -and -.I vmods1 -fields. If the real and virtual modifier definitions specify conflicting values -for a single modifier, +.I vmods0 +and +.I vmods1 +fields. If the real and virtual modifier definitions specify conflicting values +for a single modifier, the real modifier definition has priority. -Key releases cause a KeyRelease event for the key specified by the -.I new_key -field instead of the actual key. The state for this event consists of the -effective keyboard modifiers +Key releases cause a KeyRelease event for the key specified by the +.I new_key +field instead of the actual key. The state for this event consists of the +effective keyboard modifiers at the time of the release, changed as described previously. -The XkbSA_RedirectKey action normally redirects to another key on the same -device as the key that -caused the event, unless that device does not belong to the input extension -KeyClass, in which case -this action causes an event on the core keyboard device. (The input extension -categorizes devices by -breaking them into classes. Keyboards, and other input devices with keys, are -classified as KeyClass +The XkbSA_RedirectKey action normally redirects to another key on the same +device as the key that +caused the event, unless that device does not belong to the input extension +KeyClass, in which case +this action causes an event on the core keyboard device. (The input extension +categorizes devices by +breaking them into classes. Keyboards, and other input devices with keys, are +classified as KeyClass devices by the input extension.) -The -.I vmods_mask0 -and -.I vmods_mask1 -fields actually represent one -.I vmods_mask +The +.I vmods_mask0 +and +.I vmods_mask1 +fields actually represent one +.I vmods_mask value. Xkb provides macros to convert between the two formats. -.I XkbSARedirectVModsMask -returns the -.I vmods_mask0 -and -.I vmods_mask1 -fields of -.I act -converted to an unsigned int. +.I XkbSARedirectVModsMask +returns the +.I vmods_mask0 +and +.I vmods_mask1 +fields of +.I act +converted to an unsigned int. .bp .SH STRUCTURES .LP @@ -109,5 +109,5 @@ converted to an unsigned int. unsigned char vmods0; /\&* first half of mask of virtual mods to take values from */ unsigned char vmods1; /\&* other half of mask of virtual mods to take values from */ } XkbRedirectKeyAction; - + .fi diff --git a/man/xkb/XkbSAScreen.man b/man/xkb/XkbSAScreen.man index e45e8157..6ec11aed 100644 --- a/man/xkb/XkbSAScreen.man +++ b/man/xkb/XkbSAScreen.man @@ -25,7 +25,7 @@ XkbSAScreen \- Returns the screenXXX field of act converted to a signed int .SH SYNOPSIS .HP -.B int XkbSAScreen +.B int XkbSAScreen .BI "(\^XkbSwitchScreenAction " "act" "\^);" .if n .ti +5n .if t .ti +.5i @@ -35,16 +35,16 @@ XkbSAScreen \- Returns the screenXXX field of act converted to a signed int action from which to extract screen .SH DESCRIPTION .LP -Actions associated with the XkbSwitchScreen action structure change the active +Actions associated with the XkbSwitchScreen action structure change the active screen on a multiscreen display. -The -.I type -field of the XkbSwitchScreenAction structure should always be +The +.I type +field of the XkbSwitchScreenAction structure should always be XkbSA_SwitchScreen. -The -.I flags +The +.I flags field is composed of the bitwise inclusive OR of the masks shown in Table 1. .TS @@ -56,31 +56,31 @@ _ Flag Meaning _ XkbSA_SwitchAbsolute T{ -If set, the screenXXX field represents the index of the new screen. Otherwise, +If set, the screenXXX field represents the index of the new screen. Otherwise, it represents an offset from the current screen to the new screen. T} XkbSA_SwitchApplication T{ -If not set, the action should switch to another screen on the same server. -Otherwise, it should switch to another X server or application that shares the +If not set, the action should switch to another screen on the same server. +Otherwise, it should switch to another X server or application that shares the same physical display. T} .TE -The -.I screenXXX -field is a signed character value that represents either the relative or -absolute screen index, depending on the state of the XkbSA_SwitchAbsolute bit in -the -.I flags -field. Xkb provides the following macros to convert between the integer and +The +.I screenXXX +field is a signed character value that represents either the relative or +absolute screen index, depending on the state of the XkbSA_SwitchAbsolute bit in +the +.I flags +field. Xkb provides the following macros to convert between the integer and signed character value for screen numbers in XkbSwitchScreenAction structures. -.I XkbSAScreen -macro returns the -.I screenXXX -field of -.I act -converted to a signed int. +.I XkbSAScreen +macro returns the +.I screenXXX +field of +.I act +converted to a signed int. .SH STRUCTURES .LP .nf @@ -95,8 +95,8 @@ converted to a signed int. .SH NOTES .LP -The XkbSwitchScreen action is optional. Servers are free to ignore the action or -any of its -flags if they do not support the requested behavior. If the action is ignored, -it behaves like XkbSA_NoAction. Otherwise, key press and key release events do -not generate an event. +The XkbSwitchScreen action is optional. Servers are free to ignore the action or +any of its +flags if they do not support the requested behavior. If the action is ignored, +it behaves like XkbSA_NoAction. Otherwise, key press and key release events do +not generate an event. diff --git a/man/xkb/XkbSASetGroup.man b/man/xkb/XkbSASetGroup.man index 54f99f21..45bcb2e8 100644 --- a/man/xkb/XkbSASetGroup.man +++ b/man/xkb/XkbSASetGroup.man @@ -37,13 +37,13 @@ action from which to set group group index to set in group_XXX .SH DESCRIPTION .LP -.I XkbSASetGroup -sets the -.I group_XXX -field of -.I act -from the group index -.I grp. +.I XkbSASetGroup +sets the +.I group_XXX +field of +.I act +from the group index +.I grp. .SH STRUCTURE .LP Actions associated with the XkbGroupAction structure change the diff --git a/man/xkb/XkbSASetPtrDfltValue.man b/man/xkb/XkbSASetPtrDfltValue.man index 09da49a4..b7be5e4c 100644 --- a/man/xkb/XkbSASetPtrDfltValue.man +++ b/man/xkb/XkbSASetPtrDfltValue.man @@ -39,22 +39,22 @@ action in which to set valueXXX value to set in valueXXX .SH DESCRIPTION .LP -Actions associated with the XkbPtrDfltAction structure change the mk_dflt_btn +Actions associated with the XkbPtrDfltAction structure change the mk_dflt_btn attribute of the MouseKeys control. -If the MouseKeys control is not enabled, KeyPress and KeyRelease events are -treated as though the action is XkbSA_NoAction. Otherwise, this action changes -the -.I mk_dflt_btn +If the MouseKeys control is not enabled, KeyPress and KeyRelease events are +treated as though the action is XkbSA_NoAction. Otherwise, this action changes +the +.I mk_dflt_btn attribute of the MouseKeys control. -The -.I type +The +.I type field of the XkbPtrDfltAction structure should always be XkbSA_SetPtrDflt. -The -.I flags -field is composed of the bitwise inclusive OR of the values shown in Table 1 +The +.I flags +field is composed of the bitwise inclusive OR of the values shown in Table 1 (currently there is only one value defined). .TS @@ -66,29 +66,29 @@ _ Flag Meaning _ XkbSA_DfltBtnAbsolute T{ -If set, the value field represents an absolute pointer button. Otherwise, the +If set, the value field represents an absolute pointer button. Otherwise, the value field represents the amount to be added to the current default button. T} .TE -The -.I affect -field specifies what changes as a result of this action. The only valid value -for the -.I affect +The +.I affect +field specifies what changes as a result of this action. The only valid value +for the +.I affect field is XkbSA_AffectDfltBtn. -The -.I valueXXX +The +.I valueXXX field is a signed character that represents the new button value for the -.I mk_dflt_btn -attribute of the MouseKeys control. If XkbSA_DfltBtnAbsolute is set in -.I flags, valueXXX -specifies the button to be used; otherwise, -.I valueXXX -specifies the amount to be added to the current default button. In either case, -illegal button choices are wrapped back around into range. Xkb provides macros, -to convert between the integer and signed character values in XkbPtrDfltAction +.I mk_dflt_btn +attribute of the MouseKeys control. If XkbSA_DfltBtnAbsolute is set in +.I flags, valueXXX +specifies the button to be used; otherwise, +.I valueXXX +specifies the amount to be added to the current default button. In either case, +illegal button choices are wrapped back around into range. Xkb provides macros, +to convert between the integer and signed character values in XkbPtrDfltAction structures. .SH STRUCTURES .LP diff --git a/man/xkb/XkbSASetScreen.man b/man/xkb/XkbSASetScreen.man index 582acaa1..4b38c79b 100644 --- a/man/xkb/XkbSASetScreen.man +++ b/man/xkb/XkbSASetScreen.man @@ -39,16 +39,16 @@ action in which to set screenXXX value to set in screenXXX .SH DESCRIPTION .LP -Actions associated with the XkbSwitchScreen action structure change the active +Actions associated with the XkbSwitchScreen action structure change the active screen on a multiscreen display. -The -.I type -field of the XkbSwitchScreenAction structure should always be +The +.I type +field of the XkbSwitchScreenAction structure should always be XkbSA_SwitchScreen. -The -.I flags +The +.I flags field is composed of the bitwise inclusive OR of the masks shown in Table 1. .TS @@ -60,23 +60,23 @@ _ Flag Meaning _ XkbSA_SwitchAbsolute T{ -If set, the screenXXX field represents the index of the new screen. Otherwise, +If set, the screenXXX field represents the index of the new screen. Otherwise, it represents an offset from the current screen to the new screen. T} XkbSA_SwitchApplication T{ -If not set, the action should switch to another screen on the same server. -Otherwise, it should switch to another X server or application that shares the +If not set, the action should switch to another screen on the same server. +Otherwise, it should switch to another X server or application that shares the same physical display. T} .TE -The -.I screenXXX -field is a signed character value that represents either the relative or -absolute screen index, depending on the state of the XkbSA_SwitchAbsolute bit in -the -.I flags -field. Xkb provides the following macros to convert between the integer and +The +.I screenXXX +field is a signed character value that represents either the relative or +absolute screen index, depending on the state of the XkbSA_SwitchAbsolute bit in +the +.I flags +field. Xkb provides the following macros to convert between the integer and signed character value for screen numbers in XkbSwitchScreenAction structures. .SH STRUCTURES .LP @@ -91,7 +91,7 @@ signed character value for screen numbers in XkbSwitchScreenAction structures. .fi .SH NOTES .LP -This action is optional. Servers are free to ignore the action or any of its -flags if they do not support the requested behavior. If the action is ignored, -it behaves like XkbSA_NoAction. Otherwise, key press and key release events do -not generate an event. +This action is optional. Servers are free to ignore the action or any of its +flags if they do not support the requested behavior. If the action is ignored, +it behaves like XkbSA_NoAction. Otherwise, key press and key release events do +not generate an event. diff --git a/man/xkb/XkbSelectEventDetails.man b/man/xkb/XkbSelectEventDetails.man index bd9800d3..6d9729f0 100644 --- a/man/xkb/XkbSelectEventDetails.man +++ b/man/xkb/XkbSelectEventDetails.man @@ -21,9 +21,9 @@ .\" .TH XkbSelectEventDetails __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSelectEventDetails \- Selects or deselects for a specific Xkb event and -optionally places conditions on when events of that type are reported to your -client +XkbSelectEventDetails \- Selects or deselects for a specific Xkb event and +optionally places conditions on when events of that type are reported to your +client .SH SYNOPSIS .HP .B Bool XkbSelectEventDetails @@ -37,7 +37,7 @@ client .SH ARGUMENTS .TP .I display -connection to the X server +connection to the X server .TP .I device_spec device ID, or XkbUseCoreKbd @@ -52,90 +52,90 @@ determines events to be selected / deselected 1=>select, 0->deselect; for events in bits_to_change .SH DESCRIPTION .LP -Xkb events are selected using an event mask, much the same as normal core X -events are selected. However, unlike selecting core X events, where you must -specify the selection status (on or off) for all possible event types whenever -you wish to change the selection criteria for any one event, Xkb allows you to -restrict the specification to only the event types you wish to change. This -means that you do not need to remember the event selection values for all +Xkb events are selected using an event mask, much the same as normal core X +events are selected. However, unlike selecting core X events, where you must +specify the selection status (on or off) for all possible event types whenever +you wish to change the selection criteria for any one event, Xkb allows you to +restrict the specification to only the event types you wish to change. This +means that you do not need to remember the event selection values for all possible types each time you want to change one of them. -Many Xkb event types are generated under several different circumstances. When -selecting to receive an Xkb event, you may specify either that you want it -delivered under all circumstances, or that you want it delivered only for a +Many Xkb event types are generated under several different circumstances. When +selecting to receive an Xkb event, you may specify either that you want it +delivered under all circumstances, or that you want it delivered only for a subset of the possible circumstances. - -You can also deselect an event type that was previously selected for, using the + +You can also deselect an event type that was previously selected for, using the same granularity. -Xkb provides two functions to select and deselect delivery of Xkb events. -.I XkbSelectEvents -allows you to select or deselect delivery of more than one Xkb event type at -once. Events selected using -.I XkbSelectEvents -are delivered to your program under all circumstances that generate the events. -To restrict delivery of an event to a subset of the conditions under which it -occurs, use -.I XkbSelectEventDetails. XkbSelectEventDetails -only allows you to change the selection conditions for a single event at a time, -but it provides a means of fine-tuning the conditions under which the event is +Xkb provides two functions to select and deselect delivery of Xkb events. +.I XkbSelectEvents +allows you to select or deselect delivery of more than one Xkb event type at +once. Events selected using +.I XkbSelectEvents +are delivered to your program under all circumstances that generate the events. +To restrict delivery of an event to a subset of the conditions under which it +occurs, use +.I XkbSelectEventDetails. XkbSelectEventDetails +only allows you to change the selection conditions for a single event at a time, +but it provides a means of fine-tuning the conditions under which the event is delivered. -To select or deselect for a specific Xkb event and optionally place conditions -on when events of that type are reported to your client, use -.I XkbSelectEventDetails. -This allows you to exercise a finer granularity of -control over delivery of Xkb events with +To select or deselect for a specific Xkb event and optionally place conditions +on when events of that type are reported to your client, use +.I XkbSelectEventDetails. +This allows you to exercise a finer granularity of +control over delivery of Xkb events with .I XkbSelectEvents. -While -.I XkbSelectEvents -allows multiple events to be selected, -.I XkbSelectEventDetails -changes the selection criteria for a single type of Xkb -event. The interpretation of the -.I bits_to_change -and -.I values_for_bits +While +.I XkbSelectEvents +allows multiple events to be selected, +.I XkbSelectEventDetails +changes the selection criteria for a single type of Xkb +event. The interpretation of the +.I bits_to_change +and +.I values_for_bits masks depends on the event type in question. - -.I XkbSelectEventDetails -changes the Xkb event selection mask for the keyboard -specified by -.I device_spec -and the Xkb event specified by -.I event_type. -To turn on event selection for an event detail, set the bit for the -detail in the -.I bits_to_change -parameter and set the corresponding bit in the -.I values_for_bits -parameter. To turn off event detail selection for a detail, set -the bit for the detail in the -.I bits_to_change -parameter and do not set the corresponding bit in the -.I values_for_bits + +.I XkbSelectEventDetails +changes the Xkb event selection mask for the keyboard +specified by +.I device_spec +and the Xkb event specified by +.I event_type. +To turn on event selection for an event detail, set the bit for the +detail in the +.I bits_to_change +parameter and set the corresponding bit in the +.I values_for_bits +parameter. To turn off event detail selection for a detail, set +the bit for the detail in the +.I bits_to_change +parameter and do not set the corresponding bit in the +.I values_for_bits parameter. -If an invalid event type is specified, a BadValue protocol error results. If a -bit is not set in the -.I bits_to_change +If an invalid event type is specified, a BadValue protocol error results. If a +bit is not set in the +.I bits_to_change parameter, but the corresponding bit is set in the -.I values_for_bits -parameter, a BadMatch protocol error results. If an undefined -bit is set in either the -.I bits_to_change -or the -.I values_for_bits +.I values_for_bits +parameter, a BadMatch protocol error results. If an undefined +bit is set in either the +.I bits_to_change +or the +.I values_for_bits parameter, a BadValue protocol error results. -For each type of Xkb event, the legal event details that you can specify in the -.I XkbSelectEventDetails +For each type of Xkb event, the legal event details that you can specify in the +.I XkbSelectEventDetails request are listed in the chapters that describe each event in detail. .SH DIAGNOSTICS .TP 15 .SM BadMatch -A compatible version of Xkb was not available in the server or an argument has +A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid .TP 15 .SM BadValue diff --git a/man/xkb/XkbSetAutoRepeatRate.man b/man/xkb/XkbSetAutoRepeatRate.man index 327e9c52..1e2ac83e 100644 --- a/man/xkb/XkbSetAutoRepeatRate.man +++ b/man/xkb/XkbSetAutoRepeatRate.man @@ -21,7 +21,7 @@ .\" .TH XkbSetAutoRepeatRate __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSetAutoRepeatRate \- Sets the attributes of the RepeatKeys control for a +XkbSetAutoRepeatRate \- Sets the attributes of the RepeatKeys control for a keyboard device .SH SYNOPSIS .HP @@ -47,50 +47,50 @@ initial delay, ms delay between repeats, ms .SH DESCRIPTION .LP -The core protocol allows only control over whether or not the entire keyboard or -individual keys should auto-repeat when held down. RepeatKeys is a boolean -control that extends this capability by adding control over the delay until a -key begins to repeat and the rate at which it repeats. RepeatKeys is coupled -with the core auto-repeat control: when RepeatKeys is enabled or disabled, the +The core protocol allows only control over whether or not the entire keyboard or +individual keys should auto-repeat when held down. RepeatKeys is a boolean +control that extends this capability by adding control over the delay until a +key begins to repeat and the rate at which it repeats. RepeatKeys is coupled +with the core auto-repeat control: when RepeatKeys is enabled or disabled, the core auto-repeat is enabled or disabled and vice versa. -Auto-repeating keys are controlled by two attributes. The first, -.I timeout, -is the delay after the initial press of an auto-repeating key and the first -generated repeat event. The second, -.I interval, -is the delay between all subsequent generated repeat events. As with all boolean -controls, configuring the attributes that determine how the control operates +Auto-repeating keys are controlled by two attributes. The first, +.I timeout, +is the delay after the initial press of an auto-repeating key and the first +generated repeat event. The second, +.I interval, +is the delay between all subsequent generated repeat events. As with all boolean +controls, configuring the attributes that determine how the control operates does not automatically enable the control as a whole. -.I XkbSetAutoRepeatRate -sends a request to the X server to configure the AutoRepeat control attributes -to the values specified in -.I timeout -and +.I XkbSetAutoRepeatRate +sends a request to the X server to configure the AutoRepeat control attributes +to the values specified in +.I timeout +and .I interval. - -.I XkbSetAutoRepeatRate -does not wait for a reply; it normally returns True. Specifying a zero value for -either -.I timeout -or -.I interval -causes the server to generate a BadValue protocol error. If a compatible version -of the Xkb extension is not available in the server, -.I XkbSetAutoRepeatRate + +.I XkbSetAutoRepeatRate +does not wait for a reply; it normally returns True. Specifying a zero value for +either +.I timeout +or +.I interval +causes the server to generate a BadValue protocol error. If a compatible version +of the Xkb extension is not available in the server, +.I XkbSetAutoRepeatRate returns False. .SH "RETURN VALUES" .TP 15 True -The -.I XkbSetAutoRepeatRate +The +.I XkbSetAutoRepeatRate function returns True normally. .TP 15 False -The -.I XkbSetAutoRepeatRate -function returns False if a compatible version of the Xkb extension is not +The +.I XkbSetAutoRepeatRate +function returns False if a compatible version of the Xkb extension is not available in the server. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbSetAutoResetControls.man b/man/xkb/XkbSetAutoResetControls.man index 128da0e3..85b90d30 100644 --- a/man/xkb/XkbSetAutoResetControls.man +++ b/man/xkb/XkbSetAutoResetControls.man @@ -21,7 +21,7 @@ .\" .TH XkbSetAutoResetControls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSetAutoResetControls \- Changes the current values of the AutoReset control +XkbSetAutoResetControls \- Changes the current values of the AutoReset control attributes .SH SYNOPSIS .HP @@ -41,29 +41,29 @@ connection to X server controls for which to change auto-reset values .TP .I auto_ctrls -controls from changes that should auto reset +controls from changes that should auto reset .TP .I auto_values 1 bit => auto-reset on .SH DESCRIPTION .LP -.I XkbSetAutoResetControls -changes the auto-reset status and associated auto-reset values for the controls -selected by -.I changes. -For any control selected by -.I changes, -if the corresponding bit is set in -.I auto_ctrls, -the control is configured to auto-reset when the client exits. If the -corresponding bit in -.I auto_values -is on, the control is turned on when the client exits; if zero, the control is -turned off when the client exits. For any control selected by -.I changes, -if the corresponding bit is not set in -.I auto_ctrls, -the control is configured to not reset when the client exits. +.I XkbSetAutoResetControls +changes the auto-reset status and associated auto-reset values for the controls +selected by +.I changes. +For any control selected by +.I changes, +if the corresponding bit is set in +.I auto_ctrls, +the control is configured to auto-reset when the client exits. If the +corresponding bit in +.I auto_values +is on, the control is turned on when the client exits; if zero, the control is +turned off when the client exits. For any control selected by +.I changes, +if the corresponding bit is not set in +.I auto_ctrls, +the control is configured to not reset when the client exits. For example: @@ -71,30 +71,30 @@ For example: To leave the auto-reset controls for StickyKeys the way they are: ok = XkbSetAutoResetControls(dpy, 0, 0, 0); - -To change the auto-reset controls so that StickyKeys are unaffected when the + +To change the auto-reset controls so that StickyKeys are unaffected when the client exits: ok = XkbSetAutoResetControls(dpy, XkbStickyKeysMask, 0, 0); - -To change the auto-reset controls so that StickyKeys are turned off when the + +To change the auto-reset controls so that StickyKeys are turned off when the client exits: ok = XkbSetAutoResetControls(dpy, XkbStickyKeysMask, XkbStickyKeysMask, 0); - -To change the auto-reset controls so that StickyKeys are turned on when the + +To change the auto-reset controls so that StickyKeys are turned on when the client exits: - ok = XkbSetAutoResetControls(dpy, XkbStickyKeysMask, XkbStickyKeysMask, + ok = XkbSetAutoResetControls(dpy, XkbStickyKeysMask, XkbStickyKeysMask, XkbStickyKeysMask); .fi -.I XkbSetAutoResetControls -backfills -.I auto_ctrls -and -.I auto_values -with the auto-reset controls for this particular client. Note that all of the -bits are valid in the returned values, not just the ones selected in the -.I changes +.I XkbSetAutoResetControls +backfills +.I auto_ctrls +and +.I auto_values +with the auto-reset controls for this particular client. Note that all of the +bits are valid in the returned values, not just the ones selected in the +.I changes mask. diff --git a/man/xkb/XkbSetCompatMap.man b/man/xkb/XkbSetCompatMap.man index c6e0be32..f8b67caa 100644 --- a/man/xkb/XkbSetCompatMap.man +++ b/man/xkb/XkbSetCompatMap.man @@ -44,34 +44,34 @@ mask of compat map components to set source for compat map components .TP .I update_actions -True => apply to server's keyboard map +True => apply to server's keyboard map .SH DESCRIPTION -To modify the server's compatibility map, first modify a local copy of the Xkb -compatibility map, then call -.I XkbSetCompatMap. +To modify the server's compatibility map, first modify a local copy of the Xkb +compatibility map, then call +.I XkbSetCompatMap. You may allocate a new compatibility map for this purpose using -.I XkbAllocCompatMap. -You may also use a compatibility map from another server, although you need to -adjust the -.I device_spec -field in the XkbDescRec accordingly. Note that symbol interpretations in a +.I XkbAllocCompatMap. +You may also use a compatibility map from another server, although you need to +adjust the +.I device_spec +field in the XkbDescRec accordingly. Note that symbol interpretations in a compatibility map ( -.IR sym_interpret , -the vector of XkbSymInterpretRec structures) are also allocated using this same +.IR sym_interpret , +the vector of XkbSymInterpretRec structures) are also allocated using this same function. -.I XkbSetCompatMap -copies compatibility map information from the keyboard description in -.I xkb -to the server specified in -.I display's -compatibility map for the device specified by the -.I device_spec -field of -.IR xkb . -Unless you have specifically modified this field, it is the default keyboard -device. -.I which -specifies the compatibility map components to be set, and is an inclusive OR of +.I XkbSetCompatMap +copies compatibility map information from the keyboard description in +.I xkb +to the server specified in +.I display's +compatibility map for the device specified by the +.I device_spec +field of +.IR xkb . +Unless you have specifically modified this field, it is the default keyboard +device. +.I which +specifies the compatibility map components to be set, and is an inclusive OR of the bits shown in Table 1. .TS @@ -87,41 +87,41 @@ XkbGroupCompatMask (1<<1) Group maps XkbAllCompatMask (0x3) All compatibility map components .TE -After updating its compatibility map for the specified device, if -.I update_actions -is True, the server applies the new compatibility map to its entire keyboard for -the device to generate a new set of key semantics, compatibility state, and a -new core keyboard map. If -.I update_actions -is False, the new compatibility map is not used to generate any modifications to -the current device semantics, state, or core keyboard map. One reason for not -applying the compatibility map immediately would be if one server was being -configured to match another on a piecemeal basis; the map should not be applied +After updating its compatibility map for the specified device, if +.I update_actions +is True, the server applies the new compatibility map to its entire keyboard for +the device to generate a new set of key semantics, compatibility state, and a +new core keyboard map. If +.I update_actions +is False, the new compatibility map is not used to generate any modifications to +the current device semantics, state, or core keyboard map. One reason for not +applying the compatibility map immediately would be if one server was being +configured to match another on a piecemeal basis; the map should not be applied until everything is updated. To force an update at a later time, use -.I XkbSetCompatMap -specifying -.I which -as zero and -.I update_actions -as True. -.I XkbSetCompatMap -returns True if successful and False if unsuccessful. The server may report -problems it encounters when processing the request subsequently via protocol +.I XkbSetCompatMap +specifying +.I which +as zero and +.I update_actions +as True. +.I XkbSetCompatMap +returns True if successful and False if unsuccessful. The server may report +problems it encounters when processing the request subsequently via protocol errors. .SH "RETURN VALUES" .TP 15 True -The -.I XkbSetCompatMap +The +.I XkbSetCompatMap function returns True if successful. .TP 15 False -The -.I XkbSetCompatMap +The +.I XkbSetCompatMap function returns False if unsuccessful. .SH STRUCTURES -The complete description of an Xkb keyboard is given by an XkbDescRec. The -component +The complete description of an Xkb keyboard is given by an XkbDescRec. The +component structures in the XkbDescRec represent the major Xkb components. .nf @@ -142,25 +142,25 @@ typedef struct { .fi -The -.I display -field points to an X display structure. The -.I flags -field is private to the library: modifying -.I flags -may yield unpredictable results. The -.I device_spec -field specifies the device identifier of the keyboard input device, or -XkbUseCoreKeyboard, which specifies the core keyboard device. The +The +.I display +field points to an X display structure. The +.I flags +field is private to the library: modifying +.I flags +may yield unpredictable results. The +.I device_spec +field specifies the device identifier of the keyboard input device, or +XkbUseCoreKeyboard, which specifies the core keyboard device. The .I min_key_code -and -.I max_key_code -fields specify the least and greatest keycode that can be returned by the -keyboard. +and +.I max_key_code +fields specify the least and greatest keycode that can be returned by the +keyboard. -Each structure component has a corresponding mask bit that is used in function -calls to indicate that the structure should be manipulated in some manner, such as -allocating it or freeing it. These masks and their relationships to the fields in the +Each structure component has a corresponding mask bit that is used in function +calls to indicate that the structure should be manipulated in some manner, such as +allocating it or freeing it. These masks and their relationships to the fields in the XkbDescRec are shown in Table 2. .TS @@ -183,7 +183,7 @@ XkbAllComponentsMask All Fields (0x7f) The XkbSymInterpretRec structure specifies a symbol interpretation: .EX - + typedef struct { KeySym sym; /\&* keysym of interest or NULL */ unsigned char flags; /\&* XkbSI_AutoRepeat, XkbSI_LockingKey */ @@ -192,7 +192,7 @@ The XkbSymInterpretRec structure specifies a symbol interpretation: unsigned char virtual_mod; /\&* 1 modifier to add to key virtual mod map */ XkbAnyAction act; /\&* action to bind to symbol position on key */ } XkbSymInterpretRec,*XkbSymInterpretPtr; -.EN +.EN .SH "SEE ALSO" .BR XkbAllocCompatMap (__libmansuffix__) diff --git a/man/xkb/XkbSetControls.man b/man/xkb/XkbSetControls.man index ebcb7acf..6aa1d666 100644 --- a/man/xkb/XkbSetControls.man +++ b/man/xkb/XkbSetControls.man @@ -22,7 +22,7 @@ .\" .TH XkbSetControls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSetControls \- Copies changes to the X server based on a modified ctrls +XkbSetControls \- Copies changes to the X server based on a modified ctrls structure in a local copy of the keyboard description .SH SYNOPSIS .HP @@ -44,35 +44,35 @@ mask of controls requested keyboard description for controls information .SH DESCRIPTION .LP -For each bit that is set in the -.I which -parameter, -.I XkbSetControls -sends the corresponding values from the -.I xkb->ctrls -field to the server. Valid values for -.I which +For each bit that is set in the +.I which +parameter, +.I XkbSetControls +sends the corresponding values from the +.I xkb->ctrls +field to the server. Valid values for +.I which are any combination of the masks listed in Table 1 that have "ok" in the -.I which +.I which column. -Table 1 shows the actual values for the individual mask bits used to select -controls for -modification and to enable and disable the control. Note that the same mask bit -is used to -specify general modifications to the parameters used to configure the control -(which), and to -enable and disable the control (enabled_ctrls). The anomalies in the table (no -"ok" in column) -are for controls that have no configurable attributes; and for controls that are -not boolean +Table 1 shows the actual values for the individual mask bits used to select +controls for +modification and to enable and disable the control. Note that the same mask bit +is used to +specify general modifications to the parameters used to configure the control +(which), and to +enable and disable the control (enabled_ctrls). The anomalies in the table (no +"ok" in column) +are for controls that have no configurable attributes; and for controls that are +not boolean controls and therefore cannot be enabled or disabled. .TS c s s s l l l l l l l l -l l l l. +l l l l. Table 1 Controls Mask Bits _ Mask Bit which or enabled Value @@ -96,62 +96,62 @@ XkbInternalModsMask ok (1L<<28) XkbIgnoreLockModsMask ok (1L<<29) XkbPerKeyRepeatMask ok (1L<<30) XkbControlsEnabledMask ok (1L<<31) -XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | +XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | XkbAccessXFeedbackMask) -XkbAllBooleanCtrlsMask ok (0x00001FFF) +XkbAllBooleanCtrlsMask ok (0x00001FFF) XkbAllControlsMask ok (0xF8001FFF) .TE -If -.I xkb->ctrls -is NULL, the server does not support a compatible version of Xkb, or the Xkb -extension has not been properly initialized, -.I XkbSetControls +If +.I xkb->ctrls +is NULL, the server does not support a compatible version of Xkb, or the Xkb +extension has not been properly initialized, +.I XkbSetControls returns False. Otherwise, it sends the request to the X server and returns True. -Note that changes to attributes of controls in the XkbControlsRec structure are -apparent only when the associated control is enabled, although the corresponding -values are still updated in the X server. For example, the -.I repeat_delay -and -.I repeat_interval -fields are ignored unless the RepeatKeys control is enabled (that is, the X -server's equivalent of -.I xkb->ctrls -has XkbRepeatKeyMask set in -.I enabled_ctrls). +Note that changes to attributes of controls in the XkbControlsRec structure are +apparent only when the associated control is enabled, although the corresponding +values are still updated in the X server. For example, the +.I repeat_delay +and +.I repeat_interval +fields are ignored unless the RepeatKeys control is enabled (that is, the X +server's equivalent of +.I xkb->ctrls +has XkbRepeatKeyMask set in +.I enabled_ctrls). It is permissible to modify the attributes of a control in one call to -.I XkbSetControls -and enable the control in a subsequent call. See -.I XkbChangeEnabledControls +.I XkbSetControls +and enable the control in a subsequent call. See +.I XkbChangeEnabledControls for more information on enabling and disabling controls. -Note that the -.I enabled_ctrls -field is itself a control - the EnabledControls control. As such, to set a +Note that the +.I enabled_ctrls +field is itself a control - the EnabledControls control. As such, to set a specific configuration of enabled and disabled boolean controls, you must set -.I enabled_ctrls -to the appropriate bits to enable only the controls you want and disable all -others, then specify the XkbControlsEnabledMask in a call to -.I XkbSetControls. +.I enabled_ctrls +to the appropriate bits to enable only the controls you want and disable all +others, then specify the XkbControlsEnabledMask in a call to +.I XkbSetControls. -Because this is somewhat awkward if all you want to do is enable and disable -controls, and not modify any of their attributes, a convenience function is also -provided for this purpose, +Because this is somewhat awkward if all you want to do is enable and disable +controls, and not modify any of their attributes, a convenience function is also +provided for this purpose, .I XkbChangeEnabledControls. .SH "RETURN VALUES" .TP 15 True -The -.I XkbSetControls +The +.I XkbSetControls function returns True when it sends the request to the X server. .TP 15 False -The -.I XkbSetControls -function returns False when -.I xkb->ctrls -is NULL, the server does not support a compatible version of Xkb, or the Xkb +The +.I XkbSetControls +function returns False when +.I xkb->ctrls +is NULL, the server does not support a compatible version of Xkb, or the Xkb extension has not been properly initialized. .SH DIAGNOSTICS .TP 15 @@ -159,7 +159,7 @@ extension has not been properly initialized. Unable to allocate storage .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +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 XkbChangeEnabledControls (__libmansuffix__), diff --git a/man/xkb/XkbSetDebuggingFlags.man b/man/xkb/XkbSetDebuggingFlags.man index c27952cf..e790574a 100644 --- a/man/xkb/XkbSetDebuggingFlags.man +++ b/man/xkb/XkbSetDebuggingFlags.man @@ -51,7 +51,7 @@ values for debug output flags selected by mask message to print right now .TP .I ctrls_mask -mask selecting debug controls to change +mask selecting debug controls to change .TP .I ctrls values for debug controls selected by ctrls_mask @@ -63,68 +63,68 @@ resulting state of all debug output flags resulting state of all debug controls .SH DESCRIPTION .LP -The debugging aids are intended for use primarily by Xkb implementors and are +The debugging aids are intended for use primarily by Xkb implementors and are optional in any implementation. -There are two bitmasks that may be used to control debugging. One bitmask -controls the output of debugging information, and the other controls behavior. +There are two bitmasks that may be used to control debugging. One bitmask +controls the output of debugging information, and the other controls behavior. Both bitmasks are initially all zeros. -To change the values of any of the debug controls, use +To change the values of any of the debug controls, use .I XkbSetDebuggingFlags. -.I XkbSetDebuggingFlags -modifies the debug output flags as specified by -.I mask -and -flags, -modifies the debug controls flags as specified by -.I ctrls_mask -and -ctrls, -prints the message -.I msg, -and backfills -.I ret_flags -and -.I ret_ctrls -with the resulting debug output and debug controls flags. +.I XkbSetDebuggingFlags +modifies the debug output flags as specified by +.I mask +and +flags, +modifies the debug controls flags as specified by +.I ctrls_mask +and +ctrls, +prints the message +.I msg, +and backfills +.I ret_flags +and +.I ret_ctrls +with the resulting debug output and debug controls flags. -When bits are set in the debug output masks, -.I mask -and -.I flags, -Xkb prints debug information corresponding to each bit at appropriate points -during its processing. The device to which the output is written is -implementation-dependent, but is normally the same device to which X server -error messages are directed; thus the bits that can be set in -.I mask -and -.I flags -is implementation-specific. To turn on a debug output selection, set the bit for -the output in the -.I mask -parameter and set the corresponding bit in the -.I flags -parameter. To turn off event selection for an event, set the bit for the output -in the -.I mask -parameter and do not set the corresponding bit in the -.I flags +When bits are set in the debug output masks, +.I mask +and +.I flags, +Xkb prints debug information corresponding to each bit at appropriate points +during its processing. The device to which the output is written is +implementation-dependent, but is normally the same device to which X server +error messages are directed; thus the bits that can be set in +.I mask +and +.I flags +is implementation-specific. To turn on a debug output selection, set the bit for +the output in the +.I mask +parameter and set the corresponding bit in the +.I flags +parameter. To turn off event selection for an event, set the bit for the output +in the +.I mask +parameter and do not set the corresponding bit in the +.I flags parameter. -When bits are set in the debug controls masks, -.I ctrls_mask -and -.I ctrls, -Xkb modifies its behavior according to each controls bit. -.I ctrls_mask -and -ctrls -are related in the same way that -.I mask -and -.I flags +When bits are set in the debug controls masks, +.I ctrls_mask +and +.I ctrls, +Xkb modifies its behavior according to each controls bit. +.I ctrls_mask +and +ctrls +are related in the same way that +.I mask +and +.I flags are. The valid controls bits are defined in Table 1. .TS @@ -137,31 +137,31 @@ _ XkbDF_DisableLocks (1 << 0) Disable actions that lock modifiers .TE -.I XkbSetDebuggingFlags -returns True if successful and False otherwise. The only protocol error it may -generate is BadAlloc, if for some reason it is unable to allocate storage. +.I XkbSetDebuggingFlags +returns True if successful and False otherwise. The only protocol error it may +generate is BadAlloc, if for some reason it is unable to allocate storage. -.I XkbSetDebuggingFlags -is intended for developer use and may be disabled in production X servers. If it -is disabled, -.I XkbSetDebuggingFlags +.I XkbSetDebuggingFlags +is intended for developer use and may be disabled in production X servers. If it +is disabled, +.I XkbSetDebuggingFlags has no effect and does not generate any protocol errors. -The message in -.I msg -is written immediately. The device to which it is written is implementation -dependent but is normally the same device where X server error messages are -directed. +The message in +.I msg +is written immediately. The device to which it is written is implementation +dependent but is normally the same device where X server error messages are +directed. .SH "RETURN VALUES" .TP 15 True -The -.I XkbSetDebuggingFlags +The +.I XkbSetDebuggingFlags function returns True when successful. .TP 15 False -The -.I XkbSetDebuggingFlags +The +.I XkbSetDebuggingFlags function returns False when not successful. .SH DIAGNOSTICS .TP 15 diff --git a/man/xkb/XkbSetDeviceButtonActions.man b/man/xkb/XkbSetDeviceButtonActions.man index ed6b2ccc..1ef05e29 100644 --- a/man/xkb/XkbSetDeviceButtonActions.man +++ b/man/xkb/XkbSetDeviceButtonActions.man @@ -45,35 +45,35 @@ number of first button to update, 0 relative number of buttons to update .SH DESCRIPTION .LP -.I XkbSetDeviceButtonActions -assigns actions to the buttons of the device specified in -.I device_info->device_spec. -Actions are assigned to -.I num_buttons -buttons beginning with -.I first_button -and are taken from the actions specified in +.I XkbSetDeviceButtonActions +assigns actions to the buttons of the device specified in +.I device_info->device_spec. +Actions are assigned to +.I num_buttons +buttons beginning with +.I first_button +and are taken from the actions specified in .I device_info->btn_acts. If the server does not support assignment of Xkb actions to extension device buttons, -.I XkbSetDeviceButtonActions -has no effect and returns False. If the device has no buttons or if -.I first_button -or -.I num_buttons -specify buttons outside of the valid range as determined by -.I device_info->num_btns, -the function has no effect and returns False. Otherwise, -.I XkbSetDeviceButtonActions -sends a request to the server to change the actions for the specified buttons and returns +.I XkbSetDeviceButtonActions +has no effect and returns False. If the device has no buttons or if +.I first_button +or +.I num_buttons +specify buttons outside of the valid range as determined by +.I device_info->num_btns, +the function has no effect and returns False. Otherwise, +.I XkbSetDeviceButtonActions +sends a request to the server to change the actions for the specified buttons and returns True. -If the actual request sent to the server involved illegal button numbers, a BadValue protocol -error is generated. If an invalid device identifier is specified in -.I device_info->device_spec, +If the actual request sent to the server involved illegal button numbers, a BadValue protocol +error is generated. If an invalid device identifier is specified in +.I device_info->device_spec, a BadKeyboard protocol error results. If the actual device specified in -.I device_info->device_spec -does not contain buttons and a request affecting buttons is made, a BadMatch protocol error is +.I device_info->device_spec +does not contain buttons and a request affecting buttons is made, a BadMatch protocol error is generated. .SH DIAGNOSTICS .TP 15 @@ -81,7 +81,7 @@ generated. The device specified was not a valid core or input extension device .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has correct type +A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid .TP 15 .B BadValue diff --git a/man/xkb/XkbSetDeviceInfo.man b/man/xkb/XkbSetDeviceInfo.man index 0e4b7f3d..69da87c2 100644 --- a/man/xkb/XkbSetDeviceInfo.man +++ b/man/xkb/XkbSetDeviceInfo.man @@ -22,7 +22,7 @@ .\" .TH XkbSetDeviceInfo __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSetDeviceInfo \- Modify some or all of the characteristics of an X Input +XkbSetDeviceInfo \- Modify some or all of the characteristics of an X Input Extension device .SH SYNOPSIS .HP @@ -44,55 +44,55 @@ mask indicating characteristics to modify structure defining the device and modifications .SH DESCRIPTION .LP -To change characteristics of an X Input Extension device in the server, first +To change characteristics of an X Input Extension device in the server, first modify a local copy of the device structure and then use either -.I XkbSetDeviceInfo, +.I XkbSetDeviceInfo, or, to save network traffic, use an XkbDeviceChangesRec structure and call -.I XkbChangeDeviceInfo +.I XkbChangeDeviceInfo to download the changes to the server. -.I XkbSetDeviceInfo -sends a request to the server to modify the characteristics of the device +.I XkbSetDeviceInfo +sends a request to the server to modify the characteristics of the device specified in the -.I device_info -structure. The particular characteristics modified are identified by the bits -set in -.I which -and take their values from the relevant fields in -device_info (see Table 1). XkbSetDeviceInfo returns True if the request was -successfully sent to the server. If the X server implementation does not allow -interaction between the X input extension and the Xkb Extension, the function +.I device_info +structure. The particular characteristics modified are identified by the bits +set in +.I which +and take their values from the relevant fields in +device_info (see Table 1). XkbSetDeviceInfo returns True if the request was +successfully sent to the server. If the X server implementation does not allow +interaction between the X input extension and the Xkb Extension, the function does nothing and returns False. .bp .nf Table 1 XkbDeviceInfoRec Mask Bits ____________________________________________________________________________________ Name XkbDeviceInfoRec Value Capability If Set - Fields Effected + Fields Effected ____________________________________________________________________________________ XkbXI_KeyboardsMask (1L <<0) Clients can use all Xkb requests and events - with KeyClass devices + with KeyClass devices supported by the input device extension. -XkbXI_ButtonActionsMask num_btns (1L <<1) Clients can assign key - btn_acts actions to buttons +XkbXI_ButtonActionsMask num_btns (1L <<1) Clients can assign key + btn_acts actions to buttons non-KeyClass input extension devices. - + XkbXI_IndicatorNamesMask leds->names (1L <<2) Clients can assign names to indicators on non-KeyClass input extension devices. - + XkbXI_IndicatorMapsMask leds->maps (1L <<3) Clients can assign indicator maps to - indicators on + indicators on non-KeyClass input extension devices. -XkbXI_IndicatorStateMask leds->state (1L <<4) Clients can request +XkbXI_IndicatorStateMask leds->state (1L <<4) Clients can request the status of indicators on non-KeyClass input extension devices. @@ -105,7 +105,7 @@ XkbXI_UnsupportedFeaturesMask unsupported (1L <<15) XkbXI_AllDeviceFeaturesMask Those selected (0x1e) XkbXI_IndicatorsMask | by Value Column XkbSI_ButtonActionsMask - masks + masks XkbXI_AllFeaturesMask Those selected (0x1f) XkbSI_AllDeviceFeaturesMask | by Value Column XkbSI_KeyboardsMask @@ -116,84 +116,84 @@ XkbXI_AllDetailsMask Those selected (0x801f) XkbXI_AllFeaturesMask | masks .fi -The -.I which -parameter specifies which aspects of the device should be changed and is a -bitmask composed of an inclusive OR or one or more of the following bits: -XkbXI_ButtonActionsMask, XkbXI_IndicatorNamesMask, XkbXI_IndicatorMapsMask. If -the features requested to be manipulated in -.I which -are valid for the device, but the server does not support assignment of one or +The +.I which +parameter specifies which aspects of the device should be changed and is a +bitmask composed of an inclusive OR or one or more of the following bits: +XkbXI_ButtonActionsMask, XkbXI_IndicatorNamesMask, XkbXI_IndicatorMapsMask. If +the features requested to be manipulated in +.I which +are valid for the device, but the server does not support assignment of one or more of them, that particular portion of the request is ignored. - -If the device specified in -.I device_info->device_spec -does not contain buttons and a request affecting buttons is made, or the device -does not contain indicators and a request affecting indicators is made, a + +If the device specified in +.I device_info->device_spec +does not contain buttons and a request affecting buttons is made, or the device +does not contain indicators and a request affecting indicators is made, a BadMatch protocol error results. -If the XkbXI_ButtonActionsMask bit is set in the -.I supported -mask returned by -.I XkbGetDeviceInfo, -the Xkb extension allows applications to assign key actions to buttons on input -extension devices other than the core keyboard device. If the -XkbXI_ButtonActionsMask is set in -.I which, -the actions for all buttons specified in -.I device_info -are set to the XkbActions specified in -.I device_info->btn_acts. +If the XkbXI_ButtonActionsMask bit is set in the +.I supported +mask returned by +.I XkbGetDeviceInfo, +the Xkb extension allows applications to assign key actions to buttons on input +extension devices other than the core keyboard device. If the +XkbXI_ButtonActionsMask is set in +.I which, +the actions for all buttons specified in +.I device_info +are set to the XkbActions specified in +.I device_info->btn_acts. If the number of buttons requested to be updated is not valid for the device, -.I XkbSetDeviceInfo +.I XkbSetDeviceInfo returns False and a BadValue protocol error results. -If the XkbXI_IndicatorMaps and / or XkbXI_IndicatorNamesMask bit is set in the -.I supported -mask returned by -.I XkbGetDeviceInfo, -the Xkb extension allows applications to assign maps and / or names to the -indicators of nonkeyboard extension devices. If supported, maps and / or names -can be assigned to all extension device indicators, whether they are part of a +If the XkbXI_IndicatorMaps and / or XkbXI_IndicatorNamesMask bit is set in the +.I supported +mask returned by +.I XkbGetDeviceInfo, +the Xkb extension allows applications to assign maps and / or names to the +indicators of nonkeyboard extension devices. If supported, maps and / or names +can be assigned to all extension device indicators, whether they are part of a keyboard feedback or part of an indicator feedback. - -If the XkbXI_IndicatorMapsMask and / or XkbXI_IndicatorNamesMask flag is set in -.I which, -the indicator maps and / or names for all -.I device_info->num_leds -indicator devices specified in -.I device_info->leds -are set to the maps and / or names specified in -.I device_info->leds. device_info->leds->led_class -and -.I led_id -specify the input extension class and device ID for each indicator device to -modify; if they have invalid values, a BadValue protocol error results and -.I XkbSetDeviceInfo -returns False. If they have legal values but do not specify a keyboard or -indicator class feedback for the device in question, a BadMatch error results. + +If the XkbXI_IndicatorMapsMask and / or XkbXI_IndicatorNamesMask flag is set in +.I which, +the indicator maps and / or names for all +.I device_info->num_leds +indicator devices specified in +.I device_info->leds +are set to the maps and / or names specified in +.I device_info->leds. device_info->leds->led_class +and +.I led_id +specify the input extension class and device ID for each indicator device to +modify; if they have invalid values, a BadValue protocol error results and +.I XkbSetDeviceInfo +returns False. If they have legal values but do not specify a keyboard or +indicator class feedback for the device in question, a BadMatch error results. If any of the values in -.I device_info->leds->names +.I device_info->leds->names are not a valid Atom or None, a BadAtom protocol error results. .SH "RETURN VALUES" .TP 15 True -The -.I XkbSetDeviceInfo +The +.I XkbSetDeviceInfo function returns True if the request was successfully sent to the server. .TP 15 False -The -.I XkbSetDeviceInfo -function returns False if the X server implementation does not allow interaction +The +.I XkbSetDeviceInfo +function returns False if the X server implementation does not allow interaction between the X input extension and the Xkb Extension. .SH STRUCTURES .LP -Changes to an Xkb extension device may be tracked by listening to -XkbDeviceExtensionNotify events and accumulating the changes in an -XkbDeviceChangesRec structure. The changes noted in the structure may then be -used in subsequent operations to update either a server configuration or a local -copy of an Xkb extension device configuration. The changes structure is defined +Changes to an Xkb extension device may be tracked by listening to +XkbDeviceExtensionNotify events and accumulating the changes in an +XkbDeviceChangesRec structure. The changes noted in the structure may then be +used in subsequent operations to update either a server configuration or a local +copy of an Xkb extension device configuration. The changes structure is defined as follows: .nf @@ -211,7 +211,7 @@ typedef struct _XkbDeviceChanges { A name is neither a valid Atom or None .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid .TP 15 .B BadValue diff --git a/man/xkb/XkbSetIgnoreLockMods.man b/man/xkb/XkbSetIgnoreLockMods.man index e1673629..1a7eed97 100644 --- a/man/xkb/XkbSetIgnoreLockMods.man +++ b/man/xkb/XkbSetIgnoreLockMods.man @@ -22,7 +22,7 @@ .\" .TH XkbSetIgnoreLockMods __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSetIgnoreLockMods \- Sets the modifiers that, if locked, are not to be +XkbSetIgnoreLockMods \- Sets the modifiers that, if locked, are not to be reported in matching events to passive grabs .SH SYNOPSIS .HP @@ -47,99 +47,99 @@ device ID, or XkbUseCoreKbd mask of real modifiers affected by this call .TP .I real_values -values for affected real modifiers (1=>set, 0=>unset) +values for affected real modifiers (1=>set, 0=>unset) .TP .I affect_virtual -mask of virtual modifiers affected by this call +mask of virtual modifiers affected by this call .TP .I virtual_values -values for affected virtual modifiers (1=>set, 0=>unset) +values for affected virtual modifiers (1=>set, 0=>unset) .SH DESCRIPTION .LP -The core protocol does not provide a way to exclude specific modifiers from grab -calculations, with the result that locking modifiers sometimes have +The core protocol does not provide a way to exclude specific modifiers from grab +calculations, with the result that locking modifiers sometimes have unanticipated side effects. -The IgnoreLockMods control specifies modifiers that should be excluded from grab -calculations. These modifiers are also not reported in any core events except -KeyPress and KeyRelease events that do not activate a passive grab and that do +The IgnoreLockMods control specifies modifiers that should be excluded from grab +calculations. These modifiers are also not reported in any core events except +KeyPress and KeyRelease events that do not activate a passive grab and that do not occur while a grab is active. -Manipulate the IgnoreLockMods control via the -.I ignore_lock -field in the XkbControlsRec structure, then use -.I XkbSetControls -and -.I XkbGetControls -to query and change this control. Alternatively, use +Manipulate the IgnoreLockMods control via the +.I ignore_lock +field in the XkbControlsRec structure, then use +.I XkbSetControls +and +.I XkbGetControls +to query and change this control. Alternatively, use .I XkbSetIgnoreLockMods. -.I XkbSetIgnoreLockMods +.I XkbSetIgnoreLockMods sends a request to the server to change the server's IgnoreLockMods control. -.I affect_real -and -.I real_values -are masks of real modifier bits indicating which real modifiers are to be added +.I affect_real +and +.I real_values +are masks of real modifier bits indicating which real modifiers are to be added and removed from the server's IgnoreLockMods control. Modifiers selected by both -.I affect_real -and -.I real_values -are added to the server's IgnoreLockMods control; those selected by -.I affect_real -but not by -.I real_values -are removed from the server's IgnoreLockMods control. Valid values for -.I affect_real -and -.I real_values -consist of any combination of the eight core modifier bits: ShiftMask, LockMask, -ControlMask, Mod1Mask - Mod5Mask. -.I affect_virtual -and -.I virtual_values -are masks of virtual modifier bits indicating which virtual modifiers are to be -added and removed from the server's IgnoreLockMods control. Modifiers selected -by both -.I affect_virtual -and -.I virtual_values -are added to the server's IgnoreLockMods control; those selected by -.I affect_virtual -but not by -.I virtual_values -are removed from the server's IgnoreLockMods control. See below for a discussion -of virtual modifier masks to use in -.I affect_virtual -and -.I virtual_values. XkbSetIgnoreLockMods -does not wait for a reply from the server. It returns True if the request was +.I affect_real +and +.I real_values +are added to the server's IgnoreLockMods control; those selected by +.I affect_real +but not by +.I real_values +are removed from the server's IgnoreLockMods control. Valid values for +.I affect_real +and +.I real_values +consist of any combination of the eight core modifier bits: ShiftMask, LockMask, +ControlMask, Mod1Mask - Mod5Mask. +.I affect_virtual +and +.I virtual_values +are masks of virtual modifier bits indicating which virtual modifiers are to be +added and removed from the server's IgnoreLockMods control. Modifiers selected +by both +.I affect_virtual +and +.I virtual_values +are added to the server's IgnoreLockMods control; those selected by +.I affect_virtual +but not by +.I virtual_values +are removed from the server's IgnoreLockMods control. See below for a discussion +of virtual modifier masks to use in +.I affect_virtual +and +.I virtual_values. XkbSetIgnoreLockMods +does not wait for a reply from the server. It returns True if the request was sent, and False otherwise. -Virtual modifiers are named by converting their string name to an X Atom and -storing the Atom in the -.I names.vmods -array in an XkbDescRec structure. The position of a name Atom in the -.I names.vmods -array defines the bit position used to represent the virtual modifier and also -the index used when accessing virtual modifier information in arrays: the name -in the i-th (0 relative) entry of -.I names.vmods -is the i-th virtual modifier, represented by the mask (1<vmodmap[first_vmodmap_key] .. .SH "RETURN VALUES" .TP 15 True -The -.I XkbSetMap -function returns True all components specified by -.I which -are present in the -.I xkb +The +.I XkbSetMap +function returns True all components specified by +.I which +are present in the +.I xkb parameter. .TP 15 False -The -.I XkbSetMap -function returns False if any component specified by -.I which -is not present in the -.I xkb +The +.I XkbSetMap +function returns False if any component specified by +.I which +is not present in the +.I xkb parameter. .SH STRUCTURES -Use the XkbMapChangesRec structure to identify and track partial modifications -to the mapping components +Use the XkbMapChangesRec structure to identify and track partial modifications +to the mapping components and to reduce the amount of traffic between the server and clients. .nf @@ -287,8 +287,8 @@ typedef struct _XkbMapChanges { .fi -The complete description of an Xkb keyboard is given by an XkbDescRec. The -component +The complete description of an Xkb keyboard is given by an XkbDescRec. The +component structures in the XkbDescRec represent the major Xkb components. .nf @@ -308,24 +308,24 @@ typedef struct { } XkbDescRec, *XkbDescPtr; .fi -The -.I display -field points to an X display structure. The -.I flags field is private to the library: modifying -.I flags -may yield unpredictable results. The -.I device_spec -field specifies the device identifier of the keyboard input device, or -XkbUseCoreKeyboard, which specifies the core keyboard device. The +The +.I display +field points to an X display structure. The +.I flags field is private to the library: modifying +.I flags +may yield unpredictable results. The +.I device_spec +field specifies the device identifier of the keyboard input device, or +XkbUseCoreKeyboard, which specifies the core keyboard device. The .I min_key_code -and -.I max_key_code -fields specify the least and greatest keycode that can be returned by the -keyboard. +and +.I max_key_code +fields specify the least and greatest keycode that can be returned by the +keyboard. -Each structure component has a corresponding mask bit that is used in function -calls to indicate that the structure should be manipulated in some manner, such as -allocating it or freeing it. These masks and their relationships to the fields in the +Each structure component has a corresponding mask bit that is used in function +calls to indicate that the structure should be manipulated in some manner, such as +allocating it or freeing it. These masks and their relationships to the fields in the XkbDescRec are shown in Table 3. .bp .TS @@ -351,7 +351,7 @@ XkbAllComponentsMask All Fields (0x7f) Unable to allocate storage .TP 15 .B BadLength -The length of a request is shorter or longer than that required to minimally +The length of a request is shorter or longer than that required to minimally contain the arguments .TP 15 .B BadValue diff --git a/man/xkb/XkbSetModActionVMods.man b/man/xkb/XkbSetModActionVMods.man index c130a594..d2a3ff54 100644 --- a/man/xkb/XkbSetModActionVMods.man +++ b/man/xkb/XkbSetModActionVMods.man @@ -22,7 +22,7 @@ .\" .TH XkbSetModActionVMods __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSetModActionVMods \- Sets the vmods1 and vmods2 fields of act using the vmods +XkbSetModActionVMods \- Sets the vmods1 and vmods2 fields of act using the vmods format of an Xkb modifier description .SH SYNOPSIS .HP @@ -40,18 +40,18 @@ action in which to set vmods virtual mods to set .SH DESCRIPTION .LP -.I XkbSetModActionVMods -sets the -.I vmods1 -and -.I vmods2 -fields of -.I act -using the -.I vmods -format of an Xkb modifier description. +.I XkbSetModActionVMods +sets the +.I vmods1 +and +.I vmods2 +fields of +.I act +using the +.I vmods +format of an Xkb modifier description. .SH NOTES .LP -Despite the fact that the first parameter of these two macros is of type -XkbAction, these macros may be used only with Actions of type XkbModAction and +Despite the fact that the first parameter of these two macros is of type +XkbAction, these macros may be used only with Actions of type XkbModAction and XkbISOAction. diff --git a/man/xkb/XkbSetNamedIndicator.man b/man/xkb/XkbSetNamedIndicator.man index 2bf7bd3c..622fc289 100644 --- a/man/xkb/XkbSetNamedIndicator.man +++ b/man/xkb/XkbSetNamedIndicator.man @@ -21,8 +21,8 @@ .\" .TH XkbSetNamedIndicator __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSetNamedIndicator \- Names an indicator if it is not already named; toggles -the state of the indicator; sets the indicator to a specified state and sets the +XkbSetNamedIndicator \- Names an indicator if it is not already named; toggles +the state of the indicator; sets the indicator to a specified state and sets the indicator map for the indicator .SH SYNOPSIS .HP @@ -76,19 +76,19 @@ whether a new indicator with the specified name should be created when necessary new map for the indicator .SH DESCRIPTION .LP -If a compatible version of the Xkb extension is not available in the server, +If a compatible version of the Xkb extension is not available in the server, .I XkbSetNamedDeviceIndicator -returns False. Otherwise, it sends a request to the X server to change the -indicator specified by -.I name +returns False. Otherwise, it sends a request to the X server to change the +indicator specified by +.I name and returns True. - -If -.I change_state -is True, + +If +.I change_state +is True, .I XkbSetNamedDeviceIndicator -tells the server to change the state of the named indicator to the value -specified by +tells the server to change the state of the named indicator to the value +specified by .IR state . If .I change_state @@ -96,23 +96,23 @@ is False, then .I state is not used. -If an indicator with the name specified by -.I name -does not already exist, the -.I create_new -parameter tells the server whether it should create a new named indicator. If -.I create_new -is True, the server finds the first indicator that doesn't have a name and gives -it the name specified by +If an indicator with the name specified by +.I name +does not already exist, the +.I create_new +parameter tells the server whether it should create a new named indicator. If +.I create_new +is True, the server finds the first indicator that doesn't have a name and gives +it the name specified by .IR name . -If the optional parameter, +If the optional parameter, .IR map , is not NULL, .I XkbSetNamedDeviceIndicator -tells the server to change the indicator's map to the values specified in +tells the server to change the indicator's map to the values specified in .IR map . -In addition, it can also generate XkbIndicatorStateNotify, +In addition, it can also generate XkbIndicatorStateNotify, XkbIndicatorMapNotify, and XkbNamesNotify events. .LP .I XkbSetNamedIndicator @@ -135,12 +135,12 @@ It returns the return value from .SH "RETURN VALUES" .TP 15 True -The +The .IR XkbSetNamedIndicator " and " XkbSetNamedDeviceIndicator functions return True if a compatible version of the Xkb extension is available in the server. .TP 15 False -The +The .IR XkbSetNamedIndicator " and " XkbSetNamedDeviceIndicator functions return False if a compatible version of the Xkb extension is not available in the server. .SH DIAGNOSTICS diff --git a/man/xkb/XkbSetNames.man b/man/xkb/XkbSetNames.man index 6295e439..b5b02e83 100644 --- a/man/xkb/XkbSetNames.man +++ b/man/xkb/XkbSetNames.man @@ -51,51 +51,51 @@ number of types for which names are to be changed keyboard description from which names are to be taken .SH DESCRIPTION .LP -To change the symbolic names in the server, first modify a local copy of the -keyboard description and then -use either -.I XkbSetNames, +To change the symbolic names in the server, first modify a local copy of the +keyboard description and then +use either +.I XkbSetNames, or, to save network traffic, use a XkbNameChangesRecstructure and call -.I XkbChangeNames -to download the changes to the server. -.I XkbSetNames -and -.I XkbChangeNames -can generate BadAlloc, BadAtom, BadLength, BadMatch, and BadImplementation +.I XkbChangeNames +to download the changes to the server. +.I XkbSetNames +and +.I XkbChangeNames +can generate BadAlloc, BadAtom, BadLength, BadMatch, and BadImplementation errors. -Use -.I XkbSetNames -to change many names at the same time. For each bit set in -.I which, XkbSetNames -takes the corresponding value (or values in the case of arrays) from the -keyboard description -.I xkb +Use +.I XkbSetNames +to change many names at the same time. For each bit set in +.I which, XkbSetNames +takes the corresponding value (or values in the case of arrays) from the +keyboard description +.I xkb and sends it to the server. -The -.I first_type -and -.I num_types +The +.I first_type +and +.I num_types arguments are used only if XkbKeyTypeNamesMask or XkbKTLevelNamesMask is set in -.I which -and specify a subset of the types for which the corresponding names are to be -changed. If either or both of -these mask bits are set but the specified types are illegal, -.I XkbSetNames -returns False and does not update any of the names specified in -.I which. -The specified types are illegal if -.I xkb -does not include a map component or if -.I first_type -and -.I num_types +.I which +and specify a subset of the types for which the corresponding names are to be +changed. If either or both of +these mask bits are set but the specified types are illegal, +.I XkbSetNames +returns False and does not update any of the names specified in +.I which. +The specified types are illegal if +.I xkb +does not include a map component or if +.I first_type +and +.I num_types specify types that are not defined in the keyboard description. .SH STRUCTURES .LP -The XkbNameChangesRec allows applications to identify small modifications to the -symbolic names and +The XkbNameChangesRec allows applications to identify small modifications to the +symbolic names and effectively reduces the amount of traffic sent to the server: .nf @@ -113,20 +113,20 @@ effectively reduces the amount of traffic sent to the server: unsigned long changed_indicators; /\&* mask of indicators for which names were changed */ unsigned char changed_groups; /\&* mask of groups for which names were changed */ } XkbNameChangesRec, *XkbNameChangesPtr - -.fi -The -.I changed -field specifies the name components that have changed and is the bitwise -inclusive OR of the valid names -mask bits defined in Table 1. The rest of the fields in the structure specify -the ranges that have changed + +.fi +The +.I changed +field specifies the name components that have changed and is the bitwise +inclusive OR of the valid names +mask bits defined in Table 1. The rest of the fields in the structure specify +the ranges that have changed for the various kinds of symbolic names, as shown in Table 2. -Xkb provides several functions that work with symbolic names. Each of these -functions uses a mask to -specify individual fields of the structures described above. These masks and -their relationships to the +Xkb provides several functions that work with symbolic names. Each of these +functions uses a mask to +specify individual fields of the structures described above. These masks and +their relationships to the fields in a keyboard description are shown in Table 1. .TS @@ -191,11 +191,11 @@ A name is neither a valid Atom or None Invalid reply from server .TP 15 .B BadLength -The length of a request is shorter or longer than that required to minimally +The length of a request is shorter or longer than that required to minimally contain the arguments .TP 15 .B BadMatch -A compatible version of Xkb was not available in the server or an argument has +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 XkbChangeNames (__libmansuffix__) diff --git a/man/xkb/XkbSetPtrActionX.man b/man/xkb/XkbSetPtrActionX.man index 60896bf5..452243fd 100644 --- a/man/xkb/XkbSetPtrActionX.man +++ b/man/xkb/XkbSetPtrActionX.man @@ -22,7 +22,7 @@ .\" .TH XkbSetPtrActionX __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSetPtrActionX \- Sets the high_XXX and low_XXX fields of act from the signed +XkbSetPtrActionX \- Sets the high_XXX and low_XXX fields of act from the signed integer value x .SH SYNOPSIS .HP @@ -40,24 +40,24 @@ action in which to set X new value to set .SH DESCRIPTION .LP -Actions associated with the XkbPtrAction structure move the pointer when keys +Actions associated with the XkbPtrAction structure move the pointer when keys are pressed and released. -If the MouseKeys control is not enabled, KeyPress and KeyRelease events are +If the MouseKeys control is not enabled, KeyPress and KeyRelease events are treated as though the action is XkbSA_NoAction. -If the MouseKeys control is enabled, a server action of type XkbSA_MovePtr -instructs the server to generate core pointer MotionNotify events rather than -the usual KeyPress event, and the corresponding KeyRelease event disables any -mouse keys timers that were created as a result of handling the XkbSA_MovePtr +If the MouseKeys control is enabled, a server action of type XkbSA_MovePtr +instructs the server to generate core pointer MotionNotify events rather than +the usual KeyPress event, and the corresponding KeyRelease event disables any +mouse keys timers that were created as a result of handling the XkbSA_MovePtr action. -The -.I type +The +.I type field of the XkbPtrAction structure is always XkbSA_MovePtr. -The -.I flags +The +.I flags field is a bitwise inclusive OR of the masks shown in Table 1. .TS @@ -69,28 +69,28 @@ _ Action Type Meaning _ XkbSA_NoAcceleration T{ -If not set, and the MouseKeysAccel control is enabled, the KeyPress initiates a +If not set, and the MouseKeysAccel control is enabled, the KeyPress initiates a mouse keys timer for this key; every time the timer expires, the cursor moves. T} XkbSA_MoveAbsoluteX T{ -If set, the X portion of the structure specifies the new pointer X coordinate. -Otherwise, the X portion is added to the current pointer X coordinate to +If set, the X portion of the structure specifies the new pointer X coordinate. +Otherwise, the X portion is added to the current pointer X coordinate to determine the new pointer X coordinate. T} XkbSA_MoveAbsoluteY T{ -If set, the Y portion of the structure specifies the new pointer Y coordinate. -Otherwise, the Y portion is added to the current pointer Y coordinate to +If set, the Y portion of the structure specifies the new pointer Y coordinate. +Otherwise, the Y portion is added to the current pointer Y coordinate to determine the new pointer Y coordinate. T} .TE Each of the X and Y coordinates of the XkbPtrAction structure is composed of -two signed 16-bit values, that is, the X coordinate is composed of -.I high_XXX -and -.I low_XXX, -and similarly for the Y coordinate. Xkb provides the following macros, to -convert between a signed integer and two signed 16-bit values in XkbPtrAction +two signed 16-bit values, that is, the X coordinate is composed of +.I high_XXX +and +.I low_XXX, +and similarly for the Y coordinate. Xkb provides the following macros, to +convert between a signed integer and two signed 16-bit values in XkbPtrAction structures. .SH STRUCTURES .LP @@ -105,4 +105,4 @@ structures. unsigned char low_YYY; /\&* y coordinate, low bits */ } XkbPtrAction; -.fi +.fi diff --git a/man/xkb/XkbSetPtrActionY.man b/man/xkb/XkbSetPtrActionY.man index acbf0231..96e0b80b 100644 --- a/man/xkb/XkbSetPtrActionY.man +++ b/man/xkb/XkbSetPtrActionY.man @@ -22,7 +22,7 @@ .\" .TH XkbSetPtrActionY __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSetPtrActionY \- Sets the high_YYY and low_YYY fields of act from the signed +XkbSetPtrActionY \- Sets the high_YYY and low_YYY fields of act from the signed integer value y .SH SYNOPSIS .HP @@ -40,24 +40,24 @@ action in which to set Y new value to set .SH DESCRIPTION .LP -Actions associated with the XkbPtrAction structure move the pointer when keys +Actions associated with the XkbPtrAction structure move the pointer when keys are pressed and released. -If the MouseKeys control is not enabled, KeyPress and KeyRelease events are +If the MouseKeys control is not enabled, KeyPress and KeyRelease events are treated as though the action is XkbSA_NoAction. -If the MouseKeys control is enabled, a server action of type XkbSA_MovePtr -instructs the server to generate core pointer MotionNotify events rather than -the usual KeyPress event, and the corresponding KeyRelease event disables any -mouse keys timers that were created as a result of handling the XkbSA_MovePtr +If the MouseKeys control is enabled, a server action of type XkbSA_MovePtr +instructs the server to generate core pointer MotionNotify events rather than +the usual KeyPress event, and the corresponding KeyRelease event disables any +mouse keys timers that were created as a result of handling the XkbSA_MovePtr action. -The -.I type +The +.I type field of the XkbPtrAction structure is always XkbSA_MovePtr. -The -.I flags +The +.I flags field is a bitwise inclusive OR of the masks shown in Table 1. .TS @@ -69,28 +69,28 @@ _ Action Type Meaning _ XkbSA_NoAcceleration T{ -If not set, and the MouseKeysAccel control is enabled, the KeyPress initiates a +If not set, and the MouseKeysAccel control is enabled, the KeyPress initiates a mouse keys timer for this key; every time the timer expires, the cursor moves. T} XkbSA_MoveAbsoluteX T{ -If set, the X portion of the structure specifies the new pointer X coordinate. -Otherwise, the X portion is added to the current pointer X coordinate to +If set, the X portion of the structure specifies the new pointer X coordinate. +Otherwise, the X portion is added to the current pointer X coordinate to determine the new pointer X coordinate. T} XkbSA_MoveAbsoluteY T{ -If set, the Y portion of the structure specifies the new pointer Y coordinate. -Otherwise, the Y portion is added to the current pointer Y coordinate to +If set, the Y portion of the structure specifies the new pointer Y coordinate. +Otherwise, the Y portion is added to the current pointer Y coordinate to determine the new pointer Y coordinate. T} .TE Each of the X and Y coordinates of the XkbPtrAction structure is composed of -two signed 16-bit values, that is, the X coordinate is composed of -.I high_XXX -and -.I low_XXX, -and similarly for the Y coordinate. Xkb provides the following macros, to -convert between a signed integer and two signed 16-bit values in XkbPtrAction +two signed 16-bit values, that is, the X coordinate is composed of +.I high_XXX +and +.I low_XXX, +and similarly for the Y coordinate. Xkb provides the following macros, to +convert between a signed integer and two signed 16-bit values in XkbPtrAction structures. .SH STRUCTURES .LP @@ -105,4 +105,4 @@ structures. unsigned char low_YYY; /\&* y coordinate, low bits */ } XkbPtrAction; -.fi +.fi diff --git a/man/xkb/XkbSetServerInternalMods.man b/man/xkb/XkbSetServerInternalMods.man index ac8be546..16d001fa 100644 --- a/man/xkb/XkbSetServerInternalMods.man +++ b/man/xkb/XkbSetServerInternalMods.man @@ -22,7 +22,7 @@ .\" .TH XkbSetServerInternalMods __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSetServerInternalMods \- Sets the modifiers that are consumed by the server +XkbSetServerInternalMods \- Sets the modifiers that are consumed by the server before events are delivered to the client .SH SYNOPSIS .HP @@ -47,103 +47,103 @@ device ID, or XkbUseCoreKbd mask of real modifiers affected by this call .TP .I real_values -values for affected real modifiers (1=>set, 0=>unset) +values for affected real modifiers (1=>set, 0=>unset) .TP .I affect_virtual -mask of virtual modifiers affected by this call +mask of virtual modifiers affected by this call .TP .I virtual_values -values for affected virtual modifiers (1=>set, 0=>unset) +values for affected virtual modifiers (1=>set, 0=>unset) .SH DESCRIPTION .LP -The core protocol does not provide any means to prevent a modifier from being -reported in events sent to clients; Xkb, however makes this possible via the -InternalMods control. It specifies modifiers that should be consumed by the -server and not reported to clients. When a key is pressed and a modifier that -has its bit set in the InternalMods control is reported to the server, the -server uses the modifier when determining the actions to apply for the key. The -server then clears the bit, so it is not actually reported to the client. In -addition, modifiers specified in the InternalMods control are not used to +The core protocol does not provide any means to prevent a modifier from being +reported in events sent to clients; Xkb, however makes this possible via the +InternalMods control. It specifies modifiers that should be consumed by the +server and not reported to clients. When a key is pressed and a modifier that +has its bit set in the InternalMods control is reported to the server, the +server uses the modifier when determining the actions to apply for the key. The +server then clears the bit, so it is not actually reported to the client. In +addition, modifiers specified in the InternalMods control are not used to determine grabs and are not used to calculate core protocol compatibility state. -Manipulate the InternalMods control via the -.I internal -field in the XkbControlsRec structure, using -.I XkbSetControls -and -.I XkbGetControls. -Alternatively, use +Manipulate the InternalMods control via the +.I internal +field in the XkbControlsRec structure, using +.I XkbSetControls +and +.I XkbGetControls. +Alternatively, use .I XkbSetServerInternalMods. -.I XkbSetServerInternalMods -sends a request to the server to change the internal modifiers consumed by the -server. -.I affect_real -and -.I real_values -are masks of real modifier bits indicating which real modifiers are to be added -and removed from the server's internal modifiers control. Modifiers selected by -both -.I affect_real -and -.I real_values +.I XkbSetServerInternalMods +sends a request to the server to change the internal modifiers consumed by the +server. +.I affect_real +and +.I real_values +are masks of real modifier bits indicating which real modifiers are to be added +and removed from the server's internal modifiers control. Modifiers selected by +both +.I affect_real +and +.I real_values are added to the server's internal modifiers control; those selected by -.I affect_real -but not by -.I real_values +.I affect_real +but not by +.I real_values are removed from the server's internal modifiers mask. Valid values for -.I affect_real -and -.I real_values -consist of any combination of the eight core modifier bits: ShiftMask, LockMask, -ControlMask, Mod1Mask - Mod5Mask. -.I affect_virtual -and -.I virtual_values -are masks of virtual modifier bits indicating which virtual modifiers are to be -added and removed from the server's internal modifiers control. Modifiers -selected by both -.I affect_virtual -and -.I virtual_values +.I affect_real +and +.I real_values +consist of any combination of the eight core modifier bits: ShiftMask, LockMask, +ControlMask, Mod1Mask - Mod5Mask. +.I affect_virtual +and +.I virtual_values +are masks of virtual modifier bits indicating which virtual modifiers are to be +added and removed from the server's internal modifiers control. Modifiers +selected by both +.I affect_virtual +and +.I virtual_values are added to the server's internal modifiers control; those selected by -.I affect_virtual -but not by -.I virtual_values -are removed from the server's internal modifiers control. See below for a -discussion of virtual modifier masks to use in -.I affect_virtual -and -.I virtual_values. XkbSetServerInternalMods -does not wait for a reply from the server. It returns True if the request was +.I affect_virtual +but not by +.I virtual_values +are removed from the server's internal modifiers control. See below for a +discussion of virtual modifier masks to use in +.I affect_virtual +and +.I virtual_values. XkbSetServerInternalMods +does not wait for a reply from the server. It returns True if the request was sent and False otherwise. -Virtual modifiers are named by converting their string name to an X Atom and -storing the Atom in the -.I names.vmods -array in an XkbDescRec structure. The position of a name Atom in the -.I names.vmods -array defines the bit position used to represent the virtual modifier and also -the index used when accessing virtual modifier information in arrays: the name -in the i-th (0 relative) entry of -.I names.vmods -is the i-th virtual modifier, represented by the mask (1<