head	1.1;
branch	1.1.1;
access;
symbols
	netbsd-11-0-RC7:1.1.1.4
	libX11-1-8-13:1.1.1.5
	netbsd-11-0-RC6:1.1.1.4
	netbsd-11-0-RC5:1.1.1.4
	netbsd-11-0-RC4:1.1.1.4
	netbsd-11-0-RC3:1.1.1.4
	netbsd-11-0-RC2:1.1.1.4
	netbsd-11-0-RC1:1.1.1.4
	netbsd-11:1.1.1.4.0.4
	netbsd-11-base:1.1.1.4
	libX11-1-8-12:1.1.1.4
	netbsd-10-1-RELEASE:1.1.1.4
	libX11-1-8-10:1.1.1.4
	libX11-1-8-9:1.1.1.4
	netbsd-8-3-RELEASE:1.1.1.3
	netbsd-9-4-RELEASE:1.1.1.3
	netbsd-10-0-RELEASE:1.1.1.4
	netbsd-10-0-RC6:1.1.1.4
	netbsd-10-0-RC5:1.1.1.4
	netbsd-10-0-RC4:1.1.1.4
	netbsd-10-0-RC3:1.1.1.4
	netbsd-10-0-RC2:1.1.1.4
	netbsd-10-0-RC1:1.1.1.4
	libX11-1-8-7:1.1.1.4
	libX11-1-8-6:1.1.1.4
	libX11-1-8-4:1.1.1.4
	libX11-1-8-3:1.1.1.4
	netbsd-10:1.1.1.4.0.2
	netbsd-10-base:1.1.1.4
	libX11-1-8-2:1.1.1.4
	netbsd-9-3-RELEASE:1.1.1.3
	libX11-1-8-1:1.1.1.3
	libX11-1-7-2:1.1.1.3
	libX11-1-7-1:1.1.1.3
	netbsd-9-2-RELEASE:1.1.1.3
	libX11-1-7-0:1.1.1.3
	netbsd-9-1-RELEASE:1.1.1.3
	libX11-1-6-12:1.1.1.3
	libX11-1-6-10:1.1.1.3
	netbsd-8-2-RELEASE:1.1.1.3
	libX11-1-6-9:1.1.1.3
	netbsd-9-0-RELEASE:1.1.1.3
	netbsd-9-0-RC2:1.1.1.3
	netbsd-9-0-RC1:1.1.1.3
	netbsd-9:1.1.1.3.0.18
	netbsd-9-base:1.1.1.3
	libX11-1-6-8:1.1.1.3
	netbsd-8-1-RELEASE:1.1.1.3
	netbsd-8-1-RC1:1.1.1.3
	libX11-1-6-7:1.1.1.3
	netbsd-7-2-RELEASE:1.1.1.3
	libX11-1-6-6:1.1.1.3
	netbsd-8-0-RELEASE:1.1.1.3
	netbsd-8-0-RC2:1.1.1.3
	netbsd-8-0-RC1:1.1.1.3
	netbsd-7-1-2-RELEASE:1.1.1.3
	netbsd-7-1-1-RELEASE:1.1.1.3
	netbsd-8:1.1.1.3.0.16
	netbsd-8-base:1.1.1.3
	netbsd-7-1:1.1.1.3.0.14
	netbsd-7-1-RELEASE:1.1.1.3
	libX11-1-6-5:1.1.1.3
	netbsd-7-1-RC2:1.1.1.3
	netbsd-7-1-RC1:1.1.1.3
	netbsd-7-0-2-RELEASE:1.1.1.3
	libX11-1-6-4:1.1.1.3
	netbsd-7-0-1-RELEASE:1.1.1.3
	netbsd-7-0:1.1.1.3.0.12
	netbsd-7-0-RELEASE:1.1.1.3
	netbsd-7-0-RC3:1.1.1.3
	netbsd-7-0-RC2:1.1.1.3
	libX11-1-6-3:1.1.1.3
	netbsd-7-0-RC1:1.1.1.3
	netbsd-5-2-3-RELEASE:1.1.1.1
	netbsd-5-1-5-RELEASE:1.1.1.1
	netbsd-6-0-6-RELEASE:1.1.1.3
	netbsd-6-1-5-RELEASE:1.1.1.3
	netbsd-7:1.1.1.3.0.10
	netbsd-7-base:1.1.1.3
	netbsd-6-1-4-RELEASE:1.1.1.3
	netbsd-6-0-5-RELEASE:1.1.1.3
	riastradh-xf86-video-intel-2-7-1-pre-2-21-15:1.1.1.3
	libX11-1-6-2:1.1.1.3
	riastradh-drm2:1.1.1.3.0.8
	riastradh-drm2-base:1.1.1.3
	netbsd-6-1-3-RELEASE:1.1.1.3
	netbsd-6-0-4-RELEASE:1.1.1.3
	netbsd-5-2-2-RELEASE:1.1.1.1
	netbsd-5-1-4-RELEASE:1.1.1.1
	netbsd-6-1-2-RELEASE:1.1.1.3
	netbsd-6-0-3-RELEASE:1.1.1.3
	netbsd-5-2-1-RELEASE:1.1.1.1
	netbsd-5-1-3-RELEASE:1.1.1.1
	netbsd-6-1-1-RELEASE:1.1.1.3
	libX11-1-6-0:1.1.1.3
	libX11-1-5-99-902:1.1.1.3
	netbsd-6-1:1.1.1.3.0.6
	netbsd-6-0-2-RELEASE:1.1.1.3
	netbsd-6-1-RELEASE:1.1.1.3
	netbsd-6-1-RC4:1.1.1.3
	netbsd-6-1-RC3:1.1.1.3
	netbsd-6-1-RC2:1.1.1.3
	netbsd-6-1-RC1:1.1.1.3
	netbsd-5-2:1.1.1.1.0.8
	netbsd-6-0-1-RELEASE:1.1.1.3
	netbsd-5-2-RELEASE:1.1.1.1
	netbsd-5-2-RC1:1.1.1.1
	netbsd-6-0:1.1.1.3.0.4
	netbsd-6-0-RELEASE:1.1.1.3
	netbsd-6-0-RC2:1.1.1.3
	netbsd-6-0-RC1:1.1.1.3
	netbsd-6:1.1.1.3.0.2
	netbsd-6-base:1.1.1.3
	netbsd-5-1-2-RELEASE:1.1.1.1
	netbsd-5-1-1-RELEASE:1.1.1.1
	libX11-1-4-4:1.1.1.3
	libX11-1-4-3:1.1.1.3
	libX11-1-4-1:1.1.1.3
	libX11-1-3-6:1.1.1.2
	netbsd-5-1:1.1.1.1.0.6
	netbsd-5-1-RELEASE:1.1.1.1
	netbsd-5-1-RC4:1.1.1.1
	libX11-1-3-5:1.1.1.2
	libX11-1-3-4:1.1.1.2
	netbsd-5-1-RC3:1.1.1.1
	libX11-1-3-3:1.1.1.2
	netbsd-5-1-RC2:1.1.1.1
	netbsd-5-1-RC1:1.1.1.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.1
	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.1
	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.39;	author mrg;	state Exp;
