1 files changed, 132 insertions, 0 deletions
diff --git a/libX11/man/xkb/XkbAllocNames.man b/libX11/man/xkb/XkbAllocNames.man
new file mode 100644
index 000000000..eec606b5f
--- /dev/null
+++ b/libX11/man/xkb/XkbAllocNames.man
@@ -0,0 +1,132 @@
+'\" 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__)