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.36;	author mrg;	state Exp;
branches
	1.1.1.1;
next	;

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

1.1.1.2
date	2010.05.22.01.22.20;	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.52;	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
@.\" 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 XkbSetAutoRepeatRate __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
XkbSetAutoRepeatRate \- Sets the attributes of the RepeatKeys control for a 
keyboard device
.SH SYNOPSIS
.B Bool XkbSetAutoRepeatRate
(
.I display,
.I device_spec,
.I timeout,
.I interval
)
.br
      Display *\fI display \fP\^;
.br
      unsigned int \fI device_spec \fP\^;
.br
      unsigned int \fI timeout \fP\^;
.br
      unsigned int \fI interval \fP\^;                  
.if n .ti +5n
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- display
connection to X server
.TP
.I \- device_spec
device to configure, or XkbUseCoreKbd
.TP
.I \- timeout
initial delay, ms
.TP
.I \- interval
delay between repeats, ms
.SH DESCRIPTION
.LP
The core protocol allows only control over whether or not the entire keyboard or 
individual keys should auto-repeat when held down. RepeatKeys is a boolean 
control that extends this capability by adding control over the delay until a 
key begins to repeat and the rate at which it repeats. RepeatKeys is coupled 
with the core auto-repeat control: when RepeatKeys is enabled or disabled, the 
core auto-repeat is enabled or disabled and vice versa.

Auto-repeating keys are controlled by two attributes. The first, 
.I timeout, 
is the delay after the initial press of an auto-repeating key and the first 
generated repeat event. The second, 
.I interval, 
is the delay between all subsequent generated repeat events. As with all boolean 
controls, configuring the attributes that determine how the control operates 
does not automatically enable the control as a whole.

.I XkbSetAutoRepeatRate 
sends a request to the X server to configure the AutoRepeat control attributes 
to the values specified in 
.I timeout 
and 
.I interval.
 
.I XkbSetAutoRepeatRate 
does not wait for a reply; it normally returns True. Specifying a zero value for 
either 
.I timeout 
or 
.I interval 
causes the server to generate a BadValue protocol error. If a compatible version 
of the Xkb extension is not available in the server, 
.I XkbSetAutoRepeatRate 
returns False.
.SH "RETURN VALUES"
.TP 15
True
The 
.I XkbSetAutoRepeatRate 
function returns True normally.
.TP 15
False
The 
.I XkbSetAutoRepeatRate 
function returns False if a compatible version of the Xkb extension is not 
available in the server.
.SH DIAGNOSTICS
.TP 15
.B BadValue
An argument is out of range
@


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
@d1 3
a3 2
.\" Copyright 1999 Sun Microsystems, Inc.  All rights reserved.
.\"
d5 23
a27 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 "(\^Display *" "display" "\^,"
.BI "unsigned int " "device_spec" "\^,"
.BI "unsigned int " "timeout" "\^,"
.BI "unsigned int " "interval" "\^);"
@


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
@d1 1
a1 1
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
@


1.1.1.4
log
@initial import of libX11-1.8.2
@
text
@d1 1
a1 1
.\" Copyright (c) 1999, Oracle and/or its affiliates.
d37 1
a37 1
.I display
d40 1
a40 1
.I device_spec
d43 1
a43 1
.I timeout
d46 1
a46 1
.I interval
@


1.1.1.5
log
@initial import of libX11-1.8.13
@
text
@d24 1
a24 1
XkbSetAutoRepeatRate \- Sets the attributes of the RepeatKeys control for a
d50 5
a54 5
The core protocol allows only control over whether or not the entire keyboard or
individual keys should auto-repeat when held down. RepeatKeys is a boolean
control that extends this capability by adding control over the delay until a
key begins to repeat and the rate at which it repeats. RepeatKeys is coupled
with the core auto-repeat control: when RepeatKeys is enabled or disabled, the
d57 7
a63 7
Auto-repeating keys are controlled by two attributes. The first,
.I timeout,
is the delay after the initial press of an auto-repeating key and the first
generated repeat event. The second,
.I interval,
is the delay between all subsequent generated repeat events. As with all boolean
controls, configuring the attributes that determine how the control operates
d66 5
a70 5
.I XkbSetAutoRepeatRate
sends a request to the X server to configure the AutoRepeat control attributes
to the values specified in
.I timeout
and
d72 10
a81 10

.I XkbSetAutoRepeatRate
does not wait for a reply; it normally returns True. Specifying a zero value for
either
.I timeout
or
.I interval
causes the server to generate a BadValue protocol error. If a compatible version
of the Xkb extension is not available in the server,
.I XkbSetAutoRepeatRate
d86 2
a87 2
The
.I XkbSetAutoRepeatRate
d91 3
a93 3
The
.I XkbSetAutoRepeatRate
function returns False if a compatible version of the Xkb extension is not
@