diff options
Diffstat (limited to 'libX11/man/xkb/XkbFreeGeomKeyAliases.man')
-rw-r--r-- | libX11/man/xkb/XkbFreeGeomKeyAliases.man | 178 |
1 files changed, 89 insertions, 89 deletions
diff --git a/libX11/man/xkb/XkbFreeGeomKeyAliases.man b/libX11/man/xkb/XkbFreeGeomKeyAliases.man index 3a468feec..15ad0b24b 100644 --- a/libX11/man/xkb/XkbFreeGeomKeyAliases.man +++ b/libX11/man/xkb/XkbFreeGeomKeyAliases.man @@ -1,89 +1,89 @@ -.\" 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 XkbFreeGeomKeyAliases __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
-.SH NAME
-XkbFreeGeomKeyAliases \- Free geometry key aliases
-.SH SYNOPSIS
-.HP
-.B void XkbFreeGeomKeyAliases
-.BI "(\^XkbGeometryPtr " "geom" "\^,"
-.BI "int " "first" "\^,"
-.BI "int " "count" "\^,"
-.BI "Bool " "free_all" "\^);"
-.if n .ti +5n
-.if t .ti +.5i
-.SH ARGUMENTS
-.TP
-.I \- geom
-geometry in which key aliases should be freed
-.TP
-.I \- first
-first key alias to be freed
-.TP
-.I \- count
-number of key aliases to be freed
-.TP
-.I \- free_all
-True => all key aliases are freed
-.SH DESCRIPTION
-.LP
-Xkb provides a number of functions to allocate and free subcomponents of a
-keyboard geometry. Use these functions to create or modify keyboard geometries.
-Note that these functions merely allocate space for the new element(s), and it
-is up to you to fill in the values explicitly in your code. These allocation
-functions increase
-.I sz_*
-but never touch
-.I num_*
-(unless there is an allocation failure, in which case they reset both
-.I sz_*
-and
-.I num_*
-to zero). These functions return Success if they succeed, BadAlloc if they are
-not able to allocate space, or BadValue if a parameter is not as expected.
-
-If
-.I free_all
-is True, all aliases in the top level of the specified geometry
-.I geom
-are freed regardless of the value of
-.I first
-or
-.I count.
-Otherwise,
-.I count
-aliases in
-.I geom
-are freed beginning with the one specified by
-.I first.
-.SH "RETURN VALUES"
-.TP 15
-Success
-The XkbFreeGeomKeyAliases function returns Success if there are no allocation
-errors.
-.SH DIAGNOSTICS
-.TP 15
-.B BadAlloc
-Unable to allocate storage
-.TP 15
-.B BadValue
-An argument is out of range
+.\" 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 XkbFreeGeomKeyAliases __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbFreeGeomKeyAliases \- Free geometry key aliases +.SH SYNOPSIS +.HP +.B void XkbFreeGeomKeyAliases +.BI "(\^XkbGeometryPtr " "geom" "\^," +.BI "int " "first" "\^," +.BI "int " "count" "\^," +.BI "Bool " "free_all" "\^);" +.if n .ti +5n +.if t .ti +.5i +.SH ARGUMENTS +.TP +.I \- geom +geometry in which key aliases should be freed +.TP +.I \- first +first key alias to be freed +.TP +.I \- count +number of key aliases to be freed +.TP +.I \- free_all +True => all key aliases are freed +.SH DESCRIPTION +.LP +Xkb provides a number of functions to allocate and free subcomponents of a +keyboard geometry. Use these functions to create or modify keyboard geometries. +Note that these functions merely allocate space for the new element(s), and it +is up to you to fill in the values explicitly in your code. These allocation +functions increase +.I sz_* +but never touch +.I num_* +(unless there is an allocation failure, in which case they reset both +.I sz_* +and +.I num_* +to zero). These functions return Success if they succeed, BadAlloc if they are +not able to allocate space, or BadValue if a parameter is not as expected. + +If +.I free_all +is True, all aliases in the top level of the specified geometry +.I geom +are freed regardless of the value of +.I first +or +.I count. +Otherwise, +.I count +aliases in +.I geom +are freed beginning with the one specified by +.I first. +.SH "RETURN VALUES" +.TP 15 +Success +The XkbFreeGeomKeyAliases function returns Success if there are no allocation +errors. +.SH DIAGNOSTICS +.TP 15 +.B BadAlloc +Unable to allocate storage +.TP 15 +.B BadValue +An argument is out of range |