head 1.1; branch 1.1.1; access; symbols netbsd-11-0-RC7:1.1.1.5 libX11-1-8-13:1.1.1.6 netbsd-11-0-RC6:1.1.1.5 netbsd-11-0-RC5:1.1.1.5 netbsd-11-0-RC4:1.1.1.5 netbsd-11-0-RC3:1.1.1.5 netbsd-11-0-RC2:1.1.1.5 netbsd-11-0-RC1:1.1.1.5 netbsd-11:1.1.1.5.0.4 netbsd-11-base:1.1.1.5 libX11-1-8-12:1.1.1.5 netbsd-10-1-RELEASE:1.1.1.5 libX11-1-8-10:1.1.1.5 libX11-1-8-9:1.1.1.5 netbsd-8-3-RELEASE:1.1.1.4 netbsd-9-4-RELEASE:1.1.1.4 netbsd-10-0-RELEASE:1.1.1.5 netbsd-10-0-RC6:1.1.1.5 netbsd-10-0-RC5:1.1.1.5 netbsd-10-0-RC4:1.1.1.5 netbsd-10-0-RC3:1.1.1.5 netbsd-10-0-RC2:1.1.1.5 netbsd-10-0-RC1:1.1.1.5 libX11-1-8-7:1.1.1.5 libX11-1-8-6:1.1.1.5 libX11-1-8-4:1.1.1.5 libX11-1-8-3:1.1.1.5 netbsd-10:1.1.1.5.0.2 netbsd-10-base:1.1.1.5 libX11-1-8-2:1.1.1.5 netbsd-9-3-RELEASE:1.1.1.4 libX11-1-8-1:1.1.1.4 libX11-1-7-2:1.1.1.4 libX11-1-7-1:1.1.1.4 netbsd-9-2-RELEASE:1.1.1.4 libX11-1-7-0:1.1.1.4 netbsd-9-1-RELEASE:1.1.1.4 libX11-1-6-12:1.1.1.4 libX11-1-6-10:1.1.1.4 netbsd-8-2-RELEASE:1.1.1.4 libX11-1-6-9:1.1.1.4 netbsd-9-0-RELEASE:1.1.1.4 netbsd-9-0-RC2:1.1.1.4 netbsd-9-0-RC1:1.1.1.4 netbsd-9:1.1.1.4.0.18 netbsd-9-base:1.1.1.4 libX11-1-6-8:1.1.1.4 netbsd-8-1-RELEASE:1.1.1.4 netbsd-8-1-RC1:1.1.1.4 libX11-1-6-7:1.1.1.4 netbsd-7-2-RELEASE:1.1.1.4 libX11-1-6-6:1.1.1.4 netbsd-8-0-RELEASE:1.1.1.4 netbsd-8-0-RC2:1.1.1.4 netbsd-8-0-RC1:1.1.1.4 netbsd-7-1-2-RELEASE:1.1.1.4 netbsd-7-1-1-RELEASE:1.1.1.4 netbsd-8:1.1.1.4.0.16 netbsd-8-base:1.1.1.4 netbsd-7-1:1.1.1.4.0.14 netbsd-7-1-RELEASE:1.1.1.4 libX11-1-6-5:1.1.1.4 netbsd-7-1-RC2:1.1.1.4 netbsd-7-1-RC1:1.1.1.4 netbsd-7-0-2-RELEASE:1.1.1.4 libX11-1-6-4:1.1.1.4 netbsd-7-0-1-RELEASE:1.1.1.4 netbsd-7-0:1.1.1.4.0.12 netbsd-7-0-RELEASE:1.1.1.4 netbsd-7-0-RC3:1.1.1.4 netbsd-7-0-RC2:1.1.1.4 libX11-1-6-3:1.1.1.4 netbsd-7-0-RC1:1.1.1.4 netbsd-5-2-3-RELEASE:1.1.1.1.2.1 netbsd-5-1-5-RELEASE:1.1.1.1.2.1 netbsd-6-0-6-RELEASE:1.1.1.4 netbsd-6-1-5-RELEASE:1.1.1.4 netbsd-7:1.1.1.4.0.10 netbsd-7-base:1.1.1.4 netbsd-6-1-4-RELEASE:1.1.1.4 netbsd-6-0-5-RELEASE:1.1.1.4 riastradh-xf86-video-intel-2-7-1-pre-2-21-15:1.1.1.4 libX11-1-6-2:1.1.1.4 riastradh-drm2:1.1.1.4.0.8 riastradh-drm2-base:1.1.1.4 netbsd-6-1-3-RELEASE:1.1.1.4 netbsd-6-0-4-RELEASE:1.1.1.4 netbsd-5-2-2-RELEASE:1.1.1.1.2.1 netbsd-5-1-4-RELEASE:1.1.1.1.2.1 netbsd-6-1-2-RELEASE:1.1.1.4 netbsd-6-0-3-RELEASE:1.1.1.4 netbsd-5-2-1-RELEASE:1.1.1.1.2.1 netbsd-5-1-3-RELEASE:1.1.1.1.2.1 netbsd-6-1-1-RELEASE:1.1.1.4 libX11-1-6-0:1.1.1.4 libX11-1-5-99-902:1.1.1.4 netbsd-6-1:1.1.1.4.0.6 netbsd-6-0-2-RELEASE:1.1.1.4 netbsd-6-1-RELEASE:1.1.1.4 netbsd-6-1-RC4:1.1.1.4 netbsd-6-1-RC3:1.1.1.4 netbsd-6-1-RC2:1.1.1.4 netbsd-6-1-RC1:1.1.1.4 netbsd-5-2:1.1.1.1.2.1.0.4 netbsd-6-0-1-RELEASE:1.1.1.4 netbsd-5-2-RELEASE:1.1.1.1.2.1 netbsd-5-2-RC1:1.1.1.1.2.1 netbsd-6-0:1.1.1.4.0.4 netbsd-6-0-RELEASE:1.1.1.4 netbsd-6-0-RC2:1.1.1.4 netbsd-6-0-RC1:1.1.1.4 netbsd-6:1.1.1.4.0.2 netbsd-6-base:1.1.1.4 netbsd-5-1-2-RELEASE:1.1.1.1.2.1 netbsd-5-1-1-RELEASE:1.1.1.1.2.1 libX11-1-4-4:1.1.1.4 libX11-1-4-3:1.1.1.4 libX11-1-4-1:1.1.1.4 libX11-1-3-6:1.1.1.3 netbsd-5-1:1.1.1.1.2.1.0.2 netbsd-5-1-RELEASE:1.1.1.1.2.1 netbsd-5-1-RC4:1.1.1.1.2.1 libX11-1-3-5:1.1.1.3 libX11-1-3-4:1.1.1.3 netbsd-5-1-RC3:1.1.1.1.2.1 libX11-1-3-3:1.1.1.3 netbsd-5-1-RC2:1.1.1.1.2.1 netbsd-5-1-RC1:1.1.1.1.2.1 netbsd-5-0-2-RELEASE:1.1.1.1 netbsd-5-0-1-RELEASE:1.1.1.1 libX11-1-2-2:1.1.1.2 netbsd-5-0:1.1.1.1.0.4 netbsd-5-0-RELEASE:1.1.1.1 netbsd-5-0-RC4:1.1.1.1 netbsd-5-0-RC3:1.1.1.1 libX11-1-2:1.1.1.2 netbsd-5-0-RC2:1.1.1.1 netbsd-5-0-RC1:1.1.1.1 netbsd-5:1.1.1.1.0.2 netbsd-5-base:1.1.1.1 libX11-1-1-4:1.1.1.1 xorg:1.1.1; locks; strict; comment @.\" @; 1.1 date 2008.07.30.02.43.37; author mrg; state Exp; branches 1.1.1.1; next ; 1.1.1.1 date 2008.07.30.02.43.37; author mrg; state Exp; branches 1.1.1.1.2.1; next 1.1.1.2; 1.1.1.2 date 2009.03.10.16.12.57; author mrg; state Exp; branches; next 1.1.1.3; 1.1.1.3 date 2010.05.22.01.22.21; author mrg; state Exp; branches; next 1.1.1.4; 1.1.1.4 date 2011.02.23.07.55.43; author mrg; state Exp; branches; next 1.1.1.5; 1.1.1.5 date 2022.11.11.04.44.53; author mrg; state Exp; branches; next 1.1.1.6; commitid w9YHRKXKhJZNYe1E; 1.1.1.6 date 2026.07.11.23.01.34; author mrg; state Exp; branches; next ; commitid y4lCG7To2wFx2iNG; 1.1.1.1.2.1 date 2009.09.17.03.32.57; author snj; state Exp; branches; next ; desc @@ 1.1 log @Initial revision @ text @'\" t .\" Copyright (c) 1999 - Sun Microsystems, Inc. .\" All rights reserved. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the .\" "Software"), to deal in the Software without restriction, including .\" without limitation the rights to use, copy, modify, merge, publish, .\" distribute, and/or sell copies of the Software, and to permit persons .\" to whom the Software is furnished to do so, provided that the above .\" copyright notice(s) and this permission notice appear in all copies of .\" the Software and that both the above copyright notice(s) and this .\" permission notice appear in supporting documentation. .\" .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT .\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR .\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL .\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING .\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, .\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION .\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" .\" Except as contained in this notice, the name of a copyright holder .\" shall not be used in advertising or otherwise to promote the sale, use .\" or other dealings in this Software without prior written authorization .\" of the copyright holder. .\" .TH XkbSetIndicatorMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .SH NAME XkbSetIndicatorMap \- Downloads the changes to the server based on modifications to a local copy of the keyboard description which will update the maps for one or more indicators .SH SYNOPSIS .B Bool XkbSetIndicatorMap ( .I dpy, .I which, .I desc ) .br Display *\fI dpy \fP\^; .br unsigned int \fI which \fP\^; .br XkbDescPtr \fI desc \fP\^; .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS .TP .I \- dpy connection to the X server .TP .I \- which mask of indicators to change .TP .I \- desc keyboard description from which the maps are taken .SH DESCRIPTION .LP This section discusses the effects of explicitly changing indicators depending upon different settings in the indicator map. See Tables 1 and Table 2 for information on the effects of the indicator map fields when explicit changes are made. .TS c s s c s s l l l l l lw(3i). Table 1 XkbIndicatorMapRec which_groups and groups, Indicator Drives Keyboard _ which_groups New State Effect on Keyboard Group State _ XkbIM_UseNone On or Off No effect XkbIM_UseBase On or Off No effect XkbIM_UseLatched On T{ The groups field is treated as a group mask. The keyboard group latch is changed to the lowest numbered group specified in groups; if groups is empty, the keyboard group latch is changed to zero. T} XkbIM_UseLatched Off T{ The groups field is treated as a group mask. If the indicator is explicitly extinguished, keyboard group latch is changed to the lowest numbered group not specified in groups; if groups is zero, the keyboard group latch is set to the index of the highest legal keyboard group. T} XkbIM_UseLocked or .br XkbIM_UseEffective On T{ If the groups mask is empty, group is not changed; otherwise, the locked keyboard group is changed to the lowest numbered group specified in groups. T} XkbIM_UseLocked or .br XkbIM_UseEffective Off T{ Locked keyboard group is changed to the lowest numbered group that is not specified in the groups mask, or to Group1 if the groups mask contains all keyboard groups. T} .TE .TS c s s c s s l l l l l lw(3i). Table 2 XkbIidocatorMapRec which_mods and mods, Indicator Drives Keyboard _ which_mods New State Effect on Keyboard Modifiers _ XkbIM_UseNone or 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. T} 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{ Any modifiers specified in the mask field of mods are added to the locked modifiers. T} 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{ Any modifiers specified in the mask field of mods are removed from both the locked and latched modifiers. T} .TE 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 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. If neither XkbIM_NoAutomatic nor XkbIM_NoExplicit is set in an indicator map, Xkb honors any request to change the state of the indicator, but the new state might be immediately superseded by automatic changes to the indicator state if the keyboard state or controls change. The effects of changing an indicator that drives the keyboard are cumulative; it is possible for a single change to affect keyboard group, modifiers, and controls simultaneously. If you change an indicator for which both the XkbIM_LEDDrivesKB and XkbIM_NoAutomatic flags are specified, Xkb applies the keyboard changes specified in the other indicator map fields and changes the indicator to reflect the state that was explicitly requested. The indicator remains in the new state until it is explicitly changed again. If the XkbIM_NoAutomatic flag is not set and XkbIM_LEDDrivesKB is set, Xkb applies the changes specified in the other indicator map fields and sets the state of the indicator to the values specified by the indicator map. Note that it is possible in this case for the indicator to end up in a different state than the one that was explicitly requested. For example, Xkb does not extinguish an indicator with .I which_mods of XkbIM_UseBase and .I mods of Shift if, at the time Xkb processes the request to extinguish the indicator, one of the Shift keys is physically depressed. If you explicitly light an indicator for which XkbIM_LEDDrivesKB is set, Xkb enables all of the boolean controls specified in the .I ctrls field of its indicator map. Explicitly extinguishing such an indicator causes Xkb to disable all of the boolean controls specified in .I ctrls. For each bit set in the .I which parameter, .I XkbSetIndicatorMap sends the corresponding indicator map from the .I desc parameter to the server. .SH "SEE ALSO" .BR XkbSetNamedIndicator (__libmansuffix__)@ 1.1.1.1 log @initial import of libX11-1.1.4 @ text @@ 1.1.1.1.2.1 log @Apply patch (requested by mrg in ticket #958): Bring over X.Org updates from HEAD. @ text @d114 1 a114 1 Table 2 XkbIndicatorMapRec which_mods and mods, d194 1 a194 1 .BR XkbSetNamedIndicator (__libmansuffix__) @ 1.1.1.2 log @initial import of libX11-1.2 @ text @d114 1 a114 1 Table 2 XkbIndicatorMapRec which_mods and mods, d194 1 a194 1 .BR XkbSetNamedIndicator (__libmansuffix__) @ 1.1.1.3 log @initial import of libX11-1.3.3 @ text @d2 3 a4 2 .\" Copyright 1999 Sun Microsystems, Inc. All rights reserved. .\" d6 23 a28 17 .\" 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. a35 1 .HP d37 11 a47 3 .BI "(\^Display *" "dpy" "\^," .BI "unsigned int " "which" "\^," .BI "XkbDescPtr " "desc" "\^);" @ 1.1.1.4 log @initial import of libX11-1.4.1: - remove support for building without XCB - many man page updates - many random bug fixes - several new nls aliases (need to enable these yet.) @ text @d2 1 a2 1 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. @ 1.1.1.5 log @initial import of libX11-1.8.2 @ text @d2 1 a2 1 .\" Copyright (c) 1999, Oracle and/or its affiliates. d38 1 a38 1 .I dpy d41 1 a41 1 .I which d44 1 a44 1 .I desc d105 1 a105 3 XkbIM_UseNone or .br XkbIM_UseBase On or Off No Effect d114 1 a114 5 XkbIM_UseLocked, .br XkbIM_UseCompat, or .br XkbIM_UseEffective On T{ d122 1 a122 3 XkbIM_UseCompat or .br XkbIM_UseEffective Off T{ d132 2 a133 2 .IR XkbSetNamedIndicator ), Xkb changes the keyboard state and controls to reflect the other fields of the @ 1.1.1.6 log @initial import of libX11-1.8.13 @ text @d25 2 a26 2 XkbSetIndicatorMap \- Downloads the changes to the server based on modifications to a local copy of the keyboard description which will update the maps for one d48 3 a50 3 This section discusses the effects of explicitly changing indicators depending upon different settings in the indicator map. See Tables 1 and Table 2 for information on the effects of the indicator map fields when explicit changes are d58 1 a58 1 Table 1 XkbIndicatorMapRec which_groups and groups, d66 3 a68 3 The groups field is treated as a group mask. The keyboard group latch is changed to the lowest numbered group specified in groups; if groups is empty, the keyboard group latch is d72 4 a75 4 The groups field is treated as a group mask. If the indicator is explicitly extinguished, keyboard group latch is changed to the lowest numbered group not specified in groups; if groups is zero, the keyboard d81 2 a82 2 If the groups mask is empty, group is not changed; otherwise, the locked keyboard group is changed to the d88 2 a89 2 Locked keyboard group is changed to the lowest numbered group that is not specified in the groups mask, or d109 1 a109 1 Any modifiers specified in the mask field of mods are added to the latched d113 1 a113 1 Any modifiers specified in the mask field of mods are removed from the latched d121 1 a121 1 Any modifiers specified in the mask field of mods are added to the locked d125 1 a125 1 Any modifiers specified in the mask field of mods are removed from the locked d131 1 a131 1 Any modifiers specified in the mask field of mods are removed from both the d136 1 a136 1 If XkbIM_LEDDrivesKB is set and XkbIM_NoExplicit is not, and if you call a d138 2 a139 2 .I XkbSetIndicatorMap or d142 2 a143 2 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, d145 4 a148 4 If neither XkbIM_NoAutomatic nor XkbIM_NoExplicit is set in an indicator map, Xkb honors any request to change the state of the indicator, but the new state might be immediately superseded by automatic changes to the indicator state if d151 2 a152 2 The effects of changing an indicator that drives the keyboard are cumulative; it is possible for a single change to affect keyboard group, modifiers, and d155 4 a158 4 If you change an indicator for which both the XkbIM_LEDDrivesKB and XkbIM_NoAutomatic flags are specified, Xkb applies the keyboard changes specified in the other indicator map fields and changes the indicator to reflect the state that was explicitly requested. The indicator remains in the new state d161 10 a170 10 If the XkbIM_NoAutomatic flag is not set and XkbIM_LEDDrivesKB is set, Xkb applies the changes specified in the other indicator map fields and sets the state of the indicator to the values specified by the indicator map. Note that it is possible in this case for the indicator to end up in a different state than the one that was explicitly requested. For example, Xkb does not extinguish an indicator with .I which_mods of XkbIM_UseBase and .I mods of Shift if, at the time Xkb processes the request to extinguish the indicator, d173 13 a185 13 If you explicitly light an indicator for which XkbIM_LEDDrivesKB is set, Xkb enables all of the boolean controls specified in the .I ctrls field of its indicator map. Explicitly extinguishing such an indicator causes Xkb to disable all of the boolean controls specified in .I ctrls. For each bit set in the .I which parameter, .I XkbSetIndicatorMap sends the corresponding indicator map from the .I desc @