diff options
Diffstat (limited to 'libX11/man/xkb/XkbAllocNames.man')
-rw-r--r-- | libX11/man/xkb/XkbAllocNames.man | 232 |
1 files changed, 116 insertions, 116 deletions
diff --git a/libX11/man/xkb/XkbAllocNames.man b/libX11/man/xkb/XkbAllocNames.man index 9084713ed..f6286e7d4 100644 --- a/libX11/man/xkb/XkbAllocNames.man +++ b/libX11/man/xkb/XkbAllocNames.man @@ -1,116 +1,116 @@ -'\" t -.\" Copyright 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, 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 XkbAllocNames __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbAllocNames \- Allocate symbolic names structures -.SH SYNOPSIS -.HP -.B Status XkbAllocNames -.BI "(\^XkbDescPtr " "xkb" "\^," -.BI "unsigned int " "which" "\^," -.BI "int " "num_rg" "\^," -.BI "int " "num_key_aliases" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- xkb -keyboard description for which names are to be allocated -.TP -.I \- which -mask of names to be allocated -.TP -.I \- num_rg -total number of radio group names needed -.TP -.I \- num_key_aliases -total number of key aliases needed -.SH DESCRIPTION -.LP -Most applications do not need to directly allocate symbolic names structures. Do -not allocate a names structure directly using -.I malloc -or -.I Xmalloc -if your application changes the number of key aliases or radio groups or -constructs a symbolic names structure without loading the necessary components -from the X server. Instead use -.I XkbAllocNames. - -.I XkbAllocNames -can return BadAlloc, BadMatch, and BadValue errors. The -.I which -parameter is the bitwise inclusive OR of the valid names mask bits defined in -Table 1. - -.TS -c s s s -l l l l. -Table 1 Symbolic Names Masks -_ -Mask Bit Value Keyboard Field - Component -_ -XkbKeycodesNameMask (1<<0) Xkb->names keycodes -XkbGeometryNameMask (1<<1) Xkb->names geometry -XkbSymbolsNameMask (1<<2) Xkb->names symbols -XkbPhysSymbolsNameMask (1<<3) Xkb->names phys_symbols -XkbTypesNameMask (1<<4) Xkb->names type -XkbCompatNameMask (1<<5) Xkb->names compat -XkbKeyTypeNamesMask (1<<6) Xkb->map type[*].name -XkbKTLevelNamesMask (1<<7) Xkb->map type[*].lvl_names[*] -XkbIndicatorNamesMask (1<<8) Xkb->names indicators[*] -XkbKeyNamesMask (1<<9) Xkb->names keys[*], num_keys -XkbKeyAliasesMask (1<<10) Xkb->names key_aliases[*], num_key_aliases -XkbVirtualModNamesMask (1<<11) Xkb->names vmods[*] -XkbGroupNamesMask (1<<12) Xkb->names groups[*] -XkbRGNamesMask (1<<13) Xkb->names radio_groups[*], num_rg -XkbComponentNamesMask (0x3f) Xkb->names keycodes, - geometry, - symbols, - physical symbols, - types, and - compatibility map -XkbAllNamesMask (0x3fff) Xkb->names all name components -.TE - -Do not free symbolic names structures directly using -.I free -or -.I XFree. -Use -.I XkbFreeNames -instead. -.SH DIAGNOSTICS -.TP 15 -.B BadAlloc -Unable to allocate storage -.TP 15 -.B BadMatch -A compatible version of Xkb was not available in the server or an argument has -correct type and range, but is otherwise invalid -.TP 15 -.B BadValue -An argument is out of range -.SH "SEE ALSO" -.BR XkbFreeNames (__libmansuffix__) +'\" 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 XkbAllocNames __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
+.SH NAME
+XkbAllocNames \- Allocate symbolic names structures
+.SH SYNOPSIS
+.HP
+.B Status XkbAllocNames
+.BI "(\^XkbDescPtr " "xkb" "\^,"
+.BI "unsigned int " "which" "\^,"
+.BI "int " "num_rg" "\^,"
+.BI "int " "num_key_aliases" "\^);"
+.if n .ti +5n
+.if t .ti +.5i
+.SH ARGUMENTS
+.TP
+.I \- xkb
+keyboard description for which names are to be allocated
+.TP
+.I \- which
+mask of names to be allocated
+.TP
+.I \- num_rg
+total number of radio group names needed
+.TP
+.I \- num_key_aliases
+total number of key aliases needed
+.SH DESCRIPTION
+.LP
+Most applications do not need to directly allocate symbolic names structures. Do
+not allocate a names structure directly using
+.I malloc
+or
+.I Xmalloc
+if your application changes the number of key aliases or radio groups or
+constructs a symbolic names structure without loading the necessary components
+from the X server. Instead use
+.I XkbAllocNames.
+
+.I XkbAllocNames
+can return BadAlloc, BadMatch, and BadValue errors. The
+.I which
+parameter is the bitwise inclusive OR of the valid names mask bits defined in
+Table 1.
+
+.TS
+c s s s
+l l l l.
+Table 1 Symbolic Names Masks
+_
+Mask Bit Value Keyboard Field
+ Component
+_
+XkbKeycodesNameMask (1<<0) Xkb->names keycodes
+XkbGeometryNameMask (1<<1) Xkb->names geometry
+XkbSymbolsNameMask (1<<2) Xkb->names symbols
+XkbPhysSymbolsNameMask (1<<3) Xkb->names phys_symbols
+XkbTypesNameMask (1<<4) Xkb->names type
+XkbCompatNameMask (1<<5) Xkb->names compat
+XkbKeyTypeNamesMask (1<<6) Xkb->map type[*].name
+XkbKTLevelNamesMask (1<<7) Xkb->map type[*].lvl_names[*]
+XkbIndicatorNamesMask (1<<8) Xkb->names indicators[*]
+XkbKeyNamesMask (1<<9) Xkb->names keys[*], num_keys
+XkbKeyAliasesMask (1<<10) Xkb->names key_aliases[*], num_key_aliases
+XkbVirtualModNamesMask (1<<11) Xkb->names vmods[*]
+XkbGroupNamesMask (1<<12) Xkb->names groups[*]
+XkbRGNamesMask (1<<13) Xkb->names radio_groups[*], num_rg
+XkbComponentNamesMask (0x3f) Xkb->names keycodes,
+ geometry,
+ symbols,
+ physical symbols,
+ types, and
+ compatibility map
+XkbAllNamesMask (0x3fff) Xkb->names all name components
+.TE
+
+Do not free symbolic names structures directly using
+.I free
+or
+.I XFree.
+Use
+.I XkbFreeNames
+instead.
+.SH DIAGNOSTICS
+.TP 15
+.B BadAlloc
+Unable to allocate storage
+.TP 15
+.B BadMatch
+A compatible version of Xkb was not available in the server or an argument has
+correct type and range, but is otherwise invalid
+.TP 15
+.B BadValue
+An argument is out of range
+.SH "SEE ALSO"
+.BR XkbFreeNames (__libmansuffix__)
|