NAME

xrandr-align -- utility to keep the proper alignment between the screen and an X input device

SYNOPSIS

xrandr-align [OPTIONS] [FUNCTION] [FUNCTION-OPTIONS]

DESCRIPTION

The xrandr-align is a utility to keep the proper alignment between the screen and an X input device. The utility works in both ways. First, it can dynamically align an input device (touchscreen) to correspond the varying orientation of the screen. Second, it can dynamically align the screen to correspond the varying spacial orientation of the display (handheld device). In addition it can list available input devices and screen outputs.

OPTIONS

-v | --verbose

Turns on the verbose output mode.

FUNCTIONS

version

Prints out the program version and the versions of XInput and XRandR extensions available on the running X server. This function does not require any additional options.

list-input [--short | --long] [name-or-ID]

If no argument is given lists all available input devices. If an argument is given, shows all the features of the device with the given name or ID. If --long is provided, the output includes detailed information about the capabilities of each devices. Otherwise, or if --short is provided, only the device names and some minimal information is listed.

list-output [--screen=integer]

If no argument is given lists all available screen outputs. Optionally the screen number can be specified.

align [--input=name-or-ID] [--screen=integer] [--output=name-or-ID] [--pre-script=pre-script] [--post-script=post-script]

The default function. It is called when no function name is given. It queries the current screen configuration and applies the current coordinate transformation to the input device. If no options are given then the Core Pointer and the Primary Output (or the first available output) is used in correspondence. The name or the ID of the input device can be specified with the input option. The name or ID of the output can explicitly specified with the output option. For a multiple screen configuration the output selection can be directed by specifying the screen number.

Optionally a script defined with pre-script can be run prior to alignment and an other script defined by post-script can be run after alignment.

monitor [--input=name-or-ID] [--screen=integer] [--output=name-or-ID] [--pre-script=pre-script] [--post-script=post-script]

Listens to the screen (CRTC, output) change events from RandR and applies each coordinate transformation to the input device. If no options are given then the Core Pointer and the Primary Output (or the first available output) is used in correspondence. The name or the ID of the input device can be specified with the input option. The name or ID of the output can explicitly specified with the output option. For a multiple screen configuration the output selection can be directed by specifying the screen number.

Optionally a script defined with pre-script can be run prior to each alignment and an other script defined by post-script can be run after each alignment.

gravitate [--input=name-or-ID] [--screen=integer] [--ratio=float] [--threshold=float]

Listens to the events from the given input device which should be a gravity sensor (accelerometer) and rotates the screen in accordance with the varying spacial orientation of the device. The gravity sensor data is analysed with the use of ratio and threshold parameters. The first defines the minimum ratio between horizontal and vertical pitch in order to select the prevalent one and equals 2.0 by default. The second defines the minimal pitch value to consider in relation to the axis value range and equals 0.12 by default. The name or the ID of the input device should be specified with the input option. Optionally the screen number can be specified.

ENVIRONMENT

The program uses the DISPLAY environment variable specifying the X display to connect.

SEE ALSO

xrandr-align-monitor(1), xrandr-align-gravitate(1), xinput(1), xrandr(1)

LICENSE

Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of the authors not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The authors make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

THE AUTHORS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR 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.

COPYRIGHT

Copyright 2012, Paul Wolneykien, ALT Linux Ltd.

Original xinput utility:

Copyright 1996,1997, Frederic Lepied.
Copyright 2008, Philip Langdale.

Original xrandr utility:


Copyright 2001 Keith Packard.

AUTHORS

Paul Wolneykien <manowar@altlinux.org>
Philip Langdale, <philipl@alumni.utexas.net>
Frederic Lepied, France <Frederic.Lepied@sugix.frmug.org>
Peter Hutterer <peter.hutterer@who-t.net>
Julien Cristau <jcristau@debian.org>
Thomas Jaeger <ThJaeger@gmail.com>
Keith Packard, Open Source Technology Center, Intel Corporation
Jim Gettys, Cambridge Research Laboratory, HP Labs, HP
and more.