branches
	1.1.1.1;
next	;

1.1.1.1
date	2008.07.30.02.43.39;	author mrg;	state Exp;
branches;
next	1.1.1.2;

1.1.1.2
date	2010.05.22.01.22.21;	author mrg;	state Exp;
branches;
next	1.1.1.3;

1.1.1.3
date	2011.02.23.07.55.43;	author mrg;	state Exp;
branches;
next	1.1.1.4;

1.1.1.4
date	2022.11.11.04.44.53;	author mrg;	state Exp;
branches;
next	1.1.1.5;
commitid	w9YHRKXKhJZNYe1E;

1.1.1.5
date	2026.07.11.23.01.34;	author mrg;	state Exp;
branches;
next	;
commitid	y4lCG7To2wFx2iNG;


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 XkbAllocNames __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
XkbAllocNames \- Allocate symbolic names structures
.SH SYNOPSIS
.B Status XkbAllocNames
(
.I xkb,
.I which,
.I num_rg,
.I num_key_aliases
)
.br
      XkbDescPtr \fIxkb\fP\^;
.br
      unsigned int \fIwhich\fP\^;
.br
      int \fInum_rg\fP\^;
.br
      int \fInum_key_aliases\fP\^;
.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__)
@


1.1.1.1
log
@initial import of libX11-1.1.4
@
text
@@


1.1.1.2
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.
a33 1
.HP
d35 14
a48 4
.BI "(\^XkbDescPtr " "xkb" "\^,"
.BI "unsigned int " "which" "\^,"
.BI "int " "num_rg" "\^,"
.BI "int " "num_key_aliases" "\^);"
@


1.1.1.3
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.4
log
@initial import of libX11-1.8.2
@
text
@d2 1
a2 1
.\" Copyright (c) 1999, Oracle and/or its affiliates.
d37 1
a37 1
.I xkb
d40 1
a40 1
.I which
d43 1
a43 1
.I num_rg
d46 1
a46 1
.I num_key_aliases
@


1.1.1.5
log
@initial import of libX11-1.8.13
@
text
@d50 8
a57 8
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
d60 4
a63 4
.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
d97 6
a102 6
Do not free symbolic names structures directly using
.I free
or
.I XFree.
Use
.I XkbFreeNames
d110 1
a110 1
A compatible version of Xkb was not available in the server or an argument has
@