[Patch] Documenting pointer acceleration

[Peter Hutterer]

On Thu, Dec 17, 2009 at 04:33:35PM +0100, Simon Thum wrote:
> Resending to include philip as xinput maintainer. xset doesn't have a
> dedicated maintainer. Alan?

> >From 369279a9d90c410944300c5985c18b7f0028e750 Mon Sep 17 00:00:00 2001
> From: Simon Thum <simon.thum at gmx.de>
> Date: Sun, 18 Oct 2009 15:10:56 +0200
> Subject: [PATCH] xinput: clarify role of set-ptr-feedback
> 
> ---
>  man/xinput.man |    6 +++++-
>  1 files changed, 5 insertions(+), 1 deletions(-)
> 
> diff --git a/man/xinput.man b/man/xinput.man
> index fbf445e..e322e05 100644
> --- a/man/xinput.man
> +++ b/man/xinput.man
> @@ -39,7 +39,11 @@ Change the mode of \fIdevice\fP.
>  .PP
>  .TP 8
>  .B --set-ptr-feedback \fIdevice\fP \fIthreshold\fP \fInum\fP \fIdenom\fP
> -Change the acceleration of \fIdevice\fP.
> +Change the pointer acceleration (or feedback) parameters of \fIdevice\fP.
> +The xset man page has more details. For X.Org Server 1.7
> +and above, there are additional device properties pertaining to pointer
> +acceleration. These do not replace, but complement the pointer feedback
> +setting.
>  .PP
>  .TP 8
>  .B --set-integer-feedback \fIdevice\fP \fIindex\fP \fIvalue\fP
> -- 
> 1.6.4.4

> >From 824500ed21fb7ace558e5099681e69556e12c849 Mon Sep 17 00:00:00 2001
> From: Simon Thum <simon.thum at gmx.de>
> Date: Sun, 18 Oct 2009 17:49:41 +0200
> Subject: [PATCH] xset: update info about pointer acceleration
> 
> Also, try to avoid confusion in the description of
> what acceleration means.
> ---
>  xset.man |   28 +++++++++++++++++++---------
>  1 files changed, 19 insertions(+), 9 deletions(-)
> 
> diff --git a/xset.man b/xset.man
> index 0377640..3a42acd 100644
> --- a/xset.man
> +++ b/xset.man
> @@ -188,13 +188,16 @@ xset led named "Scroll Lock"
>  .TP 8
>  .B mouse
>  The \fBm\fP option controls the mouse parameters; it may be
> -abbreviated to 'm'.
> -The parameters for the mouse are `acceleration' and `threshold'.
> -The acceleration can be specified as an integer, or as a simple
> -fraction.
> -The mouse, or whatever pointer the machine is connected to,
> -will go `acceleration' times as fast when it travels more than `threshold'
> -pixels in a short time.  This way, the mouse can be used for precise
> +abbreviated to 'm'. Of course, it applies to most pointing devices, not just
> +mice. The parameters for the pointing device are `acceleration' and
> +`threshold'. The acceleration can be specified as an integer, or as a simple
> +fraction. Threshold is just an integer. The setting is applied to all connected
> +pointing devices. xinput(1) should be used if you need device-specific settings.
> +
> +By default the pointer (the on-screen representation of the pointing device)
> +will go `acceleration' times as fast when the device travels more than
> +`threshold' mickeys (i.e. would-be pixels) in 10 ms, including a small
> +transition range. This way, the pointing device can be used for precise
>  alignment when it is moved slowly, yet it can be set to travel across
>  the screen in a flick of the wrist when desired.  One or both
>  parameters for the 
> @@ -208,8 +211,15 @@ If the `threshold' parameter is provided and 0, the `acceleration'
>  parameter will be used in the exponent of a more natural and continuous
>  formula, giving precise control for slow motion but big reach for fast
>  motion, and a progressive transition for motions in between.
> -Recommended `acceleration' value in this case is 3/2 to 2, but not
> +Recommended `acceleration' value in this case is 3/2 to 3, but not
>  limited to that range.
> +
> +In the X.org X Server 1.6 and above, the behaviour described so far is linked
> +to the default profile. There are other profiles (i.e. functions determining
> +pointer acceleration from device velocity) and additional settings, so the
> +above description may not apply to non-default cases. In the X.org Server 1.7,
> +these are available as input device properties (see xinput).
> +
>  .PP
>  .TP 8
>  .B p
> @@ -280,7 +290,7 @@ These settings will be reset to default values when you log out.
>  Note that not all X implementations are guaranteed to honor all of these
>  options.
>  .SH "SEE ALSO"
> -X(__miscmansuffix__), Xserver(1), xmodmap(1), xrdb(1), xsetroot(1)
> +X(__miscmansuffix__), Xserver(1), xmodmap(1), xrdb(1), xsetroot(1), xinput(1)
>  .SH AUTHOR
>  Bob Scheifler, MIT Laboratory for Computer Science
>  .br
> -- 
> 1.6.4.4

given the two changes alan already suggested, 
Reviewed-by: Peter Hutterer <peter.hutterer at who-t.net>

please send out the last version of these patches and I'll push them once
they're in my inbox.

Cheers,
  Peter