diff options
| author | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2024-07-10 07:13:50 +0000 |
|---|---|---|
| committer | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2024-07-10 07:13:50 +0000 |
| commit | 2751d9056236ad40c0e2bd2572600ce9a311f2d8 (patch) | |
| tree | 0403dd78495298db0ba82047ca08109e78b7cf30 /lib/libX11 | |
| parent | dc1de40297a7e4505b42ed3bf4a13008d3a94c2e (diff) | |
Update to libX11 1.8.9 part 1 : documentation updates
Diffstat (limited to 'lib/libX11')
227 files changed, 937 insertions, 3809 deletions
diff --git a/lib/libX11/man/Compose.man b/lib/libX11/man/Compose.man index aba221ac7..4adea990d 100644 --- a/lib/libX11/man/Compose.man +++ b/lib/libX11/man/Compose.man @@ -1,4 +1,4 @@ -.\" Copyright 2009 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 2009, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/XAddHost.man b/lib/libX11/man/XAddHost.man index bb75aa2d5..d71b9c072 100644 --- a/lib/libX11/man/XAddHost.man +++ b/lib/libX11/man/XAddHost.man @@ -29,7 +29,7 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.\" Copyright 2004 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 2004, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/XGetVisualInfo.man b/lib/libX11/man/XGetVisualInfo.man index 5f1342ca3..e54529a4a 100644 --- a/lib/libX11/man/XGetVisualInfo.man +++ b/lib/libX11/man/XGetVisualInfo.man @@ -115,7 +115,7 @@ structure contains: .LP /\&* Visual information mask bits */ .TS -lw(.5i) lw(2.5i) lw(.8i). +lw(10) lw(2.5i) lw(.8i). T{ \&#define T} T{ diff --git a/lib/libX11/man/XInitThreads.man b/lib/libX11/man/XInitThreads.man index 4ae952287..b629bd28d 100644 --- a/lib/libX11/man/XInitThreads.man +++ b/lib/libX11/man/XInitThreads.man @@ -52,6 +52,8 @@ XInitThreads, XLockDisplay, XUnlockDisplay \- multi-threading support .HP Status XInitThreads\^(void); .HP +Status XFreeThreads\^(void); +.HP void XLockDisplay\^(\^Display *\fIdisplay\fP\^); .HP void XUnlockDisplay\^(\^Display *\fIdisplay\fP\^); @@ -76,7 +78,11 @@ are protected by some other access mechanism (for example, a mutual exclusion lock in a toolkit or through explicit client programming), Xlib thread initialization is not required. It is recommended that single-threaded programs not call this function. - +.LP +The +.B XFreeThreads +function frees the memory allocated by +.BR XInitThreads . .LP The .B XLockDisplay diff --git a/lib/libX11/man/XOpenIM.man b/lib/libX11/man/XOpenIM.man index cfc978819..e5dd25be9 100644 --- a/lib/libX11/man/XOpenIM.man +++ b/lib/libX11/man/XOpenIM.man @@ -139,7 +139,8 @@ returns NULL if no input method could be opened. .LP The .B XCloseIM -function closes the specified input method. +function closes the specified input method and frees the memory pointed +to by the im argument. .LP The .B XSetIMValues diff --git a/lib/libX11/man/XSetScreenSaver.man b/lib/libX11/man/XSetScreenSaver.man index 46626a46c..4b88fb752 100644 --- a/lib/libX11/man/XSetScreenSaver.man +++ b/lib/libX11/man/XSetScreenSaver.man @@ -116,3 +116,81 @@ Other negative values generate a error. If the timeout value is nonzero, .B XSetScreenSaver +enables the screen saver. +An interval of 0 disables the random-pattern motion. +Both values are limited to a 16-bit signed integer range by the wire protocol, +despite the C prototype. +If no input from devices (keyboard, mouse, and so on) is generated +for the specified number of timeout seconds once the screen saver is enabled, +the screen saver is activated. +.LP +For each screen, +if blanking is preferred and the hardware supports video blanking, +the screen simply goes blank. +Otherwise, if either exposures are allowed or the screen can be regenerated +without sending +.B Expose +events to clients, +the screen is tiled with the root window background tile randomly +re-origined each interval seconds. +Otherwise, the screens' states do not change, +and the screen saver is not activated. +The screen saver is deactivated, +and all screen states are restored at the next +keyboard or pointer input or at the next call to +.B XForceScreenSaver +with mode +.BR ScreenSaverReset . +.LP +If the server-dependent screen saver method supports periodic change, +the interval argument serves as a hint about how long the change period +should be, and zero hints that no periodic change should be made. +Examples of ways to change the screen include scrambling the colormap +periodically, moving an icon image around the screen periodically, or tiling +the screen with the root window background tile, randomly re-origined +periodically. +.LP +.B XSetScreenSaver +can generate a +.B BadValue +error. +.LP +If the specified mode is +.B ScreenSaverActive +and the screen saver currently is deactivated, +.B XForceScreenSaver +activates the screen saver even if the screen saver had been disabled +with a timeout of zero. +If the specified mode is +.B ScreenSaverReset +and the screen saver currently is enabled, +.B XForceScreenSaver +deactivates the screen saver if it was activated, +and the activation timer is reset to its initial state +(as if device input had been received). +.LP +.B XForceScreenSaver +can generate a +.B BadValue +error. +.LP +The +.B XActivateScreenSaver +function activates the screen saver. +.LP +The +.B XResetScreenSaver +function resets the screen saver. +.LP +The +.B XGetScreenSaver +function gets the current screen saver values. +.SH DIAGNOSTICS +.TP 1i +.B BadValue +Some numeric value falls outside the range of values accepted by the request. +Unless a specific range is specified for an argument, the full range defined +by the argument's type is accepted. Any argument defined as a set of +alternatives can generate this error. +.SH "SEE ALSO" +\fI\*(xL\fP diff --git a/lib/libX11/man/xkb/Makefile.am b/lib/libX11/man/xkb/Makefile.am index 1f4e37075..411f03b5c 100644 --- a/lib/libX11/man/xkb/Makefile.am +++ b/lib/libX11/man/xkb/Makefile.am @@ -20,7 +20,6 @@ libman_PRE = \ XkbAllocCompatMap.man \ XkbAllocControls.man \ XkbAllocDeviceInfo.man \ - XkbAllocDeviceLedInfo.man \ XkbAllocGeomColors.man \ XkbAllocGeomDoodads.man \ XkbAllocGeomKeyAliases.man \ @@ -46,7 +45,6 @@ libman_PRE = \ XkbChangeControls.man \ XkbChangeDeviceInfo.man \ XkbChangeEnabledControls.man \ - XkbChangeIndicators.man \ XkbChangeMap.man \ XkbChangeNames.man \ XkbChangeTypesOfKey.man \ @@ -84,10 +82,8 @@ libman_PRE = \ XkbFreeKeyboard.man \ XkbFreeNames.man \ XkbFreeServerMap.man \ - XkbGetAccessXTimeout.man \ XkbGetAutoRepeatRate.man \ XkbGetAutoResetControls.man \ - XkbGetBounceKeysDelay.man \ XkbGetCompatMap.man \ XkbGetControls.man \ XkbGetControlsChanges.man \ @@ -97,7 +93,6 @@ libman_PRE = \ XkbGetDeviceInfoChanges.man \ XkbGetDeviceLedInfo.man \ XkbGetGeometry.man \ - XkbGetIndicatorChanges.man \ XkbGetIndicatorMap.man \ XkbGetIndicatorState.man \ XkbGetKeyActions.man \ @@ -110,14 +105,11 @@ libman_PRE = \ XkbGetKeyboard.man \ XkbGetKeyboardByName.man \ XkbGetMap.man \ - XkbGetNameChanges.man \ XkbGetNamedDeviceIndicator.man \ XkbGetNamedGeometry.man \ XkbGetNamedIndicator.man \ XkbGetNames.man \ - XkbGetSlowKeysDelay.man \ XkbGetState.man \ - XkbGetStickyKeysOptions.man \ XkbGetUpdatedMap.man \ XkbGetVirtualMods.man \ XkbGetXlibControls.man \ @@ -130,14 +122,13 @@ libman_PRE = \ XkbKeyGroupWidth.man \ XkbKeyGroupsWidth.man \ XkbKeyHasActions.man \ + XkbKeyKeyType.man \ + XkbKeyKeyTypeIndex.man \ XkbKeyNumActions.man \ XkbKeyNumGroups.man \ XkbKeyNumSyms.man \ XkbKeySymEntry.man \ - XkbKeySymsOffset.man \ XkbKeySymsPtr.man \ - XkbKeyType.man \ - XkbKeyTypeIndex.man \ XkbKeyTypesForCoreSymbols.man \ XkbKeycodeToKeysym.man \ XkbKeysymToModifiers.man \ @@ -152,7 +143,6 @@ libman_PRE = \ XkbModActionVMods.man \ XkbNoteControlsChanges.man \ XkbNoteDeviceChanges.man \ - XkbNoteIndicatorChanges.man \ XkbNoteNameChanges.man \ XkbOpenDisplay.man \ XkbOutOfRangeGroupInfo.man \ @@ -165,7 +155,7 @@ libman_PRE = \ XkbResizeKeyActions.man \ XkbResizeKeySyms.man \ XkbResizeKeyType.man \ - XkbSAActionSetCtrls.man \ + XkbActionSetCtrls.man \ XkbSAGroup.man \ XkbSAPtrDfltValue.man \ XkbSARedirectSetVMods.man \ @@ -178,10 +168,8 @@ libman_PRE = \ XkbSASetScreen.man \ XkbSelectEventDetails.man \ XkbSelectEvents.man \ - XkbSetAccessXTimeout.man \ XkbSetAutoRepeatRate.man \ XkbSetAutoResetControls.man \ - XkbSetBounceKeysDelay.man \ XkbSetCompatMap.man \ XkbSetControls.man \ XkbSetDebuggingFlags.man \ diff --git a/lib/libX11/man/xkb/Makefile.in b/lib/libX11/man/xkb/Makefile.in index 54bc6eb5a..1ea0a6f2e 100644 --- a/lib/libX11/man/xkb/Makefile.in +++ b/lib/libX11/man/xkb/Makefile.in @@ -217,6 +217,7 @@ STRICT_CFLAGS = @STRICT_CFLAGS@ STRIP = @STRIP@ STYLESHEET_SRCDIR = @STYLESHEET_SRCDIR@ TRADITIONALCPPFLAGS = @TRADITIONALCPPFLAGS@ +USE_THREAD_LIBS = @USE_THREAD_LIBS@ VERSION = @VERSION@ WCHAR32 = @WCHAR32@ X11_CFLAGS = @X11_CFLAGS@ @@ -317,7 +318,6 @@ libman_PRE = \ XkbAllocCompatMap.man \ XkbAllocControls.man \ XkbAllocDeviceInfo.man \ - XkbAllocDeviceLedInfo.man \ XkbAllocGeomColors.man \ XkbAllocGeomDoodads.man \ XkbAllocGeomKeyAliases.man \ @@ -343,7 +343,6 @@ libman_PRE = \ XkbChangeControls.man \ XkbChangeDeviceInfo.man \ XkbChangeEnabledControls.man \ - XkbChangeIndicators.man \ XkbChangeMap.man \ XkbChangeNames.man \ XkbChangeTypesOfKey.man \ @@ -381,10 +380,8 @@ libman_PRE = \ XkbFreeKeyboard.man \ XkbFreeNames.man \ XkbFreeServerMap.man \ - XkbGetAccessXTimeout.man \ XkbGetAutoRepeatRate.man \ XkbGetAutoResetControls.man \ - XkbGetBounceKeysDelay.man \ XkbGetCompatMap.man \ XkbGetControls.man \ XkbGetControlsChanges.man \ @@ -394,7 +391,6 @@ libman_PRE = \ XkbGetDeviceInfoChanges.man \ XkbGetDeviceLedInfo.man \ XkbGetGeometry.man \ - XkbGetIndicatorChanges.man \ XkbGetIndicatorMap.man \ XkbGetIndicatorState.man \ XkbGetKeyActions.man \ @@ -407,14 +403,11 @@ libman_PRE = \ XkbGetKeyboard.man \ XkbGetKeyboardByName.man \ XkbGetMap.man \ - XkbGetNameChanges.man \ XkbGetNamedDeviceIndicator.man \ XkbGetNamedGeometry.man \ XkbGetNamedIndicator.man \ XkbGetNames.man \ - XkbGetSlowKeysDelay.man \ XkbGetState.man \ - XkbGetStickyKeysOptions.man \ XkbGetUpdatedMap.man \ XkbGetVirtualMods.man \ XkbGetXlibControls.man \ @@ -427,14 +420,13 @@ libman_PRE = \ XkbKeyGroupWidth.man \ XkbKeyGroupsWidth.man \ XkbKeyHasActions.man \ + XkbKeyKeyType.man \ + XkbKeyKeyTypeIndex.man \ XkbKeyNumActions.man \ XkbKeyNumGroups.man \ XkbKeyNumSyms.man \ XkbKeySymEntry.man \ - XkbKeySymsOffset.man \ XkbKeySymsPtr.man \ - XkbKeyType.man \ - XkbKeyTypeIndex.man \ XkbKeyTypesForCoreSymbols.man \ XkbKeycodeToKeysym.man \ XkbKeysymToModifiers.man \ @@ -449,7 +441,6 @@ libman_PRE = \ XkbModActionVMods.man \ XkbNoteControlsChanges.man \ XkbNoteDeviceChanges.man \ - XkbNoteIndicatorChanges.man \ XkbNoteNameChanges.man \ XkbOpenDisplay.man \ XkbOutOfRangeGroupInfo.man \ @@ -462,7 +453,7 @@ libman_PRE = \ XkbResizeKeyActions.man \ XkbResizeKeySyms.man \ XkbResizeKeyType.man \ - XkbSAActionSetCtrls.man \ + XkbActionSetCtrls.man \ XkbSAGroup.man \ XkbSAPtrDfltValue.man \ XkbSARedirectSetVMods.man \ @@ -475,10 +466,8 @@ libman_PRE = \ XkbSASetScreen.man \ XkbSelectEventDetails.man \ XkbSelectEvents.man \ - XkbSetAccessXTimeout.man \ XkbSetAutoRepeatRate.man \ XkbSetAutoResetControls.man \ - XkbSetBounceKeysDelay.man \ XkbSetCompatMap.man \ XkbSetControls.man \ XkbSetDebuggingFlags.man \ diff --git a/lib/libX11/man/xkb/XkbActionCtrls.man b/lib/libX11/man/xkb/XkbActionCtrls.man index e1e4173c8..b747103d9 100644 --- a/lib/libX11/man/xkb/XkbActionCtrls.man +++ b/lib/libX11/man/xkb/XkbActionCtrls.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,7 +31,7 @@ XkbActionCtrls \- Returns the ctrls fields of act converted to an unsigned int .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action from which to extract controls .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSAActionSetCtrls.man b/lib/libX11/man/xkb/XkbActionSetCtrls.man index f8a0ce652..67b20231a 100644 --- a/lib/libX11/man/xkb/XkbSAActionSetCtrls.man +++ b/lib/libX11/man/xkb/XkbActionSetCtrls.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -20,9 +20,9 @@ .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER .\" DEALINGS IN THE SOFTWARE. .\" -.TH XkbSAActionSetCtrls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.TH XkbActionSetCtrls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbSAActionSetCtrls \- Sets the +XkbActionSetCtrls \- Sets the .I ctrls0 through .I ctrls3 @@ -32,17 +32,17 @@ from .I ctrls .SH SYNOPSIS .HP -.B void XkbSAActionSetCtrls +.B void XkbActionSetCtrls .BI "(\^XkbCtrlsAction " "act" "\^," .BI "unsigned int " "ctrls" "\^);" .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action in which to set ctrls0-ctrls3 .TP -.I \- ctrls +.I ctrls value to set in ctrls0-ctrls3 .SH DESCRIPTION .LP @@ -121,7 +121,7 @@ fields represent the boolean controls in the .I enabled_ctrls field of the controls structure. Xkb macros, to convert between the two formats. -.I XkbSAActionSetCtrls +.I XkbActionSetCtrls sets the .I ctrls0 through diff --git a/lib/libX11/man/xkb/XkbAddDeviceLedInfo.man b/lib/libX11/man/xkb/XkbAddDeviceLedInfo.man index 3a612e264..426e8581d 100644 --- a/lib/libX11/man/xkb/XkbAddDeviceLedInfo.man +++ b/lib/libX11/man/xkb/XkbAddDeviceLedInfo.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbAddDeviceLedInfo \- Initialize an XkbDeviceLedInfoRec structure .if t .ti +.5i .SH ARGUMENTS .TP -.I \- device_info +.I device_info structure in which to add LED info .TP -.I \- led_class +.I led_class input extension class for LED device of interest .TP -.I \- led_id +.I led_id input extension ID for LED device of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddGeomColor.man b/lib/libX11/man/xkb/XkbAddGeomColor.man index 6ebe22c3a..d8f667a32 100644 --- a/lib/libX11/man/xkb/XkbAddGeomColor.man +++ b/lib/libX11/man/xkb/XkbAddGeomColor.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry to be updated .TP -.I \- spec +.I spec color to be added .TP -.I \- pixel +.I pixel color to be added .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddGeomDoodad.man b/lib/libX11/man/xkb/XkbAddGeomDoodad.man index b6519fddc..a90483aa8 100644 --- a/lib/libX11/man/xkb/XkbAddGeomDoodad.man +++ b/lib/libX11/man/xkb/XkbAddGeomDoodad.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ top-level geometry .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry to which the doodad is added .TP -.I \- section +.I section section, if any, to which the doodad is added .TP -.I \- name +.I name name of the new doodad .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddGeomKey.man b/lib/libX11/man/xkb/XkbAddGeomKey.man index 2132224dd..8c6e60667 100644 --- a/lib/libX11/man/xkb/XkbAddGeomKey.man +++ b/lib/libX11/man/xkb/XkbAddGeomKey.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -30,7 +30,7 @@ XkbAddGeomKey \- Add one key at the end of an existing row of keys .if t .ti +.5i .SH ARGUMENTS .TP -.I \- row +.I row row to be updated .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddGeomKeyAlias.man b/lib/libX11/man/xkb/XkbAddGeomKeyAlias.man index 63f8924bc..521694f1d 100644 --- a/lib/libX11/man/xkb/XkbAddGeomKeyAlias.man +++ b/lib/libX11/man/xkb/XkbAddGeomKeyAlias.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry to be updated .TP -.I \- alias +.I alias alias to be added .TP -.I \- real +.I real real name to be bound to the new alias .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddGeomOutline.man b/lib/libX11/man/xkb/XkbAddGeomOutline.man index 3479da267..6c58983ce 100644 --- a/lib/libX11/man/xkb/XkbAddGeomOutline.man +++ b/lib/libX11/man/xkb/XkbAddGeomOutline.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbAddGeomOutline \- Add one outline to an existing shape .if t .ti +.5i .SH ARGUMENTS .TP -.I \- shape +.I shape shape to be updated .TP -.I \- sz_points +.I sz_points number of points to be reserved .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddGeomOverlay.man b/lib/libX11/man/xkb/XkbAddGeomOverlay.man index 1693d12b8..444b2e657 100644 --- a/lib/libX11/man/xkb/XkbAddGeomOverlay.man +++ b/lib/libX11/man/xkb/XkbAddGeomOverlay.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,13 +32,13 @@ XkbAddGeomOverlay \- Add one overlay to a section .if t .ti +.5i .SH ARGUMENTS .TP -.I \- section +.I section section to which an overlay will be added .TP -.I \- name +.I name name of the overlay .TP -.I \- sz_rows +.I sz_rows number of rows to reserve in the overlay .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddGeomOverlayKey.man b/lib/libX11/man/xkb/XkbAddGeomOverlayKey.man index bce3d266c..c64e70f8a 100644 --- a/lib/libX11/man/xkb/XkbAddGeomOverlayKey.man +++ b/lib/libX11/man/xkb/XkbAddGeomOverlayKey.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbAddGeomOverlayKey \- Add a key to an existing overlay row .if t .ti +.5i .SH ARGUMENTS .TP -.I \- overlay +.I overlay overlay to be updated .TP -.I \- row +.I row row in overlay to be updated .TP -.I \- under +.I under primary name of the key to be considered .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddGeomOverlayRow.man b/lib/libX11/man/xkb/XkbAddGeomOverlayRow.man index 760f91a37..95b0d4213 100644 --- a/lib/libX11/man/xkb/XkbAddGeomOverlayRow.man +++ b/lib/libX11/man/xkb/XkbAddGeomOverlayRow.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,13 +32,13 @@ XkbAddGeomOverlayRow \- Add a row to an existing overlay .if t .ti +.5i .SH ARGUMENTS .TP -.I \- overlay +.I overlay overlay to be updated .TP -.I \- row_under +.I row_under row to be overlaid in the section overlay overlays .TP -.I \- sz_keys +.I sz_keys number of keys to reserve in the row .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddGeomProperty.man b/lib/libX11/man/xkb/XkbAddGeomProperty.man index 1ec546cd6..9b40ab10e 100644 --- a/lib/libX11/man/xkb/XkbAddGeomProperty.man +++ b/lib/libX11/man/xkb/XkbAddGeomProperty.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry to be updated .TP -.I \- name +.I name name of the new property .TP -.I \- value +.I value value for the new property .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddGeomRow.man b/lib/libX11/man/xkb/XkbAddGeomRow.man index e400cb8f3..0646d3e0b 100644 --- a/lib/libX11/man/xkb/XkbAddGeomRow.man +++ b/lib/libX11/man/xkb/XkbAddGeomRow.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbAddGeomRow \- Add a row to a section .if t .ti +.5i .SH ARGUMENTS .TP -.I \- section +.I section section to be updated .TP -.I \- sz_keys +.I sz_keys number of keys to be reserved .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddGeomSection.man b/lib/libX11/man/xkb/XkbAddGeomSection.man index 9e5ca388f..f5da1cce8 100644 --- a/lib/libX11/man/xkb/XkbAddGeomSection.man +++ b/lib/libX11/man/xkb/XkbAddGeomSection.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,19 +34,19 @@ XkbAddGeomSection \- Add one section to an existing keyboard geometry .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry to be updated .TP -.I \- name +.I name name of the new section .TP -.I \- sz_rows +.I sz_rows number of rows to reserve in the section .TP -.I \- sz_doodads +.I sz_doodads number of doodads to reserve in the section .TP -.I \- sz_overlays +.I sz_overlays number of overlays to reserve in the section .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddGeomShape.man b/lib/libX11/man/xkb/XkbAddGeomShape.man index a7950010e..2f8834950 100644 --- a/lib/libX11/man/xkb/XkbAddGeomShape.man +++ b/lib/libX11/man/xkb/XkbAddGeomShape.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,13 +32,13 @@ XkbAddGeomShape \- Add a shape to a keyboard geometry .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry to be updated .TP -.I \- name +.I name name of the new shape .TP -.I \- sz_outlines +.I sz_outlines number of outlines to be reserved .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAddSymInterpret.man b/lib/libX11/man/xkb/XkbAddSymInterpret.man index 0171602f3..5ca629d97 100644 --- a/lib/libX11/man/xkb/XkbAddSymInterpret.man +++ b/lib/libX11/man/xkb/XkbAddSymInterpret.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ interpretations in an XkbCompatRec .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description to be updated .TP -.I \- si +.I si symbol interpretation to be added .TP -.I \- updateMap +.I updateMap True=>apply compatibility map to keys .TP -.I \- changes +.I changes changes are put here .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocClientMap.man b/lib/libX11/man/xkb/XkbAllocClientMap.man index 1e2a19430..668f8a808 100644 --- a/lib/libX11/man/xkb/XkbAllocClientMap.man +++ b/lib/libX11/man/xkb/XkbAllocClientMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ record .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description in which to allocate client map .TP -.I \- which +.I which mask selecting map components to allocate .TP -.I \- type_count +.I type_count value of num_types field in map to be allocated .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocCompatMap.man b/lib/libX11/man/xkb/XkbAllocCompatMap.man index 78a02bd9c..d0a184bde 100644 --- a/lib/libX11/man/xkb/XkbAllocCompatMap.man +++ b/lib/libX11/man/xkb/XkbAllocCompatMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbAllocCompatMap \- Allocate a new compatibility map if you do not already have .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description in which to allocate compat map .TP -.I \- which +.I which mask of compatibility map components to allocate .TP -.I \- num_si +.I num_si number of symbol interpretations to allocate .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocControls.man b/lib/libX11/man/xkb/XkbAllocControls.man index 9e9b35566..b5d4bc2b0 100644 --- a/lib/libX11/man/xkb/XkbAllocControls.man +++ b/lib/libX11/man/xkb/XkbAllocControls.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,10 +32,10 @@ XkbAllocControls \- Allocates an XkbControlsRec structure in the XkbDescRec .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description in which to allocate ctrls rec .TP -.I \- which +.I which mask of components of ctrls to allocate .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocDeviceInfo.man b/lib/libX11/man/xkb/XkbAllocDeviceInfo.man index 615e09fe7..00e540f0d 100644 --- a/lib/libX11/man/xkb/XkbAllocDeviceInfo.man +++ b/lib/libX11/man/xkb/XkbAllocDeviceInfo.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbAllocDeviceInfo \- Obtain an XkbDeviceInfoRec structure .if t .ti +.5i .SH ARGUMENTS .TP -.I \- device_spec +.I device_spec device ID with which structure will be used .TP -.I \- n_buttons +.I n_buttons number of button actions to allocate space for .TP -.I \- sz_leds +.I sz_leds number of LED feedbacks to allocate space for .SH DESCRIPTION .LP @@ -58,10 +58,8 @@ is nonzero, .I sz_leds XkbDeviceLedInfoRec structures are also allocated and linked into the XkbDeviceInfoRec structure. If you request XkbDeviceLedInfoRec structures be allocated using this request, you must initialize them -explicitly. - -To obtain an XkbDeviceLedInfoRec structure, use -.I XkbAllocDeviceLedInfo. +explicitly, by using +.BR XkbAddDeviceLedInfo (__libmansuffix__). .SH STRUCTURES .LP Information about X Input Extension devices is transferred between a client program and the Xkb @@ -97,4 +95,4 @@ extension in an XkbDeviceInfoRec structure: } XkbDeviceLedInfoRec, *XkbDeviceLedInfoPtr; .fi .SH "SEE ALSO" -.BR XkbAllocDeviceLedInfo (__libmansuffix__) +.BR XkbAddDeviceLedInfo (__libmansuffix__) diff --git a/lib/libX11/man/xkb/XkbAllocDeviceLedInfo.man b/lib/libX11/man/xkb/XkbAllocDeviceLedInfo.man deleted file mode 100644 index 0e835d700..000000000 --- a/lib/libX11/man/xkb/XkbAllocDeviceLedInfo.man +++ /dev/null @@ -1,113 +0,0 @@ -'\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbAllocDeviceLedInfo __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbAllocDeviceLedInfo \- Obtain an XkbDeviceLedInfoRec structure -.SH SYNOPSIS -.HP -.B Status XkbAllocDeviceLedInfo -.BI "(\^XkbDeviceInfoPtr " "device_info" "\^," -.BI "int " "num_needed" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- device_info -structure in which to allocate LED space -.TP -.I \- num_needed -number of indicators to allocate space for -.SH DESCRIPTION -.LP -.I XkbAllocDeviceLedInfo -allocates space for an XkbDeviceLedInfoRec and places it in -.I device_info. -If -.I num_needed -is nonzero, -.I num_needed -XkbIndicatorMapRec structures are also allocated and linked into the XkbDeviceLedInfoRec structure. If you request XkbIndicatorMapRec structures be allocated using this request, you must initialize them explicitly. All other fields are initialized to zero. - -To initialize an XkbDeviceLedInfoRec structure, use -.I XkbAddDeviceLedInfo. -.SH STRUCTURES -.LP -Information about X Input Extension devices is transferred between a client program and the Xkb -extension in an XkbDeviceInfoRec structure: -.nf - - typedef struct { - char * name; /\&* name for device */ - Atom type; /\&* name for class of devices */ - unsigned short device_spec; /\&* device of interest */ - Bool has_own_state; /\&* True=>this device has its own state */ - unsigned short supported; /\&* bits indicating supported capabilities */ - unsigned short unsupported; /\&* bits indicating unsupported capabilities */ - unsigned short num_btns; /\&* number of entries in btn_acts */ - XkbAction * btn_acts; /\&* button actions */ - unsigned short sz_leds; /\&* total number of entries in LEDs vector */ - unsigned short num_leds; /\&* number of valid entries in LEDs vector */ - unsigned short dflt_kbd_fb; /\&* input extension ID of default (core kbd) indicator */ - unsigned short dflt_led_fb; /\&* input extension ID of default indicator feedback */ - XkbDeviceLedInfoPtr leds; /\&* LED descriptions */ - } XkbDeviceInfoRec, *XkbDeviceInfoPtr; - - - typedef struct { - unsigned short led_class; /\&* class for this LED device*/ - unsigned short led_id; /\&* ID for this LED device */ - unsigned int phys_indicators; /\&* bits for which LEDs physically present */ - unsigned int maps_present; /\&* bits for which LEDs have maps in maps */ - unsigned int names_present; /\&* bits for which LEDs are in names */ - unsigned int state; /\&* 1 bit => corresponding LED is on */ - Atom names[XkbNumIndicators]; /\&* names for LEDs */ - XkbIndicatorMapRec maps; /\&* indicator maps for each LED */ - } XkbDeviceLedInfoRec, *XkbDeviceLedInfoPtr; - -.fi -Each indicator has its own set of attributes that specify whether clients can explicitly set its state and whether it tracks the keyboard state. The attributes of each indicator are held in the maps array, which is an array of XkbIndicatorRec structures: -.nf - - typedef struct { - unsigned char flags; /\&* how the indicator can be changed */ - unsigned char which_groups; /\&* match criteria for groups */ - unsigned char groups; /\&* which keyboard groups the indicator watches */ - unsigned char which_mods; /\&* match criteria for modifiers */ - XkbModsRec mods; /\&* which modifiers the indicator watches */ - unsigned int ctrls; /\&* which controls the indicator watches */ - } XkbIndicatorMapRec, *XkbIndicatorMapPtr; - -.fi -This indicator map specifies for each indicator: - -.IP \(bu 5 -The conditions under which the keyboard modifier state affects the indicator -.IP \(bu 5 -The conditions under which the keyboard group state affects the indicator -.IP \(bu 5 -The conditions under which the state of the boolean controls affects the indicator -.IP \(bu 5 -The effect (if any) of attempts to explicitly change the state of the indicator using the functions XkbSetControls or XChangeKeyboardControl -.SH "SEE ALSO" -.BR XkbAddDeviceLedInfo (__libmansuffix__), -.BR XkbSetControls (__libmansuffix__) diff --git a/lib/libX11/man/xkb/XkbAllocGeomColors.man b/lib/libX11/man/xkb/XkbAllocGeomColors.man index f3224e173..e48c1ba71 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomColors.man +++ b/lib/libX11/man/xkb/XkbAllocGeomColors.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbAllocGeomColors \- Allocate geometry colors .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry for which colors should be allocated .TP -.I \- num_needed +.I num_needed number of new colors required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeomDoodads.man b/lib/libX11/man/xkb/XkbAllocGeomDoodads.man index 882aaf2aa..874ee5620 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomDoodads.man +++ b/lib/libX11/man/xkb/XkbAllocGeomDoodads.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,10 +32,10 @@ XkbAllocGeomDoodads \- Allocate doodads that are global to a keyboard geometry .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry for which doodads should be allocated .TP -.I \- num_needed +.I num_needed number of new doodads required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeomKeyAliases.man b/lib/libX11/man/xkb/XkbAllocGeomKeyAliases.man index 9daa76790..55dab7fb0 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomKeyAliases.man +++ b/lib/libX11/man/xkb/XkbAllocGeomKeyAliases.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbAllocGeomKeyAliases \- Allocate geometry key aliases .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry for which key aliases should be allocated .TP -.I \- num_needed +.I num_needed number of new key aliases required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeomKeys.man b/lib/libX11/man/xkb/XkbAllocGeomKeys.man index cfa979d3b..ad8375bf1 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomKeys.man +++ b/lib/libX11/man/xkb/XkbAllocGeomKeys.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbAllocGeomKeys \- Allocate space for an arbitrary number of keys to a row .if t .ti +.5i .SH ARGUMENTS .TP -.I \- row +.I row row to which keys should be allocated .TP -.I \- num_needed +.I num_needed number of new keys required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeomOutlines.man b/lib/libX11/man/xkb/XkbAllocGeomOutlines.man index 5a191bb38..7cfc051ef 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomOutlines.man +++ b/lib/libX11/man/xkb/XkbAllocGeomOutlines.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,10 +32,10 @@ shape .if t .ti +.5i .SH ARGUMENTS .TP -.I \- shape +.I shape shape for which outlines should be allocated .TP -.I \- num_needed +.I num_needed number of new outlines required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeomOverlayKeys.man b/lib/libX11/man/xkb/XkbAllocGeomOverlayKeys.man index 157b7ef20..58d16ee35 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomOverlayKeys.man +++ b/lib/libX11/man/xkb/XkbAllocGeomOverlayKeys.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,10 +32,10 @@ XkbAllocGeomOverlayKeys \- Allocate keys in an overlay row .if t .ti +.5i .SH ARGUMENTS .TP -.I \- row +.I row section for which rows should be allocated .TP -.I \- num_needed +.I num_needed number of new rows required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeomOverlayRows.man b/lib/libX11/man/xkb/XkbAllocGeomOverlayRows.man index c1c952bb9..9101e2426 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomOverlayRows.man +++ b/lib/libX11/man/xkb/XkbAllocGeomOverlayRows.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbAllocGeomOverlayRows \- Allocate rows in a overlay .if t .ti +.5i .SH ARGUMENTS .TP -.I \- overlay +.I overlay section for which rows should be allocated .TP -.I \- num_needed +.I num_needed number of new rows required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeomOverlays.man b/lib/libX11/man/xkb/XkbAllocGeomOverlays.man index 4cf95a750..2c7a9afbd 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomOverlays.man +++ b/lib/libX11/man/xkb/XkbAllocGeomOverlays.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbAllocGeomOverlays \- Allocate overlays in a section .if t .ti +.5i .SH ARGUMENTS .TP -.I \- section +.I section section for which overlays should be allocated .TP -.I \- num_needed +.I num_needed number of new overlays required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeomPoints.man b/lib/libX11/man/xkb/XkbAllocGeomPoints.man index 91c1637ab..70975a146 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomPoints.man +++ b/lib/libX11/man/xkb/XkbAllocGeomPoints.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbAllocGeomPoints \- Allocate points in an outline .if t .ti +.5i .SH ARGUMENTS .TP -.I \- outline +.I outline outline for which points should be allocated .TP -.I \- num_needed +.I num_needed number of new points required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeomProps.man b/lib/libX11/man/xkb/XkbAllocGeomProps.man index 1a8599058..4db666c5b 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomProps.man +++ b/lib/libX11/man/xkb/XkbAllocGeomProps.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,11 +31,11 @@ XkbAllocGeomProps \- Allocate geometry properties .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom -_summary_ +.I geom +geometry for which properties should be allocated .TP -.I \- num_needed -_summary_ +.I num_needed +number of new properties required .SH DESCRIPTION .LP Xkb provides a number of functions to allocate and free subcomponents of a diff --git a/lib/libX11/man/xkb/XkbAllocGeomRows.man b/lib/libX11/man/xkb/XkbAllocGeomRows.man index 46772903e..bdeec804f 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomRows.man +++ b/lib/libX11/man/xkb/XkbAllocGeomRows.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbAllocGeomRows \- Allocate rows in a section .if t .ti +.5i .SH ARGUMENTS .TP -.I \- section +.I section section for which rows should be allocated .TP -.I \- num_needed +.I num_needed number of new rows required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeomSectionDoodads.man b/lib/libX11/man/xkb/XkbAllocGeomSectionDoodads.man index 36664aa0b..669c68ae8 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomSectionDoodads.man +++ b/lib/libX11/man/xkb/XkbAllocGeomSectionDoodads.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,10 +32,10 @@ XkbAllocGeomSectionDoodads \- Allocate doodads that are specific to a section .if t .ti +.5i .SH ARGUMENTS .TP -.I \- section +.I section section for which doodads should be allocated .TP -.I \- num_needed +.I num_needed number of new doodads required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeomSections.man b/lib/libX11/man/xkb/XkbAllocGeomSections.man index 4bbe54318..767c1123b 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomSections.man +++ b/lib/libX11/man/xkb/XkbAllocGeomSections.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbAllocGeomSections \- Allocate geometry sections .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry for which sections should be allocated .TP -.I \- num_needed +.I num_needed number of new sections required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeomShapes.man b/lib/libX11/man/xkb/XkbAllocGeomShapes.man index 2b7d50f3d..6d6580254 100644 --- a/lib/libX11/man/xkb/XkbAllocGeomShapes.man +++ b/lib/libX11/man/xkb/XkbAllocGeomShapes.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbAllocGeomShapes \- Allocate space for an arbitrary number of geometry shapes .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry for which shapes should be allocated .TP -.I \- num_needed +.I num_needed number of new shapes required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocGeometry.man b/lib/libX11/man/xkb/XkbAllocGeometry.man index 7ff05bccc..998f854dc 100644 --- a/lib/libX11/man/xkb/XkbAllocGeometry.man +++ b/lib/libX11/man/xkb/XkbAllocGeometry.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,10 +32,10 @@ XkbAllocGeometry \- Allocate an entire geometry .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description for which geometry is to be allocated .TP -.I \- sizes +.I sizes initial sizes for all geometry components .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocIndicatorMaps.man b/lib/libX11/man/xkb/XkbAllocIndicatorMaps.man index ee37c150e..cf2a6e834 100644 --- a/lib/libX11/man/xkb/XkbAllocIndicatorMaps.man +++ b/lib/libX11/man/xkb/XkbAllocIndicatorMaps.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,7 +32,7 @@ member of the keyboard description record .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description structure .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocKeyboard.man b/lib/libX11/man/xkb/XkbAllocKeyboard.man index 96522fe3b..eb94e2850 100644 --- a/lib/libX11/man/xkb/XkbAllocKeyboard.man +++ b/lib/libX11/man/xkb/XkbAllocKeyboard.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbAllocNames.man b/lib/libX11/man/xkb/XkbAllocNames.man index 18aa4c193..2814f6e1c 100644 --- a/lib/libX11/man/xkb/XkbAllocNames.man +++ b/lib/libX11/man/xkb/XkbAllocNames.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ XkbAllocNames \- Allocate symbolic names structures .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description for which names are to be allocated .TP -.I \- which +.I which mask of names to be allocated .TP -.I \- num_rg +.I num_rg total number of radio group names needed .TP -.I \- num_key_aliases +.I num_key_aliases total number of key aliases needed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbAllocServerMap.man b/lib/libX11/man/xkb/XkbAllocServerMap.man index ed242594c..b1bc12e2e 100644 --- a/lib/libX11/man/xkb/XkbAllocServerMap.man +++ b/lib/libX11/man/xkb/XkbAllocServerMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbAllocServerMap \- Allocate and initialize an empty server map description rec .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description in which to allocate server map .TP -.I \- which +.I which mask selecting map components to allocate .TP -.I \- count_acts +.I count_acts value of num_acts field in map to be allocated .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbApplyCompatMapToKey.man b/lib/libX11/man/xkb/XkbApplyCompatMapToKey.man index 46d94dbfe..640d5e1eb 100644 --- a/lib/libX11/man/xkb/XkbApplyCompatMapToKey.man +++ b/lib/libX11/man/xkb/XkbApplyCompatMapToKey.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ key to get its semantics updated .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description to be updated .TP -.I \- key +.I key key to be updated .TP -.I \- changes +.I changes notes changes to the Xkb keyboard description .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbBell.man b/lib/libX11/man/xkb/XkbBell.man index e6e745bbf..d0b611aaa 100644 --- a/lib/libX11/man/xkb/XkbBell.man +++ b/lib/libX11/man/xkb/XkbBell.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ XkbBell \- Rings the bell on the default keyboard .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to the X server .TP -.I \- window +.I window event window, or None .TP -.I \- percent +.I percent relative volume, which can range from -100 to 100 inclusive .TP -.I \- name +.I name a bell name, or NULL .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbBellEvent.man b/lib/libX11/man/xkb/XkbBellEvent.man index a99968ca6..8c8f0a94e 100644 --- a/lib/libX11/man/xkb/XkbBellEvent.man +++ b/lib/libX11/man/xkb/XkbBellEvent.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -35,16 +35,16 @@ without ringing the bell .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to the X server .TP -.I \- window +.I window the event window, or None .TP -.I \- percent, +.I percent relative volume, which can range from -100 to 100 inclusive .TP -.I \- name +.I name a bell name, or NULL .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbChangeControls.man b/lib/libX11/man/xkb/XkbChangeControls.man index 44a348282..81f78e744 100644 --- a/lib/libX11/man/xkb/XkbChangeControls.man +++ b/lib/libX11/man/xkb/XkbChangeControls.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -312,7 +312,6 @@ typedef struct _XkbControlsChanges { XkbChangeControls(__libmansuffix__), XkbChangeDeviceInfo(__libmansuffix__), XkbChangeEnabledControls(__libmansuffix__), -XkbChangeIndicators(__libmansuffix__), XkbChangeMap(__libmansuffix__), XkbChangeNames(__libmansuffix__), XkbChangeTypesOfKey(__libmansuffix__) diff --git a/lib/libX11/man/xkb/XkbChangeDeviceInfo.man b/lib/libX11/man/xkb/XkbChangeDeviceInfo.man index 22d0097e0..b97e6594b 100644 --- a/lib/libX11/man/xkb/XkbChangeDeviceInfo.man +++ b/lib/libX11/man/xkb/XkbChangeDeviceInfo.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ XkbDeviceChangesRec .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- device_info +.I device_info local copy of device state and configuration .TP -.I \- changes +.I changes note specifying changes in device_info .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbChangeEnabledControls.man b/lib/libX11/man/xkb/XkbChangeEnabledControls.man index 48fd288ec..79755284f 100644 --- a/lib/libX11/man/xkb/XkbChangeEnabledControls.man +++ b/lib/libX11/man/xkb/XkbChangeEnabledControls.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ XkbChangeEnabledControls \- Manipulates the EnabledControls control .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- device_spec - keyboard device to modify +.I device_spec +keyboard device to modify .TP -.I \- mask +.I mask 1 bit -> controls to enable / disable .TP -.I \- values +.I values 1 bit => enable, 0 bit => disable .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbChangeIndicators.man b/lib/libX11/man/xkb/XkbChangeIndicators.man deleted file mode 100644 index 1d663d759..000000000 --- a/lib/libX11/man/xkb/XkbChangeIndicators.man +++ /dev/null @@ -1,156 +0,0 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbChangeIndicators __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbChangeIndicators \- Changes indicator maps or state without passing the -entire keyboard description -.SH SYNOPSIS -.HP -.B Bool XkbChangeIndicators -.BI "(\^Display *" "dpy" "\^," -.BI "XkbDescPtr " "xkb" "\^," -.BI "XkbIndicatorChangesPtr " "changes" "\^," -.BI "unsigned int " "state" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- dpy -connection to the X server -.TP -.I \- xkb -keyboard description from which names are to be taken. -.TP -.I \- changes -indicators to be updated on the server -.TP -.I \- state -new state of indicators listed in changes->state_changes -.SH DESCRIPTION -.LP -The XkbIndicatorChangesRec identifies small modifications to the indicator map. -Use it with the function -.I XkbChangeIndicators -to reduce the amount of traffic sent to the server (see STRUCTURES). - -The -.I state_changes -field is a mask that specifies the indicators that have changed state, and -.I map_changes -is a mask that specifies the indicators whose maps have changed. - -.I XkbChangeIndicators -copies any maps specified by -.I changes -from the keyboard description, -.I xkb, -to the server specified by -.I dpy. -If any bits are set in the -.I state_changes -field of -.I changes, XkbChangeIndicators -also sets the state of those indicators to the values specified in the -.I state -mask. A 1 bit in -.I state -turns the corresponding indicator on, a 0 bit turns it off. - -In addition, it can also generate XkbIndicatorStateNotify and -XkbIndicatorMapNotify events. - -Whenever an indicator changes state, the server sends XkbIndicatorStateNotify events -to all interested clients. Similarly, whenever an indicator's map changes, the -server sends XkbIndicatorMapNotify events to all interested clients. - -To receive XkbIndicatorStateNotify events, use -.I XkbSelectEvents -with both the -.I bits_to_change -and -.I values_for_bits -parameters containing XkbIndicatorStateNotifyMask. To receive XkbIndicatorMapNotify -events, use -.I XkbSelectEvents -with XkbIndicatorMapNotifyMask. - -To receive events for only specific indicators, use -.I XkbSelectEventDetails. -Set the -.I event_type -parameter to XkbIndicatorStateNotify or XkbIndicatorMapNotify, and set both the -.I bits_to_change -and -.I values_for_bits -detail parameters to a mask where each bit specifies one indicator, turning on those -bits that specify the indicators for which you want to receive events. - -.I xkb_type -is either XkbIndicatorStateNotify or XkbIndicatorMapNotify, depending on whether the -event is a kbIndicatorStateNotify event or kbIndicatorMapNotify event. - -The -.I changed -parameter is a mask that is the bitwise inclusive OR of the indicators that have -changed. If the event is of type XkbIndicatorMapNotify, -.I changed -reports the maps that changed. If the event is of type XkbIndicatorStateNotify, -.I changed -reports the indicators that have changed state. -.I state -is a mask that specifies the current state of all indicators, whether they have -changed or not, for both XkbIndicatorStateNotify and IndicatorMapNotify events. -.SH STRUCTURES -.LP -.nf - typedef struct _XkbIndicatorChanges { - unsigned int state_changes; - unsigned int map_changes; - }XkbIndicatorChangesRec,*XkbIndicatorChangesPtr; - -.fi -Both types of indicator events use the same structure: - -.nf - typedef struct _XkbIndicatorNotify { - int type; /\&* Xkb extension base event code */ - unsigned long serial; /\&* X server serial number for event */ - Bool send_event; /\&* True => synthetically generated */ - Display * display; /\&* server connection where event generated */ - Time time; /\&* server time when event generated */ - int xkb_type; /\&* specifies state or map notify */ - int device; /\&* Xkb device ID, will not be XkbUseCoreKbd*/ - unsigned int changed; /\&* mask of indicators with new state or map */ - unsigned int state; /\&* current state of all indicators */ - } XkbIndicatorNotifyEvent; - -.fi -.SH DIAGNOSTICS -.TP 15 -.B BadAtom -A name is neither a valid Atom or None -.TP 15 -.B BadImplementation -Invalid reply from server -.SH "SEE ALSO" -.BR XkbIndicatorMapNotify (__libmansuffix__), -.BR XkbIndicatorStateNotify (__libmansuffix__) diff --git a/lib/libX11/man/xkb/XkbChangeMap.man b/lib/libX11/man/xkb/XkbChangeMap.man index 3d74e23fb..7849c3cd5 100644 --- a/lib/libX11/man/xkb/XkbChangeMap.man +++ b/lib/libX11/man/xkb/XkbChangeMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -35,13 +35,13 @@ keyboard description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- xkb +.I xkb description from which new values are taken .TP -.I \- changes +.I changes identifies component parts to update .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbChangeNames.man b/lib/libX11/man/xkb/XkbChangeNames.man index 6b6f7c47a..d3064aa91 100644 --- a/lib/libX11/man/xkb/XkbChangeNames.man +++ b/lib/libX11/man/xkb/XkbChangeNames.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -22,24 +22,24 @@ .\" .TH XkbChangeNames __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbChangeNames \- _summary-line_ +XkbChangeNames \- Change symbolic names in the server .SH SYNOPSIS .HP .B Bool XkbChangeNames .BI "(\^Display *" "dpy" "\^," .BI "unsigned int " "which" "\^," -.BI "XkbDescPtr " "Xkb" "\^);" +.BI "XkbDescPtr " "xkb" "\^);" .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to the X server .TP -.I \- which +.I which mask of names or map components to be updated .TP -.I \- Xkb +.I xkb keyboard description to be updated .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbChangeTypesOfKey.man b/lib/libX11/man/xkb/XkbChangeTypesOfKey.man index 060e75e7f..f6d32e029 100644 --- a/lib/libX11/man/xkb/XkbChangeTypesOfKey.man +++ b/lib/libX11/man/xkb/XkbChangeTypesOfKey.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -36,22 +36,22 @@ XkbChangeTypesOfKey \- Change the number of groups and the types bound to a key .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description to be changed .TP -.I \- key +.I key keycode for key of interest .TP -.I \- n_groups +.I n_groups new number of groups for key .TP -.I \- groups +.I groups mask indicating groups to change .TP -.I \- new_types_in +.I new_types_in indices for new groups specified in groups .TP -.I \- p_changes +.I p_changes notes changes made to xkb .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbComputeRowBounds.man b/lib/libX11/man/xkb/XkbComputeRowBounds.man index b72ca5bdb..2d75c6e9a 100644 --- a/lib/libX11/man/xkb/XkbComputeRowBounds.man +++ b/lib/libX11/man/xkb/XkbComputeRowBounds.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,13 +32,13 @@ XkbComputeRowBounds \- Update the bounding box of a row .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry that contains the section .TP -.I \- section +.I section section that contains the row .TP -.I \- row +.I row row to be examined and updated .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbComputeSectionBounds.man b/lib/libX11/man/xkb/XkbComputeSectionBounds.man index ce56c0cfe..ce7188469 100644 --- a/lib/libX11/man/xkb/XkbComputeSectionBounds.man +++ b/lib/libX11/man/xkb/XkbComputeSectionBounds.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbComputeSectionBounds \- Update the bounding box of a section .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry that contains the section .TP -.I \- section +.I section section to be examined and updated .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbComputeShapeBounds.man b/lib/libX11/man/xkb/XkbComputeShapeBounds.man index 063ae801f..75ac7af00 100644 --- a/lib/libX11/man/xkb/XkbComputeShapeBounds.man +++ b/lib/libX11/man/xkb/XkbComputeShapeBounds.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -30,7 +30,7 @@ XkbComputeShapeBounds \- Updates the bounding box of a shape .if t .ti +.5i .SH ARGUMENTS .TP -.I \- shape +.I shape shape to be examined .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbComputeShapeTop.man b/lib/libX11/man/xkb/XkbComputeShapeTop.man index 50a0d3b16..8454d5e87 100644 --- a/lib/libX11/man/xkb/XkbComputeShapeTop.man +++ b/lib/libX11/man/xkb/XkbComputeShapeTop.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbComputeShapeTop \- Determines the bounding box of the top surface of a shape .if t .ti +.5i .SH ARGUMENTS .TP -.I \- shape +.I shape shape to be examined .TP -.I \- bounds_rtrn +.I bounds_rtrn backfilled with the bounding box for the shape .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbCopyKeyType.man b/lib/libX11/man/xkb/XkbCopyKeyType.man index bba09e5e1..88aa0d611 100644 --- a/lib/libX11/man/xkb/XkbCopyKeyType.man +++ b/lib/libX11/man/xkb/XkbCopyKeyType.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbCopyKeyType \- Copy one XkbKeyTypeRec structures .if t .ti +.5i .SH ARGUMENTS .TP -.I \- from +.I from pointer to XkbKeyTypeRec to be copied .TP -.I \- into +.I into pointer to XkbKeyTypeRec to be changed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbCopyKeyTypes.man b/lib/libX11/man/xkb/XkbCopyKeyTypes.man index a93abdb9d..975f1a286 100644 --- a/lib/libX11/man/xkb/XkbCopyKeyTypes.man +++ b/lib/libX11/man/xkb/XkbCopyKeyTypes.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,13 +32,13 @@ XkbCopyKeyTypes \- Copy more than one XkbKeyTypeRec structure .if t .ti +.5i .SH ARGUMENTS .TP -.I \- from +.I from pointer to array of XkbKeyTypeRecs to copy .TP -.I \- into +.I into pointer to array of XkbKeyTypeRecs to change .TP -.I \- num_types +.I num_types number of types to copy .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbDeviceBell.man b/lib/libX11/man/xkb/XkbDeviceBell.man index 5bfdc452a..407643c09 100644 --- a/lib/libX11/man/xkb/XkbDeviceBell.man +++ b/lib/libX11/man/xkb/XkbDeviceBell.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -37,25 +37,25 @@ XkbDeviceBell \- Rings the bell on an X input extension device or the default ke .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to the X server .TP -.I \- window +.I window window for which the bell is generated, or None .TP -.I \- device_spec +.I device_spec device ID, or XkbUseCoreKbd .TP -.I \- bell_class +.I bell_class X input extension bell class of the bell to be rung .TP -.I \- bell_id +.I bell_id X input extension bell ID of the bell to be rung .TP -.I \- percent +.I percent bell volume, from -100 to 100 inclusive .TP -.I \- name +.I name a name for the bell, or NULL .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbDeviceBellEvent.man b/lib/libX11/man/xkb/XkbDeviceBellEvent.man index b51d8d674..57387f05c 100644 --- a/lib/libX11/man/xkb/XkbDeviceBellEvent.man +++ b/lib/libX11/man/xkb/XkbDeviceBellEvent.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -38,25 +38,25 @@ for the keyboard, without ringing the corresponding bell .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to the X server .TP -.I \- window +.I window event window, or None .TP -.I \- device_spec +.I device_spec device ID, or XkbUseCoreKbd .TP -.I \- bell_class +.I bell_class input extension bell class for the event .TP -.I \- bell_id +.I bell_id input extension bell ID for the event .TP -.I \- percent +.I percent volume for the bell, which can range from -100 to 100 inclusive .TP -.I \- name +.I name a bell name, or NULL .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFindOverlayForKey.man b/lib/libX11/man/xkb/XkbFindOverlayForKey.man index e80cb8380..f5f5ec57d 100644 --- a/lib/libX11/man/xkb/XkbFindOverlayForKey.man +++ b/lib/libX11/man/xkb/XkbFindOverlayForKey.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ key that is part of an overlay .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry that contains the section .TP -.I \- section +.I section section to be searched for matching keys .TP -.I \- under +.I under primary name of the key to be considered .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbForceBell.man b/lib/libX11/man/xkb/XkbForceBell.man index 7e63050a5..9f546f145 100644 --- a/lib/libX11/man/xkb/XkbForceBell.man +++ b/lib/libX11/man/xkb/XkbForceBell.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,10 +33,10 @@ bell on the default keyboard .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to the X server .TP -.I \- percent +.I percent volume for the bell, which can range from -100 to 100 inclusive .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbForceDeviceBell.man b/lib/libX11/man/xkb/XkbForceDeviceBell.man index 3d267bd2c..e10a5586c 100644 --- a/lib/libX11/man/xkb/XkbForceDeviceBell.man +++ b/lib/libX11/man/xkb/XkbForceDeviceBell.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -37,22 +37,22 @@ settings for audible bells .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to the X server .TP -.I \- window +.I window event window, or None .TP -.I \- device_spec +.I device_spec device ID, or XkbUseCoreKbd .TP -.I \- bell_class +.I bell_class input extension class of the bell to be rung .TP -.I \- bell_id +.I bell_id input extension ID of the bell to be rung .TP -.I \- percent +.I percent relative volume, which can range from -100 to 100 inclusive .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeClientMap.man b/lib/libX11/man/xkb/XkbFreeClientMap.man index a31f15d5e..394556733 100644 --- a/lib/libX11/man/xkb/XkbFreeClientMap.man +++ b/lib/libX11/man/xkb/XkbFreeClientMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ structure .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description containing client map to free .TP -.I \- which +.I which mask identifying components of map to free .TP -.I \- free_all +.I free_all True => free all client components and map itself .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeCompatMap.man b/lib/libX11/man/xkb/XkbFreeCompatMap.man index 22184d016..6d76f791a 100644 --- a/lib/libX11/man/xkb/XkbFreeCompatMap.man +++ b/lib/libX11/man/xkb/XkbFreeCompatMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbFreeCompatMap \- Free an entire compatibility map or selected portions of one .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description in which to free compatibility map .TP -.I \- which +.I which mask of compatibility map components to free .TP -.I \- free_map +.I free_map True => free XkbCompatMap structure itself .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeComponentList.man b/lib/libX11/man/xkb/XkbFreeComponentList.man index 85aa4ef15..8778b2cc2 100644 --- a/lib/libX11/man/xkb/XkbFreeComponentList.man +++ b/lib/libX11/man/xkb/XkbFreeComponentList.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,7 +32,7 @@ XkbFreeComponentList \- Free the structure returned by .if t .ti +.5i .SH ARGUMENTS .TP -.I \- list +.I list pointer to XkbComponentListRec to free .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeControls.man b/lib/libX11/man/xkb/XkbFreeControls.man index 1b0737bd1..5403ad090 100644 --- a/lib/libX11/man/xkb/XkbFreeControls.man +++ b/lib/libX11/man/xkb/XkbFreeControls.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbFreeControls \- Frees memory used by the ctrls member of an XkbDescRec struct .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description in which to free controls components .TP -.I \- which +.I which mask of components of ctrls to free .TP -.I \- free_all +.I free_all True => free everything + ctrls itself .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeDeviceInfo.man b/lib/libX11/man/xkb/XkbFreeDeviceInfo.man index 80a878f5e..587761c38 100644 --- a/lib/libX11/man/xkb/XkbFreeDeviceInfo.man +++ b/lib/libX11/man/xkb/XkbFreeDeviceInfo.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbFreeDeviceInfo \- Free an XkbDeviceInfoRec structure .if t .ti +.5i .SH ARGUMENTS .TP -.I \- device_info +.I device_info pointer to XkbDeviceInfoRec in which to free items .TP -.I \- which +.I which mask of components of device_info to free .TP -.I \- free_all +.I free_all True => free everything, including device_info .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomColors.man b/lib/libX11/man/xkb/XkbFreeGeomColors.man index 76ebf389a..f7378fd2b 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomColors.man +++ b/lib/libX11/man/xkb/XkbFreeGeomColors.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,16 +33,16 @@ XkbFreeGeomColors \- Free geometry colors .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry in which colors should be freed .TP -.I \- first +.I first first color to be freed .TP -.I \- count +.I count number of colors to be freed .TP -.I \- free_all +.I free_all True => all colors are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomDoodads.man b/lib/libX11/man/xkb/XkbFreeGeomDoodads.man index 9371a8c4a..53e83e859 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomDoodads.man +++ b/lib/libX11/man/xkb/XkbFreeGeomDoodads.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,13 +32,13 @@ XkbFreeGeomDoodads \- Free geometry doodads .if t .ti +.5i .SH ARGUMENTS .TP -.I \- doodads +.I doodads doodads to be freed .TP -.I \- count +.I count number of doodads to be freed .TP -.I \- free_all +.I free_all True => all doodads are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomKeyAliases.man b/lib/libX11/man/xkb/XkbFreeGeomKeyAliases.man index 15ad0b24b..11cd0c24d 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomKeyAliases.man +++ b/lib/libX11/man/xkb/XkbFreeGeomKeyAliases.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,16 +33,16 @@ XkbFreeGeomKeyAliases \- Free geometry key aliases .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry in which key aliases should be freed .TP -.I \- first +.I first first key alias to be freed .TP -.I \- count +.I count number of key aliases to be freed .TP -.I \- free_all +.I free_all True => all key aliases are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomKeys.man b/lib/libX11/man/xkb/XkbFreeGeomKeys.man index a99e2d496..0338ec39c 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomKeys.man +++ b/lib/libX11/man/xkb/XkbFreeGeomKeys.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,16 +33,16 @@ XkbFreeGeomKeys \- Free geometry keys .if t .ti +.5i .SH ARGUMENTS .TP -.I \- row +.I row row in which keys should be freed .TP -.I \- first +.I first first key to be freed .TP -.I \- count +.I count number of keys to be freed .TP -.I \- free_all +.I free_all True => all keys are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomOutlines.man b/lib/libX11/man/xkb/XkbFreeGeomOutlines.man index 0aa5a3431..d5255fe71 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomOutlines.man +++ b/lib/libX11/man/xkb/XkbFreeGeomOutlines.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,16 +33,16 @@ XkbFreeGeomOutlines \- Free geometry outlines .if t .ti +.5i .SH ARGUMENTS .TP -.I \- shape +.I shape shape in which outlines should be freed .TP -.I \- first +.I first first outline to be freed .TP -.I \- count +.I count number of outlines to be freed .TP -.I \- free_all +.I free_all True => all outlines are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomOverlayKeys.man b/lib/libX11/man/xkb/XkbFreeGeomOverlayKeys.man index f4fb4dcbd..5f2314b51 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomOverlayKeys.man +++ b/lib/libX11/man/xkb/XkbFreeGeomOverlayKeys.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,16 +33,16 @@ XkbFreeGeomOverlayKeys \- Free keys in an overlay row .if t .ti +.5i .SH ARGUMENTS .TP -.I \- row +.I row row in which keys should be freed .TP -.I \- first +.I first first key to be freed .TP -.I \- count +.I count number of keys to be freed .TP -.I \- free_all +.I free_all True => all keys are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomOverlayRows.man b/lib/libX11/man/xkb/XkbFreeGeomOverlayRows.man index 0371c017e..3f700d187 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomOverlayRows.man +++ b/lib/libX11/man/xkb/XkbFreeGeomOverlayRows.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,16 +33,16 @@ XkbFreeGeomOverlayRows \- Free rows in an overlay .if t .ti +.5i .SH ARGUMENTS .TP -.I \- overlay +.I overlay section in which rows should be freed .TP -.I \- first +.I first first row to be freed .TP -.I \- count +.I count number of rows to be freed .TP -.I \- free_all +.I free_all True => all rows are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomOverlays.man b/lib/libX11/man/xkb/XkbFreeGeomOverlays.man index 399df3c07..f8bb578eb 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomOverlays.man +++ b/lib/libX11/man/xkb/XkbFreeGeomOverlays.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,16 +33,16 @@ XkbFreeGeomOverlays \- Free rows in a section .if t .ti +.5i .SH ARGUMENTS .TP -.I \- section +.I section section in which overlays should be freed .TP -.I \- first +.I first first overlay to be freed .TP -.I \- count +.I count number of overlays to be freed .TP -.I \- free_all +.I free_all True => all overlays are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomPoints.man b/lib/libX11/man/xkb/XkbFreeGeomPoints.man index 7f6219153..a270b9056 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomPoints.man +++ b/lib/libX11/man/xkb/XkbFreeGeomPoints.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,16 +33,16 @@ XkbFreeGeomPoints \- Free points in a outline .if t .ti +.5i .SH ARGUMENTS .TP -.I \- outline +.I outline outline in which points should be freed .TP -.I \- first +.I first first point to be freed .TP -.I \- count +.I count number of points to be freed .TP -.I \- free_all +.I free_all True => all points are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomProperties.man b/lib/libX11/man/xkb/XkbFreeGeomProperties.man index b1d9b92a3..91b84ef51 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomProperties.man +++ b/lib/libX11/man/xkb/XkbFreeGeomProperties.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,16 +33,16 @@ XkbFreeGeomProperties \- Free geometry properties .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry in which properties should be freed .TP -.I \- first +.I first first property to be freed .TP -.I \- count +.I count number of properties to be freed .TP -.I \- free_all +.I free_all True => all properties are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomRows.man b/lib/libX11/man/xkb/XkbFreeGeomRows.man index ceb489a28..4d38d22b9 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomRows.man +++ b/lib/libX11/man/xkb/XkbFreeGeomRows.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,16 +33,16 @@ XkbFreeGeomRows \- Free rows in a section .if t .ti +.5i .SH ARGUMENTS .TP -.I \- section +.I section section in which rows should be freed .TP -.I \- first +.I first first row to be freed .TP -.I \- count +.I count number of rows to be freed .TP -.I \- free_all +.I free_all True => all rows are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomSections.man b/lib/libX11/man/xkb/XkbFreeGeomSections.man index f67a16a14..3c0935268 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomSections.man +++ b/lib/libX11/man/xkb/XkbFreeGeomSections.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,16 +33,16 @@ XkbFreeGeomSections \- Free geometry sections .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry in which sections should be freed .TP -.I \- first +.I first first section to be freed .TP -.I \- count +.I count number of sections to be freed .TP -.I \- free_all +.I free_all True => all sections are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeomShapes.man b/lib/libX11/man/xkb/XkbFreeGeomShapes.man index 168860feb..ee89ecd43 100644 --- a/lib/libX11/man/xkb/XkbFreeGeomShapes.man +++ b/lib/libX11/man/xkb/XkbFreeGeomShapes.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,16 +33,16 @@ XkbFreeGeomShapes \- Free geometry shapes .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry in which shapes should be freed .TP -.I \- first +.I first first shape to be freed .TP -.I \- count +.I count number of shapes to be freed .TP -.I \- free_all +.I free_all True => all shapes are freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeGeometry.man b/lib/libX11/man/xkb/XkbFreeGeometry.man index 36af778eb..4447d4166 100644 --- a/lib/libX11/man/xkb/XkbFreeGeometry.man +++ b/lib/libX11/man/xkb/XkbFreeGeometry.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,13 +32,13 @@ XkbFreeGeometry \- Free an entire geometry .if t .ti +.5i .SH ARGUMENTS .TP -.I \- geom +.I geom geometry to be freed .TP -.I \- which +.I which mask of geometry components to be freed .TP -.I \- free_all +.I free_all True => the entire geometry is freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeIndicatorMaps.man b/lib/libX11/man/xkb/XkbFreeIndicatorMaps.man index bff887fce..09877975c 100644 --- a/lib/libX11/man/xkb/XkbFreeIndicatorMaps.man +++ b/lib/libX11/man/xkb/XkbFreeIndicatorMaps.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,7 +32,7 @@ member of an XkbDescRec structure .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description structure .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeKeyboard.man b/lib/libX11/man/xkb/XkbFreeKeyboard.man index 6d90307f8..c68dcf7fd 100644 --- a/lib/libX11/man/xkb/XkbFreeKeyboard.man +++ b/lib/libX11/man/xkb/XkbFreeKeyboard.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbFreeNames.man b/lib/libX11/man/xkb/XkbFreeNames.man index cdb021ec7..a88daaed6 100644 --- a/lib/libX11/man/xkb/XkbFreeNames.man +++ b/lib/libX11/man/xkb/XkbFreeNames.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbFreeNames \- Free symbolic names structures .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description for which names are to be freed .TP -.I \- which +.I which mask of names components to be freed .TP -.I \- free_map +.I free_map True => XkbNamesRec structure itself should be freed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbFreeServerMap.man b/lib/libX11/man/xkb/XkbFreeServerMap.man index 8798510bb..b4c00eb84 100644 --- a/lib/libX11/man/xkb/XkbFreeServerMap.man +++ b/lib/libX11/man/xkb/XkbFreeServerMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ structure .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description containing server map to free .TP -.I \- which +.I which mask identifying components of map to free .TP -.I \- free_all +.I free_all True => free all server map components and server itself .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetAccessXTimeout.man b/lib/libX11/man/xkb/XkbGetAccessXTimeout.man deleted file mode 100644 index 1448e3db0..000000000 --- a/lib/libX11/man/xkb/XkbGetAccessXTimeout.man +++ /dev/null @@ -1,140 +0,0 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbGetAccessXTimeout __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbGetAccessXTimeout \- Queries the current AccessXTimeout options for a -keyboard device -.SH SYNOPSIS -.HP -.B Bool XkbGetAccessXTimeout -.BI "(\^Display *" "display" "\^," -.BI "unsigned int " "device_spec" "\^," -.BI "unsigned short *" "timeout_rtrn" "\^," -.BI "unsigned int *" "ctrls_mask_rtrn" "\^," -.BI "unsigned int *" "ctrls_values_rtrn" "\^," -.BI "unsigned short *" "options_mask_rtrn" "\^," -.BI "unsigned short *" "options_values_rtrn" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- display -unsigned short -.TP -.I \- device_spec -device to query, or XkbUseCoreKbd -.TP -.I \- timeout_rtrn -delay until AccessXTimeout, seconds -.TP -.I \- ctrls_mask_rtrn -backfilled with controls to modify -.TP -.I \- ctrls_values_rtrn -backfilled with on/off status for controls -.TP -.I \- options_mask_rtrn -backfilled with ax_options to modify -.TP -.I \- options_values_rtrn -backfilled with values for ax_options -.SH DESCRIPTION -.LP -In environments where computers are shared, features such as SlowKeys present a -problem: if -SlowKeys is on, the keyboard can appear to be unresponsive because keys are not -accepted -until they are held for a certain period of time. To help solve this problem, -Xkb provides -an AccessXTimeout control to automatically change the enabled/disabled state of -any boolean -controls and to change the value of the AccessXKeys and AccessXFeedback control -attributes -if the keyboard is idle for a specified period of time. - -When a timeout as specified by AccessXTimeout occurs and a control is -consequently modified, -Xkb generates an XkbControlsNotify event. - -.I XkbGetAccessXTimeout -sends a request to the X server to obtain the current values for the -AccessXTimeout attributes, waits for a reply, and backfills the values into the -appropriate arguments. The parameters -.I options_mask_rtrn -and -.I options_values_rtrn -are backfilled with the options to modify and the values for -.I ax_options, -which is a field in the XkbControlsRec structure. -.I XkbGetAccessXTimeout -returns True if successful; if a compatible version of the Xkb extension is not -available in the server, -.I XkbGetAccessXTimeout -returns False. -.SH "RETURN VALUES" -.TP 15 -True -The -.I XkbGetAccessXTimeout -returns True when it successfully sends a request to the X server to obtain the -current values for the AccessXTimeout attributes, waits for a reply, and -backfills the values into the appropriate arguments. -.TP 15 -False -The -.I XkbGetAccessXTimeout -function returns False if a compatible version of the Xkb extension is not -available in the -server. -.SH STRUCTURES -.LP -.nf -The XkbControlsRec structure is defined as follows: - -\&#define XkbMaxLegalKeyCode 255 -\&#define XkbPerKeyBitArraySize ((XkbMaxLegalKeyCode+1)/8) - -typedef struct { - unsigned char mk_dflt_btn; /\&* default button for keyboard driven mouse */ - unsigned char num_groups; /\&* number of keyboard groups */ - unsigned char groups_wrap; /\&* how to wrap out-of-bounds groups */ - XkbModsRec internal; /\&* defines server internal modifiers */ - XkbModsRec ignore_lock; /\&* modifiers to ignore when checking for grab */ - unsigned int enabled_ctrls; /\&* 1 bit => corresponding boolean control enabled */ - unsigned short repeat_delay; /\&* ms delay until first repeat */ - unsigned short repeat_interval; /\&* ms delay between repeats */ - unsigned short slow_keys_delay; /\&* ms minimum time key must be down to be ok */ - unsigned short debounce_delay; /\&* ms delay before key reactivated */ - unsigned short mk_delay; /\&* ms delay to second mouse motion event */ - unsigned short mk_interval; /\&* ms delay between repeat mouse events */ - unsigned short mk_time_to_max; /\&* # intervals until constant mouse move */ - unsigned short mk_max_speed; /\&* multiplier for maximum mouse speed */ - short mk_curve; /\&* determines mouse move curve type */ - unsigned short ax_options; /\&* 1 bit => Access X option enabled */ - unsigned short ax_timeout; /\&* seconds until Access X disabled */ - unsigned short axt_opts_mask; /\&* 1 bit => options to reset on Access X timeout */ - unsigned short axt_opts_values; /\&* 1 bit => turn option on, 0=> off */ - unsigned int axt_ctrls_mask; /\&* which bits in enabled_ctrls to modify */ - unsigned int axt_ctrls_values; /\&* values for new bits in enabled_ctrls */ - unsigned char per_key_repeat[XkbPerKeyBitArraySize]; /\&* per key auto repeat */ -} XkbControlsRec, *XkbControlsPtr; -.fi diff --git a/lib/libX11/man/xkb/XkbGetAutoRepeatRate.man b/lib/libX11/man/xkb/XkbGetAutoRepeatRate.man index ffbc8b8c7..3fb816b81 100644 --- a/lib/libX11/man/xkb/XkbGetAutoRepeatRate.man +++ b/lib/libX11/man/xkb/XkbGetAutoRepeatRate.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ for a keyboard device .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to X server .TP -.I \- device_spec +.I device_spec desired device ID, or XkbUseCoreKbd .TP -.I \- timeout_rtrn +.I timeout_rtrn backfilled with initial repeat delay, ms .TP -.I \- interval_rtrn +.I interval_rtrn backfilled with subsequent repeat delay, ms .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetAutoResetControls.man b/lib/libX11/man/xkb/XkbGetAutoResetControls.man index 667db5316..53e9a0220 100644 --- a/lib/libX11/man/xkb/XkbGetAutoResetControls.man +++ b/lib/libX11/man/xkb/XkbGetAutoResetControls.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,13 +32,13 @@ XkbGetAutoResetControls \- Gets the current values of the auto-reset controls .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy - connection to X server +.I dpy +connection to X server .TP -.I \- auto_ctrls - specifies which bits in auto_values are relevant +.I auto_ctrls +specifies which bits in auto_values are relevant .TP -.I \- auto_values +.I auto_values 1 bit => corresponding control has auto-reset on .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetBounceKeysDelay.man b/lib/libX11/man/xkb/XkbGetBounceKeysDelay.man deleted file mode 100644 index fe4a5a8f0..000000000 --- a/lib/libX11/man/xkb/XkbGetBounceKeysDelay.man +++ /dev/null @@ -1,211 +0,0 @@ -'\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbGetBounceKeysDelay __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbGetBounceKeysDelay \- Queries the current BounceKeys delay for a keyboard -device. -.SH SYNOPSIS -.HP -.B Bool XkbGetBounceKeysDelay -.BI "(\^Display *" "display" "\^," -.BI "unsigned int " "device_spec" "\^," -.BI "unsigned int *" "delay_rtrn" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- display -connection to X server -.TP -.I \- device_spec -device ID, or XkbUseCoreKbd -.TP -.I \- delay_rtrn -backfilled with bounce keys delay, ms -.SH DESCRIPTION -.LP -The server can generate XkbAccessXNotify events for some of the global keyboard -controls. -The detail field describes what AccessX event just occurred and can be any of -the values in -Table 1. - -.TS -c s -l l -l lw(4i). -Table 1 AccessXNotify Events -_ -detail Reason -_ -XkbAXN_SKPress T{ -A key was pressed when SlowKeys was enabled. -T} -XkbAXN_SKAccept T{ -A key was accepted (held longer than the SlowKeys delay). -T} -XkbAXN_SKRelease T{ -An accepted SlowKeys key was released. -T} -XkbAXN_SKReject T{ -A key was rejected (released before the SlowKeys delay expired). -T} -XkbAXN_BKAccept T{ -A key was accepted by BounceKeys. -T} -XkbAXN_BKReject T{ -A key was rejected (pressed before the BounceKeys delay expired). -T} -XkbAXN_AXKWarning T{ -AccessXKeys is about to turn on/off StickyKeys or BounceKeys. -T} -.TE - - -The -.I keycode -field reports the keycode of the key for which the event occurred. If the action -is related to -.I SlowKeys, -the -.I slowKeysDelay -field contains the current SlowKeys acceptance delay. If the action is related -to BounceKeys, -the -.I debounceDelay -field contains the current BounceKeys debounce delay. - -Selecting for AccessX Events - -To receive XkbAccessXNotify events under all possible conditions, use -.I XkbSelectEvents -and pass XkbAccesXNotifyMask in both -.I bits_to_change -and -.I values_for_bits. - -To receive XkbStateNotify events only under certain conditions, use -.I XkbSelectEventDetails -using XkbAccessXNotify as the -.I event_type -and specifying the desired state changes in -.I bits_to_change -and -.I values_for_bits -using mask bits from Table 2. - -.TS -c s s -l l l -l l lw(3i). -Table 2 AccessXNotify Event Details -_ -XkbAccessXNotify Event Details Value Circumstances -_ -XkbAXN_SKPressMask (1<<0) T{ -Slow key press notification wanted -T} -XkbAXN_SKAcceptMask (1<<1) T{ -Slow key accept notification wanted -T} -XkbAXN_SKRejectMask (1<<2) T{ -Slow key reject notification wanted -T} -XkbAXN_SKReleaseMask (1<<3) T{ -Slow key release notification wanted -T} -XkbAXN_BKAcceptMask (1<<4) T{ -Bounce key accept notification wanted -T} -XkbAXN_BKRejectMask (1<<5) T{ -Bounce key reject notification wanted -T} -XkbAXN_AXKWarningMask (1<<6) T{ -AccessX warning notification wanted -T} -XkbAllAccessXEventsMask (0x7f) T{ -All AccessX features notifications wanted -T} -.TE - -Some users may accidentally "bounce" on a key when they release it. They press -it once, then accidentally press it again after they release it. The BounceKeys -control temporarily disables a key after it has been pressed, effectively -"debouncing" the keyboard. The period of time the key is disabled after it is -released is known as the -.I BounceKeys delay. -BounceKeys is a boolean control. - -When the BounceKeys control is active, the server reports acceptance or -rejection of any key to interested clients by sending an appropriate -AccessXNotify event (see STRUCTURES). - -.I XkbGetBounceKeysDelay -requests the attributes of the BounceKeys control from the server, waits for a -reply, and backfills -.I delay_rtrn -with the BounceKeys delay attribute. -.I XkbGetBounceKeysDelay -returns True if successful; if a compatible version of the Xkb extension is not -available in the server -.I XkbGetSlowKeysDelay -returns False. -.SH "RETURN VALUES" -.TP 15 -True -The -.I XkbGetBounceKeysDelay -function returns True when it successfully requests the attributes of the -BounceKeys control from the server, waits for a -reply, and backfills -.I delay_rtrn -with the BounceKeys delay attribute. -.TP 15 -False -The -.I XkbGetBounceKeysDelay -function returns False if a compatible version of the Xkb extension is not -available in the server. -.SH STRUCTURES -.LP -The structure for the XkbAccessXNotify event type is as follows: - -.nf -typedef struct { - int type; /\&* Xkb extension base event code */ - unsigned long serial; /\&* X server serial number for event */ - Bool send_event; /\&* True => synthetically generated */ - Display * display; /\&* server connection where event generated */ - Time time; /\&* server time when event generated */ - int xkb_type; /\&* XkbAccessXNotify */ - int device; /\&* Xkb device ID, will not be XkbUseCoreKbd */ - int detail; /\&* XkbAXN_* */ - KeyCode keycode; /\&* key of event */ - int slowKeysDelay; /\&* current SlowKeys delay */ - int debounceDelay; /\&* current debounce delay */ -} XkbAccessXNotifyEvent; - -.fi -.SH "SEE ALSO" -.BR XkbGetSlowKeysDelay (__libmansuffix__) - diff --git a/lib/libX11/man/xkb/XkbGetCompatMap.man b/lib/libX11/man/xkb/XkbGetCompatMap.man index d7d0a88b5..35cea885f 100644 --- a/lib/libX11/man/xkb/XkbGetCompatMap.man +++ b/lib/libX11/man/xkb/XkbGetCompatMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ components from the server .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to server .TP -.I \- which +.I which mask of compatibility map components to fetch .TP -.I \- xkb +.I xkb keyboard description where results placed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetControls.man b/lib/libX11/man/xkb/XkbGetControls.man index fc9b8c036..3dd7f71b3 100644 --- a/lib/libX11/man/xkb/XkbGetControls.man +++ b/lib/libX11/man/xkb/XkbGetControls.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbGetControls \- Finds the current state of Xkb server controls .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to X server .TP -.I \- which +.I which mask of controls requested .TP -.I \- xkb +.I xkb keyboard description for controls information .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetControlsChanges.man b/lib/libX11/man/xkb/XkbGetControlsChanges.man index dd3f81bc4..48a795514 100644 --- a/lib/libX11/man/xkb/XkbGetControlsChanges.man +++ b/lib/libX11/man/xkb/XkbGetControlsChanges.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ XkbGetControlsChanges .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- xkb +.I xkb xkb->ctrls will be updated .TP -.I \- changes +.I changes indicates which parts of xkb->ctrls to update .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetDetectableAutoRepeat.man b/lib/libX11/man/xkb/XkbGetDetectableAutoRepeat.man index 5bffb759c..b008d23c3 100644 --- a/lib/libX11/man/xkb/XkbGetDetectableAutoRepeat.man +++ b/lib/libX11/man/xkb/XkbGetDetectableAutoRepeat.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,10 +32,10 @@ DetectableAutoRepeat .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to X server .TP -.I \- supported_rtrn +.I supported_rtrn backfilled True if DetectableAutoRepeat supported .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetDeviceButtonActions.man b/lib/libX11/man/xkb/XkbGetDeviceButtonActions.man index b3f8f7472..2bdb1c65b 100644 --- a/lib/libX11/man/xkb/XkbGetDeviceButtonActions.man +++ b/lib/libX11/man/xkb/XkbGetDeviceButtonActions.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -36,19 +36,19 @@ Extension device .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- device_info +.I device_info structure to update with results .TP -.I \- all_buttons +.I all_buttons True => get information for all buttons .TP -.I \- first_button +.I first_button number of first button for which info is desired .TP -.I \- num_buttons +.I num_buttons number of buttons for which info is desired .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetDeviceInfo.man b/lib/libX11/man/xkb/XkbGetDeviceInfo.man index d5a5d020e..b79ae6ad7 100644 --- a/lib/libX11/man/xkb/XkbGetDeviceInfo.man +++ b/lib/libX11/man/xkb/XkbGetDeviceInfo.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -37,19 +37,19 @@ extension device .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- which +.I which mask indicating information to return .TP -.I \- device_spec +.I device_spec device ID, or XkbUseCoreKbd .TP -.I \- ind_class +.I ind_class feedback class for indicator requests .TP -.I \- ind_id +.I ind_id feedback ID for indicator requests .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetDeviceInfoChanges.man b/lib/libX11/man/xkb/XkbGetDeviceInfoChanges.man index 69b5fb56e..ab6810022 100644 --- a/lib/libX11/man/xkb/XkbGetDeviceInfoChanges.man +++ b/lib/libX11/man/xkb/XkbGetDeviceInfoChanges.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -35,13 +35,13 @@ device .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- device_info +.I device_info structure to update with results .TP -.I \- changes +.I changes contains notes of changes that have occurred .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetDeviceLedInfo.man b/lib/libX11/man/xkb/XkbGetDeviceLedInfo.man index 81e066210..704ca0199 100644 --- a/lib/libX11/man/xkb/XkbGetDeviceLedInfo.man +++ b/lib/libX11/man/xkb/XkbGetDeviceLedInfo.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -36,19 +36,19 @@ with an LED feedback of an input extension device .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- device_info +.I device_info structure to update with results .TP -.I \- led_class +.I led_class LED feedback class assigned by input extension .TP -.I \- led_id +.I led_id LED feedback ID assigned by input extension .TP -.I \- which +.I which mask indicating desired information .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetGeometry.man b/lib/libX11/man/xkb/XkbGetGeometry.man index afe334607..38624c335 100644 --- a/lib/libX11/man/xkb/XkbGetGeometry.man +++ b/lib/libX11/man/xkb/XkbGetGeometry.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,10 +32,10 @@ description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to the X server .TP -.I \- xkb +.I xkb keyboard description that contains the ID for the keyboard and into which the geometry should be loaded .SH DESCRIPTION diff --git a/lib/libX11/man/xkb/XkbGetIndicatorChanges.man b/lib/libX11/man/xkb/XkbGetIndicatorChanges.man deleted file mode 100644 index 881c66931..000000000 --- a/lib/libX11/man/xkb/XkbGetIndicatorChanges.man +++ /dev/null @@ -1,153 +0,0 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbGetIndicatorChanges __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbGetIndicatorChanges \- Updates a local copy of the keyboard description with -the actual values of one or more calls to XkbNoteIndicatorChanges -.SH SYNOPSIS -.HP -.B Status XkbGetIndicatorChanges -.BI "(\^Display *" "dpy" "\^," -.BI "XkbDescPtr " "xkb" "\^," -.BI "XkbIndicatorChangesPtr " "changes" "\^," -.BI "unsigned int " "state" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- dpy -connection to the X server -.TP -.I \- xkb -keyboard description to hold the new values -.TP -.I \- changes -indicator maps/state to be obtained from the server -.TP -.I \- state -backfilled with the state of the indicators -.SH DESCRIPTION -.LP -Whenever an indicator changes state, the server sends XkbIndicatorStateNotify events to all -interested clients. Similarly, whenever an indicator's map changes, the server sends -XkbIndicatorMapNotify events to all interested clients. - -To receive XkbIndicatorStateNotify events, use -.I XkbSelectEvents -with both the -.I bits_to_change -and -.I values_for_bits -parameters containing XkbIndicatorStateNotifyMask. To receive XkbIndicatorMapNotify events, -use -.I XkbSelectEvents -with XkbIndicatorMapNotifyMask. - -To receive events for only specific indicators, use -.I XkbSelectEventDetails. -Set the -.I event_type -parameter to XkbIndicatorStateNotify or XkbIndicatorMapNotify, and set both the -.I bits_to_change -and -.I values_for_bits -detail parameters to a mask where each bit specifies one indicator, turning on those bits that -specify the indicators for which you want to receive events. - -Both types of indicator events use the same structure: -.nf - -typedef struct _XkbIndicatorNotify { - int type; /\&* Xkb extension base event code */ - unsigned long serial; /\&* X server serial number for event */ - Bool send_event; /\&* True => synthetically generated */ - Display * display; /\&* server connection where event generated */ - Time time; /\&* server time when event generated */ - int xkb_type; /\&* specifies state or map notify */ - int device; /\&* Xkb device ID, will not be XkbUseCoreKbd */ - unsigned int changed; /\&* mask of indicators with new state or map */ - unsigned int state; /\&* current state of all indicators */ -} XkbIndicatorNotifyEvent; - -.fi -.I xkb_type -is either XkbIndicatorStateNotify or XkbIndicatorMapNotify, depending on whether the event is -a kbIndicatorStateNotify event or kbIndicatorMapNotify event. - -The -.I changed -parameter is a mask that is the bitwise inclusive OR of the indicators that have changed. If -the event is of type XkbIndicatorMapNotify, -.I changed -reports the maps that changed. If the event is of type XkbIndicatorStateNotify, -.I changed -reports the indicators that have changed state. -.I state -is a mask that specifies the current state of all indicators, whether they have changed or -not, for both XkbIndicatorStateNotify and IndicatorMapNotify events. - -When your client application receives either a XkbIndicatorStateNotify event or -XkbIndicatorMapNotify event, you can note the changes in a changes structure by calling -.I XkbNoteIndicatorChanges. - -.I XkbGetIndicatorChanges -examines the -.I changes -parameter, pulls over the necessary information from the server, and copies the -results into the -.I xkb -keyboard description. If any bits are set in the -.I state_changes -field of -.I changes, XkbGetIndicatorChanges -also places the state of those indicators in -.I state. -If the -.I indicators -field of -.I xkb -is NULL, -.I XkbGetIndicatorChanges -allocates and initializes it. To free the -.I indicators -field, use -.I XkbFreeIndicators. -.SH DIAGNOSTICS -.TP 15 -.B BadAlloc -Unable to allocate storage -.TP 15 -.B BadImplementation -Invalid reply from server -.TP 15 -.B BadMatch -A compatible version of Xkb was not available in the server or an argument has -correct type and range, but is otherwise invalid -.SH "SEE ALSO" -.BR XkbFreeIndicators (__libmansuffix__), -.BR XkbGetIndicatorChanges (__libmansuffix__), -.BR XkbNoteIndicatorChanges (__libmansuffix__), -.BR XkbSelectEvents (__libmansuffix__), -.BR XkbSelectEventDetail (__libmansuffix__) - - - diff --git a/lib/libX11/man/xkb/XkbGetIndicatorMap.man b/lib/libX11/man/xkb/XkbGetIndicatorMap.man index 7da827973..52e40bc02 100644 --- a/lib/libX11/man/xkb/XkbGetIndicatorMap.man +++ b/lib/libX11/man/xkb/XkbGetIndicatorMap.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ specify the indicators .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to the X server .TP -.I \- which +.I which mask of indicators for which maps should be returned .TP -.I \- desc +.I desc keyboard description to be updated .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetIndicatorState.man b/lib/libX11/man/xkb/XkbGetIndicatorState.man index 850475283..1e6030b45 100644 --- a/lib/libX11/man/xkb/XkbGetIndicatorState.man +++ b/lib/libX11/man/xkb/XkbGetIndicatorState.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,13 +32,13 @@ XkbGetIndicatorState \- Obtains the current state of the keyboard indicators .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to the X server .TP -.I \- device_spec +.I device_spec device ID, or XkbUseCoreKbd .TP -.I \- state_return +.I state_return backfilled with a mask of the indicator state .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetKeyActions.man b/lib/libX11/man/xkb/XkbGetKeyActions.man index 726add48f..3c1076edd 100644 --- a/lib/libX11/man/xkb/XkbGetKeyActions.man +++ b/lib/libX11/man/xkb/XkbGetKeyActions.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ keys in a keyboard description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- first +.I first keycode of first key of interest .TP -.I \- num +.I num number of keys desired .TP -.I \- xkb +.I xkb pointer to keyboard description where result is stored .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetKeyBehaviors.man b/lib/libX11/man/xkb/XkbGetKeyBehaviors.man index 02b638b7c..02522d4c0 100644 --- a/lib/libX11/man/xkb/XkbGetKeyBehaviors.man +++ b/lib/libX11/man/xkb/XkbGetKeyBehaviors.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ a keyboard description from the server .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to server .TP -.I \- first +.I first keycode of first key to get .TP -.I \- num +.I num number of keys for which behaviors are desired .TP -.I \- xkb +.I xkb Xkb description to contain the result .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetKeyExplicitComponents.man b/lib/libX11/man/xkb/XkbGetKeyExplicitComponents.man index 8026d30bc..c9be4c754 100644 --- a/lib/libX11/man/xkb/XkbGetKeyExplicitComponents.man +++ b/lib/libX11/man/xkb/XkbGetKeyExplicitComponents.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -35,16 +35,16 @@ array) for a subset of the keys in a keyboard description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to server .TP -.I \- first +.I first keycode of first key to fetch .TP -.I \- num +.I num number of keys for which to get explicit info .TP -.I \- xkb +.I xkb Xkb description in which to put results .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetKeyModifierMap.man b/lib/libX11/man/xkb/XkbGetKeyModifierMap.man index 03a0ff974..5a9993643 100644 --- a/lib/libX11/man/xkb/XkbGetKeyModifierMap.man +++ b/lib/libX11/man/xkb/XkbGetKeyModifierMap.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ keyboard description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- first +.I first keycode of first key to get .TP -.I \- num +.I num number of keys for which information is desired .TP -.I \- xkb +.I xkb keyboard description to update .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetKeySyms.man b/lib/libX11/man/xkb/XkbGetKeySyms.man index a68da7f63..59efd6ade 100644 --- a/lib/libX11/man/xkb/XkbGetKeySyms.man +++ b/lib/libX11/man/xkb/XkbGetKeySyms.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- first +.I first keycode of first key to get .TP -.I \- num +.I num number of keycodes for which syms desired .TP -.I \- xkb +.I xkb Xkb description to be updated .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetKeyTypes.man b/lib/libX11/man/xkb/XkbGetKeyTypes.man index d685209c0..d904ac6fa 100644 --- a/lib/libX11/man/xkb/XkbGetKeyTypes.man +++ b/lib/libX11/man/xkb/XkbGetKeyTypes.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -35,16 +35,16 @@ keyboard mapping .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- first +.I first index to first type to get, 0 => 1st type .TP -.I \- num +.I num number of key types to be returned .TP -.I \- xkb +.I xkb keyboard description containing client map to update .SH DESCRIPTION .LP @@ -77,6 +77,6 @@ The Xkb extension has not been properly initialized .B BadValue An argument is out of range .SH "SEE ALSO" -.BR XkbKeyType (__libmansuffix__), -.BR XkbKeyTypeIndex (__libmansuffix__) +.BR XkbKeyKeyType (__libmansuffix__), +.BR XkbKeyKeyTypeIndex (__libmansuffix__) diff --git a/lib/libX11/man/xkb/XkbGetKeyVirtualModMap.man b/lib/libX11/man/xkb/XkbGetKeyVirtualModMap.man index 2416b6f3d..e82b84c75 100644 --- a/lib/libX11/man/xkb/XkbGetKeyVirtualModMap.man +++ b/lib/libX11/man/xkb/XkbGetKeyVirtualModMap.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ for a subset of the keys in a keyboard description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to server .TP -.I \- first +.I first keycode of first key to fetch .TP -.I \- num +.I num number of keys for which virtual mod maps are desired .TP -.I \- xkb +.I xkb Xkb description where results will be placed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetKeyboard.man b/lib/libX11/man/xkb/XkbGetKeyboard.man index ef44afb74..c5daf5b02 100644 --- a/lib/libX11/man/xkb/XkbGetKeyboard.man +++ b/lib/libX11/man/xkb/XkbGetKeyboard.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -47,7 +47,7 @@ determines events to be selected / deselected 1=>select, 0->deselect; for events in bits_to_change .SH DESCRIPTION .LP -.I XkbGetKeyboard +.B XkbGetKeyboard allocates and returns a pointer to a keyboard description. It queries the server for those components specified in the .I which @@ -76,17 +76,32 @@ XkbGeometryMask geom (1L<<6) XkbAllComponentsMask All Fields (1L<<7) .TE -.I XkbGetKeyboard +.B XkbGetKeyboard is used to read the current description for one or more components of a keyboard device. It calls -.I XkbGetKeyboardByName +.BR XkbGetKeyboardByName (__libmansuffix__) as follows: .I XkbGetKeyboardByName(dpy, device_spec, NULL, .I which, which, False). +.LP +If successful, +.B XkbGetKeyboard +returns a pointer to a newly allocated +.B XkbDescRec +structure, +which is described in +.BR XkbGetKeyboardByName (__libmansuffix__), +and which should be freed with +.BR XkbFreeKeyboard (__libmansuffix__). +If +.B XkbGetKeyboard +does not succeed, it returns +.BR NULL . .SH DIAGNOSTICS .TP 15 .SM BadAlloc Unable to allocate storage - +.SH "SEE ALSO" +.BR XkbGetKeyboardByName (__libmansuffix__) diff --git a/lib/libX11/man/xkb/XkbGetKeyboardByName.man b/lib/libX11/man/xkb/XkbGetKeyboardByName.man index ed50a13af..4eabdb7ad 100644 --- a/lib/libX11/man/xkb/XkbGetKeyboardByName.man +++ b/lib/libX11/man/xkb/XkbGetKeyboardByName.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -38,22 +38,22 @@ replace an active one .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- device_spec +.I device_spec device ID, or XkbUseCoreKbd .TP -.I \- names +.I names names of components to fetch .TP -.I \- want +.I want desired structures in returned record .TP -.I \- need +.I need mandatory structures in returned record .TP -.I \- load +.I load True => load into .I device_spec .SH DESCRIPTION diff --git a/lib/libX11/man/xkb/XkbGetMap.man b/lib/libX11/man/xkb/XkbGetMap.man index 45b55e730..b5d2f3fca 100644 --- a/lib/libX11/man/xkb/XkbGetMap.man +++ b/lib/libX11/man/xkb/XkbGetMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -35,13 +35,13 @@ client map and server map .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to X server .TP -.I \- which +.I which mask selecting subcomponents to populate .TP -.I \- device_spec +.I device_spec device_id, or XkbUseCoreKbd .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetNameChanges.man b/lib/libX11/man/xkb/XkbGetNameChanges.man deleted file mode 100644 index 359c7c963..000000000 --- a/lib/libX11/man/xkb/XkbGetNameChanges.man +++ /dev/null @@ -1,70 +0,0 @@ -'\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbGetNameChanges __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbGetNameChanges \- Update the local copy of the keyboard description with the -actual values of the results of one or more calls to -.I XkbNoteNameChanges -.SH SYNOPSIS -.HP -.B Status XkbGetNameChanges -.BI "(\^Display *" "dpy" "\^," -.BI "XkbDescPtr " "xkb" "\^," -.BI "XkbNameChangesPtr " "changes" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- dpy -connection to the X server -.TP -.I \- xkb -keyboard description to which names are copied -.TP -.I \- changes -names components to be obtained from the server -.SH DESCRIPTION -.LP -.I XkbGetNameChanges -examines the -.I changes -parameter, retrieves the necessary information from the server, and places the -results into the -.I xkb -keyboard description. - -.I XkbGetNamesChanges -can generate BadAlloc, BadImplementation, and BadMatch errors. -.SH DIAGNOSTICS -.TP 15 -.B BadAlloc -Unable to allocate storage -.TP 15 -.B BadImplementation -Invalid reply from server -.TP 15 -.B BadMatch -A compatible version of Xkb was not available in the server or an argument has -correct type and range, but is otherwise invalid -.SH "SEE ALSO" -.BR XkbNoteNameChanges (__libmansuffix__) diff --git a/lib/libX11/man/xkb/XkbGetNamedGeometry.man b/lib/libX11/man/xkb/XkbGetNamedGeometry.man index c7572a0d1..c8a4bb1b6 100644 --- a/lib/libX11/man/xkb/XkbGetNamedGeometry.man +++ b/lib/libX11/man/xkb/XkbGetNamedGeometry.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,13 +32,13 @@ by name .BI "Atom " "name" "\^);" .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to the X server .TP -.I \- xkb +.I xkb keyboard description into which the geometry should be loaded .TP -.I \- name +.I name name of the geometry to be loaded .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetNamedIndicator.man b/lib/libX11/man/xkb/XkbGetNamedIndicator.man index be65056b8..35a2990b8 100644 --- a/lib/libX11/man/xkb/XkbGetNamedIndicator.man +++ b/lib/libX11/man/xkb/XkbGetNamedIndicator.man @@ -1,4 +1,4 @@ -.\" Copyright 1999, 2017, Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, 2017, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -47,31 +47,31 @@ indicator by name .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to the X server .TP -.I \- dev_spec +.I dev_spec keyboard device ID, or XkbUseCoreKbd .TP -.I \- led_class +.I led_class feedback class, or XkbDfltXIClass .TP -.I \- led_id +.I led_id feedback ID, or XkbDfltXIId .TP -.I \- name +.I name name of the indicator to be retrieved .TP -.I \- ndx_rtrn +.I ndx_rtrn backfilled with the index of the retrieved indicator .TP -.I \- state_rtrn +.I state_rtrn backfilled with the current state of the retrieved indicator .TP -.I \- map_rtrn - backfilled with the mapping for the retrieved indicator +.I map_rtrn +backfilled with the mapping for the retrieved indicator .TP -.I \- real_rtrn +.I real_rtrn backfilled with True if the named indicator is real (physical) .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetNames.man b/lib/libX11/man/xkb/XkbGetNames.man index 9d5ca5e75..40a882d22 100644 --- a/lib/libX11/man/xkb/XkbGetNames.man +++ b/lib/libX11/man/xkb/XkbGetNames.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -28,18 +28,18 @@ XkbGetNames \- Obtain symbolic names from the server .B Status XkbGetNames .BI "(\^Display *" "dpy" "\^," .BI "unsigned int " "which" "\^," -.BI "XkbDescPtr " "Xkb" "\^);" +.BI "XkbDescPtr " "xkb" "\^);" .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to the X server .TP -.I \- which +.I which mask of names or map components to be updated .TP -.I \- Xkb +.I xkb keyboard description to be updated .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetSlowKeysDelay.man b/lib/libX11/man/xkb/XkbGetSlowKeysDelay.man deleted file mode 100644 index 485b3a1cb..000000000 --- a/lib/libX11/man/xkb/XkbGetSlowKeysDelay.man +++ /dev/null @@ -1,214 +0,0 @@ -'\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbGetSlowKeysDelay __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbGetSlowKeysDelay \- Gets the SlowKeys acceptance delay for a keyboard device -.SH SYNOPSIS -.HP -.B Bool XkbGetSlowKeysDelay -.BI "(\^Display *" "display" "\^," -.BI "unsigned int " "device_spec" "\^," -.BI "unsigned int *" "delay_rtrn" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- display -connection to X server -.TP -.I \- device_spec -device ID, or XkbUseCoreKbd -.TP -.I \- delay_rtrn -backfilled with SlowKeys delay, ms -.SH DESCRIPTION -.LP -Some users may accidentally bump keys while moving a hand or typing stick toward -the key they want. Usually, the keys that are accidentally bumped are just hit -for a very short period of time. The SlowKeys control helps filter these -accidental bumps by telling the server to wait a specified period, called the -.I SlowKeys acceptance delay, -before delivering key events. If the key is released before this period elapses, -no key events are generated. Users can then bump any number of keys on their way -to the one they want without accidentally getting those characters. Once they -have reached the key they want, they can then hold the desired key long enough -for the computer to accept it. SlowKeys is a boolean control with one -configurable attribute. - -When the SlowKeys control is active, the server reports the initial key press, -subsequent acceptance or rejection, and release of any key to interested clients -by sending an appropriate AccessXNotify event (see section 10.6.4). - -The server can generate XkbAccessXNotify events for some of the global keyboard -controls. -The detail field describes what AccessX event just occurred and can be any of -the values in -Table 1. -The server can generate XkbAccessXNotify events for some of the global keyboard -controls. -The detail field describes what AccessX event just occurred and can be any of -the values in -Table 1. - -.TS -c s -l l -l lw(4i). -Table 1 AccessXNotify Events -_ -detail Reason -_ -XkbAXN_SKPress T{ -A key was pressed when SlowKeys was enabled. -T} -XkbAXN_SKAccept T{ -A key was accepted (held longer than the SlowKeys delay). -T} -XkbAXN_SKRelease T{ -An accepted SlowKeys key was released. -T} -XkbAXN_SKReject T{ -A key was rejected (released before the SlowKeys delay expired). -T} -XkbAXN_BKAccept T{ -A key was accepted by BounceKeys. -T} -XkbAXN_BKReject T{ -A key was rejected (pressed before the BounceKeys delay expired). -T} -XkbAXN_AXKWarning T{ -AccessXKeys is about to turn on/off StickyKeys or BounceKeys. -T} -.TE - - -The -.I keycode -field reports the keycode of the key for which the event occurred. If the action -is related to -.I SlowKeys, -the -.I slowKeysDelay -field contains the current SlowKeys acceptance delay. If the action is related -to BounceKeys, -the -.I debounceDelay -field contains the current BounceKeys debounce delay. - -Selecting for AccessX Events - -To receive XkbAccessXNotify events under all possible conditions, use -.I XkbSelectEvents -and pass XkbAccesXNotifyMask in both -.I bits_to_change -and -.I values_for_bits. - -To receive XkbStateNotify events only under certain conditions, use -.I XkbSelectEventDetails -using XkbAccessXNotify as the -.I event_type -and specifying the desired state changes in -.I bits_to_change -and -.I values_for_bits -using mask bits from Table 2. - -.TS -c s s -l l l -l l lw(3i). -Table 2 AccessXNotify Event Details -_ -XkbAccessXNotify Event Details Value Circumstances -_ -XkbAXN_SKPressMask (1<<0) T{ -Slow key press notification wanted -T} -XkbAXN_SKAcceptMask (1<<1) T{ -Slow key accept notification wanted -T} -XkbAXN_SKRejectMask (1<<2) T{ -Slow key reject notification wanted -T} -XkbAXN_SKReleaseMask (1<<3) T{ -Slow key release notification wanted -T} -XkbAXN_BKAcceptMask (1<<4) T{ -Bounce key accept notification wanted -T} -XkbAXN_BKRejectMask (1<<5) T{ -Bounce key reject notification wanted -T} -XkbAXN_AXKWarningMask (1<<6) T{ -AccessX warning notification wanted -T} -XkbAllAccessXEventsMask (0x7f) T{ -All AccessX features notifications wanted -T} -.TE - -.I XkbGetSlowKeysDelay -requests the attributes of the SlowKeys control from the server, waits for a -reply and backfills -.I delay_rtrn -with the SlowKeys delay attribute. -.I XkbGetSlowKeysDelay -returns True if successful; , -.I XkbGetSlowKeysDelay -returns False. -.SH "RETURN VALUES" -.TP 15 -True -The -.I XkbGetSlowKeysDelay -function returns True if the request of the Slowkeys control from the server was -successful. -.I -.TP 15 -False -The -.I XkbGetSlowKeysDelay -function returns False if a compatible version of the Xkb extension is not -available in the server. -.SH STRUCTURES -.LP -The structure for the XkbAccessXNotify event type is as follows: - -.nf -typedef struct { - int type; /\&* Xkb extension base event code */ - unsigned long serial; /\&* X server serial number for event */ - Bool send_event; /\&* True => synthetically generated */ - Display * display; /\&* server connection where event generated */ - Time time; /\&* server time when event generated */ - int xkb_type; /\&* XkbAccessXNotify */ - int device; /\&* Xkb device ID, will not be XkbUseCoreKbd */ - int detail; /\&* XkbAXN_* */ - KeyCode keycode; /\&* key of event */ - int slowKeysDelay; /\&* current SlowKeys delay */ - int debounceDelay; /\&* current debounce delay */ -} XkbAccessXNotifyEvent; - -.fi - diff --git a/lib/libX11/man/xkb/XkbGetState.man b/lib/libX11/man/xkb/XkbGetState.man index 4547e592d..e46002db2 100644 --- a/lib/libX11/man/xkb/XkbGetState.man +++ b/lib/libX11/man/xkb/XkbGetState.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbGetStickyKeysOptions.man b/lib/libX11/man/xkb/XkbGetStickyKeysOptions.man deleted file mode 100644 index d691e9bfd..000000000 --- a/lib/libX11/man/xkb/XkbGetStickyKeysOptions.man +++ /dev/null @@ -1,115 +0,0 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbGetStickyKeysOptions __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbGetStickyKeysOptions \- Queries the current StickyKeys attributes for a keyboard device -.SH SYNOPSIS -.HP -.B Bool XkbGetStickyKeysOptions -.BI "(\^Display *" "display" "\^," -.BI "unsigned int " "device_spec" "\^," -.BI "unsigned int *" "options_rtrn" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- display -connection to X server -.TP -.I \- device_spec -device ID, or XkbUseCoreKbd -.TP -.I \- options_rtrn -backfilled with StickyKeys option mask -.SH DESCRIPTION -.LP -The StickyKeys control has two options that can be accessed via the -.I ax_options -of an XkbControlsRec structure. The first option, TwoKeys, specifies whether StickyKeys should -automatically turn off when two keys are pressed at the same time. This feature is useful for -shared computers so people who do not want them do not need to turn StickyKeys off if a previous -user left StickyKeys on. The second option, LatchToLock, specifies whether or not StickyKeys -locks a modifier when pressed twice in a row. - -.I XkbGetStickyKeysOptions -requests the attributes of the StickyKeys control from the server, waits for a reply, and -backfills -.I options_rtrn -with a mask indicating whether the individual StickyKeys options are on or off. Valid bits in -.I options_rtrn -are: -.nf - - XkbAX_TwoKeysMask - XkbAX_LatchToLockMask - -.fi -.I XkbGetStickyKeysOptions -returns True if successful; if a compatible version of the Xkb extension is not available in the -server -.I XkbGetStickyKeysOptions -returns False. -.SH "RETURN VALUES" -.TP 15 -True -The -.I XkbGetStickyKeysOptions -function returns True if the request for the attributes of the StickyKeys control from the -server was successful. -.TP 15 -False -The -.I XkbGetStickyKeysOptions -function returns False if a compatible version of the Xkb extension is not available in the -server. -.SH STRUCTURES -.nf -The XkbControlsRec structure is defined as follows: - - #define XkbMaxLegalKeyCode 255 - #define XkbPerKeyBitArraySize ((XkbMaxLegalKeyCode+1)/8) - - typedef struct { - unsigned char mk_dflt_btn; /\&* default button for keyboard driven mouse */ - unsigned char num_groups; /\&* number of keyboard groups */ - unsigned char groups_wrap; /\&* how to wrap out-of-bounds groups */ - XkbModsRec internal; /\&* defines server internal modifiers */ - XkbModsRec ignore_lock; /\&* modifiers to ignore when checking for grab */ - unsigned int enabled_ctrls; /\&* 1 bit => corresponding boolean control enabled */ - unsigned short repeat_delay; /\&* ms delay until first repeat */ - unsigned short repeat_interval; /\&* ms delay between repeats */ - unsigned short slow_keys_delay; /\&* ms minimum time key must be down to be ok */ - unsigned short debounce_delay; /\&* ms delay before key reactivated */ - unsigned short mk_delay; /\&* ms delay to second mouse motion event */ - unsigned short mk_interval; /\&* ms delay between repeat mouse events */ - unsigned short mk_time_to_max; /\&* # intervals until constant mouse move */ - unsigned short mk_max_speed; /\&* multiplier for maximum mouse speed */ - short mk_curve; /\&* determines mouse move curve type */ - unsigned short ax_options; /\&* 1 bit => Access X option enabled */ - unsigned short ax_timeout; /\&* seconds until Access X disabled */ - unsigned short axt_opts_mask; /\&* 1 bit => options to reset on Access X timeout */ - unsigned short axt_opts_values; /\&* 1 bit => turn option on, 0=> off */ - unsigned int axt_ctrls_mask; /\&* which bits in enabled_ctrls to modify */ - unsigned int axt_ctrls_values; /\&* values for new bits in enabled_ctrls */ - unsigned char per_key_repeat[XkbPerKeyBitArraySize]; /\&* per key auto repeat */ - } XkbControlsRec, *XkbControlsPtr; -.fi diff --git a/lib/libX11/man/xkb/XkbGetUpdatedMap.man b/lib/libX11/man/xkb/XkbGetUpdatedMap.man index 5ac077f9b..fd391c2e3 100644 --- a/lib/libX11/man/xkb/XkbGetUpdatedMap.man +++ b/lib/libX11/man/xkb/XkbGetUpdatedMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ keyboard description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to X server .TP -.I \- which +.I which mask selecting subcomponents to populate .TP -.I \- xkb +.I xkb keyboard description to be updated .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetVirtualMods.man b/lib/libX11/man/xkb/XkbGetVirtualMods.man index e17558056..a8602dff1 100644 --- a/lib/libX11/man/xkb/XkbGetVirtualMods.man +++ b/lib/libX11/man/xkb/XkbGetVirtualMods.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ array) in a keyboard description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to server .TP -.I \- which +.I which mask indicating virtual modifier bindings to get .TP -.I \- xkb +.I xkb Xkb description where results will be placed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbGetXlibControls.man b/lib/libX11/man/xkb/XkbGetXlibControls.man index 95ccb1edb..4b72fadfc 100644 --- a/lib/libX11/man/xkb/XkbGetXlibControls.man +++ b/lib/libX11/man/xkb/XkbGetXlibControls.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,7 +31,7 @@ XkbGetXlibControls \- Determines the current state of the Library Controls .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to X server .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbIgnoreExtension.man b/lib/libX11/man/xkb/XkbIgnoreExtension.man index c65e4a93d..1ecf38683 100644 --- a/lib/libX11/man/xkb/XkbIgnoreExtension.man +++ b/lib/libX11/man/xkb/XkbIgnoreExtension.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbInitCanonicalKeyTypes.man b/lib/libX11/man/xkb/XkbInitCanonicalKeyTypes.man index 45dde7bcc..bd00cb3e8 100644 --- a/lib/libX11/man/xkb/XkbInitCanonicalKeyTypes.man +++ b/lib/libX11/man/xkb/XkbInitCanonicalKeyTypes.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ client map to their default values .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description containing client map to initialize .TP -.I \- which +.I which mask of types to initialize .TP -.I \- keypadVMod +.I keypadVMod index of NumLock virtual modifier .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeyAction.man b/lib/libX11/man/xkb/XkbKeyAction.man index 39b3773a0..10a6fe597 100644 --- a/lib/libX11/man/xkb/XkbKeyAction.man +++ b/lib/libX11/man/xkb/XkbKeyAction.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,13 +32,13 @@ XkbKeyAction \- Returns the key action .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .TP -.I \- idx +.I idx index for group and shift level .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeyActionEntry.man b/lib/libX11/man/xkb/XkbKeyActionEntry.man index 56fa61c74..5d54ab581 100644 --- a/lib/libX11/man/xkb/XkbKeyActionEntry.man +++ b/lib/libX11/man/xkb/XkbKeyActionEntry.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -36,16 +36,16 @@ keycode .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .TP -.I \- shift +.I shift shift level within group .TP -.I \- grp +.I grp group index for group of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeyActionsPtr.man b/lib/libX11/man/xkb/XkbKeyActionsPtr.man index cfd30db36..809fbb0cd 100644 --- a/lib/libX11/man/xkb/XkbKeyActionsPtr.man +++ b/lib/libX11/man/xkb/XkbKeyActionsPtr.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,10 +34,10 @@ the key corresponding to keycode .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeyGroupInfo.man b/lib/libX11/man/xkb/XkbKeyGroupInfo.man index ba299d224..c57ebad3f 100644 --- a/lib/libX11/man/xkb/XkbKeyGroupInfo.man +++ b/lib/libX11/man/xkb/XkbKeyGroupInfo.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,10 +34,10 @@ keycode .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeyGroupWidth.man b/lib/libX11/man/xkb/XkbKeyGroupWidth.man index 8d2f9da48..33d4d9a70 100644 --- a/lib/libX11/man/xkb/XkbKeyGroupWidth.man +++ b/lib/libX11/man/xkb/XkbKeyGroupWidth.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -36,13 +36,13 @@ for the key corresponding to .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .TP -.I \- grp +.I grp group of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeyGroupsWidth.man b/lib/libX11/man/xkb/XkbKeyGroupsWidth.man index 84609d0d3..c42afa6b3 100644 --- a/lib/libX11/man/xkb/XkbKeyGroupsWidth.man +++ b/lib/libX11/man/xkb/XkbKeyGroupsWidth.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,10 +33,10 @@ corresponding to .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeyHasActions.man b/lib/libX11/man/xkb/XkbKeyHasActions.man index f95aaa549..4d05d926e 100644 --- a/lib/libX11/man/xkb/XkbKeyHasActions.man +++ b/lib/libX11/man/xkb/XkbKeyHasActions.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,10 +33,10 @@ has any actions associated with it .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeyType.man b/lib/libX11/man/xkb/XkbKeyKeyType.man index 6fcd21687..1dfd224a1 100644 --- a/lib/libX11/man/xkb/XkbKeyType.man +++ b/lib/libX11/man/xkb/XkbKeyKeyType.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -20,12 +20,12 @@ .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER .\" DEALINGS IN THE SOFTWARE. .\" -.TH XkbKeyType __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.TH XkbKeyKeyType __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeyType \- Obtain the index of a key type or the pointer to a key type +XkbKeyKeyType \- Obtain the index of a key type or the pointer to a key type .SH SYNOPSIS .HP -.B XkbKeyTypePtr XkbKeyType +.B XkbKeyTypePtr XkbKeyKeyType .BI "(\^XkbDescPtr " "xkb" "\^," .BI "KeyCode " "keycode" "\^," .BI "int " "group" "\^);" @@ -33,17 +33,17 @@ XkbKeyType \- Obtain the index of a key type or the pointer to a key type .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .TP -.I \- group +.I group group index .SH DESCRIPTION .LP -.I XkbKeyType +.I XkbKeyKeyType returns a pointer to the key type in the .I types vector of the client map in diff --git a/lib/libX11/man/xkb/XkbKeyTypeIndex.man b/lib/libX11/man/xkb/XkbKeyKeyTypeIndex.man index e198e7289..677c085fd 100644 --- a/lib/libX11/man/xkb/XkbKeyTypeIndex.man +++ b/lib/libX11/man/xkb/XkbKeyKeyTypeIndex.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -20,12 +20,12 @@ .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER .\" DEALINGS IN THE SOFTWARE. .\" -.TH XkbKeyTypeIndex __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.TH XkbKeyKeyTypeIndex __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME -XkbKeyTypeIndex \- Obtain the index of a key type or the pointer to a key type +XkbKeyKeyTypeIndex \- Obtain the index of a key type or the pointer to a key type .SH SYNOPSIS .HP -.B int XkbKeyTypeIndex +.B int XkbKeyKeyTypeIndex .BI "(\^XkbDescPtr " "xkb" "\^," .BI "KeyCode " "keycode" "\^," .BI "int " "group" "\^);" @@ -33,17 +33,17 @@ XkbKeyTypeIndex \- Obtain the index of a key type or the pointer to a key type .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .TP -.I \- group +.I group group index .SH DESCRIPTION .LP -.I XkbKeyTypeIndex +.I XkbKeyKeyTypeIndex computes an index into the .I types vector of the client map in diff --git a/lib/libX11/man/xkb/XkbKeyNumActions.man b/lib/libX11/man/xkb/XkbKeyNumActions.man index be7d7806e..7d249dde2 100644 --- a/lib/libX11/man/xkb/XkbKeyNumActions.man +++ b/lib/libX11/man/xkb/XkbKeyNumActions.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,10 +33,10 @@ keycode .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeyNumGroups.man b/lib/libX11/man/xkb/XkbKeyNumGroups.man index 32e75c9a9..fbb7c31f7 100644 --- a/lib/libX11/man/xkb/XkbKeyNumGroups.man +++ b/lib/libX11/man/xkb/XkbKeyNumGroups.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,10 +33,10 @@ corresponding to keycode .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeyNumSyms.man b/lib/libX11/man/xkb/XkbKeyNumSyms.man index 74b481270..f85393077 100644 --- a/lib/libX11/man/xkb/XkbKeyNumSyms.man +++ b/lib/libX11/man/xkb/XkbKeyNumSyms.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,10 +34,10 @@ to .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeySymEntry.man b/lib/libX11/man/xkb/XkbKeySymEntry.man index 8c8a7900d..fa221d56c 100644 --- a/lib/libX11/man/xkb/XkbKeySymEntry.man +++ b/lib/libX11/man/xkb/XkbKeySymEntry.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -38,16 +38,16 @@ from the two-dimensional array of keysyms for the key corresponding to .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .TP -.I \- shift +.I shift shift level of interest .TP -.I \- grp +.I grp group of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeySymsOffset.man b/lib/libX11/man/xkb/XkbKeySymsOffset.man deleted file mode 100644 index 123c54609..000000000 --- a/lib/libX11/man/xkb/XkbKeySymsOffset.man +++ /dev/null @@ -1,66 +0,0 @@ -'\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbKeySymsOffset __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbKeySymsOffset \- Returns the offset of the two-dimensional array of keysyms -for the key corresponding to -.I keycode -.SH SYNOPSIS -.HP -.B int XkbKeySymsOffset -.BI "(\^XkbDescPtr " "xkb" "\^," -.BI "KeyCode " "keycode" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- xkb -Xkb description of interest -.TP -.I \- keycode -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 -shift level is computed as: -.nf - - idx = group_index * key_width + shift_level - -.fi -The -.I offset -field of the -.I key_sym_map -entry for a key is used to access the beginning of the array. - -.I XkbKeySymsOffset -returns the offset of the two-dimensional array of keysyms for the key -corresponding to -.I keycode. diff --git a/lib/libX11/man/xkb/XkbKeySymsPtr.man b/lib/libX11/man/xkb/XkbKeySymsPtr.man index f423165ac..191a7b670 100644 --- a/lib/libX11/man/xkb/XkbKeySymsPtr.man +++ b/lib/libX11/man/xkb/XkbKeySymsPtr.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,10 +34,10 @@ the key corresponding to .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb Xkb description of interest .TP -.I \- keycode +.I keycode keycode of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeyTypesForCoreSymbols.man b/lib/libX11/man/xkb/XkbKeyTypesForCoreSymbols.man index e7678d5c2..3d6b40b93 100644 --- a/lib/libX11/man/xkb/XkbKeyTypesForCoreSymbols.man +++ b/lib/libX11/man/xkb/XkbKeyTypesForCoreSymbols.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -37,22 +37,22 @@ symbols bound to a key in a core keyboard mapping .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description in which to place symbols .TP -.I \- map_width +.I map_width width of core protocol keymap in xkb_syms_rtrn .TP -.I \- core_syms +.I core_syms core protocol format array of KeySyms .TP -.I \- protected +.I protected explicit key types .TP -.I \- types_inout +.I types_inout backfilled with the canonical types bound to groups one and two for the key .TP -.I \- xkb_syms_rtrn +.I xkb_syms_rtrn backfilled with symbols bound to the key in the Xkb mapping .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeycodeToKeysym.man b/lib/libX11/man/xkb/XkbKeycodeToKeysym.man index 32efa01d0..849f45d21 100644 --- a/lib/libX11/man/xkb/XkbKeycodeToKeysym.man +++ b/lib/libX11/man/xkb/XkbKeycodeToKeysym.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ group and shift level .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- kc +.I kc key of interest .TP -.I \- group +.I group group of interest .TP -.I \- level +.I level shift level of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbKeysymToModifiers.man b/lib/libX11/man/xkb/XkbKeysymToModifiers.man index acc432a77..1fcfb682a 100644 --- a/lib/libX11/man/xkb/XkbKeysymToModifiers.man +++ b/lib/libX11/man/xkb/XkbKeysymToModifiers.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,10 +32,10 @@ on the core keyboard .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- ks +.I ks keysym of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbLatchGroup.man b/lib/libX11/man/xkb/XkbLatchGroup.man index 8e7c431ab..3cc1fd35e 100644 --- a/lib/libX11/man/xkb/XkbLatchGroup.man +++ b/lib/libX11/man/xkb/XkbLatchGroup.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbLatchModifiers.man b/lib/libX11/man/xkb/XkbLatchModifiers.man index 940dc6d0f..a810139e4 100644 --- a/lib/libX11/man/xkb/XkbLatchModifiers.man +++ b/lib/libX11/man/xkb/XkbLatchModifiers.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbLibraryVersion.man b/lib/libX11/man/xkb/XkbLibraryVersion.man index fc00e78cd..cbc64cc6b 100644 --- a/lib/libX11/man/xkb/XkbLibraryVersion.man +++ b/lib/libX11/man/xkb/XkbLibraryVersion.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbListComponents.man b/lib/libX11/man/xkb/XkbListComponents.man index babdf5e50..95d97f52e 100644 --- a/lib/libX11/man/xkb/XkbListComponents.man +++ b/lib/libX11/man/xkb/XkbListComponents.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ XkbListComponents \- List of components for one or more component types .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- device_spec +.I device_spec device ID, or XkbUseCoreKbd .TP -.I \- ptrns +.I ptrns namelist for components of interest .TP -.I \- max_inout +.I max_inout max # returned names, # left over .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbLockGroup.man b/lib/libX11/man/xkb/XkbLockGroup.man index 413d5300f..09bf72699 100644 --- a/lib/libX11/man/xkb/XkbLockGroup.man +++ b/lib/libX11/man/xkb/XkbLockGroup.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbLockModifiers.man b/lib/libX11/man/xkb/XkbLockModifiers.man index 3d038235b..2286ed012 100644 --- a/lib/libX11/man/xkb/XkbLockModifiers.man +++ b/lib/libX11/man/xkb/XkbLockModifiers.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbLookupKeyBinding.man b/lib/libX11/man/xkb/XkbLookupKeyBinding.man index 7671ad585..25354c66c 100644 --- a/lib/libX11/man/xkb/XkbLookupKeyBinding.man +++ b/lib/libX11/man/xkb/XkbLookupKeyBinding.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -35,22 +35,22 @@ XkbLookupKeyBinding \- Find the string bound to a key by XRebindKeySym .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to server .TP -.I \- sym +.I sym connection to server .TP -.I \- state +.I state state for which string is to be looked up .TP -.I \- buf +.I buf buffer into which returned string is written .TP -.I \- nbytes +.I nbytes size of buffer in bytes .TP -.I \- extra_rtrn +.I extra_rtrn backfilled with number bytes overflow .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbLookupKeySym.man b/lib/libX11/man/xkb/XkbLookupKeySym.man index 8a8f0c108..2aeb0c81e 100644 --- a/lib/libX11/man/xkb/XkbLookupKeySym.man +++ b/lib/libX11/man/xkb/XkbLookupKeySym.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,19 +34,19 @@ XkbLookupKeySym \- Find the symbol associated with a key for a particular state .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- key +.I key key for which symbols are to be found .TP -.I \- state +.I state state for which symbol should be found .TP -.I \- mods_rtrn +.I mods_rtrn backfilled with consumed modifiers .TP -.I \- sym_rtrn +.I sym_rtrn backfilled with symbol associated with key + state .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbModActionVMods.man b/lib/libX11/man/xkb/XkbModActionVMods.man index bdf47db4b..8d7e2e7c4 100644 --- a/lib/libX11/man/xkb/XkbModActionVMods.man +++ b/lib/libX11/man/xkb/XkbModActionVMods.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,7 +32,7 @@ Xkb modifier description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action from which to extract virtual mods .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbNoteControlsChanges.man b/lib/libX11/man/xkb/XkbNoteControlsChanges.man index ad17d5df6..372e5ef8d 100644 --- a/lib/libX11/man/xkb/XkbNoteControlsChanges.man +++ b/lib/libX11/man/xkb/XkbNoteControlsChanges.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ event .if t .ti +.5i .SH ARGUMENTS .TP -.I \- changes +.I changes records changes indicated by new .TP -.I \- new +.I new tells which things have changed .TP -.I \- wanted +.I wanted tells which parts of new to record in changes .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbNoteDeviceChanges.man b/lib/libX11/man/xkb/XkbNoteDeviceChanges.man index ab36913c3..ff538802b 100644 --- a/lib/libX11/man/xkb/XkbNoteDeviceChanges.man +++ b/lib/libX11/man/xkb/XkbNoteDeviceChanges.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbNoteDeviceChanges \- Note device changes reported in an XkbExtensionDeviceNot .if t .ti +.5i .SH ARGUMENTS .TP -.I \- old +.I old structure tracking state changes .TP -.I \- new +.I new event indicating state changes .TP -.I \- wanted +.I wanted mask indicating changes to note .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbNoteIndicatorChanges.man b/lib/libX11/man/xkb/XkbNoteIndicatorChanges.man deleted file mode 100644 index 4a85e6aca..000000000 --- a/lib/libX11/man/xkb/XkbNoteIndicatorChanges.man +++ /dev/null @@ -1,123 +0,0 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbNoteIndicatorChanges __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbNoteIndicatorChanges \- Notes the changes in a changes structure -.SH SYNOPSIS -.HP -.B void XkbNoteIndicatorChanges -.BI "(\^XkbIndicatorChangesPtr " "old" "\^," -.BI "XkbIndicatorNotifyEvent *" "new" "\^," -.BI "unsigned int " "wanted" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- old -XkbIndicatorChanges structure to be updated -.TP -.I \- new -event from which changes are to be copied -.TP -.I \- wanted -which changes are to be noted -.SH DESCRIPTION -.LP -Whenever an indicator changes state, the server sends XkbIndicatorStateNotify events to all -interested clients. Similarly, whenever an indicator's map changes, the server sends -XkbIndicatorMapNotify events to all interested clients. - -To receive XkbIndicatorStateNotify events, use -.I XkbSelectEvents -with both the -.I bits_to_change -and -.I values_for_bits -parameters containing XkbIndicatorStateNotifyMask. To receive XkbIndicatorMapNotify events, -use -.I XkbSelectEvents -with XkbIndicatorMapNotifyMask. - -To receive events for only specific indicators, use -.I XkbSelectEventDetails. -Set the -.I event_type -parameter to XkbIndicatorStateNotify or XkbIndicatorMapNotify, and set both the -.I bits_to_change -and -.I values_for_bits -detail parameters to a mask where each bit specifies one indicator, turning on those bits that -specify the indicators for which you want to receive events. - -The -.I changed -parameter is a mask that is the bitwise inclusive OR of the indicators that have changed. If -the event is of type XkbIndicatorMapNotify, -.I changed -reports the maps that changed. If the event is of type XkbIndicatorStateNotify, -.I changed -reports the indicators that have changed state. -.I state -is a mask that specifies the current state of all indicators, whether they have changed or -not, for both XkbIndicatorStateNotify and IndicatorMapNotify events. - -When your client application receives either a XkbIndicatorStateNotify event or -XkbIndicatorMapNotify event, you can note the changes in a changes structure by calling -.I XkbNoteIndicatorChanges. - - -The -.I wanted -parameter is the bitwise inclusive OR of XkbIndicatorMapMask and -XkbIndicatorStateMask. -.I XkbNoteIndicatorChanges -copies any changes reported in -.I new -and specified in -.I wanted -into the changes record specified by -.I old. -.SH STRUCTURES -Both types of indicator events use the same structure: -.nf - -typedef struct _XkbIndicatorNotify { - int type; /\&* Xkb extension base event code */ - unsigned long serial; /\&* X server serial number for event */ - Bool send_event; /\&* True => synthetically generated */ - Display * display; /\&* server connection where event generated */ - Time time; /\&* server time when event generated */ - int xkb_type; /\&* specifies state or map notify */ - int device; /\&* Xkb device ID, will not be XkbUseCoreKbd */ - unsigned int changed; /\&* mask of indicators with new state or map */ - unsigned int state; /\&* current state of all indicators */ -} XkbIndicatorNotifyEvent; - -.fi -.I xkb_type -is either XkbIndicatorStateNotify or XkbIndicatorMapNotify, depending on whether the event is -a kbIndicatorStateNotify event or kbIndicatorMapNotify event. -.SH "SEE ALSO" -.BR XkbIndicatorMapMask (__libmansuffix__), -.BR XkbIndicatorStateMask (__libmansuffix__), -.BR XkbSelectEventDetails (__libmansuffix__), -.BR XkbSelectEvents (__libmansuffix__) diff --git a/lib/libX11/man/xkb/XkbNoteNameChanges.man b/lib/libX11/man/xkb/XkbNoteNameChanges.man index fe028f037..f0efd17bc 100644 --- a/lib/libX11/man/xkb/XkbNoteNameChanges.man +++ b/lib/libX11/man/xkb/XkbNoteNameChanges.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbNoteNameChanges \- Note the changed names in a changes structure .if t .ti +.5i .SH ARGUMENTS .TP -.I \- old +.I old XkbNameChanges structure to be updated .TP -.I \- new +.I new event from which changes are to be copied .TP -.I \- wanted +.I wanted types of names for which changes are to be noted .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbOpenDisplay.man b/lib/libX11/man/xkb/XkbOpenDisplay.man index 41b20c0c0..ff84f313f 100644 --- a/lib/libX11/man/xkb/XkbOpenDisplay.man +++ b/lib/libX11/man/xkb/XkbOpenDisplay.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbOutOfRangeGroupInfo.man b/lib/libX11/man/xkb/XkbOutOfRangeGroupInfo.man index d281edb7d..4803f67d7 100644 --- a/lib/libX11/man/xkb/XkbOutOfRangeGroupInfo.man +++ b/lib/libX11/man/xkb/XkbOutOfRangeGroupInfo.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,7 +32,7 @@ from the group_info field of an XkbSymMapRec structure .if t .ti +.5i .SH ARGUMENTS .TP -.I \- grp_inf +.I grp_inf Xkb description of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbOutOfRangeGroupNumber.man b/lib/libX11/man/xkb/XkbOutOfRangeGroupNumber.man index ce9419de0..bab5b29d7 100644 --- a/lib/libX11/man/xkb/XkbOutOfRangeGroupNumber.man +++ b/lib/libX11/man/xkb/XkbOutOfRangeGroupNumber.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,7 +32,7 @@ as a group index, from the group_info field of an XkbSymMapRec structure .if t .ti +.5i .SH ARGUMENTS .TP -.I \- grp_inf +.I grp_inf Xkb description of interest .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbPtrActionX.man b/lib/libX11/man/xkb/XkbPtrActionX.man index 409437d36..02bb0cd0f 100644 --- a/lib/libX11/man/xkb/XkbPtrActionX.man +++ b/lib/libX11/man/xkb/XkbPtrActionX.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,7 +32,7 @@ signed int .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action from which to extract X .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbPtrActionY.man b/lib/libX11/man/xkb/XkbPtrActionY.man index ccea0eb31..799d7161e 100644 --- a/lib/libX11/man/xkb/XkbPtrActionY.man +++ b/lib/libX11/man/xkb/XkbPtrActionY.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,7 +32,7 @@ signed int .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action from which to extract Y .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbQueryExtension.man b/lib/libX11/man/xkb/XkbQueryExtension.man index 9f73dd0aa..af2f63510 100644 --- a/lib/libX11/man/xkb/XkbQueryExtension.man +++ b/lib/libX11/man/xkb/XkbQueryExtension.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbRefreshKeyboardMapping.man b/lib/libX11/man/xkb/XkbRefreshKeyboardMapping.man index 29173b656..46987975e 100644 --- a/lib/libX11/man/xkb/XkbRefreshKeyboardMapping.man +++ b/lib/libX11/man/xkb/XkbRefreshKeyboardMapping.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,7 +31,7 @@ library .if t .ti +.5i .SH ARGUMENTS .TP -.I \- event +.I event event initiating remapping .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbResizeDeviceButtonActions.man b/lib/libX11/man/xkb/XkbResizeDeviceButtonActions.man index e88b346ed..d0618cf3d 100644 --- a/lib/libX11/man/xkb/XkbResizeDeviceButtonActions.man +++ b/lib/libX11/man/xkb/XkbResizeDeviceButtonActions.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,10 +32,10 @@ XkbResizeDeviceButtonActions \- Allocate additional space for button actions in .if t .ti +.5i .SH ARGUMENTS .TP -.I \- device_info +.I device_info structure in which to allocate button actions .TP -.I \- new_total +.I new_total new total number of button actions needed .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbResizeKeyActions.man b/lib/libX11/man/xkb/XkbResizeKeyActions.man index b316aaafe..b5cf34989 100644 --- a/lib/libX11/man/xkb/XkbResizeKeyActions.man +++ b/lib/libX11/man/xkb/XkbResizeKeyActions.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbResizeKeyActions \- Change the number of actions bound to a key .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description to change .TP -.I \- key +.I key keycode of key to change .TP -.I \- needed +.I needed new number of actions required .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbResizeKeySyms.man b/lib/libX11/man/xkb/XkbResizeKeySyms.man index 9219ee51d..788a2b552 100644 --- a/lib/libX11/man/xkb/XkbResizeKeySyms.man +++ b/lib/libX11/man/xkb/XkbResizeKeySyms.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbResizeKeySyms \- Change the number of symbols bound to a key .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description to be changed .TP -.I \- key +.I key keycode for key to modify .TP -.I \- needed +.I needed new number of keysyms required for key .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbResizeKeyType.man b/lib/libX11/man/xkb/XkbResizeKeyType.man index a19158a6f..cbed3d8c1 100644 --- a/lib/libX11/man/xkb/XkbResizeKeyType.man +++ b/lib/libX11/man/xkb/XkbResizeKeyType.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -35,19 +35,19 @@ XkbResizeKeyType \- Change the number of levels in a key type .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description containing client map to update .TP -.I \- type_ndx +.I type_ndx index in xkb->map->types of type to change .TP -.I \- map_count +.I map_count total # of map entries needed for the type .TP -.I \- want_preserve +.I want_preserve True => list of preserved modifiers is necessary .TP -.I \- new_num_lvls +.I new_num_lvls new max # of levels for type .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSAGroup.man b/lib/libX11/man/xkb/XkbSAGroup.man index 6f95688e4..3703263bf 100644 --- a/lib/libX11/man/xkb/XkbSAGroup.man +++ b/lib/libX11/man/xkb/XkbSAGroup.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -29,7 +29,7 @@ XkbSAGroup \- Returns the group_XXX field of act converted to a signed int .BI "(\^XkbAction " "act" "\^);" .SH ARGUMENTS .TP -.I \- act +.I act action from which to extract group .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSAPtrDfltValue.man b/lib/libX11/man/xkb/XkbSAPtrDfltValue.man index 14ffcb941..d795c4c4a 100644 --- a/lib/libX11/man/xkb/XkbSAPtrDfltValue.man +++ b/lib/libX11/man/xkb/XkbSAPtrDfltValue.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,7 +31,7 @@ XkbSAPtrDfltValue \- Returns the valueXXX field of act converted to a signed int .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action from which to extract group .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSARedirectSetVMods.man b/lib/libX11/man/xkb/XkbSARedirectSetVMods.man index de3c0e51f..49a5c8113 100644 --- a/lib/libX11/man/xkb/XkbSARedirectSetVMods.man +++ b/lib/libX11/man/xkb/XkbSARedirectSetVMods.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,10 +31,10 @@ XkbSARedirectSetVMods \- Sets the vmods0 and vmods1 of act from v .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action in which to set vmods .TP -.I \- v +.I v new value for virtual modifiers .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSARedirectSetVModsMask.man b/lib/libX11/man/xkb/XkbSARedirectSetVModsMask.man index ff83da0af..088ae51eb 100644 --- a/lib/libX11/man/xkb/XkbSARedirectSetVModsMask.man +++ b/lib/libX11/man/xkb/XkbSARedirectSetVModsMask.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,10 +33,10 @@ from vm .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action in which to set vmods .TP -.I \- vm +.I vm new value for virtual modifier mask .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSARedirectVMods.man b/lib/libX11/man/xkb/XkbSARedirectVMods.man index 909086889..cb176755d 100644 --- a/lib/libX11/man/xkb/XkbSARedirectVMods.man +++ b/lib/libX11/man/xkb/XkbSARedirectVMods.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,7 +31,7 @@ an unsigned int .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action from which to extract vmods .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSARedirectVModsMask.man b/lib/libX11/man/xkb/XkbSARedirectVModsMask.man index 8317b0b3a..ae97e6f43 100644 --- a/lib/libX11/man/xkb/XkbSARedirectVModsMask.man +++ b/lib/libX11/man/xkb/XkbSARedirectVModsMask.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,7 +31,7 @@ converted to an unsigned int .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action from which to extract vmods .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSAScreen.man b/lib/libX11/man/xkb/XkbSAScreen.man index 6d07758a4..e45e8157a 100644 --- a/lib/libX11/man/xkb/XkbSAScreen.man +++ b/lib/libX11/man/xkb/XkbSAScreen.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -31,7 +31,7 @@ XkbSAScreen \- Returns the screenXXX field of act converted to a signed int .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action from which to extract screen .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSASetGroup.man b/lib/libX11/man/xkb/XkbSASetGroup.man index 0eef50a39..54f99f21e 100644 --- a/lib/libX11/man/xkb/XkbSASetGroup.man +++ b/lib/libX11/man/xkb/XkbSASetGroup.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -30,10 +30,10 @@ XkbSASetGroup \- Sets the group_XXX field of act from the group index grp .BI "int " "grp" "\^);" .SH ARGUMENTS .TP -.I \- act +.I act action from which to set group .TP -.I \- grp +.I grp group index to set in group_XXX .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSASetPtrDfltValue.man b/lib/libX11/man/xkb/XkbSASetPtrDfltValue.man index d32f32c69..09da49a4b 100644 --- a/lib/libX11/man/xkb/XkbSASetPtrDfltValue.man +++ b/lib/libX11/man/xkb/XkbSASetPtrDfltValue.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,10 +32,10 @@ XkbSASetPtrDfltValue \- Sets the valueXXX field of act from val .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action in which to set valueXXX .TP -.I \- val +.I val value to set in valueXXX .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSASetScreen.man b/lib/libX11/man/xkb/XkbSASetScreen.man index 0ab650b3c..582acaa19 100644 --- a/lib/libX11/man/xkb/XkbSASetScreen.man +++ b/lib/libX11/man/xkb/XkbSASetScreen.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,10 +32,10 @@ XkbSASetScreen \- Sets the screenXXX field of act from s .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action in which to set screenXXX .TP -.I \- s +.I s value to set in screenXXX .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSelectEventDetails.man b/lib/libX11/man/xkb/XkbSelectEventDetails.man index cd341f96e..bd9800d3b 100644 --- a/lib/libX11/man/xkb/XkbSelectEventDetails.man +++ b/lib/libX11/man/xkb/XkbSelectEventDetails.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbSelectEvents.man b/lib/libX11/man/xkb/XkbSelectEvents.man index 09999b923..87c0f560c 100644 --- a/lib/libX11/man/xkb/XkbSelectEvents.man +++ b/lib/libX11/man/xkb/XkbSelectEvents.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbSetAccessXTimeout.man b/lib/libX11/man/xkb/XkbSetAccessXTimeout.man deleted file mode 100644 index c1043788e..000000000 --- a/lib/libX11/man/xkb/XkbSetAccessXTimeout.man +++ /dev/null @@ -1,193 +0,0 @@ -'\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbSetAccessXTimeout __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbSetAccessXTimeout \- Configures the AccessXTimeout options for a keyboard -device -.SH SYNOPSIS -.HP -.B Bool XkbSetAccessXTimeout -.BI "(\^Display *" "display" "\^," -.BI "unsigned int " "device_spec" "\^," -.BI "unsigned short " "timeout" "\^," -.BI "unsigned int " "ctrls_mask" "\^," -.BI "unsigned int " "ctrls_values" "\^," -.BI "unsigned short " "opts_mask" "\^," -.BI "unsigned short " "opts_values" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- display -connection to X server -.TP -.I \- device_spec -device to configure, or XkbUseCoreKbd -.TP -.I \- timeout -seconds idle until AccessXTimeout occurs -.TP -.I \- ctrls_mask -boolean controls to modify -.TP -.I \- ctrls_values -new bits for controls selected by ctrls_mask -.TP -.I \- opts_mask -ax_options to change -.TP -.I \- opts_values -new bits for ax_options selected by opts_mask -.SH DESCRIPTION -.LP -In environments where computers are shared, features such as SlowKeys present a -problem: if SlowKeys is on, the keyboard can appear to be unresponsive because -keys are not accepted until they are held for a certain period of time. To help -solve this problem, Xkb provides an AccessXTimeout control to automatically -change the enabled/disabled state of any boolean controls and to change the -value of the AccessXKeys and AccessXFeedback control attributes if the keyboard -is idle for a specified period of time. - -When a timeout as specified by AccessXTimeout occurs and a control is -consequently modified, Xkb generates an XkbControlsNotify event. For more -information on XkbControlsNotify events. - -.I timeout -specifies the number of seconds the keyboard must be idle before the controls -are modified. -.I ctrls_mask -specifies what controls are to be enabled or disabled, and -.I ctrls_values -specifies whether those controls are to be enabled or disabled. The bit values -correspond to those for enabling and disabling boolean controls using -.I XkbChangeEnabledControls. - The -.I opts_mask -field specifies which attributes of the AccessXKeys and AccessXFeedback controls -are to be changed, and -.I opts_values -specifies the new values for those options. The bit values correspond to those -for the -.I ax_options -field of an XkbDescRec. - -.I XkbSetAccessXTimeout -sends a request to configure the AccessXTimeout control to the server. It does -not wait for a reply, and normally returns True. If a compatible version of the -Xkb extension is not available in the server, -.I XkbSetAccessXTimeout -returns False. -.SH "RETURN VALUES" -.TP 15 -True -The -.I XkbSetAccessXTimeout -function returns True when a compatible version of the Xkb extension is available in the server. -.TP 15 -False -The -.I XkbSetAccessXTimeout -function returns False when a compatible version of the Xkb extension is not available in the server. -.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. - -.nf -typedef struct { - struct _XDisplay * display; /\&* connection to X server */ - unsigned short flags; /\&* private to Xkb, do not modify */ - unsigned short device_spec; /\&* device of interest */ - KeyCode min_key_code; /\&* minimum keycode for device */ - KeyCode max_key_code; /\&* maximum keycode for device */ - XkbControlsPtr ctrls; /\&* controls */ - XkbServerMapPtr server; /\&* server keymap */ - XkbClientMapPtr map; /\&* client keymap */ - XkbIndicatorPtr indicators; /\&* indicator map */ - XkbNamesPtr names; /\&* names for all components */ - XkbCompatMapPtr compat; /\&* compatibility map */ - XkbGeometryPtr geom; /\&* physical geometry of keyboard */ -} 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 -.I min_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 -shown in Table 1. - -.TS -c s s -l l l -l l l. -Table 1 Mask Bits for XkbDescRec -_ -Mask Bit XkbDescRec Field Value -_ -XkbControlsMask ctrls (1L<<0) -XkbServerMapMask server (1L<<1) -XkbIClientMapMask map (1L<<2) -XkbIndicatorMapMask indicators (1L<<3) -XkbNamesMask names (1L<<4) -XkbCompatMapMask compat (1L<<5) -XkbGeometryMask geom (1L<<6) -XkbAllComponentsMask All Fields (0x7f) -.TE - -The structure for the XkbControlsNotify event is defined as follows: -.nf - - typedef struct { - int type; /\&* Xkb extension base event code */ - unsigned long serial; /\&* X server serial number for event */ - Bool send_event; /\&* True => synthetically generated */ - Display * display; /\&* server connection where event generated */ - Time time; /\&* server time when event generated */ - int xkb_type; /\&* XkbCompatMapNotify */ - int device; /\&* Xkb device ID, will not be XkbUseCoreKbd */ - unsigned int changed_ctrls; /\&* bits indicating which controls data have changed*/ - unsigned int enabled_ctrls; /\&* controls currently enabled in server */ - unsigned int enabled_ctrl_changes; /\&* bits indicating enabled/disabled controls */ - int num_groups; /\&* current number of keyboard groups */ - KeyCode keycode; /\&* != 0 => keycode of key causing change */ - char event_type; /\&* Type of event causing change */ - char req_major; /\&* major event code of event causing change */ - char req_minor; /\&* minor event code of event causing change */ - } XkbControlsNotifyEvent; - -.fi -.SH "SEE ALSO" -.BR XkbChangeEnabledControls (__libmansuffix__) diff --git a/lib/libX11/man/xkb/XkbSetAutoRepeatRate.man b/lib/libX11/man/xkb/XkbSetAutoRepeatRate.man index 3deec37a6..327e9c523 100644 --- a/lib/libX11/man/xkb/XkbSetAutoRepeatRate.man +++ b/lib/libX11/man/xkb/XkbSetAutoRepeatRate.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ keyboard device .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to X server .TP -.I \- device_spec +.I device_spec device to configure, or XkbUseCoreKbd .TP -.I \- timeout +.I timeout initial delay, ms .TP -.I \- interval +.I interval delay between repeats, ms .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetAutoResetControls.man b/lib/libX11/man/xkb/XkbSetAutoResetControls.man index ecaf891f8..128da0e3c 100644 --- a/lib/libX11/man/xkb/XkbSetAutoResetControls.man +++ b/lib/libX11/man/xkb/XkbSetAutoResetControls.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,16 +34,16 @@ attributes .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- changes +.I changes controls for which to change auto-reset values .TP -.I \- auto_ctrls +.I auto_ctrls controls from changes that should auto reset .TP -.I \- auto_values +.I auto_values 1 bit => auto-reset on .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetBounceKeysDelay.man b/lib/libX11/man/xkb/XkbSetBounceKeysDelay.man deleted file mode 100644 index e6f11b1d1..000000000 --- a/lib/libX11/man/xkb/XkbSetBounceKeysDelay.man +++ /dev/null @@ -1,206 +0,0 @@ -'\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. -.\" -.\" Permission is hereby granted, free of charge, to any person obtaining a -.\" copy of this software and associated documentation files (the "Software"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbSetBounceKeysDelay __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbSetBounceKeysDelay \- Sets the BounceKeys delay for a keyboard device -.SH SYNOPSIS -.HP -.B Bool XkbSetBounceKeysDelay -.BI "(\^Display *" "display" "\^," -.BI "unsigned int " "device_spec" "\^," -.BI "unsigned int *" "delay" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- display -connection to X server -.TP -.I \- device_spec -device ID, or XkbUseCoreKbd -.TP -.I \- delay -backfilled with bounce keys delay, ms -.SH DESCRIPTION -.LP -The server can generate XkbAccessXNotify events for some of the global keyboard -controls. -The detail field describes what AccessX event just occurred and can be any of -the values in -Table 1. - -.TS -c s -l l -l lw(4i). -Table 1 AccessXNotify Events -_ -detail Reason -_ -XkbAXN_SKPress T{ -A key was pressed when SlowKeys was enabled. -T} -XkbAXN_SKAccept T{ -A key was accepted (held longer than the SlowKeys delay). -T} -XkbAXN_SKRelease T{ -An accepted SlowKeys key was released. -T} -XkbAXN_SKReject T{ -A key was rejected (released before the SlowKeys delay expired). -T} -XkbAXN_BKAccept T{ -A key was accepted by BounceKeys. -T} -XkbAXN_BKReject T{ -A key was rejected (pressed before the BounceKeys delay expired). -T} -XkbAXN_AXKWarning T{ -AccessXKeys is about to turn on/off StickyKeys or BounceKeys. -T} -.TE - -The -.I keycode -field reports the keycode of the key for which the event occurred. If the action -is related to -.I SlowKeys, -the -.I slowKeysDelay -field contains the current SlowKeys acceptance delay. If the action is related -to BounceKeys, -the -.I debounceDelay -field contains the current BounceKeys debounce delay. - -Selecting for AccessX Events - -To receive XkbAccessXNotify events under all possible conditions, use -.I XkbSelectEvents -and pass XkbAccesXNotifyMask in both -.I bits_to_change -and -.I values_for_bits. - -To receive XkbStateNotify events only under certain conditions, use -.I XkbSelectEventDetails -using XkbAccessXNotify as the -.I event_type -and specifying the desired state changes in -.I bits_to_change -and -.I values_for_bits -using mask bits from Table 2. - -.TS -c s s -l l l -l l lw(3i). -Table 2 AccessXNotify Event Details -_ -XkbAccessXNotify Event Details Value Circumstances -_ -XkbAXN_SKPressMask (1<<0) T{ -Slow key press notification wanted -T} -XkbAXN_SKAcceptMask (1<<1) T{ -Slow key accept notification wanted -T} -XkbAXN_SKRejectMask (1<<2) T{ -Slow key reject notification wanted -T} -XkbAXN_SKReleaseMask (1<<3) T{ -Slow key release notification wanted -T} -XkbAXN_BKAcceptMask (1<<4) T{ -Bounce key accept notification wanted -T} -XkbAXN_BKRejectMask (1<<5) T{ -Bounce key reject notification wanted -T} -XkbAXN_AXKWarningMask (1<<6) T{ -AccessX warning notification wanted -T} -XkbAllAccessXEventsMask (0x7f) T{ -All AccessX features notifications wanted -T} -.TE - -Some users may accidentally "bounce" on a key when they release it. They press -it once, then accidentally press it again after they release it. The BounceKeys -control temporarily disables a key after it has been pressed, effectively -"debouncing" the keyboard. The period of time the key is disabled after it is -released is known as the -.I BounceKeys delay. -BounceKeys is a boolean control. - -When the BounceKeys control is active, the server reports acceptance or -rejection of any key to interested clients by sending an appropriate -AccessXNotify event. - -.I XkbSetBounceKeysDelay -sends a request to configure the BounceKeys control to the server. It does not -wait for a reply and normally returns True. Specifying a value of zero for the -delay parameter causes -.I XkbSetBounceKeysDelay -to generate a BadValue protocol error. If a compatible version of the Xkb -extension is not available in the server, -.I XkbSetBounceKeysDelay -returns False. -.SH "RETURN VALUES" -.TP 15 -True -The -.I XkbSetBounceKeysDelay -function returns True when it sends a request to configure the BounceKeys -control to the server. -.TP 15 -False -The -.I XkbSetBounceKeysDelay -function returns False if a compatible version of the Xkb extension is not -available in the server. -.SH STRUCTURES -.LP -The structure for the XkbAccessXNotify event type is as follows: - -.nf -typedef struct { - int type; /\&* Xkb extension base event code */ - unsigned long serial; /\&* X server serial number for event */ - Bool send_event; /\&* True => synthetically generated */ - Display * display; /\&* server connection where event generated */ - Time time; /\&* server time when event generated */ - int xkb_type; /\&* XkbAccessXNotify */ - int device; /\&* Xkb device ID, will not be XkbUseCoreKbd */ - int detail; /\&* XkbAXN_* */ - KeyCode keycode; /\&* key of event */ - int slowKeysDelay; /\&* current SlowKeys delay */ - int debounceDelay; /\&* current debounce delay */ -} XkbAccessXNotifyEvent; - -.fi -.SH DIAGNOSTICS -.TP 15 -.B BadValue -An argument is out of range diff --git a/lib/libX11/man/xkb/XkbSetCompatMap.man b/lib/libX11/man/xkb/XkbSetCompatMap.man index 50f0224b7..c6e0be32b 100644 --- a/lib/libX11/man/xkb/XkbSetCompatMap.man +++ b/lib/libX11/man/xkb/XkbSetCompatMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbSetControls.man b/lib/libX11/man/xkb/XkbSetControls.man index 8993ad089..ebcb7acfb 100644 --- a/lib/libX11/man/xkb/XkbSetControls.man +++ b/lib/libX11/man/xkb/XkbSetControls.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ structure in a local copy of the keyboard description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to X server .TP -.I \- which +.I which mask of controls requested .TP -.I \- xkb +.I xkb keyboard description for controls information .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetDebuggingFlags.man b/lib/libX11/man/xkb/XkbSetDebuggingFlags.man index 358ccf83f..c27952cf1 100644 --- a/lib/libX11/man/xkb/XkbSetDebuggingFlags.man +++ b/lib/libX11/man/xkb/XkbSetDebuggingFlags.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -38,28 +38,28 @@ XkbSetDebuggingFlags \- Change the values of any of the debug controls .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to X server .TP -.I \- mask +.I mask mask selecting debug output flags to change .TP -.I \- flags +.I flags values for debug output flags selected by mask .TP -.I \- msg +.I msg message to print right now .TP -.I \- ctrls_mask +.I ctrls_mask mask selecting debug controls to change .TP -.I \- ctrls +.I ctrls values for debug controls selected by ctrls_mask .TP -.I \- ret_flags +.I ret_flags resulting state of all debug output flags .TP -.I \- ret_ctrls +.I ret_ctrls resulting state of all debug controls .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetDetectableAutoRepeat.man b/lib/libX11/man/xkb/XkbSetDetectableAutoRepeat.man index c54b349be..3f3340ea3 100644 --- a/lib/libX11/man/xkb/XkbSetDetectableAutoRepeat.man +++ b/lib/libX11/man/xkb/XkbSetDetectableAutoRepeat.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -30,13 +30,13 @@ XkbSetDetectableAutoRepeat \- Sets DetectableAutoRepeat .BI "Bool *" "supported_rtrn" "\^);" .SH ARGUMENTS .TP -.I \- display +.I display connection to X server .TP -.I \- detectable +.I detectable True => set DetectableAutoRepeat .TP -.I \- supported_rtrn +.I supported_rtrn backfilled True if DetectableAutoRepeat supported .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetDeviceButtonActions.man b/lib/libX11/man/xkb/XkbSetDeviceButtonActions.man index 122fc45f2..ed6b2ccc9 100644 --- a/lib/libX11/man/xkb/XkbSetDeviceButtonActions.man +++ b/lib/libX11/man/xkb/XkbSetDeviceButtonActions.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -32,16 +32,16 @@ XkbSetDeviceButtonActions \- Change only the button actions for an input extensi .BI "unsigned int " "num_buttons" "\^);" .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- device +.I device structure defining the device and modifications .TP -.I \- first_button +.I first_button number of first button to update, 0 relative .TP -.I \- num_buttons +.I num_buttons number of buttons to update .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetDeviceInfo.man b/lib/libX11/man/xkb/XkbSetDeviceInfo.man index 062dbcaed..0e4b7f3d1 100644 --- a/lib/libX11/man/xkb/XkbSetDeviceInfo.man +++ b/lib/libX11/man/xkb/XkbSetDeviceInfo.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,13 +34,13 @@ Extension device .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- which +.I which mask indicating characteristics to modify .TP -.I \- device_info +.I device_info structure defining the device and modifications .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetIgnoreLockMods.man b/lib/libX11/man/xkb/XkbSetIgnoreLockMods.man index 7e6acd572..e16736291 100644 --- a/lib/libX11/man/xkb/XkbSetIgnoreLockMods.man +++ b/lib/libX11/man/xkb/XkbSetIgnoreLockMods.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -37,22 +37,22 @@ reported in matching events to passive grabs .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to the X server .TP -.I \- device_spec +.I device_spec device ID, or XkbUseCoreKbd .TP -.I \- affect_real +.I affect_real mask of real modifiers affected by this call .TP -.I \- real_values +.I real_values values for affected real modifiers (1=>set, 0=>unset) .TP -.I \- affect_virtual +.I affect_virtual mask of virtual modifiers affected by this call .TP -.I \- virtual_values +.I virtual_values values for affected virtual modifiers (1=>set, 0=>unset) .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetIndicatorMap.man b/lib/libX11/man/xkb/XkbSetIndicatorMap.man index 5d5a48b2c..24db4e795 100644 --- a/lib/libX11/man/xkb/XkbSetIndicatorMap.man +++ b/lib/libX11/man/xkb/XkbSetIndicatorMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -35,13 +35,13 @@ or more indicators .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to the X server .TP -.I \- which +.I which mask of indicators to change .TP -.I \- desc +.I desc keyboard description from which the maps are taken .SH DESCRIPTION .LP @@ -102,7 +102,9 @@ Indicator Drives Keyboard _ which_mods New State Effect on Keyboard Modifiers _ -XkbIM_UseNone or XkbIM_UseBase On or Off No Effect +XkbIM_UseNone or +.br +XkbIM_UseBase On or Off No Effect XkbIM_UseLatched On T{ Any modifiers specified in the mask field of mods are added to the latched modifiers. @@ -111,7 +113,11 @@ XkbIM_UseLatched Off T{ Any modifiers specified in the mask field of mods are removed from the latched modifiers. T} -XkbIM_UseLocked, XkbIM_UseCompat, or XkbIM_UseEffective On T{ +XkbIM_UseLocked, +.br +XkbIM_UseCompat, or +.br +XkbIM_UseEffective On T{ Any modifiers specified in the mask field of mods are added to the locked modifiers. T} @@ -119,7 +125,9 @@ XkbIM_UseLocked Off T{ Any modifiers specified in the mask field of mods are removed from the locked modifiers. T} -XkbIM_UseCompat or XkbIM_UseEffective Off T{ +XkbIM_UseCompat or +.br +XkbIM_UseEffective Off T{ Any modifiers specified in the mask field of mods are removed from both the locked and latched modifiers. T} @@ -129,8 +137,8 @@ If XkbIM_LEDDrivesKB is set and XkbIM_NoExplicit is not, and if you call a function that updates the server's image of the indicator map (such as .I XkbSetIndicatorMap or -.I XkbSetNamedIndicator), - Xkb changes the keyboard state and controls to reflect the other fields of the +.IR XkbSetNamedIndicator ), +Xkb changes the keyboard state and controls to reflect the other fields of the indicator map. If you attempt to explicitly change the value of an indicator for which XkbIM_LEDDrivesKB is absent or for which XkbIM_NoExplicit is present, keyboard state or controls are unaffected. diff --git a/lib/libX11/man/xkb/XkbSetMap.man b/lib/libX11/man/xkb/XkbSetMap.man index dee27cdc8..bff7c284e 100644 --- a/lib/libX11/man/xkb/XkbSetMap.man +++ b/lib/libX11/man/xkb/XkbSetMap.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/man/xkb/XkbSetModActionVMods.man b/lib/libX11/man/xkb/XkbSetModActionVMods.man index cb2178b1b..c130a5946 100644 --- a/lib/libX11/man/xkb/XkbSetModActionVMods.man +++ b/lib/libX11/man/xkb/XkbSetModActionVMods.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,10 +33,10 @@ format of an Xkb modifier description .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action in which to set vmods .TP -.I \- vmods +.I vmods virtual mods to set .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetNamedIndicator.man b/lib/libX11/man/xkb/XkbSetNamedIndicator.man index 81df50fce..2bf7bd3c4 100644 --- a/lib/libX11/man/xkb/XkbSetNamedIndicator.man +++ b/lib/libX11/man/xkb/XkbSetNamedIndicator.man @@ -1,4 +1,4 @@ -.\" Copyright 1999, 2017, Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, 2017, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -48,31 +48,31 @@ indicator map for the indicator .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to the X server .TP -.I \- device_spec +.I device_spec device ID, or XkbUseCoreKbd .TP -.I \- led_class +.I led_class feedback class, or XkbDfltXIClass .TP -.I \- led_id +.I led_id feedback ID, or XkbDfltXIId .TP -.I \- name +.I name name of the indicator to change .TP -.I \- change_state +.I change_state whether to change the indicator state or not .TP -.I \- state +.I state desired new state for the indicator .TP -.I \- create_new +.I create_new whether a new indicator with the specified name should be created when necessary .TP -.I \- map +.I map new map for the indicator .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetNames.man b/lib/libX11/man/xkb/XkbSetNames.man index 82c9ccdb4..6295e439d 100644 --- a/lib/libX11/man/xkb/XkbSetNames.man +++ b/lib/libX11/man/xkb/XkbSetNames.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -35,19 +35,19 @@ XkbSetNames \- Change the symbolic names in the server .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to the X server .TP -.I \- which +.I which mask of names or map components to be changed .TP -.I \- first_type +.I first_type first type whose name is to be changed .TP -.I \- num_types +.I num_types number of types for which names are to be changed .TP -.I \- xkb +.I xkb keyboard description from which names are to be taken .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetPtrActionX.man b/lib/libX11/man/xkb/XkbSetPtrActionX.man index d2910c883..60896bf56 100644 --- a/lib/libX11/man/xkb/XkbSetPtrActionX.man +++ b/lib/libX11/man/xkb/XkbSetPtrActionX.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,10 +33,10 @@ integer value x .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action in which to set X .TP -.I \- x +.I x new value to set .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetPtrActionY.man b/lib/libX11/man/xkb/XkbSetPtrActionY.man index 410a4d4b3..acbf02312 100644 --- a/lib/libX11/man/xkb/XkbSetPtrActionY.man +++ b/lib/libX11/man/xkb/XkbSetPtrActionY.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,10 +33,10 @@ integer value y .if t .ti +.5i .SH ARGUMENTS .TP -.I \- act +.I act action in which to set Y .TP -.I \- y +.I y new value to set .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetServerInternalMods.man b/lib/libX11/man/xkb/XkbSetServerInternalMods.man index 193d216f9..ac8be546b 100644 --- a/lib/libX11/man/xkb/XkbSetServerInternalMods.man +++ b/lib/libX11/man/xkb/XkbSetServerInternalMods.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -37,22 +37,22 @@ before events are delivered to the client .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to the X server .TP -.I \- device_spec +.I device_spec device ID, or XkbUseCoreKbd .TP -.I \- affect_real +.I affect_real mask of real modifiers affected by this call .TP -.I \- real_values +.I real_values values for affected real modifiers (1=>set, 0=>unset) .TP -.I \- affect_virtual +.I affect_virtual mask of virtual modifiers affected by this call .TP -.I \- virtual_values +.I virtual_values values for affected virtual modifiers (1=>set, 0=>unset) .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbSetXlibControls.man b/lib/libX11/man/xkb/XkbSetXlibControls.man index 05a289899..1d62bf2e9 100644 --- a/lib/libX11/man/xkb/XkbSetXlibControls.man +++ b/lib/libX11/man/xkb/XkbSetXlibControls.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ XkbSetXlibControls \- Changes the state of the Library Controls .if t .ti +.5i .SH ARGUMENTS .TP -.I \- display +.I display connection to X server .TP -.I \- bits_to_change +.I bits_to_change selects controls to be modified .TP -.I \- values_for_bits +.I values_for_bits turns selected controls on (1) or off (0) .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbTranslateKeyCode.man b/lib/libX11/man/xkb/XkbTranslateKeyCode.man index e234412f2..e1fdd674a 100644 --- a/lib/libX11/man/xkb/XkbTranslateKeyCode.man +++ b/lib/libX11/man/xkb/XkbTranslateKeyCode.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -34,19 +34,19 @@ XkbTranslateKeyCode \- Translate a keycode to a key symbol and modifiers .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description to use for translation .TP -.I \- key +.I key keycode to translate .TP -.I \- mods +.I mods modifiers to apply when translating key .TP -.I \- mods_rtrn +.I mods_rtrn backfilled with consumed modifiers .TP -.I \- keysym_rtrn +.I keysym_rtrn keysym resulting from translation .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbTranslateKeySym.man b/lib/libX11/man/xkb/XkbTranslateKeySym.man index 9a23ce283..cbefa0ad3 100644 --- a/lib/libX11/man/xkb/XkbTranslateKeySym.man +++ b/lib/libX11/man/xkb/XkbTranslateKeySym.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -36,22 +36,22 @@ given keyboard state .if t .ti +.5i .SH ARGUMENTS .TP -.I \- dpy +.I dpy connection to X server .TP -.I \- sym_inout +.I sym_inout symbol to be translated; result of translation .TP -.I \- mods +.I mods modifiers to apply to sym_inout .TP -.I \- buf +.I buf buffer into which returned string is written .TP -.I \- nbytes +.I nbytes size of buffer in bytes .TP -.I \- extra_rtrn +.I extra_rtrn number of bytes overflow .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbUpdateMapFromCore.man b/lib/libX11/man/xkb/XkbUpdateMapFromCore.man index e65d598d2..df8832292 100644 --- a/lib/libX11/man/xkb/XkbUpdateMapFromCore.man +++ b/lib/libX11/man/xkb/XkbUpdateMapFromCore.man @@ -1,5 +1,5 @@ '\" t -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -37,22 +37,22 @@ expressed by a core format mapping .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description to update .TP -.I \- first_key +.I first_key keycode of first key description to update .TP -.I \- num_keys +.I num_keys number of key descriptions to update .TP -.I \- map_width +.I map_width width of core protocol keymap .TP -.I \- core_keysyms +.I core_keysyms symbols in core protocol keymap .TP -.I \- changes +.I changes backfilled with changes made to Xkb .SH DESCRIPTION .LP diff --git a/lib/libX11/man/xkb/XkbVirtualModsToReal.man b/lib/libX11/man/xkb/XkbVirtualModsToReal.man index 9c1ebbf4a..e383663ee 100644 --- a/lib/libX11/man/xkb/XkbVirtualModsToReal.man +++ b/lib/libX11/man/xkb/XkbVirtualModsToReal.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright (c) 1999, Oracle and/or its affiliates. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -33,13 +33,13 @@ protocol modifiers .if t .ti +.5i .SH ARGUMENTS .TP -.I \- xkb +.I xkb keyboard description for input device .TP -.I \- virtual_mask +.I virtual_mask virtual modifier mask to translate .TP -.I \- mask_rtrn +.I mask_rtrn backfilled with real modifiers .SH DESCRIPTION .LP diff --git a/lib/libX11/specs/Makefile.am b/lib/libX11/specs/Makefile.am index 6d49014a7..c1099130d 100644 --- a/lib/libX11/specs/Makefile.am +++ b/lib/libX11/specs/Makefile.am @@ -1,5 +1,5 @@ # -# Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. +# Copyright (c) 2010, Oracle and/or its affiliates. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/specs/Makefile.in b/lib/libX11/specs/Makefile.in index 2c61e9abc..5466c16eb 100644 --- a/lib/libX11/specs/Makefile.in +++ b/lib/libX11/specs/Makefile.in @@ -15,7 +15,7 @@ @SET_MAKE@ # -# Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. +# Copyright (c) 2010, Oracle and/or its affiliates. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the "Software"), @@ -250,6 +250,7 @@ STRICT_CFLAGS = @STRICT_CFLAGS@ STRIP = @STRIP@ STYLESHEET_SRCDIR = @STYLESHEET_SRCDIR@ TRADITIONALCPPFLAGS = @TRADITIONALCPPFLAGS@ +USE_THREAD_LIBS = @USE_THREAD_LIBS@ VERSION = @VERSION@ WCHAR32 = @WCHAR32@ X11_CFLAGS = @X11_CFLAGS@ diff --git a/lib/libX11/specs/XIM/Makefile.in b/lib/libX11/specs/XIM/Makefile.in index 33f53e5e8..80de2ab59 100644 --- a/lib/libX11/specs/XIM/Makefile.in +++ b/lib/libX11/specs/XIM/Makefile.in @@ -243,6 +243,7 @@ STRICT_CFLAGS = @STRICT_CFLAGS@ STRIP = @STRIP@ STYLESHEET_SRCDIR = @STYLESHEET_SRCDIR@ TRADITIONALCPPFLAGS = @TRADITIONALCPPFLAGS@ +USE_THREAD_LIBS = @USE_THREAD_LIBS@ VERSION = @VERSION@ WCHAR32 = @WCHAR32@ X11_CFLAGS = @X11_CFLAGS@ diff --git a/lib/libX11/specs/XKB/Makefile.in b/lib/libX11/specs/XKB/Makefile.in index dc18eeec3..fa10910d6 100644 --- a/lib/libX11/specs/XKB/Makefile.in +++ b/lib/libX11/specs/XKB/Makefile.in @@ -250,6 +250,7 @@ STRICT_CFLAGS = @STRICT_CFLAGS@ STRIP = @STRIP@ STYLESHEET_SRCDIR = @STYLESHEET_SRCDIR@ TRADITIONALCPPFLAGS = @TRADITIONALCPPFLAGS@ +USE_THREAD_LIBS = @USE_THREAD_LIBS@ VERSION = @VERSION@ WCHAR32 = @WCHAR32@ X11_CFLAGS = @X11_CFLAGS@ diff --git a/lib/libX11/specs/XKB/ch08.xml b/lib/libX11/specs/XKB/ch08.xml index aa308c0bf..0e532e8a0 100644 --- a/lib/libX11/specs/XKB/ch08.xml +++ b/lib/libX11/specs/XKB/ch08.xml @@ -1346,15 +1346,11 @@ field of the indicators structure. The only way to change the field is to change the keyboard map.</para></note> <para> -There are two ways to make changes to indicator maps and state: either change a +To make changes to indicator maps and state, change a local copy of the indicator maps and use <function>XkbSetIndicatorMap</function> or -<function>XkbSetNamedDeviceIndicator</function>, -or, to reduce network traffic, use an -<structname>XkbIndicatorChangesRec</structname> -structure and use -<function>XkbChangeIndicators</function>. +<function>XkbSetNamedDeviceIndicator</function>. </para> @@ -1852,135 +1848,7 @@ and returns the value which was returned by </para> </sect2> -<sect2 id='XkbIndicatorChangesRec'> -<title>The XkbIndicatorChangesRec Structure</title> - -<indexterm significance="preferred" zone="XkbIndicatorChangesRec"> -<primary><structname>XkbIndicatorChangesRec</structname></primary></indexterm> - -<para> -The -<structname>XkbIndicatorChangesRec</structname> -identifies small modifications to the indicator map. Use it with the function -<function>XkbChangeIndicators</function> -to reduce the amount of traffic sent to the server. -</para> - -<para><programlisting> -typedef struct _XkbIndicatorChanges { - unsigned int state_changes; - unsigned int map_changes; -} <structname>XkbIndicatorChangesRec</structname>,*XkbIndicatorChangesPtr; -</programlisting></para> - -<para> -The -<structfield>state_changes</structfield> -field is a mask that specifies the indicators that have changed state, and -<structfield>map_changes</structfield> -is a mask that specifies the indicators whose maps have changed. -</para> - -<para> -To change indicator maps or state without passing the entire keyboard -description, use -<function>XkbChangeIndicators</function>. -</para> - -<indexterm significance="preferred" zone="XkbChangeIndicators"><primary><function>XkbChangeIndicators</function></primary></indexterm> -<funcsynopsis id="XkbChangeIndicators"> - <funcprototype> - <funcdef>Bool <function>XkbChangeIndicators</function></funcdef> -<!-- ( -<parameter>dpy, xkb, changes, state</parameter> -) --> - - <paramdef>Display *<parameter>dpy</parameter></paramdef> - <paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef> - <paramdef>XkbIndicatorChangesPtr <parameter>changes</parameter></paramdef> - <paramdef>unsigned int <parameter>state</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>dpy</parameter> - </term> - <listitem> - <para> - connection to the X server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>xkb</parameter> - </term> - <listitem> - <para> - keyboard description from which names are to be taken. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>changes</parameter> - </term> - <listitem> - <para> - indicators to be updated on the server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>state</parameter> - </term> - <listitem> - <para> - new state of indicators listed in <parameter>changes</parameter>-><structfield>state_changes</structfield> - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<function>XkbChangeIndicators</function> -copies any maps specified by -<parameter>changes</parameter> -from the keyboard description, -<parameter>xkb</parameter>, -to the server specified by -<parameter>dpy</parameter>. -If any bits are set in the -<structfield>state_changes</structfield> -field of -<parameter>changes</parameter>, -<function>XkbChangeIndicators</function> -also sets the state of those indicators to the values specified in the -<parameter>state</parameter> -mask. A 1 bit in -<parameter>state</parameter> -turns the corresponding indicator on, a 0 bit turns it off. -</para> - - -<para> -<function>XkbChangeIndicators</function> -can generate -<errorname>BadAtom</errorname> -and -<errorname>BadImplementation</errorname> -errors. In addition, it can also generate -<symbol>XkbIndicatorStateNotify</symbol> -and -<symbol>XkbIndicatorMapNotify</symbol> -events (see <link linkend="Tracking_Changes_to_Indicator_State_or_Map">section 8.5</link>). -</para> - - -</sect2> </sect1> <sect1 id='Tracking_Changes_to_Indicator_State_or_Map'> <title>Tracking Changes to Indicator State or Map</title> @@ -2091,189 +1959,6 @@ have changed or not, for both and <symbol>XkbIndicatorMapNotify</symbol> events. </para> -<para> -When your client application receives either a -<symbol>XkbIndicatorStateNotify</symbol> -event or -<symbol>XkbIndicatorMapNotify</symbol> -event, you can note the changes in a changes structure by calling -<function>XkbNoteIndicatorChanges</function>. -</para> - -<indexterm significance="preferred" zone="XkbNoteIndicatorChanges"><primary><function>XkbNoteIndicatorChanges</function></primary></indexterm> -<funcsynopsis id="XkbNoteIndicatorChanges"> - <funcprototype> - <funcdef>void <function>XkbNoteIndicatorChanges</function></funcdef> -<!-- ( -<parameter>old</parameter>, -<parameter>new</parameter>, -<parameter>wanted</parameter> -) --> - - <paramdef>XkbIndicatorChangesPtr <parameter>old</parameter></paramdef> - <paramdef>XkbIndicatorNotifyEvent *<parameter>new</parameter></paramdef> - <paramdef>unsigned int <parameter>wanted</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>old</parameter> - </term> - <listitem> - <para> - XkbIndicatorChanges structure to be updated - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>new</parameter> - </term> - <listitem> - <para> - event from which changes are to be copied - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>wanted</parameter> - </term> - <listitem> - <para> - which changes are to be noted - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -The -<parameter>wanted</parameter> -parameter is the bitwise inclusive OR of -<symbol>XkbIndicatorMapMask</symbol> -and -<emphasis>XkbIndicatorStateMask</emphasis>. -<function>XkbNoteIndicatorChanges</function> -copies any changes reported in -<parameter>new</parameter> -and specified in -<parameter>wanted</parameter> -into the changes record specified by -<parameter>old</parameter>. -</para> - - -<para> -To update a local copy of the keyboard description with the actual values, pass -the results of one or more calls to -<function>XkbNoteIndicatorChanges</function> -to -<function>XkbGetIndicatorChanges</function>: -</para> - - -<indexterm significance="preferred" zone="XkbGetIndicatorChanges"><primary><function>XkbGetIndicatorChanges</function></primary></indexterm> -<funcsynopsis id="XkbGetIndicatorChanges"> - <funcprototype> - <funcdef>Status <function>XkbGetIndicatorChanges</function></funcdef> -<!-- ( -<parameter>dpy</parameter>, -<parameter>xkb</parameter>, -<parameter>changes</parameter>, -<parameter>state</parameter> -) --> - - <paramdef>Display *<parameter>dpy</parameter></paramdef> - <paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef> - <paramdef>XkbIndicatorChangesPtr <parameter>changes</parameter></paramdef> - <paramdef>unsigned int *<parameter>state</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>dpy</parameter> - </term> - <listitem> - <para> - connection to the X server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>xkb</parameter> - </term> - <listitem> - <para> - keyboard description to hold the new values - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>changes</parameter> - </term> - <listitem> - <para> - indicator maps/state to be obtained from the server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>state</parameter> - </term> - <listitem> - <para> - backfilled with the state of the indicators - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<function>XkbGetIndicatorChanges</function> -examines the -<parameter>changes</parameter> -parameter, pulls over the necessary information from the server, and copies -the results into the -<parameter>xkb</parameter> -keyboard description. If any bits are set in the -<structfield>state_changes</structfield> -field of -<parameter>changes</parameter>, -<function>XkbGetIndicatorChanges</function> -also places the state of those indicators in -<parameter>state</parameter>. -If the -<structfield>indicators</structfield> -field of -<parameter>xkb</parameter> -is -<symbol>NULL</symbol>, -<function>XkbGetIndicatorChanges</function> -allocates and initializes it. To free the -<structfield>indicators</structfield> -field, use -<function>XkbFreeIndicatorMaps</function> -(see <link linkend="Allocating_and_Freeing_Indicator_Maps">section 8.6</link>). -</para> - - -<para> -<function>XkbGetIndicatorChanges</function> -can generate -<errorname>BadAlloc</errorname>, -<errorname>BadImplementation</errorname>, -and -<errorname>BadMatch</errorname> -errors. -</para> - - </sect1> <sect1 id='Allocating_and_Freeing_Indicator_Maps'> <title>Allocating and Freeing Indicator Maps</title> diff --git a/lib/libX11/specs/XKB/ch10.xml b/lib/libX11/specs/XKB/ch10.xml index 72727f224..01f5adce9 100644 --- a/lib/libX11/specs/XKB/ch10.xml +++ b/lib/libX11/specs/XKB/ch10.xml @@ -1617,275 +1617,22 @@ event. For more information on events, refer to <link linkend="Tracking_Changes_to_Keyboard_Controls">section 10.11</link>. </para> - <para> -Use -<function>XkbGetAccessXTimeout</function> -to query the current +There are no convenience functions in Xkb for manipulating this control. The <emphasis>AccessXTimeout</emphasis> -options for a keyboard device. -</para> - -<indexterm significance="preferred" zone="XkbGetAccessXTimeout"><primary><function>XkbGetAccessXTimeout</function></primary></indexterm> -<funcsynopsis id="XkbGetAccessXTimeout"> - <funcprototype> - <funcdef>Bool <function>XkbGetAccessXTimeout</function></funcdef> -<!-- ( -<parameter>display</parameter>, -<parameter>device_spec</parameter>, -<parameter>timeout_rtrn</parameter>, -<parameter>ctrls_mask_rtrn</parameter>, -<parameter>ctrls_values_rtrn</parameter>, -<parameter>options_mask_rtrn, options_values_rtrn</parameter> -) --> - - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> - <paramdef>unsigned short *<parameter>timeout_rtrn</parameter></paramdef> - <paramdef>unsigned int *<parameter>ctrls_mask_rtrn</parameter></paramdef> - <paramdef>unsigned int *<parameter>ctrls_values_rtrn</parameter></paramdef> - <paramdef>unsigned short *<parameter>opts_mask_rtrn</parameter></paramdef> - <paramdef>unsigned short *<parameter>opts_values_rtrn</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>display</parameter> - </term> - <listitem> - <para> - connection to X server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>device_spec</parameter> - </term> - <listitem> - <para> - device to query, or <symbol>XkbUseCoreKbd</symbol> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>timeout_rtrn</parameter> - </term> - <listitem> - <para> - delay until AccessXTimeout, seconds - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>ctrls_mask_rtrn</parameter> - </term> - <listitem> - <para> - backfilled with controls to modify - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>ctrls_values_rtrn</parameter> - </term> - <listitem> - <para> - backfilled with on/off status for controls - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>opts_mask_rtrn</parameter> - </term> - <listitem> - <para> - backfilled with <structfield>ax_options</structfield> to modify - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>opts_values_rtrn</parameter> - </term> - <listitem> - <para> - backfilled with values for <structfield>ax_options</structfield> - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<function>XkbGetAccessXTimeout</function> -sends a request to the X server to obtain the current values for the -<emphasis>AccessXTimeout</emphasis> -attributes, waits for a reply, and backfills the values into the appropriate -arguments. -The parameters -<parameter>opts_mask_rtrn</parameter> +control settings are carried in the +<structfield>ax_timeout</structfield>, +<structfield>axt_opts_mask</structfield>, +<structfield>axt_opts_values</structfield>, +<structfield>axt_ctrls_mask</structfield>, and -<parameter>opts_values_rtrn</parameter> -are backfilled with the options to modify and the values for -<structfield>ax_options</structfield>, -which is a field in the +<structfield>axt_ctrls_values</structfield> +fields of an <structname>XkbControlsRec</structname> -structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>). -<function>XkbGetAccessXTimeout</function> -returns -<symbol>True</symbol> -if successful; if a compatible version of the Xkb extension is not available -in the server, -<function>XkbGetAccessXTimeout</function> -returns -<symbol>False</symbol>. -</para> - - -<para> -To configure the -<emphasis>AccessXTimeout</emphasis> -options for a keyboard device, use -<function>XkbSetAccessXTimeout</function>. -</para> - - -<indexterm significance="preferred" zone="XkbSetAccessXTimeout"><primary><function>XkbSetAccessXTimeout</function></primary></indexterm> -<funcsynopsis id="XkbSetAccessXTimeout"> - <funcprototype> - <funcdef>Bool <function>XkbSetAccessXTimeout</function></funcdef> -<!-- ( -<parameter>display</parameter>, -<parameter>device_spec, timeout, ctrls_mask, ctrls_values, opts_mask, -opts_values</parameter> -) --> - - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> - <paramdef>unsigned short <parameter>timeout</parameter></paramdef> - <paramdef>unsigned int <parameter>ctrls_mask</parameter></paramdef> - <paramdef>unsigned int <parameter>ctrls_values</parameter></paramdef> - <paramdef>unsigned short <parameter>opts_mask</parameter></paramdef> - <paramdef>unsigned short <parameter>opts_values</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>display</parameter> - </term> - <listitem> - <para> - connection to X server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>device_spec</parameter> - </term> - <listitem> - <para> - device to configure, or <symbol>XkbUseCoreKbd</symbol> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>timeout</parameter> - </term> - <listitem> - <para> - seconds idle until AccessXTimeout occurs - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>ctrls_mask</parameter> - </term> - <listitem> - <para> - boolean controls to modify - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>ctrls_values</parameter> - </term> - <listitem> - <para> - new bits for controls selected by <parameter>ctrls_mask</parameter> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>opts_mask</parameter> - </term> - <listitem> - <para> - <structfield>ax_options</structfield> to change - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>opts_values</parameter> - </term> - <listitem> - <para> - new bits for <structfield>ax_options</structfield> selected by <parameter>opts_mask</parameter> - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<parameter>timeout</parameter> -specifies the number of seconds the keyboard must be idle before the controls -are modified. -<parameter>ctrls_mask</parameter> -specifies what controls are to be enabled or disabled, and -<parameter>ctrls_values</parameter> -specifies whether those controls are to be enabled or disabled. The bit values -correspond to those for enabling and disabling boolean controls -(see <link linkend="The_EnabledControls_Control">section 10.1.1</link>). The -<parameter>opts_mask</parameter> -field specifies which attributes of the -<emphasis>AccessXKeys</emphasis> -and -<emphasis>AccessXFeedback</emphasis> -controls are to be changed, and -<parameter>opts_values</parameter> -specifies the new values for those options. The bit values correspond to those -for the -<structfield>ax_options</structfield> -field of an -<structname>XkbDescRec</structname> -(see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>). +structure, discussed in <link linkend="The_XkbControlsRec_Structure">section 10.8</link>. </para> -<para> -<function>XkbSetAccessXTimeout</function> -sends a request to configure the -<emphasis>AccessXTimeout</emphasis> -control to the server. -It does not wait for a reply, and normally returns -<symbol>True</symbol>. -If a compatible version of the Xkb extension is not available in the server, -<function>XkbSetAccessXTimeout</function> -returns -<symbol>False</symbol>. -</para> - </sect2> <sect2 id='The_AccessXFeedback_Control'> @@ -2285,159 +2032,15 @@ event (see <link linkend="AccessXNotify_Events">section 10.6.4</link>). </para> <para> -To get the -<emphasis>SlowKeys</emphasis> -acceptance delay for a keyboard device, use -<function>XkbGetSlowKeysDelay</function>. -</para> - -<indexterm significance="preferred" zone="XkbGetSlowKeysDelay"><primary><function>XkbGetSlowKeysDelay</function></primary></indexterm> -<funcsynopsis id="XkbGetSlowKeysDelay"> - <funcprototype> - <funcdef>Bool <function>XkbGetSlowKeysDelay</function></funcdef> -<!-- ( -<parameter>display</parameter>, -<parameter>device_spec</parameter>, -<parameter>delay_rtrn</parameter> -) --> - - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> - <paramdef>unsigned int *<parameter>delay_rtrn</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>display</parameter> - </term> - <listitem> - <para> - connection to X server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>device_spec</parameter> - </term> - <listitem> - <para> - device ID, or <symbol>XkbUseCoreKbd</symbol> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>delay_rtrn</parameter> - </term> - <listitem> - <para> - backfilled with <emphasis>SlowKeys</emphasis> delay, ms - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<function>XkbGetSlowKeysDelay</function> -requests the attributes of the -<emphasis>SlowKeys</emphasis> -control from the server, waits for a reply and backfills -<parameter>delay_rtrn</parameter> -with the -<emphasis>SlowKeys</emphasis> -delay attribute. -<function>XkbGetSlowKeysDelay</function> -returns -<symbol>True</symbol> -if successful; if a compatible version of the Xkb extension is not available -in the server, -<function>XkbGetSlowKeysDelay</function> -returns -<symbol>False</symbol>. -</para> - - -<para> -To set the +There are no convenience functions in Xkb for manipulating this control. The <emphasis>SlowKeys</emphasis> -acceptance delay for a keyboard device, use -<function>XkbSetSlowKeysDelay</function>. -</para> - - -<indexterm significance="preferred" zone="XkbSetSlowKeysDelay"><primary><function>XkbSetSlowKeysDelay</function></primary></indexterm> -<funcsynopsis id="XkbSetSlowKeysDelay"> - <funcprototype> - <funcdef>Bool <function>XkbSetSlowKeysDelay</function></funcdef> -<!-- ( -<parameter>display</parameter>, -<parameter>device_spec</parameter>, -<parameter>delay</parameter> -) --> - - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> - <paramdef>unsigned int <parameter>delay</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>display</parameter> - </term> - <listitem> - <para> - connection to X server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>device_spec</parameter> - </term> - <listitem> - <para> - device to configure, or <symbol>XkbUseCoreKbd</symbol> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>delay</parameter> - </term> - <listitem> - <para> - <emphasis>SlowKeys</emphasis> delay, ms - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<function>XkbSetSlowKeysDelay</function> -sends a request to configure the -<emphasis>SlowKeys</emphasis> -control to the server. -It does not wait for a reply, and normally returns -<symbol>True</symbol>. -Specifying a value of -<literal>0</literal> -for the -<parameter>delay</parameter> -parameter causes -<function>XkbSetSlowKeysDelay</function> -to generate a -<errorname>BadValue</errorname> -protocol error. If a compatible version of the Xkb extension is not available -in the server -<function>XkbSetSlowKeysDelay</function> -returns -<symbol>False</symbol>. +control settings are carried in the +<structfield>slow_keys_delay</structfield> +field of an +<structname>XkbControlsRec</structname> +structure, discussed in <link linkend="The_XkbControlsRec_Structure">section 10.8</link>. </para> - </sect2> <sect2 id='The_BounceKeys_Control'> <title>The BounceKeys Control</title> @@ -2466,157 +2069,13 @@ event (see <link linkend="AccessXNotify_Events">section 10.6.4</link>). <para> -Use -<function>XkbGetBounceKeysDelay</function> -to query the current -<emphasis>BounceKeys</emphasis> -delay for a keyboard device. -</para> - -<indexterm significance="preferred" zone="XkbGetBounceKeysDelay"><primary><function>XkbGetBounceKeysDelay</function></primary></indexterm> -<funcsynopsis id="XkbGetBounceKeysDelay"> - <funcprototype> - <funcdef>Bool <function>XkbGetBounceKeysDelay</function></funcdef> -<!-- ( -<parameter>display</parameter>, -<parameter>device_spec</parameter>, -<parameter>delay_rtrn</parameter> -) --> - - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> - <paramdef>unsigned int *<parameter>delay_rtrn</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>display</parameter> - </term> - <listitem> - <para> - connection to X server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>device_spec</parameter> - </term> - <listitem> - <para> - device ID, or <symbol>XkbUseCoreKbd</symbol> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>delay_rtrn</parameter> - </term> - <listitem> - <para> - backfilled with bounce keys delay, ms - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<function>XkbGetBounceKeysDelay</function> -requests the attributes of the -<emphasis>BounceKeys</emphasis> -control from the server, waits for a reply, and backfills -<parameter>delay_rtrn</parameter> -with the -<emphasis>BounceKeys</emphasis> -delay attribute. -<function>XkbGetBounceKeysDelay</function> -returns -<symbol>True</symbol> -if successful; if a compatible version of the Xkb extension is not available -in the server -<function>XkbGetSlowKeysDelay</function> -returns -<symbol>False</symbol>. -</para> - - -<para> -To set the -<emphasis>BounceKeys</emphasis> -delay for a keyboard device, use -<function>XkbSetBounceKeysDelay</function>. -</para> - - -<indexterm significance="preferred" zone="XkbSetBounceKeysDelay"><primary><function>XkbSetBounceKeysDelay</function></primary></indexterm> -<funcsynopsis id="XkbSetBounceKeysDelay"> - <funcprototype> - <funcdef>Bool <function>XkbSetBounceKeysDelay</function></funcdef> -<!-- ( -<parameter>display</parameter>, -<parameter>device_spec</parameter>, -<parameter>delay</parameter> -) --> - - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> - <paramdef>unsigned int <parameter>delay</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>display</parameter> - </term> - <listitem> - <para> - connection to X server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>device_spec</parameter> - </term> - <listitem> - <para> - device to configure, or <symbol>XkbUseCoreKbd</symbol> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>delay</parameter> - </term> - <listitem> - <para> - bounce keys delay, ms - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<function>XkbSetBounceKeysDelay</function> -sends a request to configure the +There are no convenience functions in Xkb for manipulating this control. The <emphasis>BounceKeys</emphasis> -control to the server. -It does not wait for a reply and normally returns -<symbol>True</symbol>. -Specifying a value of -<emphasis>zero</emphasis> -for the -<parameter>delay</parameter> -parameter causes -<function>XkbSetBounceKeysDelay</function> -to generate a -<errorname>BadValue</errorname> -protocol error. If a compatible version of the Xkb extension is not available -in the server, -<function>XkbSetBounceKeysDelay</function> -returns -<symbol>False</symbol>. +control settings are carried in the +<structfield>debounce_delay</structfield> +field of an +<structname>XkbControlsRec</structname> +structure, discussed in <link linkend="The_XkbControlsRec_Structure">section 10.8</link>. </para> </sect2> @@ -2756,183 +2215,14 @@ specifies whether or not locks a modifier when pressed twice in a row. </para> - -<para> -Use -<function>XkbGetStickyKeysOptions</function> -to query the current -<emphasis>StickyKeys</emphasis> -attributes for a keyboard device. -</para> - -<indexterm significance="preferred" zone="XkbGetStickyKeysOptions"><primary><function>XkbGetStickyKeysOptions</function></primary></indexterm> -<funcsynopsis id="XkbGetStickyKeysOptions"> - <funcprototype> - <funcdef>Bool <function>XkbGetStickyKeysOptions</function></funcdef> -<!-- ( -<parameter>display</parameter>, -<parameter>device_spec</parameter>, -<parameter>options_rtrn</parameter> -) --> - - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> - <paramdef>unsigned int *<parameter>options_rtrn</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>display</parameter> - </term> - <listitem> - <para> - connection to X server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>device_spec</parameter> - </term> - <listitem> - <para> - device ID, or <symbol>XkbUseCoreKbd</symbol> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>options_rtrn</parameter> - </term> - <listitem> - <para> - backfilled with StickyKeys option mask - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<function>XkbGetStickyKeysOptions</function> -requests the attributes of the -<emphasis>StickyKeys</emphasis> -control from the server, waits for a reply, and backfills -<parameter>options_rtrn</parameter> -with a mask indicating whether the individual -<emphasis>StickyKeys</emphasis> -options are on or off. Valid bits in -<parameter>options_rtrn</parameter> -are: - - <simplelist type='vert' columns='1'> - <member><symbol>XkbAX_TwoKeysMask</symbol></member> - <member><symbol>XkbAX_LatchToLockMask</symbol></member> - </simplelist> -</para> - -<para> -<function>XkbGetStickyKeysOptions</function> -returns -<symbol>True</symbol> -if successful; if a compatible version of the Xkb extension is not available -in the server -<function>XkbGetStickyKeysOptions</function> -returns -<symbol>False</symbol>. -</para> - - -<para> -To set the -<emphasis>StickyKeys</emphasis> -attributes for a keyboard device, use -<function>XkbSetStickyKeysOptions</function>. -</para> - - -<indexterm significance="preferred" zone="XkbSetStickyKeysOptions"><primary><function>XkbSetStickyKeysOptions</function></primary></indexterm> -<funcsynopsis id="XkbSetStickyKeysOptions"> - <funcprototype> - <funcdef>Bool <function>XkbSetStickyKeysOptions</function></funcdef> -<!-- ( -<parameter>display</parameter>, -<parameter>device_spec, mask, values</parameter> -) --> - - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>unsigned int <parameter>device_spec</parameter></paramdef> - <paramdef>unsigned int <parameter>mask</parameter></paramdef> - <paramdef>unsigned int <parameter>values</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>display</parameter> - </term> - <listitem> - <para> - connection to X server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>device_spec</parameter> - </term> - <listitem> - <para> - device to configure, or XkbUseCoreKbd - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>mask</parameter> - </term> - <listitem> - <para> - selects StickyKeys attributes to modify - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>values</parameter> - </term> - <listitem> - <para> - values for selected attributes - </para> - </listitem> - </varlistentry> -</variablelist> - <para> -<function>XkbSetStickyKeysOptions</function> -sends a request to configure the +There are no convenience functions in Xkb for manipulating this control. The <emphasis>StickyKeys</emphasis> -control to the server. -It does not wait for a reply and normally returns -<symbol>True</symbol>. -The valid bits to use for both the -<parameter>mask</parameter> -and -<parameter>values</parameter> -parameters are: - - <simplelist type='vert' columns='1'> - <member><symbol>XkbAX_TwoKeysMask</symbol></member> - <member><symbol>XkbAX_LatchToLockMask</symbol></member> - </simplelist> -</para> - -<para> -If a compatible version of the Xkb extension is not available in the server, -<function>XkbSetStickyKeysOptions</function> -returns -<symbol>False</symbol>. +control settings are carried in the +<structfield>ax_options</structfield> +field of an +<structname>XkbControlsRec</structname> +structure, discussed in <link linkend="The_XkbControlsRec_Structure">section 10.8</link>. </para> </sect3> diff --git a/lib/libX11/specs/XKB/ch15.xml b/lib/libX11/specs/XKB/ch15.xml index a6f3f7c68..12b6404a4 100644 --- a/lib/libX11/specs/XKB/ch15.xml +++ b/lib/libX11/specs/XKB/ch15.xml @@ -1304,10 +1304,10 @@ currently four); if a key has fewer than <symbol>XkbNumKbdGroups</symbol> groups, the extra key types are reported but ignored.</para></note> -<indexterm significance="preferred" zone="XkbKeyTypeIndex"><primary><function>XkbKeyTypeIndex</function></primary></indexterm> -<funcsynopsis id="XkbKeyTypeIndex"> +<indexterm significance="preferred" zone="XkbKeyKeyTypeIndex"><primary><function>XkbKeyKeyTypeIndex</function></primary></indexterm> +<funcsynopsis id="XkbKeyKeyTypeIndex"> <funcprototype> - <funcdef>int <function>XkbKeyTypeIndex</function></funcdef> + <funcdef>int <function>XkbKeyKeyTypeIndex</function></funcdef> <!-- ( <parameter>xkb, keycode, group</parameter> ) /* macro*/ --> @@ -1351,7 +1351,7 @@ groups, the extra key types are reported but ignored.</para></note> </variablelist> <para> -<function>XkbKeyTypeIndex</function> +<function>XkbKeyKeyTypeIndex</function> computes an index into the <structfield>types</structfield> vector of the client map in @@ -1364,10 +1364,10 @@ index. </para> -<indexterm significance="preferred" zone="XkbKeyType"><primary><function>XkbKeyType</function></primary></indexterm> -<funcsynopsis id="XkbKeyType"> +<indexterm significance="preferred" zone="XkbKeyKeyType"><primary><function>XkbKeyKeyType</function></primary></indexterm> +<funcsynopsis id="XkbKeyKeyType"> <funcprototype> - <funcdef>XkbKeyTypePtr <function>XkbKeyType</function></funcdef> + <funcdef>XkbKeyTypePtr <function>XkbKeyKeyType</function></funcdef> <!-- ( <parameter>xkb, keycode, group</parameter> ) /* macro */ --> @@ -1411,7 +1411,7 @@ index. </variablelist> <para> -<function>XkbKeyType</function> +<function>XkbKeyKeyType</function> returns a pointer to the key type in the <structfield>types</structfield> vector of the client map in @@ -1726,8 +1726,6 @@ entry for a key is used to access the beginning of the array. <para> Xkb provides the following macros for accessing the <structfield>width</structfield> -and -<structfield>offset</structfield> for individual keys, as well as macros for accessing the two-dimensional array of symbols bound to the key: </para> @@ -1829,49 +1827,6 @@ for the key corresponding to </para> -<indexterm significance="preferred" zone="XkbKeySymsOffset"><primary><function>XkbKeySymsOffset</function></primary></indexterm> -<funcsynopsis id="XkbKeySymsOffset"> - <funcprototype> - <funcdef>int <function>XkbKeySymsOffset</function></funcdef> -<!-- ( -<parameter>xkb, keycode</parameter> -) /* macro */ --> - - <paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef> - <paramdef>KeyCode <parameter>keycode</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>xkb</parameter> - </term> - <listitem> - <para> - Xkb description of interest - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>keycode</parameter> - </term> - <listitem> - <para> - keycode of interest - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<function>XkbKeySymsOffset</function> -returns the offset of the two-dimensional array of keysyms for the key -corresponding to -<parameter>keycode</parameter>. -</para> - - <indexterm significance="preferred" zone="XkbKeyNumSyms"><primary><function>XkbKeyNumSyms</function></primary></indexterm> <funcsynopsis id="XkbKeyNumSyms"> <funcprototype> diff --git a/lib/libX11/specs/XKB/ch16.xml b/lib/libX11/specs/XKB/ch16.xml index 3f5e42f04..6b2a03817 100644 --- a/lib/libX11/specs/XKB/ch16.xml +++ b/lib/libX11/specs/XKB/ch16.xml @@ -2852,10 +2852,10 @@ converted to an unsigned int. </para> -<indexterm significance="preferred" zone="XkbSAActionSetCtrls"><primary><function>XkbSAActionSetCtrls</function></primary></indexterm> -<funcsynopsis id="XkbSAActionSetCtrls"> +<indexterm significance="preferred" zone="XkbActionSetCtrls"><primary><function>XkbActionSetCtrls</function></primary></indexterm> +<funcsynopsis id="XkbActionSetCtrls"> <funcprototype> - <funcdef>void <function>XkbSAActionSetCtrls</function></funcdef> + <funcdef>void <function>XkbActionSetCtrls</function></funcdef> <!-- ( <parameter>act, ctrls</parameter> ) /* macro */ --> @@ -2888,7 +2888,7 @@ converted to an unsigned int. </variablelist> <para> -<function>XkbSAActionSetCtrls</function> +<function>XkbActionSetCtrls</function> sets the <structfield>ctrls0</structfield> through diff --git a/lib/libX11/specs/XKB/ch18.xml b/lib/libX11/specs/XKB/ch18.xml index 0f283ecfc..0b47dba94 100644 --- a/lib/libX11/specs/XKB/ch18.xml +++ b/lib/libX11/specs/XKB/ch18.xml @@ -993,85 +993,6 @@ into the changes record specified by </para> -<para> -To update the local copy of the keyboard description with the actual values, -pass to -<function>XkbGetNameChanges</function> -the results of one or more calls to -<function>XkbNoteNameChanges</function>. -</para> - - -<indexterm significance="preferred" zone="XkbGetNameChanges"><primary><function>XkbGetNameChanges</function></primary></indexterm> -<funcsynopsis id="XkbGetNameChanges"> - <funcprototype> - <funcdef>Status <function>XkbGetNameChanges</function></funcdef> -<!-- ( -<parameter>dpy</parameter>, -<parameter>xkb</parameter>, -<parameter>changes</parameter> -) --> - - <paramdef>Display *<parameter>dpy</parameter></paramdef> - <paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef> - <paramdef>XkbNameChangesPtr <parameter>changes</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>dpy</parameter> - </term> - <listitem> - <para> - connection to the X server - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>xkb</parameter> - </term> - <listitem> - <para> - keyboard description to which names are copied - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>changes</parameter> - </term> - <listitem> - <para> - names components to be obtained from the server - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<function>XkbGetNameChanges</function> -examines the -<parameter>changes</parameter> -parameter, retrieves the necessary information from the server, and places the -results into the -<parameter>xkb</parameter> -keyboard description. -</para> - - -<para> -<function>XkbGetNameChanges</function> -can generate -<errorname>BadAlloc</errorname>, -<errorname>BadImplementation</errorname>, -and -<errorname>BadMatch</errorname> -errors. -</para> - - </sect1> <sect1 id='Allocating_and_Freeing_Symbolic_Names'> <title>Allocating and Freeing Symbolic Names</title> diff --git a/lib/libX11/specs/XKB/ch21.xml b/lib/libX11/specs/XKB/ch21.xml index 7d122d92b..35e594ea3 100644 --- a/lib/libX11/specs/XKB/ch21.xml +++ b/lib/libX11/specs/XKB/ch21.xml @@ -1029,64 +1029,6 @@ explicitly. <para> -To obtain an -<structname>XkbDeviceLedInfoRec</structname> -structure, use XkbAllocDeviceLedInfo. -</para> - - -<indexterm significance="preferred" zone="XkbAllocDeviceLedInfo"><primary><function>XkbAllocDeviceLedInfo</function></primary></indexterm> -<funcsynopsis id="XkbAllocDeviceLedInfo"> - <funcprototype> - <funcdef>Status <function>XkbAllocDeviceLedInfo</function></funcdef> -<!-- (devi, num_needed) --> - - <paramdef>XkbDeviceInfoPtr <parameter>device_info</parameter></paramdef> - <paramdef>int <parameter>num_needed</parameter></paramdef> - </funcprototype> -</funcsynopsis> -<variablelist> - <varlistentry> - <term> - <parameter>device_info</parameter> - </term> - <listitem> - <para> - structure in which to allocate LED space - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>num_needed</parameter> - </term> - <listitem> - <para> - number of indicators to allocate space for - </para> - </listitem> - </varlistentry> -</variablelist> - -<para> -<function>XkbAllocDeviceLedInfo</function> -allocates space for an -<structname>XkbDeviceLedInfoRec</structname> -and places it in -<parameter>device_info</parameter>. -If num_needed is nonzero, -<parameter>num_needed</parameter> -<structname>XkbIndicatorMapRec</structname> -structures are also allocated and linked into the -<structname>XkbDeviceLedInfoRec</structname> -structure. If you request -<structname>XkbIndicatorMapRec</structname> -structures be allocated using this request, you must initialize them -explicitly. All other fields are initialized to zero. -</para> - - -<para> To initialize an <structname>XkbDeviceLedInfoRec</structname> structure, use XkbAddDeviceLedInfo. diff --git a/lib/libX11/specs/i18n/Makefile.am b/lib/libX11/specs/i18n/Makefile.am index a69a51e9f..05ae1f8eb 100644 --- a/lib/libX11/specs/i18n/Makefile.am +++ b/lib/libX11/specs/i18n/Makefile.am @@ -1,5 +1,5 @@ # -# Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. +# Copyright (c) 2010, Oracle and/or its affiliates. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/specs/i18n/Makefile.in b/lib/libX11/specs/i18n/Makefile.in index 903061cd0..c07196f72 100644 --- a/lib/libX11/specs/i18n/Makefile.in +++ b/lib/libX11/specs/i18n/Makefile.in @@ -15,7 +15,7 @@ @SET_MAKE@ # -# Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. +# Copyright (c) 2010, Oracle and/or its affiliates. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the "Software"), @@ -250,6 +250,7 @@ STRICT_CFLAGS = @STRICT_CFLAGS@ STRIP = @STRIP@ STYLESHEET_SRCDIR = @STYLESHEET_SRCDIR@ TRADITIONALCPPFLAGS = @TRADITIONALCPPFLAGS@ +USE_THREAD_LIBS = @USE_THREAD_LIBS@ VERSION = @VERSION@ WCHAR32 = @WCHAR32@ X11_CFLAGS = @X11_CFLAGS@ diff --git a/lib/libX11/specs/i18n/compose/Makefile.in b/lib/libX11/specs/i18n/compose/Makefile.in index 6e799c61f..c1313724b 100644 --- a/lib/libX11/specs/i18n/compose/Makefile.in +++ b/lib/libX11/specs/i18n/compose/Makefile.in @@ -244,6 +244,7 @@ STRICT_CFLAGS = @STRICT_CFLAGS@ STRIP = @STRIP@ STYLESHEET_SRCDIR = @STYLESHEET_SRCDIR@ TRADITIONALCPPFLAGS = @TRADITIONALCPPFLAGS@ +USE_THREAD_LIBS = @USE_THREAD_LIBS@ VERSION = @VERSION@ WCHAR32 = @WCHAR32@ X11_CFLAGS = @X11_CFLAGS@ diff --git a/lib/libX11/specs/i18n/compose/compose-chart.pl b/lib/libX11/specs/i18n/compose/compose-chart.pl index a96dfee58..197d3f15d 100644 --- a/lib/libX11/specs/i18n/compose/compose-chart.pl +++ b/lib/libX11/specs/i18n/compose/compose-chart.pl @@ -1,6 +1,6 @@ #! /usr/bin/perl # -# Copyright 2009, 2010, Oracle and/or its affiliates. All rights reserved. +# Copyright (c) 2009, 2010, Oracle and/or its affiliates. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the "Software"), diff --git a/lib/libX11/specs/i18n/framework/Makefile.in b/lib/libX11/specs/i18n/framework/Makefile.in index cba425d99..e66a0537d 100644 --- a/lib/libX11/specs/i18n/framework/Makefile.in +++ b/lib/libX11/specs/i18n/framework/Makefile.in @@ -241,6 +241,7 @@ STRICT_CFLAGS = @STRICT_CFLAGS@ STRIP = @STRIP@ STYLESHEET_SRCDIR = @STYLESHEET_SRCDIR@ TRADITIONALCPPFLAGS = @TRADITIONALCPPFLAGS@ +USE_THREAD_LIBS = @USE_THREAD_LIBS@ VERSION = @VERSION@ WCHAR32 = @WCHAR32@ X11_CFLAGS = @X11_CFLAGS@ diff --git a/lib/libX11/specs/i18n/localedb/Makefile.in b/lib/libX11/specs/i18n/localedb/Makefile.in index cdce43e13..b426f0274 100644 --- a/lib/libX11/specs/i18n/localedb/Makefile.in +++ b/lib/libX11/specs/i18n/localedb/Makefile.in @@ -241,6 +241,7 @@ STRICT_CFLAGS = @STRICT_CFLAGS@ STRIP = @STRIP@ STYLESHEET_SRCDIR = @STYLESHEET_SRCDIR@ TRADITIONALCPPFLAGS = @TRADITIONALCPPFLAGS@ +USE_THREAD_LIBS = @USE_THREAD_LIBS@ VERSION = @VERSION@ WCHAR32 = @WCHAR32@ X11_CFLAGS = @X11_CFLAGS@ diff --git a/lib/libX11/specs/i18n/trans/Makefile.in b/lib/libX11/specs/i18n/trans/Makefile.in index c07a98095..6586bd5f4 100644 --- a/lib/libX11/specs/i18n/trans/Makefile.in +++ b/lib/libX11/specs/i18n/trans/Makefile.in @@ -241,6 +241,7 @@ STRICT_CFLAGS = @STRICT_CFLAGS@ STRIP = @STRIP@ STYLESHEET_SRCDIR = @STYLESHEET_SRCDIR@ TRADITIONALCPPFLAGS = @TRADITIONALCPPFLAGS@ +USE_THREAD_LIBS = @USE_THREAD_LIBS@ VERSION = @VERSION@ WCHAR32 = @WCHAR32@ X11_CFLAGS = @X11_CFLAGS@ diff --git a/lib/libX11/specs/libX11/CH13.xml b/lib/libX11/specs/libX11/CH13.xml index 5ca597907..6be4f1c22 100644 --- a/lib/libX11/specs/libX11/CH13.xml +++ b/lib/libX11/specs/libX11/CH13.xml @@ -8045,7 +8045,11 @@ set to <symbol>XIMPreeditPosition</symbol>. When specified to any input method other than <symbol>XIMPreeditPosition</symbol>, -this <acronym>XIC</acronym> value is ignored. +this <acronym>XIC</acronym> value is ignored. Some Xlib implementations +will allow this to be set when +<symbol>XNInputStyle</symbol> is set to +<symbol>XIMPreeditCallbacks</symbol>. Behavior in that case is +implementation defined. </para> <para> <!-- .LP --> diff --git a/lib/libX11/specs/libX11/Makefile.in b/lib/libX11/specs/libX11/Makefile.in index 6f3039b60..8b1d6897b 100644 --- a/lib/libX11/specs/libX11/Makefile.in +++ b/lib/libX11/specs/libX11/Makefile.in @@ -244,6 +244,7 @@ STRICT_CFLAGS = @STRICT_CFLAGS@ STRIP = @STRIP@ STYLESHEET_SRCDIR = @STYLESHEET_SRCDIR@ TRADITIONALCPPFLAGS = @TRADITIONALCPPFLAGS@ +USE_THREAD_LIBS = @USE_THREAD_LIBS@ VERSION = @VERSION@ WCHAR32 = @WCHAR32@ X11_CFLAGS = @X11_CFLAGS@ |