Fix some roff code add see also

Signed-off-by: Walter Harms <wharms@bfs.de>
This commit is contained in:
Walter Harms 2020-11-28 20:56:35 +01:00
parent daa106927f
commit 4f15cfc645

View file

@ -23,8 +23,7 @@
.TH XkbChangeControls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" .TH XkbChangeControls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME .SH NAME
XkbChangeControls \- Provides a flexible method for updating the controls in a XkbChangeControls \- Provides a flexible method for updating the controls in a
server to match those in server to match those in the changed keyboard description
the changed keyboard description
.SH SYNOPSIS .SH SYNOPSIS
.HP .HP
.B Bool XkbChangeControls .B Bool XkbChangeControls
@ -35,40 +34,33 @@ the changed keyboard description
.if t .ti +.5i .if t .ti +.5i
.SH ARGUMENTS .SH ARGUMENTS
.TP .TP
.I \- dpy .I dpy
connection to X server connection to X server
.TP .TP
.I \- xkb .I xkb
keyboard description with changed xkb->ctrls keyboard description with changed xkb->ctrls
.TP .TP
.I \- changes .I changes
which parts of xkb->ctrls have changed which parts of xkb->ctrls have changed
.SH DESCRIPTION .SH DESCRIPTION
.LP
The XkbControlsChangesRec structure allows applications to track modifications The XkbControlsChangesRec structure allows applications to track modifications
to an XkbControlsRec to an XkbControlsRec structure and thereby reduce the amount of traffic sent
structure and thereby reduce the amount of traffic sent to the server. The same to the server. The same XkbControlsChangesRec structure may be used in several
XkbControlsChangesRec successive modifications to the same XkbControlsRec structure, then subsequently
structure may be used in several successive modifications to the same used to cause all of the changes, and only the changes, to be propagated to the server.
XkbControlsRec structure, then
subsequently used to cause all of the changes, and only the changes, to be
propagated to the server.
The The
.I changed_ctrls .I changed_ctrls
field is a mask specifying which logical sets of data in the controls structure field is a mask specifying which logical sets of data in the controls structure
have been modified. In have been modified. In this context, modified means
this context, modified means .IR set ,
.I set,
that is, if a value is set to the same value it previously contained, it has that is, if a value is set to the same value it previously contained, it has
still been modified, and is still been modified, and is noted as changed. Valid values for
noted as changed. Valid values for
.I changed_ctrls .I changed_ctrls
are any combination of the masks listed in Table 1 that have "ok" in the are any combination of the masks listed in Table 1 that have "ok" in the
.I changed_ctrls .I changed_ctrls
column. Setting a bit implies the corresponding data fields from the "Relevant column. Setting a bit implies the corresponding data fields from the "Relevant
XkbControlsRec Data XkbControlsRec Data Fields" column in Table 1 have been modified. The
Fields" column in Table 1 have been modified. The
.I enabled_ctrls_changes .I enabled_ctrls_changes
field specifies which bits in the field specifies which bits in the
.I enabled_ctrls .I enabled_ctrls
@ -250,16 +242,12 @@ T} 10.6.8
.TE .TE
Table 2 shows the actual values for the individual mask bits used to select Table 2 shows the actual values for the individual mask bits used to select
controls for controls for modification and to enable and disable the control. Note that
modification and to enable and disable the control. Note that the same mask bit the same mask bit is used to specify general modifications to the parameters
is used to used to configure the control (which), and to enable and disable the control
specify general modifications to the parameters used to configure the control (enabled_ctrls). The anomalies in the table (no "ok" in column)
(which), and to
enable and disable the control (enabled_ctrls). The anomalies in the table (no
"ok" in column)
are for controls that have no configurable attributes; and for controls that are are for controls that have no configurable attributes; and for controls that are
not boolean not boolean controls and therefore cannot be enabled or disabled.
controls and therefore cannot be enabled or disabled.
.TS .TS
c s s s c s s s
@ -296,36 +284,38 @@ XkbAllBooleanCtrlsMask ok (0x00001FFF)
XkbAllControlsMask ok (0xF8001FFF) XkbAllControlsMask ok (0xF8001FFF)
.TE .TE
If you have an Xkb description with controls that have been modified and an If you have an Xkb description with controls that have been modified and an
XkbControlsChangesRec that XkbControlsChangesRec that describes the changes that have been made, the
describes the changes that have been made, the
.I XkbChangeControls .I XkbChangeControls
function provides a flexible method for updating the controls in a server to function provides a flexible method for updating the controls in a server to
match those in the changed match those in the changed keyboard description.
keyboard description.
.I XkbChangeControls .I XkbChangeControls
copies any controls fields specified by copies any controls fields specified by
.I changes .I changes
from the keyboard description controls structure, from the keyboard description controls structure,
.I xkb->ctrls, .IR xkb->ctrls ,
to the server specified by to the server specified by
.I dpy. .IR dpy .
.SH STRUCTURES .SH STRUCTURES
.LP
The XkbControlsChangesRec structure is defined as follows: The XkbControlsChangesRec structure is defined as follows:
.nf .nf
typedef struct _XkbControlsChanges { typedef struct _XkbControlsChanges {
unsigned int changed_ctrls; /\&* bits indicating changed control data unsigned int changed_ctrls; /\&* bits indicating changed control data */
*/ unsigned int enabled_ctrls_changes; /\&* bits indicating enabled/disabled controls */
unsigned int enabled_ctrls_changes; /\&* bits indicating enabled/disabled Bool num_groups_changed; /\&* True if number of keyboard groups changed */
controls */
Bool num_groups_changed; /\&* True if number of keyboard groups
changed */
} XkbControlsChangesRec,*XkbControlsChangesPtr; } XkbControlsChangesRec,*XkbControlsChangesPtr;
.fi .fi
.SH "SEE ALSO"
XkbChangeControls(__libmansuffix__),
XkbChangeDeviceInfo(__libmansuffix__),
XkbChangeEnabledControls(__libmansuffix__),
XkbChangeIndicators(__libmansuffix__),
XkbChangeMap(__libmansuffix__),
XkbChangeNames(__libmansuffix__),
XkbChangeTypesOfKey(__libmansuffix__)