diff options
author | marha <marha@users.sourceforge.net> | 2012-08-27 08:17:50 +0200 |
---|---|---|
committer | marha <marha@users.sourceforge.net> | 2012-09-04 14:23:00 +0200 |
commit | 02b914d3b9b658a16e17cf2d95deede75dbbacc9 (patch) | |
tree | 3757711ab3e1db8e1b59877354096503d9635112 /libX11/man/xkb | |
parent | f479a5fc7f844d96b169c399cb1e8ac085de6c2b (diff) | |
download | vcxsrv-02b914d3b9b658a16e17cf2d95deede75dbbacc9.tar.gz vcxsrv-02b914d3b9b658a16e17cf2d95deede75dbbacc9.tar.bz2 vcxsrv-02b914d3b9b658a16e17cf2d95deede75dbbacc9.zip |
xwininfo fontconfig libX11 libXau libXext libxcb mesa pixman
xkeyboard-config git update 27 Aug 2012
Diffstat (limited to 'libX11/man/xkb')
-rw-r--r-- | libX11/man/xkb/XkbGetNamedGeometry.man | 316 | ||||
-rw-r--r-- | libX11/man/xkb/XkbSAGroup.man | 119 | ||||
-rw-r--r-- | libX11/man/xkb/XkbSASetGroup.man | 126 | ||||
-rw-r--r-- | libX11/man/xkb/XkbSetDetectableAutorepeat.man | 208 | ||||
-rw-r--r-- | libX11/man/xkb/XkbSetDeviceButtonActions.man | 178 |
5 files changed, 470 insertions, 477 deletions
diff --git a/libX11/man/xkb/XkbGetNamedGeometry.man b/libX11/man/xkb/XkbGetNamedGeometry.man index 24e5b36c6..c7572a0d1 100644 --- a/libX11/man/xkb/XkbGetNamedGeometry.man +++ b/libX11/man/xkb/XkbGetNamedGeometry.man @@ -1,159 +1,157 @@ -'\" 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 XkbGetNamedGeometry __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
-.SH NAME
-XkbGetNamedGeometry \- Loads a keyboard geometry description from this database
-by name
-.SH SYNTAX
-.HP
-.B Status XkbGetNamedGeometry
-.BI "(\^Display *" "dpy" "\^,"
-.BI "XkbDescPtr " "xkb" "\^,"
-.BI "Atom " "name" "\^);"
-.if n .ti +5n
-.if t .ti +.5i
-.SH ARGUMENTS
-.TP
-.I \- dpy
-connection to the X server
-.TP
-.I \- xkb
-keyboard description into which the geometry should be loaded
-.TP
-.I \- name
-name of the geometry to be loaded
-.SH DESCRIPTION
-.LP
-It is also possible to load a keyboard geometry by name. The X server maintains
-a database
-of keyboard components (see below).
-
-.I XkbGetNamedGeometry
-can return BadName if the name cannot be found.
-
-The X server maintains a database of keyboard components, identified by
-component type.
-The database contains all the information necessary to build a complete keyboard
-description for a particular device, as well as to assemble partial
-descriptions. Table 1 identifies the component types and the type of information
-they contain.
-
-.TS
-c s s
-l l l
-l l l
-l lw(2i) lw(2i).
-Table 1 Server Database Keyboard Components
-_
-Component Component Primary Contents May also contain
-Type
-_
-Keymap T{
-Complete keyboard description
-.br
-Normally assembled using a complete component from each of the other types
-T}
-.sp
-Keycodes T{
-Symbolic name for each key
-.br
-Minimum and maximum legal keycodes
-T} T{
-Aliases for some keys
-.br
-Symbolic names for indicators
-.br
-Description of indicators physically present
-T}
-.sp
-Types Key types T{
-Real modifier bindings and symbolic names for some virtual modifiers
-T}
-.sp
-Compatibility T{
-Rules used to assign actions to keysyms
-T} T{
-Maps for some indicators
-.br
-Real modifier bindings and symbolic names for some virtual modifiers
-T}
-.sp
-Symbols T{
-Symbol mapping for keyboard keys
-.br
-Modifier mapping
-.br
-Symbolic names for groups
-T} T{
-Explicit actions and behaviors for some keys
-.br
-Real modifier bindings and symbolic names for some virtual modifiers
-T}
-.sp
-Geometry Layout of the keyboard T{
-Aliases for some keys; overrides keycodes component aliases
-.br
-Symbolic names for some indicators
-.br
-Description of indicators physically present
-T}
-.TE
-
-While a keymap is a database entry for a complete keyboard description, and
-therefore
-logically different from the individual component database entries, the rules
-for
-processing keymap entries are identical to those for the individual components.
-In the
-discussion that follows, the term component is used to refer to either
-individual
-components or a keymap.
-
-There may be multiple entries for each of the component types. An entry may be
-either
-.I complete
-or
-.I partial.
-Partial entries describe only a piece of the corresponding keyboard component
-and are
-designed to be combined with other entries of the same type to form a complete
-entry.
-
-For example, a partial symbols map might describe the differences between a
-common ASCII
-keyboard and some national layout. Such a partial map is not useful on its own
-because it
-does not include those symbols that are the same on both the ASCII and national
-layouts
-(such as function keys). On the other hand, this partial map can be used to
-configure
-.I any
-ASCII keyboard to use a national layout.
-
-When a keyboard description is built, the components are processed in the order
-in which
-they appear in Table 1; later definitions override earlier ones.
-.SH DIAGNOSTICS
-.TP 15
-.B BadName
-A font or color of the specified name does not exist.
+'\" 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 XkbGetNamedGeometry __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbGetNamedGeometry \- Loads a keyboard geometry description from this database +by name +.SH SYNOPSIS +.HP +.B Status XkbGetNamedGeometry +.BI "(\^Display *" "dpy" "\^," +.BI "XkbDescPtr " "xkb" "\^," +.BI "Atom " "name" "\^);" +.SH ARGUMENTS +.TP +.I \- dpy +connection to the X server +.TP +.I \- xkb +keyboard description into which the geometry should be loaded +.TP +.I \- name +name of the geometry to be loaded +.SH DESCRIPTION +.LP +It is also possible to load a keyboard geometry by name. The X server maintains +a database +of keyboard components (see below). + +.I XkbGetNamedGeometry +can return BadName if the name cannot be found. + +The X server maintains a database of keyboard components, identified by +component type. +The database contains all the information necessary to build a complete keyboard +description for a particular device, as well as to assemble partial +descriptions. Table 1 identifies the component types and the type of information +they contain. + +.TS +c s s +l l l +l l l +l lw(2i) lw(2i). +Table 1 Server Database Keyboard Components +_ +Component Component Primary Contents May also contain +Type +_ +Keymap T{ +Complete keyboard description +.br +Normally assembled using a complete component from each of the other types +T} +.sp +Keycodes T{ +Symbolic name for each key +.br +Minimum and maximum legal keycodes +T} T{ +Aliases for some keys +.br +Symbolic names for indicators +.br +Description of indicators physically present +T} +.sp +Types Key types T{ +Real modifier bindings and symbolic names for some virtual modifiers +T} +.sp +Compatibility T{ +Rules used to assign actions to keysyms +T} T{ +Maps for some indicators +.br +Real modifier bindings and symbolic names for some virtual modifiers +T} +.sp +Symbols T{ +Symbol mapping for keyboard keys +.br +Modifier mapping +.br +Symbolic names for groups +T} T{ +Explicit actions and behaviors for some keys +.br +Real modifier bindings and symbolic names for some virtual modifiers +T} +.sp +Geometry Layout of the keyboard T{ +Aliases for some keys; overrides keycodes component aliases +.br +Symbolic names for some indicators +.br +Description of indicators physically present +T} +.TE + +While a keymap is a database entry for a complete keyboard description, and +therefore +logically different from the individual component database entries, the rules +for +processing keymap entries are identical to those for the individual components. +In the +discussion that follows, the term component is used to refer to either +individual +components or a keymap. + +There may be multiple entries for each of the component types. An entry may be +either +.I complete +or +.I partial. +Partial entries describe only a piece of the corresponding keyboard component +and are +designed to be combined with other entries of the same type to form a complete +entry. + +For example, a partial symbols map might describe the differences between a +common ASCII +keyboard and some national layout. Such a partial map is not useful on its own +because it +does not include those symbols that are the same on both the ASCII and national +layouts +(such as function keys). On the other hand, this partial map can be used to +configure +.I any +ASCII keyboard to use a national layout. + +When a keyboard description is built, the components are processed in the order +in which +they appear in Table 1; later definitions override earlier ones. +.SH DIAGNOSTICS +.TP 15 +.B BadName +A font or color of the specified name does not exist. diff --git a/libX11/man/xkb/XkbSAGroup.man b/libX11/man/xkb/XkbSAGroup.man index 2c80bfe30..3de10bc69 100644 --- a/libX11/man/xkb/XkbSAGroup.man +++ b/libX11/man/xkb/XkbSAGroup.man @@ -1,60 +1,59 @@ -'\" 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 XkbSAGroup __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
-.SH NAME
-XkbSAGroup \- Returns the group_XXX field of act converted to a signed int
-.SH SYNOPSIS
-.HP
-.B int XkbSAGroup
-.BI "(\^XkbAction " "act" "\^);"
-.if n .ti +5n
-.if t .ti +.5i
-.SH ARGUMENTS
-.TP
-.I \- act
-action from which to extract group
-.SH DESCRIPTION
-.LP
-.I XkbSAGroup
-returns the
-.I group_XXX
-field of
-.I act
-converted to a signed int.
-.SH STRUCTURE
-.LP
-Actions associated with the XkbGroupAction structure change the current group
-state when keys are
-pressed and released:
-.nf
-
- typedef struct _XkbGroupAction {
- unsigned char type; /\(** XkbSA_{Set|Latch|Lock}Group */
- unsigned char flags; /\(** with type, controls the effect on groups
-*/
- char group_XXX; /\(** represents a group index or delta */
- } XkbGroupAction;
-
-.SH WARNING
-.LP
-This manpage seems to be incomplete
+'\" 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 XkbSAGroup __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbSAGroup \- Returns the group_XXX field of act converted to a signed int +.SH SYNOPSIS +.HP +.B int XkbSAGroup +.BI "(\^XkbAction " "act" "\^);" +.SH ARGUMENTS +.TP +.I \- act +action from which to extract group +.SH DESCRIPTION +.LP +.I XkbSAGroup +returns the +.I group_XXX +field of +.I act +converted to a signed int. +.SH STRUCTURE +.LP +Actions associated with the XkbGroupAction structure change the current group +state when keys are +pressed and released: +.nf +.ft CW + typedef struct _XkbGroupAction { + unsigned char type; /\(** XkbSA_{Set|Latch|Lock}Group */ + unsigned char flags; /\(** with type, controls the effect on groups +*/ + char group_XXX; /\(** represents a group index or delta */ + } XkbGroupAction; +.ft +.fi +.SH WARNING +.LP +This manpage seems to be incomplete diff --git a/libX11/man/xkb/XkbSASetGroup.man b/libX11/man/xkb/XkbSASetGroup.man index 867d23d98..7df74c888 100644 --- a/libX11/man/xkb/XkbSASetGroup.man +++ b/libX11/man/xkb/XkbSASetGroup.man @@ -1,63 +1,63 @@ -'\" 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 XkbSASetGroup __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
-.SH NAME
-XkbSASetGroup \- Sets the group_XXX field of act from the group index grp
-.SH SYNTAX
-.HP
-.B void XkbSASetGroup
-.BI "(\^XkbAction " "act" "\^,"
-.BI "int " "grp" "\^);"
-.if n .ti +5n
-.if t .ti +.5i
-.SH ARGUMENTS
-.TP
-.I \- act
-action from which to set group
-.TP
-.I \- grp
-group index to set in group_XXX
-.SH DESCRIPTION
-.LP
-.I XkbSASetGroup
-sets the
-.I group_XXX
-field of
-.I act
-from the group index
-.I grp.
-.SH STRUCTURE
-.LP
-Actions associated with the XkbGroupAction structure change the current group state when keys are
-pressed and released:
-.nf
-
- typedef struct _XkbGroupAction {
- unsigned char type; /\(** XkbSA_{Set|Latch|Lock}Group */
- unsigned char flags; /\(** with type, controls the effect on groups */
- char group_XXX; /\(** represents a group index or delta */
- } XkbGroupAction;
-
-.SH WARNING
-.LP
-This manpage seems to be incomplete
+'\" 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 XkbSASetGroup __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbSASetGroup \- Sets the group_XXX field of act from the group index grp +.SH SYNOPSIS +.HP +.B void XkbSASetGroup +.BI "(\^XkbAction " "act" "\^," +.BI "int " "grp" "\^);" +.SH ARGUMENTS +.TP +.I \- act +action from which to set group +.TP +.I \- grp +group index to set in group_XXX +.SH DESCRIPTION +.LP +.I XkbSASetGroup +sets the +.I group_XXX +field of +.I act +from the group index +.I grp. +.SH STRUCTURE +.LP +Actions associated with the XkbGroupAction structure change the +current group state when keys are pressed and released: + +.nf +.ft CW + typedef struct _XkbGroupAction { + unsigned char type; /\(** XkbSA_{Set|Latch|Lock}Group */ + unsigned char flags; /\(** with type, controls the effect on groups */ + char group_XXX; /\(** represents a group index or delta */ + } XkbGroupAction; +.ft +.fi +.SH WARNING +.LP +This manpage seems to be incomplete diff --git a/libX11/man/xkb/XkbSetDetectableAutorepeat.man b/libX11/man/xkb/XkbSetDetectableAutorepeat.man index f519f3224..c54b349be 100644 --- a/libX11/man/xkb/XkbSetDetectableAutorepeat.man +++ b/libX11/man/xkb/XkbSetDetectableAutorepeat.man @@ -1,105 +1,103 @@ -.\" 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 XkbSetDetectableAutoRepeat __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
-.SH NAME
-XkbSetDetectableAutoRepeat \- Sets DetectableAutoRepeat
-.SH SYNTAX
-.HP
-.B Bool XkbSetDetectableAutoRepeat
-.BI "(\^Display *" "display" "\^,"
-.BI "Bool " "detectable" "\^,"
-.BI "Bool *" "supported_rtrn" "\^);"
-.if n .ti +5n
-.if t .ti +.5i
-.SH ARGUMENTS
-.TP
-.I \- display
-connection to X server
-.TP
-.I \- detectable
-True => set DetectableAutoRepeat
-.TP
-.I \- supported_rtrn
-backfilled True if DetectableAutoRepeat supported
-.SH DESCRIPTION
-.LP
-Auto-repeat is the generation of multiple key events by a keyboard when the user
-presses a key and holds it down. Keyboard hardware and device-dependent X server
-software often implement auto-repeat by generating multiple KeyPress events with
-no intervening KeyRelease event. The standard behavior of the X server is to
-generate a KeyRelease event for every KeyPress event. If the keyboard hardware
-and device-dependent software of the X server implement auto-repeat by
-generating multiple KeyPress events, the device-independent part of the X server
-by default synthetically generates a KeyRelease event after each KeyPress event.
-This provides predictable behavior for X clients, but does not allow those
-clients to detect the fact that a key is auto-repeating.
-
-Xkb allows clients to request
-.I detectable auto-repeat.
-If a client requests and the server supports DetectableAutoRepeat, Xkb generates
-KeyRelease events only when the key is physically released. If
-DetectableAutoRepeat is not supported or has not been requested, the server
-synthesizes a KeyRelease event for each repeating KeyPress event it generates.
-
-DetectableAutoRepeat, unlike other controls, is not contained in the
-XkbControlsRec structure, nor can it be enabled or disabled via the
-EnabledControls control. Instead, query and set DetectableAutoRepeat using
-.I XkbGetDetectableAutoRepeat
-and
-.I XkbSetDetectableAutoRepeat.
-
-DetectableAutoRepeat is a condition that applies to all keyboard devices for a
-client's connection to a given X server; it cannot be selectively set for some
-devices and not for others. For this reason, none of the Xkb library functions
-involving DetectableAutoRepeat involve a device specifier.
-
-This request affects all keyboard activity for the requesting client only; other
-clients still see the expected nondetectable auto-repeat behavior, unless they
-have requested otherwise.
-
-.I XkbSetDetectableAutoRepeat
-sends a request to the server to set DetectableAutoRepeat on for the current
-client if
-.I detectable
-is True, and off if
-.I detectable
-is False; it then waits for a reply. If
-.I supported_rtrn
-is not NULL,
-.I XkbSetDetectableAutoRepeat
-backfills
-.I supported_rtrn
-with True if the server supports DetectableAutoRepeat, and False if it does not.
-.I XkbSetDetectableAutoRepeat
-returns the current state of DetectableAutoRepeat for the requesting client:
-True if DetectableAutoRepeat is set, and False otherwise.
-.SH "RETURN VALUES"
-.TP 15
-True
-The
-.I XkbSetDetectableAutoRepeat
-function returns True if DetectableAutoRepeat is set.
-.TP 15
-False
-The
-.I XkbSetDetectableAutoRepeat
-function returns False if DetectableAutoRepeat is not set.
+.\" 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 XkbSetDetectableAutoRepeat __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbSetDetectableAutoRepeat \- Sets DetectableAutoRepeat +.SH SYNOPSIS +.HP +.B Bool XkbSetDetectableAutoRepeat +.BI "(\^Display *" "display" "\^," +.BI "Bool " "detectable" "\^," +.BI "Bool *" "supported_rtrn" "\^);" +.SH ARGUMENTS +.TP +.I \- display +connection to X server +.TP +.I \- detectable +True => set DetectableAutoRepeat +.TP +.I \- supported_rtrn +backfilled True if DetectableAutoRepeat supported +.SH DESCRIPTION +.LP +Auto-repeat is the generation of multiple key events by a keyboard when the user +presses a key and holds it down. Keyboard hardware and device-dependent X server +software often implement auto-repeat by generating multiple KeyPress events with +no intervening KeyRelease event. The standard behavior of the X server is to +generate a KeyRelease event for every KeyPress event. If the keyboard hardware +and device-dependent software of the X server implement auto-repeat by +generating multiple KeyPress events, the device-independent part of the X server +by default synthetically generates a KeyRelease event after each KeyPress event. +This provides predictable behavior for X clients, but does not allow those +clients to detect the fact that a key is auto-repeating. + +Xkb allows clients to request +.I detectable auto-repeat. +If a client requests and the server supports DetectableAutoRepeat, Xkb generates +KeyRelease events only when the key is physically released. If +DetectableAutoRepeat is not supported or has not been requested, the server +synthesizes a KeyRelease event for each repeating KeyPress event it generates. + +DetectableAutoRepeat, unlike other controls, is not contained in the +XkbControlsRec structure, nor can it be enabled or disabled via the +EnabledControls control. Instead, query and set DetectableAutoRepeat using +.I XkbGetDetectableAutoRepeat +and +.I XkbSetDetectableAutoRepeat. + +DetectableAutoRepeat is a condition that applies to all keyboard devices for a +client's connection to a given X server; it cannot be selectively set for some +devices and not for others. For this reason, none of the Xkb library functions +involving DetectableAutoRepeat involve a device specifier. + +This request affects all keyboard activity for the requesting client only; other +clients still see the expected nondetectable auto-repeat behavior, unless they +have requested otherwise. + +.I XkbSetDetectableAutoRepeat +sends a request to the server to set DetectableAutoRepeat on for the current +client if +.I detectable +is True, and off if +.I detectable +is False; it then waits for a reply. If +.I supported_rtrn +is not NULL, +.I XkbSetDetectableAutoRepeat +backfills +.I supported_rtrn +with True if the server supports DetectableAutoRepeat, and False if it does not. +.I XkbSetDetectableAutoRepeat +returns the current state of DetectableAutoRepeat for the requesting client: +True if DetectableAutoRepeat is set, and False otherwise. +.SH "RETURN VALUES" +.TP 15 +True +The +.I XkbSetDetectableAutoRepeat +function returns True if DetectableAutoRepeat is set. +.TP 15 +False +The +.I XkbSetDetectableAutoRepeat +function returns False if DetectableAutoRepeat is not set. diff --git a/libX11/man/xkb/XkbSetDeviceButtonActions.man b/libX11/man/xkb/XkbSetDeviceButtonActions.man index d08812d2d..122fc45f2 100644 --- a/libX11/man/xkb/XkbSetDeviceButtonActions.man +++ b/libX11/man/xkb/XkbSetDeviceButtonActions.man @@ -1,90 +1,88 @@ -'\" 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 XkbSetDeviceButtonActions __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
-.SH NAME
-XkbSetDeviceButtonActions \- Change only the button actions for an input extension device
-.SH SYNTAX
-.HP
-.B Bool XkbSetDeviceButtonActions
-.BI "(\^Display *" "dpy" "\^,"
-.BI "XkbDeviceInfoPtr " "device" "\^,"
-.BI "unsigned int " "first_button" "\^,"
-.BI "unsigned int " "num_buttons" "\^);"
-.if n .ti +5n
-.if t .ti +.5i
-.SH ARGUMENTS
-.TP
-.I \- dpy
-connection to X server
-.TP
-.I \- device
-structure defining the device and modifications
-.TP
-.I \- first_button
-number of first button to update, 0 relative
-.TP
-.I \- num_buttons
-number of buttons to update
-.SH DESCRIPTION
-.LP
-.I XkbSetDeviceButtonActions
-assigns actions to the buttons of the device specified in
-.I device_info->device_spec.
-Actions are assigned to
-.I num_buttons
-buttons beginning with
-.I first_button
-and are taken from the actions specified in
-.I device_info->btn_acts.
-
-If the server does not support assignment of Xkb actions to extension device buttons,
-.I XkbSetDeviceButtonActions
-has no effect and returns False. If the device has no buttons or if
-.I first_button
-or
-.I num_buttons
-specify buttons outside of the valid range as determined by
-.I device_info->num_btns,
-the function has no effect and returns False. Otherwise,
-.I XkbSetDeviceButtonActions
-sends a request to the server to change the actions for the specified buttons and returns
-True.
-
-If the actual request sent to the server involved illegal button numbers, a BadValue protocol
-error is generated. If an invalid device identifier is specified in
-.I device_info->device_spec,
-a BadKeyboard protocol error results. If the actual device specified in
-.I device_info->device_spec
-does not contain buttons and a request affecting buttons is made, a BadMatch protocol error is
-generated.
-.SH DIAGNOSTICS
-.TP 15
-.B BadKeyboard
-The device specified was not a valid core or input extension device
-.TP 15
-.B BadMatch
-A compatible version of Xkb was not available in the server or an argument has correct type
-and range, but is otherwise invalid
-.TP 15
-.B BadValue
-An argument is out of range
+'\" 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 XkbSetDeviceButtonActions __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbSetDeviceButtonActions \- Change only the button actions for an input extension device +.SH SYNOPSIS +.HP +.B Bool XkbSetDeviceButtonActions +.BI "(\^Display *" "dpy" "\^," +.BI "XkbDeviceInfoPtr " "device" "\^," +.BI "unsigned int " "first_button" "\^," +.BI "unsigned int " "num_buttons" "\^);" +.SH ARGUMENTS +.TP +.I \- dpy +connection to X server +.TP +.I \- device +structure defining the device and modifications +.TP +.I \- first_button +number of first button to update, 0 relative +.TP +.I \- num_buttons +number of buttons to update +.SH DESCRIPTION +.LP +.I XkbSetDeviceButtonActions +assigns actions to the buttons of the device specified in +.I device_info->device_spec. +Actions are assigned to +.I num_buttons +buttons beginning with +.I first_button +and are taken from the actions specified in +.I device_info->btn_acts. + +If the server does not support assignment of Xkb actions to extension device buttons, +.I XkbSetDeviceButtonActions +has no effect and returns False. If the device has no buttons or if +.I first_button +or +.I num_buttons +specify buttons outside of the valid range as determined by +.I device_info->num_btns, +the function has no effect and returns False. Otherwise, +.I XkbSetDeviceButtonActions +sends a request to the server to change the actions for the specified buttons and returns +True. + +If the actual request sent to the server involved illegal button numbers, a BadValue protocol +error is generated. If an invalid device identifier is specified in +.I device_info->device_spec, +a BadKeyboard protocol error results. If the actual device specified in +.I device_info->device_spec +does not contain buttons and a request affecting buttons is made, a BadMatch protocol error is +generated. +.SH DIAGNOSTICS +.TP 15 +.B BadKeyboard +The device specified was not a valid core or input extension device +.TP 15 +.B BadMatch +A compatible version of Xkb was not available in the server or an argument has correct type +and range, but is otherwise invalid +.TP 15 +.B BadValue +An argument is out of range |